unittest

.github/workflows/lint_and_unittest.yaml

@@ -0,0 +1,42 @@
+name: Code best practice and unittesting
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'bin/**'  # This will trigger the workflow only if files in the 'bin' folder are modified.
+
+concurrency:
+  group: lint-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - uses: actions/setup-python@v5
+      with:
+          python-version: '3.11'
+    - name: Install tox
+      run: python -m pip install 'tox>=1.8.0'
+    - name: Lint
+      run: tox -e lint
+
+  unittest:
+    runs-on: ubuntu-20.04
+    strategy:
+      matrix:
+        python-version: ['3.11']
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install requirements
+        run: python -m pip install -r requirements.txt
+      - name: Run unittests
+        run: |
+          PYTHONPATH=bin python -m unittest discover -s bin/tests

sources/README.md

@@ -216,6 +216,13 @@ When the tests succeed a maintainer will merge the dev branch into main. Feel fr
 
 The reason we are not running the tests directly on the pull request branch is, that this does not allow to access the GitHub secrets, that are required to run the tests.
 
+# Run the unit tests locally
+
+```
+cd codex/sources
+PYTHONPATH=bin python -m unittest discover -s bin/tests
+```
+
 ### Tools
 
 To make a test run of the tool to check its functionalities follow [Usage](#Usage) to set-up the environnement and the API key, then run