chore: update test suite (#5)

* chore: add debugging options for flask app
* test: rename fixtures
* test: add pytest configuration file
* refactor: fix tests pylint issues
* chore: update pytest debugger configuration
* fix: change aunthentication decorator
* fix: update tests
* test: rename fixtures database models
* test: add missing test assertions

Author: miguel-osuna

.dockerignore

@@ -9,3 +9,4 @@ README.rst
 README.md
 *.pyc
 __pycache__
+logs/*

.gitignore

@@ -34,6 +34,7 @@ MANIFEST
 *.spec
 
 # Installer logs
+logs/*
 pip-log.txt
 pip-delete-this-directory.txt
 

cli/test.py

@@ -5,13 +5,12 @@
 
 
 @click.command()
-@click.argument("path", default="tests")
-def test(path):
+def test():
     """
     Run tests with Pytest (pytest-sugar).
 
     :param path: Test path
     :return: Subprocess call result
     """
-    command = f"py.test -s {path}"
+    command = "py.test --capture=no"
     return subprocess.call(command, shell=True)

docker/local/application/start

@@ -4,4 +4,4 @@ set -o errexit
 set -o pipefail
 set -o nounset
 
-flask run -h 0.0.0.0 -p 8000
+python -m debugpy --listen 0.0.0.0:5678 wsgi.py --wait-for-client --multiprocess -m flask run -h 0.0.0.0 -p 5000

local.yml

@@ -15,6 +15,7 @@ services:
       - ./.envs/.local/.application
       - ./.envs/.local/.mongo
     ports:
+      - "5678:5678"
       - "8000:8000"
     command: /start
 

pytest.ini

@@ -0,0 +1,14 @@
+[pytest]
+addopts = -ra -q --pdbcls=IPython.terminal.debugger:TerminalPdb
+minversion = 7.0
+python_files = 
+    test_*.py
+python_functions = 
+    test_*
+required_plugins =
+    pytest-sugar>=0.9.4
+    pytest-cov>=3.0.0
+    pytest-flask>=1.2.0
+    pytest-factoryboy>=2.4.0
+testpaths =
+    tests

quotes_api/api/resources/quote.py

@@ -127,6 +127,7 @@ def get(self, quote_id):
         """Get quote by id."""
         try:
             quote = Quote.objects.get_or_404(id=quote_id)
+            
         except Exception:
             return (
                 {"error": "Quote does not exist."},
@@ -140,8 +141,13 @@ def put(self, quote_id):
         """Replace entire quote."""
         try:
             quote = Quote.objects.get_or_404(id=quote_id)
+
         except Exception:
-            return {"error": "Quote does not exist."}
+            return (
+                {"error": "Quote does not exist."},
+                HttpStatus.NOT_FOUND_404.value,
+            )
+
         try:
             # Create quote schema instance
             quote_schema = QuoteSchema()
@@ -151,6 +157,7 @@ def put(self, quote_id):
             quote.save()
 
             return "", HttpStatus.NO_CONTENT_204.value
+
         except Exception:
             return (
                 {"error": "Missing data."},
@@ -162,11 +169,13 @@ def patch(self, quote_id):
         """Update quote fields."""
         try:
             quote = Quote.objects.get_or_404(id=quote_id)
+
         except Exception:
             return (
                 {"error": "Quote does not exist."},
                 HttpStatus.NOT_FOUND_404.value,
             )
+
         try:
             # Check quote schema instance
             quote_schema = QuoteSchema(partial=True)
@@ -176,6 +185,7 @@ def patch(self, quote_id):
             quote.save()
 
             return "", HttpStatus.NO_CONTENT_204.value
+
         except Exception:
             return {"error": "Missing data."}, HttpStatus.BAD_REQUEST_400.value
 
@@ -184,6 +194,7 @@ def delete(self, quote_id):
         """Delete quote."""
         try:
             quote = Quote.objects.get_or_404(id=quote_id)
+
         except Exception:
             return (
                 {"error": "Quote does not exist."},
@@ -193,6 +204,7 @@ def delete(self, quote_id):
         try:
             quote.delete()
             return "", HttpStatus.NO_CONTENT_204.value
+
         except Exception:
             return (
                 {"error": "Could not delete quote."},
@@ -334,8 +346,10 @@ def post(self):
             # Create quote schema instace
             quote_schema = QuoteSchema()
             data = quote_schema.load(request.json)
+
         except Exception:
             return {"error": "Missing data."}, HttpStatus.BAD_REQUEST_400.value
+
         try:
             # Create new database entry
             quote = Quote(**data)
@@ -453,8 +467,8 @@ def get(self):
 
             # Converting CommandCursor class iterator into a list and
             # then getting the only item in it
-            random_quote = list(quote_collection.aggregate(pipeline))
-            random_quote["id"] = random_quote["_id"]
+            random_quote = list(quote_collection.aggregate(pipeline))[0]
+            random_quote["id"] = random_quote.pop("_id")
 
             # Create quote schema instance
             quote_schema = QuoteSchema()

quotes_api/api/schemas/quote.py

@@ -7,7 +7,7 @@ class QuoteSchema(ma.Schema):
     """Marshmallow quote schema."""
 
     id = ma.String(dump_only=True)
-    quote_text = ma.String()
-    author_name = ma.String()
+    quote_text = ma.String(required=True)
+    author_name = ma.String(required=True)
     author_image = ma.URL()
-    tags = ma.List(ma.String())
+    tags = ma.List(ma.String(required=True))

quotes_api/auth/decorators.py

@@ -38,6 +38,9 @@ def wrapper(*args, **kwargs):
             for role in roles:
                 if Role(role) not in role_list:
                     denied = True
+
+                if Role(role) in role_list:
+                    denied = False
                     break
 
             if denied:

quotes_api/auth/resources/token.py

@@ -234,7 +234,8 @@ class RefreshTokenRevoke(Resource):
 
     @jwt_required(refresh=True)
     def delete(self):
-        """Revokes a refresh token from the database.
+        """
+        Revokes a refresh token from the database.
 
         Used mainly for logout.
         """

quotes_api/auth/resources/user.py

@@ -310,6 +310,7 @@ def get(self, user_id):
         """Get user by id."""
         try:
             user = User.objects.get_or_404(id=user_id)
+
         except Exception:
             return (
                 {"error": "User does not exist."},
@@ -325,8 +326,13 @@ def put(self, user_id):
         """Replace entire user."""
         try:
             user = User.objects.get_or_404(id=user_id)
+
         except Exception:
-            return {"error": "User does not exist."}
+            return (
+                {"error": "User does not exist."},
+                HttpStatus.NOT_FOUND_404.value,
+            )
+
         try:
             # Create user schema instance
             user_schema = UserSchema()
@@ -345,11 +351,13 @@ def patch(self, user_id):
         """Update user fields."""
         try:
             user = User.objects.get_or_404(id=user_id)
+
         except Exception:
             return (
                 {"error": "User does not exist."},
                 HttpStatus.NOT_FOUND_404.value,
             )
+
         try:
             # Create user schema instance and ignore any missing fields
             user_schema = UserSchema(partial=True)
@@ -369,14 +377,17 @@ def delete(self, user_id):
 
         try:
             user = User.objects.get_or_404(id=user_id)
+
         except Exception:
             return (
                 {"error": "User does not exist."},
                 HttpStatus.NOT_FOUND_404.value,
             )
+
         try:
             user.delete()
             return "", HttpStatus.NO_CONTENT_204.value
+
         except Exception:
             return (
                 {"error": "Could not delete user"},

quotes_api/config.py

@@ -54,7 +54,7 @@ class TestingConfig(Config):
     SECRET_KEY = "testing"
 
     # Mongoengine Configuration
-    MONGODB_DB = "quotes_test_database"
+    MONGODB_DB = "test_quotes_database"
     MONGODB_HOST = "mongo"