Merge branch 'development' into issue526-ticket-author

Author: Chris-Boe

.env.example

@@ -1,2 +1,6 @@
 SECRET_KEY='dwellingly'
 PYTHONPATH=${PWD}:${PYTHONPATH}
+
+# To set the database to postgresql. Uncomment the env vars below
+# DEV_DATABASE_URL=postgresql://localhost/dwellingly_development
+# TEST_DATABASE_URL=postgresql://localhost/dwellingly_test

.github/workflows/pytest.yml

@@ -8,12 +8,31 @@ on:
     branches:
       - development
 
+
+env:
+  POSTGRES_HOST_AUTH_METHOD: trust
+  PGUSER: postgres
+  PGHOST: localhost
+  SECRET_KEY: dwellingly
+  TEST_DATABASE_URL: postgresql://localhost/dwellingly_test
+  FLASK_ENV: testing
+
 jobs:
   pytest:
 
     runs-on: ubuntu-latest
-    env:
-      SECRET_KEY: dwellingly
+    services:
+      postgres:
+        image: postgres
+        env:
+          POSTGRES_HOST_AUTH_METHOD: trust
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
 
     steps:
       - uses: actions/checkout@v2
@@ -25,8 +44,8 @@ jobs:
       - name: Install dependecies
         run: pipenv run dev-install
 
-      - name: Setup Database
-        run: pipenv run flask db create
+      - name: Create db
+        run: createdb dwellingly_test
 
       - name: Test
         run: |

CONTRIBUTING.md

@@ -63,8 +63,7 @@ A resource's main job is to coordinate a response for the incoming request. If d
 Each resource will usually have one test for each action (GET, POST, DELETE, etc...). When the Models and Schemas have unit tests, and when the resource uses the models and schemas appropriately, then **generally** only a successful response (The Happy Path) needs to be tested. All other responses that can occur are already tested elsewhere, including validation errors or database rows that cannot be found. Errors such as these should not be tested, as they're already built into the architecture of the app and happen automatically as long as the schemas are used along with the appropriate methods defined in the BaseModel. Tests for the resources can be found in the `tests/integration` directory.
 
 ## Installation
-Set up Dwelling Flask Testing Backend (for the first time)
-NOTE: Database is SQLite3 via SQLAlchemy
+NOTE: Default development database is SQLite3. (Optionally setup and use [PostgreSQL](#PostgreSQL-Setup) as the database.)
 
 [Note for Windows users](#Note-For-Windows-Users)
 
@@ -110,6 +109,17 @@ NOTE: Database is SQLite3 via SQLAlchemy
 Queries can be made with the Postman Collection link ( https://www.getpostman.com/collections/a86a292798c7895425e2 )
 [![Run in Postman](https://run.pstmn.io/button.svg)](https://app.getpostman.com/run-collection/0078de8f58d4ea0b78eb)
 
+### PostgreSQL Setup
+1. Install [PostgreSQL](https://www.postgresql.org/download/).
+2. Manually create the database.
+   - From a linux or mac command line run the following:
+     ```shell
+      createdb dwellingly_development
+      createdb dwellingly_test
+     ```
+3. Open up `.env` and uncomment the `DEV_DATABASE_URL` and `TEST_DATABASE_URL` env vars.
+4. Run `pipenv run flask db create`.
+
 ### Note For Windows Users
 
 Python does not come by default for Windows users. Sometimes the PATH variable in Windows will point to the wrong path and you will have trouble running the `python` and `pipenv` commands. If you don't have Python installed then follow these steps. If the steps listed above did not work for you, try the following.
@@ -130,7 +140,7 @@ If you don't see something similar, you may have several versions of Python inst
 
 ### Database migrations.
 
-Database migrations are not used for development. Please ignore do not use migrations during development.
+Database migrations are currently not used. We will start using them soon.
 
 Database migrations are managed through [Alembic](https://alembic.sqlalchemy.org/en/latest/index.html). After making a change to a model, a database migration is necessary.
 

Pipfile

@@ -28,11 +28,11 @@ PyJWT = "==2.1.0"
 Werkzeug = "==2.0.1"
 Flask-Mailman = "==0.2.4"
 Flask-Cors = "*"
-psycopg2-binary = "*"
 bcrypt = "==3.2.0"
 flask-marshmallow = "*"
 marshmallow-sqlalchemy = "*"
 alembic = "*"
+psycopg2 = "*"
 
 [requires]
 python_version = "3.8"

Pipfile.lock

@@ -27,7 +27,7 @@ class Default(object):
 
 
 class Development(Default):
-    SQLALCHEMY_DATABASE_URI = os.environ.get(
+    SQLALCHEMY_DATABASE_URI = os.getenv(
         "DEV_DATABASE_URL"
     ) or "sqlite:///" + os.path.join(basedir, "data-dev.sqlite")
     JWT_ACCESS_TOKEN_EXPIRES = False
@@ -40,7 +40,7 @@ class Development(Default):
 
 class Testing(Default):
     TESTING = True
-    SQLALCHEMY_DATABASE_URI = os.environ.get("TEST_DATABASE_URL") or "sqlite://"
+    SQLALCHEMY_DATABASE_URI = os.getenv("TEST_DATABASE_URL") or "sqlite://"
     WORK_FACTOR = 4
     JWT_ACCESS_TOKEN_EXPIRES = False
     JWT_REFRESH_TOKEN_EXPIRES = False

config/environment.py

@@ -71,11 +71,8 @@ def _pm_header(pm=None):
 
 @pytest.fixture
 def empty_test_db(app):
-    db.create_all()
-
-    yield
-
     db.drop_all()
+    db.create_all()
 
 
 # -------------     NON-FIXTURE FUNCTIONS     --------------------