Add tests and GitHub Actions (#9)

Co-authored-by: David Girón <[email protected]>

Author: arponpes

.github/workflows/ci.yaml

@@ -0,0 +1,42 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    paths:
+    - "src/**"
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    name: Build
+    steps:
+      - uses: actions/checkout@v3
+      - name: Login GHCR
+        uses: docker/login-action@v2
+        with:
+          username: ${{ github.repository_owner }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+          registry: ghcr.io
+      - name: Set metadata
+        id: meta
+        uses: docker/metadata-action@v4
+        with:
+          images: ghcr.io/${{ github.repository_owner }}/github-workflows-monitoring
+          flavor: |
+            latest=true
+          tags: |
+            type=ref,event=branch
+            type=ref,event=pr
+            type=semver,pattern={{version}}
+            type=semver,pattern={{major}}.{{minor}}
+      - name: Docker build and push
+        uses: docker/build-push-action@v4
+        with:
+          push: ${{ github.event_name != 'pull_request' }}
+          tags: ${{ steps.meta.outputs.tags }}
+          labels: ${{ steps.meta.outputs.labels }}
+          context: .

.github/workflows/tests.yaml

@@ -0,0 +1,31 @@
+name: Tests
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11"]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r tests/requirements.txt
+      - name: Lint with flake8
+        run: |
+          flake8
+      - name: Test with pytest
+        run: |
+          pytest --cov=src

README.md

@@ -1 +1,18 @@
-# github-workflows-monitoring
+# github-workflows-monitoring
+
+[![Tests](https://github.com/midokura/github-workflows-monitoring/actions/workflows/tests.yaml/badge.svg)](https://github.com/midokura/github-workflows-monitoring/actions/workflows/tests.yaml)
+
+## About
+
+Github Workflow Monitoring is a small Flask-based web server that connects to Github using websockets to monitor Github Actions workflows. It tracks each workflow's state (queued, in_progress, completed) and calculates the time spent in each state. The metrics are logged in logfmt format for easy consumption by Grafana.
+
+## Testing
+
+Into a virtual environment, install the requirements:
+
+    pip install -r tests/requirements.txt
+
+
+To run the tests:
+
+    pytest --cov=src

pytest.ini

@@ -0,0 +1,3 @@
+[pytest]
+testpaths = tests/tests.py
+pythonpath = src

setup.cfg

@@ -8,3 +8,8 @@ python_requires = >=3.8
 packages = find:
 install_requires = 
         Flask>=2.2,<3
+
+[flake8]
+max-line-length = 120
+exit-zero = True
+max-complexity = 10

src/app.py

@@ -5,6 +5,7 @@
 
 from flask import Flask, abort, request
 
+
 from const import GithubHeaders, LOGGING_CONFIG
 from utils import parse_datetime
 
@@ -21,6 +22,7 @@
 
 jobs = dict()
 
+
 # check all calls are valid
 @app.before_request
 def validate_origin_github():
@@ -90,8 +92,10 @@ def process_workflow_job():
         app.logger.warning(f"Unknown action {action}, removing from memory")
         if job_id in jobs:
             del jobs[job_id]
+        msg = None
 
-    app.logger.info(msg)
+    if msg:
+        app.logger.info(msg)
     return True
 
 
@@ -102,11 +106,7 @@ def github_webhook_process():
 
     if command == "process_workflow_job":
         app.logger.debug(f"Calling function {command}")
-        response = process_workflow_job()
-
-        if not response:
-            app.logger.error(f"Error calling {event} function")
-            return abort(500)
+        process_workflow_job()
         return "OK"
 
     app.logger.error(f"Unknown event type {event}, can't handle")

tests/__init__.py

@@ -0,0 +1,12 @@
+import pytest
+from src.app import app
+
+
+@pytest.fixture()
+def app_instance():
+    yield app
+
+
+@pytest.fixture()
+def client(app_instance):
+    return app_instance.test_client()

tests/conftest.py

@@ -0,0 +1,4 @@
+Flask
+pytest
+pytest-cov
+flake8

tests/requirements.txt

@@ -0,0 +1,127 @@
+from src.const import GithubHeaders
+
+HEADERS = {
+    GithubHeaders.EVENT.value: "workflow_job",
+    "Content-Type": "application/json",
+    "User-Agent": "GitHub-Hookshot/123",
+}
+BODY = {
+    "action": "",
+    "workflow_job": {
+        "id": 0,
+        "workflow_name": "CI",
+        "started_at": "2023-01-27T14:00:00Z",
+    },
+    "repository": {
+        "full_name": "foo/foo",
+    },
+}
+
+
+def test_method_not_allowed(client):
+    assert client.get("/github-webhook").status_code == 401
+
+
+def test_headers_not_correct(client, caplog):
+    response = client.post("/github-webhook")
+    assert response.status_code == 401
+    assert caplog.messages == [
+        "User-Agent is werkzeug/2.2.2",
+        "Content is not JSON",
+        "No GitHub Event received!",
+    ]
+
+
+def test_no_body_bad_request(client):
+    response = client.post("/github-webhook", headers=HEADERS)
+    assert response.status_code == 400
+
+
+def test_unknown_event(client, caplog):
+    headers = HEADERS.copy()
+    headers[GithubHeaders.EVENT.value] = "foo"
+    response = client.post("/github-webhook", headers=headers, json={})
+    assert response.status_code == 405
+    assert caplog.messages == ["Unknown event type foo, can't handle"]
+
+
+def test_started_job_not_stored(client, caplog):
+    body_started = BODY.copy()
+    body_started["action"] = "in_progress"
+    body_started["workflow_job"]["id"] = 2
+    response = client.post("/github-webhook", headers=HEADERS, json=body_started)
+    assert response.status_code == 200
+    assert caplog.messages == [
+        "Job 2 is in_progress but not stored!",
+        'action=in_progress repository=foo/foo job_id=2 workflow="CI" time_to_start=0',
+    ]
+
+
+def test_finished_job_not_stored(client, caplog):
+    body_finished = BODY.copy()
+    body_finished["action"] = "completed"
+    body_finished["workflow_job"]["id"] = 3
+    response = client.post("/github-webhook", headers=HEADERS, json=body_finished)
+    assert response.status_code == 200
+    assert caplog.messages == [
+        "Job 3 is completed but not stored!",
+        'action=completed repository=foo/foo job_id=3 workflow="CI" time_to_finish=0',
+    ]
+
+
+def test_unknown_action(client, caplog):
+    body_started = BODY.copy()
+    body_started["action"] = "queued"
+    body_started["workflow_job"]["id"] = 4
+    response = client.post("/github-webhook", headers=HEADERS, json=body_started)
+    body_failed = body_started.copy()
+    body_failed["action"] = "failed"
+    response = client.post("/github-webhook", headers=HEADERS, json=body_failed)
+    assert response.status_code == 200
+    assert caplog.messages == [
+        'action=queued repository=foo/foo job_id=4 workflow="CI"',
+        "Unknown action failed, removing from memory",
+    ]
+
+
+def test_queued_job(client, caplog):
+    body_queued = BODY.copy()
+    body_queued["action"] = "queued"
+    body_queued["workflow_job"]["id"] = 1
+    response = client.post("/github-webhook", headers=HEADERS, json=body_queued)
+    assert response.status_code == 200
+    assert caplog.messages == [
+        'action=queued repository=foo/foo job_id=1 workflow="CI"'
+    ]
+
+
+def test_logging_flow(client, caplog):
+    body_queued = BODY.copy()
+    body_queued["action"] = "queued"
+    body_queued["workflow_job"]["id"] = 5
+
+    response = client.post("/github-webhook", headers=HEADERS, json=body_queued)
+    assert response.status_code == 200
+    assert (
+        caplog.messages[0] == 'action=queued repository=foo/foo job_id=5 workflow="CI"'
+    )
+
+    body_started = BODY.copy()
+    body_started["action"] = "in_progress"
+    body_started["workflow_job"]["started_at"] = "2023-01-27T14:00:05Z"
+    response = client.post("/github-webhook", headers=HEADERS, json=body_started)
+    assert response.status_code == 200
+    assert (
+        caplog.messages[1]
+        == 'action=in_progress repository=foo/foo job_id=5 workflow="CI" time_to_start=5'
+    )
+
+    body_completed = BODY.copy()
+    body_completed["action"] = "completed"
+    body_completed["workflow_job"]["completed_at"] = "2023-01-27T14:05:00Z"
+    response = client.post("/github-webhook", headers=HEADERS, json=body_completed)
+    assert response.status_code == 200
+    assert (
+        caplog.messages[2]
+        == 'action=completed repository=foo/foo job_id=5 workflow="CI" time_to_finish=295'
+    )