Create python-package.yml Github workflow (#1)

* Create python-package.yml Github workflow

WIP: no testing yet (depends on MySQL Docker container)

* WIP: trying to get yoyo migrations and unittests running in Github workflow

* WIP: Trying to fix testing in Github action by providing .env.github configuration

* WIP: Trying to fix DB connection in Github action

* override .env.test for Github actions

* fixing some tests in Github action

* mark Github workflow as completed in README

Author: onlime

.env.docker

@@ -14,5 +14,3 @@ LOG_LEVEL=DEBUG
 # LOG_FILE=/tmp/policyd-rate-guard.log
 LOG_CONSOLE=True
 # SYSLOG=True
-# SENTRY_DSN=https://**********.ingest.sentry.io/XXXXXXXXXXXXXXXX
-# SENTRY_ENVIRONMENT=docker

.env.github

@@ -0,0 +1,16 @@
+
+## Database configuration
+DB_DRIVER=pymysql
+DB_HOST=127.0.0.1
+DB_PORT=3306
+DB_USER=root
+DB_PASSWORD=test
+DB_DATABASE=test
+
+## PolicydRateGuard configuration
+SOCKET="127.0.0.1,10033"
+# SOCKET=/tmp/test.sock
+LOG_LEVEL=ERROR
+# LOG_FILE=/tmp/policyd-rate-guard.log
+LOG_CONSOLE=True
+# SYSLOG=True

.github/workflows/python-package.yml

@@ -0,0 +1,54 @@
+# This workflow will install Python dependencies, run tests and lint with a variety of Python versions
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+
+name: Python package
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.9", "3.10", "3.11"]
+
+    services:
+      db:
+        image: mysql:8.0
+        env:
+          MYSQL_ROOT_PASSWORD: test
+          MYSQL_DATABASE: test
+        ports:
+          - 3306:3306
+        options: --health-cmd="mysqladmin ping" --health-interval=10s --health-timeout=5s --health-retries=3
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install flake8
+        if [ -f requirements.txt ]; then pip install -r requirements.txt; fi
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    - name: Run migrations
+      run: |
+        yoyo -c yoyo.ini.github apply
+    - name: Run tests
+      run: |
+        cp .env.github .env.test
+        python -m unittest tests/test_*.py

README.md

@@ -377,9 +377,9 @@ Planned features (coming soon):
 - [x] Define **Syslog facility** `LOG_MAIL`, **ident** `policyd-rate-guard`, and additionally log to `/var/log/policyd-rate-guard.log`
 - [x] **Sentry** integration for exception reporting
 - [x] **Ansible role** for easy production deployment
+- [x] **Github workflow** for CI/testing
+- [ ] **Publish package** to [PyPI](https://pypi.org/)
 - [ ] Implement a **configurable webhook API** call for notification to sender on reaching quota limit (on first block) to external service.
-- [ ] CI: **Github action** for testing
-- [ ] Publish to PyPI
 
 ## Credits 🙏
 

yoyo.ini.github

@@ -0,0 +1,5 @@
+[DEFAULT]
+sources = database/migrations
+database = mysql://root:test@localhost:3306/test
+batch_mode = on
+verbosity = 2