#54 - Add QA tooling (#55)

* #54 - Add QA tooling
- initial setup of QA tools
- applied Black

* - add wokflow

* Refactor access configuration loading and error handling in EventBridge writer for improved readability and maintainability

Refactor event_gate_lambda and writer modules for improved type hinting, logging, and error handling; enhance readability and maintainability

Refactor event writers to improve type hinting and logging; enhance error handling in write methods

Add copyright headers and licensing information to source files

Enhance error handling and logging in writers; refactor tests to use pytest

Refactor code for consistency and readability; update requirements for testing and dependencies

* Add CodeRabbit recommendations

* Refactor configuration imports and enhance error handling in Kafka writer

* Refactor import handling and improve error logging in Kafka writer and event gate lambda

* Add more test

* Enhance Kafka writer with configurable flush timeout and improved error handling

* Add QA tooling documentation and configuration for testing environment

* Remove section on running Action locally from developer documentation

* Fixed PR comments

* Update Python environment setup and enhance local development documentation

---------

Co-authored-by: Oto Macenauer <[email protected]>

Author: miroslavpojer

.github/CODEOWNERS

@@ -1 +1 @@
-* @ABMC831 @OlivieFranklova @Zejnilovic @oto-macenauer-absa @petr-pokorny-absa
+* @ABMC831 @Zejnilovic @oto-macenauer-absa @petr-pokorny-absa

.github/workflows/test.yml

@@ -0,0 +1,114 @@
+name: Build and Test
+on:
+  pull_request:
+    branches:
+      - '**'
+    types: [ opened, synchronize, reopened ]
+
+jobs:
+  static-code-analysis:
+    runs-on: ubuntu-latest
+    name: Pylint Static Code Analysis
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+        with:
+          persist-credentials: false
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: |
+          pip install -r requirements.txt
+
+      - name: Analyze code with Pylint
+        id: analyze-code
+        run: |
+          pylint_score=$(pylint $(git ls-files '*.py')| grep 'rated at' | awk '{print $7}' | cut -d'/' -f1)
+          echo "PYLINT_SCORE=$pylint_score" >> $GITHUB_ENV
+
+      - name: Check Pylint score
+        run: |
+          if (( $(echo "$PYLINT_SCORE < 9.5" | bc -l) )); then
+            echo "Failure: Pylint score is below 9.5 (project score: $PYLINT_SCORE)."
+            exit 1
+          else
+            echo "Success: Pylint score is above 9.5 (project score: $PYLINT_SCORE)."
+          fi
+
+  code-format-check:
+    runs-on: ubuntu-latest
+    name: Black Format Check
+    steps:
+      - name: Checkout repository
+        uses: actions/[email protected]
+        with:
+          persist-credentials: false
+
+      - name: Set up Python
+        uses: actions/[email protected]
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: |
+          pip install -r requirements.txt
+
+      - name: Check code format with Black
+        id: check-format
+        run: |
+          black --check $(git ls-files '*.py')
+
+  unit-test:
+    name: Unit Tests
+    runs-on: ubuntu-latest
+
+    defaults:
+      run:
+        shell: bash
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+
+      - name: Install Python dependencies
+        run: |
+          pip install -r requirements.txt
+
+      - name: Check code coverage with Pytest
+        run: pytest --cov=. -v tests/ --cov-fail-under=80
+
+  mypy-check:
+    runs-on: ubuntu-latest
+    name: Mypy Type Check
+    steps:
+      - name: Checkout repository
+        uses: actions/[email protected]
+        with:
+          persist-credentials: false
+
+      - name: Set up Python
+        uses: actions/[email protected]
+        with:
+          python-version: '3.11'
+          cache: 'pip'
+
+      - name: Install dependencies
+        run: |
+          pip install -r requirements.txt
+      - name: Check types with Mypy
+        id: check-types
+        run: |
+          mypy .

.gitignore

@@ -6,3 +6,4 @@ __pycache__
 /terraform/*.tfvars
 /terraform/*.tfstate*
 /terraform/.terraform*
+/.idea/