Adding smoketests for the API examples

This runs every API example in a minimal environment where the dependencies for the other API frameworks are missing. This test guarantees that json-logging works for each individual framework.

Author: chr1st1ank

.github/workflows/code_quality.yml

@@ -35,7 +35,6 @@ jobs:
     runs-on: ubuntu-latest
 
     strategy:
-      max-parallel: 4
       matrix:
         python-version: ["3.7", "3.8", "3.9"]
 
@@ -52,4 +51,28 @@ jobs:
           pip install -r test-requirements.txt
       - name: Run tests
         run:  |
-          pytest
+          pytest --ignore tests/smoketests
+
+  backendSmoketests:
+    name: Individual Backend Smoketests
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        backend: ["fastapi", "flask", "quart", "sanic"]
+
+    steps:
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: 3.9
+      - name: "Git checkout"
+        uses: actions/checkout@v2
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r tests/smoketests/${{ matrix.backend }}/requirements.txt
+      - name: Run tests
+        run:  |
+          export backend=${{ matrix.backend }}
+          pytest tests/smoketests/test_run_smoketest.py

README.md

@@ -125,7 +125,7 @@ async def home(request):
     return sanic.response.text("hello world")
 
 if __name__ == "__main__":
-    app.run(host="0.0.0.0", port=8000)
+    app.run(host="0.0.0.0", port=5000)
 ```
 
 ### Quart

tests/README.md

@@ -0,0 +1,11 @@
+# Organization of the test folder
+
+```
+├───helpers         Shared functionality for all tests
+├───smoketests      A test script to run all API examples and see if they work
+│   ├───fastapi
+│   ├───flask
+│   ├───quart
+│   └───sanic
+└───test_*.py       Unit tests
+```

tests/smoketests/fastapi/api.py

@@ -0,0 +1,20 @@
+import datetime, logging, sys, json_logging, fastapi, uvicorn
+
+app = fastapi.FastAPI()
+json_logging.init_fastapi(enable_json=True)
+json_logging.init_request_instrument(app)
+
+# init the logger as usual
+logger = logging.getLogger("test-logger")
+logger.setLevel(logging.DEBUG)
+logger.addHandler(logging.StreamHandler(sys.stdout))
+
+@app.get('/')
+def home():
+    logger.info("test log statement")
+    logger.info("test log statement with extra props", extra={'props': {"extra_property": 'extra_value'}})
+    correlation_id = json_logging.get_correlation_id()
+    return "Hello world : " + str(datetime.datetime.now())
+
+if __name__ == "__main__":
+    uvicorn.run(app, host='0.0.0.0', port=5000)

tests/smoketests/fastapi/requirements.txt

@@ -0,0 +1,5 @@
+fastapi
+uvicorn
+requests
+pytest
+-e .

tests/smoketests/flask/api.py

@@ -0,0 +1,20 @@
+import datetime, logging, sys, json_logging, flask
+
+app = flask.Flask(__name__)
+json_logging.init_flask(enable_json=True)
+json_logging.init_request_instrument(app)
+
+# init the logger as usual
+logger = logging.getLogger("test-logger")
+logger.setLevel(logging.DEBUG)
+logger.addHandler(logging.StreamHandler(sys.stdout))
+
+@app.route('/')
+def home():
+    logger.info("test log statement")
+    logger.info("test log statement with extra props", extra={'props': {"extra_property": 'extra_value'}})
+    correlation_id = json_logging.get_correlation_id()
+    return "Hello world : " + str(datetime.datetime.now())
+
+if __name__ == "__main__":
+    app.run(host='0.0.0.0', port=int(5000), use_reloader=False)

tests/smoketests/flask/requirements.txt

@@ -0,0 +1,4 @@
+flask
+requests
+pytest
+-e .

tests/smoketests/quart/api.py

@@ -0,0 +1,21 @@
+import asyncio, logging, sys, json_logging, quart
+
+app = quart.Quart(__name__)
+json_logging.init_quart(enable_json=True)
+json_logging.init_request_instrument(app)
+
+# init the logger as usual
+logger = logging.getLogger("test logger")
+logger.setLevel(logging.DEBUG)
+logger.addHandler(logging.StreamHandler(sys.stdout))
+
+@app.route('/')
+async def home():
+    logger.info("test log statement")
+    logger.info("test log statement with extra props", extra={'props': {"extra_property": 'extra_value'}})
+    correlation_id = json_logging.get_correlation_id()
+    return "Hello world"
+
+if __name__ == "__main__":
+    loop = asyncio.get_event_loop()
+    app.run(host='0.0.0.0', port=int(5000), use_reloader=False, loop=loop)

tests/smoketests/quart/requirements.txt

@@ -0,0 +1,4 @@
+quart
+requests
+pytest
+-e .

tests/smoketests/sanic/api.py

@@ -0,0 +1,24 @@
+import logging, sys, json_logging, sanic
+
+app = sanic.Sanic(name="sanic-web-app")
+json_logging.init_sanic(enable_json=True)
+json_logging.init_request_instrument(app)
+
+# init the logger as usual
+logger = logging.getLogger("sanic-integration-test-app")
+logger.setLevel(logging.DEBUG)
+logger.addHandler(logging.StreamHandler(sys.stdout))
+
+@app.route("/")
+async def home(request):
+    logger.info("test log statement")
+    logger.info("test log statement with extra props", extra={'props': {"extra_property": 'extra_value'}})
+    # this will be faster
+    correlation_id = json_logging.get_correlation_id(request=request)
+    # this will be slower, but will work in context you cant get a reference of request object
+    correlation_id_without_request_obj = json_logging.get_correlation_id()
+
+    return sanic.response.text("hello world")
+
+if __name__ == "__main__":
+    app.run(host="0.0.0.0", port=5000)