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)

tests/smoketests/sanic/requirements.txt

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

tests/smoketests/test_run_smoketest.py

@@ -0,0 +1,58 @@
+"""Test module to run all example APIs and see if they work independently of each other
+
+These tests are meant to be executed independently with only the minimal environment.
+This way it becomes clear if json_logging works without the dependencies of API frameworks one
+doesn't intend to use.
+"""
+
+import os
+import signal
+import subprocess
+import sys
+import time
+from pathlib import Path
+
+import pytest
+import requests
+
+
+def collect_backends():
+    """Generator function which returns all test backends one by one
+
+    If the environment variable "backend" is set, only this one backend is returned
+    """
+    preset_backend = os.environ.get('backend')
+    if preset_backend:
+        yield preset_backend
+    else:
+        for folder in Path(__file__).parent.iterdir():
+            if folder.is_dir():
+                yield str(folder.name)
+
+
+@pytest.mark.parametrize('backend', collect_backends(), ids=collect_backends())
+def test_api_example(backend):
+    """For each of the examples start the API and see if the root endpoint is reachable"""
+    api_process = subprocess.Popen(
+        [sys.executable, Path(__file__).parent / backend / "api.py"],
+        stdout=sys.stdout,
+        stderr=subprocess.STDOUT,
+    )
+    try:
+        deadline = time.perf_counter() + 10.0
+        while time.perf_counter() < deadline:
+            time.sleep(1)
+            session = requests.Session()
+            session.trust_env = False
+            os.environ['NO_PROXY'] = 'localhost'
+            os.environ['no_proxy'] = 'localhost'
+            try:
+                response = requests.get("http://localhost:5000/", timeout=1)
+                assert response.status_code == 200
+                return
+            except requests.exceptions.Timeout:
+                pass
+        assert False, "API did not respond"
+    finally:
+        api_process.send_signal(signal.SIGTERM)
+        api_process.wait(timeout=5.0)