GitHub actions tutorial

.github/workflows/final_lint.yaml

@@ -0,0 +1,39 @@
+name: Linter - Quality and Type Checks
+
+on:
+  - push
+  - pull_request
+  - workflow_dispatch
+
+jobs:
+  lint: # The name of the job
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      # Changed Python files only
+      - name: Get changed files
+        id: changed-files
+        uses: tj-actions/changed-files@v46
+        with:
+          files: "**/*.py"
+
+      - name: List all changed files
+        env:
+          ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files}}
+        run: |
+          for file in ${ALL_CHANGED_FILES}; do
+            echo "$file was changed"
+          done
+
+      #Set up Python
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+
+      #Ruff linter for checking. Replaces manual install and run.
+      - uses: astral-sh/ruff-action@v3
+        if: ${{ steps.changed-files.outputs.all_changed_files }}
+        with:
+          src: >-
+            ${{ steps.changed-files.outputs.all_changed_files }}

.github/workflows/my_test.yaml

@@ -0,0 +1,42 @@
+name: Run Integration and Unit Tests
+
+on:
+  push:
+  pull_request:
+    branches:
+      - master
+  workflow_dispatch:
+
+jobs:
+  get_changed_files:
+    runs-on: ubuntu-latest
+    outputs:
+      changed-files: ${{steps.changed-files.outputs.all_changed_files}}
+    steps:
+      - uses: actions/checkout@v4
+      # Changed Python files only
+      - name: Get changed files
+        id: changed-files
+        uses: tj-actions/changed-files@v46
+        with:
+          files: "**/*.py"
+
+      - name: List all changed files
+        env:
+          ALL_CHANGED_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
+        run: |
+          for file in ${ALL_CHANGED_FILES}; do
+            echo "$file was changed"
+          done
+
+  actual_tests:
+    name: Run Python tests
+    needs: get_changed_files
+    strategy:
+      matrix:
+        project: ["common", "events", "visits"]
+
+    uses: ./.github/workflows/test_workflow.yaml
+    with:
+      project: ${{ matrix.project }}
+      changed_files: ${{ needs.get_changed_files.outputs.changed-files }}

.github/workflows/test_workflow.yaml

@@ -0,0 +1,121 @@
+name: Run unit and integration tests
+
+on:
+  workflow_call:
+    inputs:
+      project:
+        description: "Describes which project we are dealing with"
+        required: true
+        type: string
+      changed_files:
+        required: true
+        type: string
+
+jobs:
+  decide_run_test:
+    name: Decide if we run test on project ${{ inputs.project}}
+    runs-on: ubuntu-latest
+    outputs:
+      run_test: ${{steps.if_run_test.outputs.RUN_TEST}}
+      workdir: ${{steps.if_run_test.outputs.WORKDIR}}
+    steps:
+      - uses: actions/checkout@v4
+      - name: Run regex to check if file match
+        id: if_run_test
+        env:
+          PROJECT: ${{ inputs.project }}
+          CHANGED_FILES: ${{inputs.changed_files}}
+        run: |
+          run_tests=false
+          for file in ${CHANGED_FILES}; do
+            #Runs project tests if any file in prject has changed or any file in common
+            if [[ ${file} =~ "common" || ${file} =~ ${PROJECT} ]]; then
+              echo "${file} has matched"
+              run_tests=true
+              break
+            fi
+          done
+
+          if [[ ${PROJECT} == "common" ]]; then
+              workdir="./common"
+          elif test -d "./services/${PROJECT}"; then
+              workdir="./services/${PROJECT}"
+          elif test -d "./tools/${PROJECT}"; then
+              workdir="./tools/${PROJECT}"
+          else
+            workdir="./"
+          fi
+
+          echo ${run_tests} ${workdir}
+
+          echo "RUN_TEST=${run_tests}" >> "$GITHUB_OUTPUT"
+          echo "WORKDIR=${workdir}" >> "$GITHUB_OUTPUT"
+
+  test_project:
+    name: Actual Test Job
+    runs-on: ubuntu-latest
+    needs: decide_run_test
+    if: ${{ needs.decide_run_test.outputs.run_test == 'true'}}
+    defaults:
+      run:
+        working-directory: ${{ needs.decide_run_test.outputs.workdir }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup db with docker and create tables
+        env:
+          PROJECT: ${{ inputs.project }}
+        run: |
+          if [[ ${PROJECT} == "common" ]]; then
+             base_dir="../"  
+          else
+            mv config.sample.py config.py
+            base_dir="../.."
+          fi
+
+          docker compose --file ${base_dir}/compose/dependencies_external/compose.yaml up -d
+
+          while ! mysqladmin ping -h 127.0.0.1 -u root -ppassword --silent; do
+              sleep 1
+          done
+
+          if [ -d SQL ]; then
+            for file in SQL/*.sql; do
+              mysql -h 127.0.0.1 -u root -ppassword integrations_db < ${file}
+            done
+          fi
+
+          # Add common SQL
+          for file in ${base_dir}/common/SQL/*.sql; do
+              mysql -h 127.0.0.1 -u root -ppassword integrations_db < ${file}
+            done
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.10"
+      - name: Install poetry
+        uses: abatilo/actions-poetry@v3
+        with:
+          poetry-version: "2.1.3"
+
+      - name: Setup a local virtual environment (if no poetry.toml file)
+        run: |
+          poetry config virtualenvs.create true --local
+          poetry config virtualenvs.in-project true --local
+
+      - uses: actions/cache@v3
+        id: cached-poetry-dependencies
+        name: Cache for the virtual environment based on the dependencies lock file
+        with:
+          path: ${{ format('{0}/.venv',  needs.decide_run_test.outputs.workdir ) }}
+          key: venv-${{ hashFiles(format('{0}/poetry.lock',  needs.decide_run_test.outputs.workdir )) }}
+
+      - name: Install dependencies
+        if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+        run: |
+          poetry install
+          poetry add pytest-github-actions-annotate-failures #Special package for github actions only
+
+      - name: Run tests with poetry
+        run: |
+          poetry run pytest -v

.github/workflows/my_lint.yaml → .github/workflows_orig/my_lint.yaml

@@ -1,4 +1,8 @@
-name: Lint Python Code - special linter
+name: Lint changed files for quality and type errors
+
+env:
+  mascot: Mona
+  super_duper_var: totally_awesome
 
 on:
   pull_request:
@@ -11,9 +15,27 @@ on:
   workflow_dispatch:
 
 jobs:
+  windows_job:
+    runs-on: windows-latest
+    steps:
+      - run: echo 'Hi ${{ env.mascot }}' # Hi Mona
+      - run: echo 'Hi ${{ env.mascot }}' # Hi Octocat
+        env:
+          mascot: Octocat
+
+  linux_job:
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo 'Hi ${{ env.mascot }}' # Hi Tux
+
   lint: # The name of the job
     runs-on: ubuntu-latest
     steps:
+      - name: Dump GitHub context
+        env:
+          GITHUB_CONTEXT: ${{ toJson(github) }}
+        run: echo "$GITHUB_CONTEXT"
+
       - uses: actions/checkout@v4
 
       - uses: actions/setup-python@v5
@@ -34,21 +56,14 @@ jobs:
             echo "$file was changed"
           done
 
-      # - name: Install poetry
-      #   uses: abatilo/actions-poetry@v4
-
-      # - name: Setup a local virtual environment (if no poetry.toml file)
-      #   run: |
-      #     poetry config virtualenvs.create true --local
-      #     poetry config virtualenvs.in-project true --local
-
-      # - uses: actions/cache@v3
-      #   name: Define a cache for the virtual environment based on the dependencies lock file
-      #   with:
-      #     path: ./.venv
-
-      # - name: Install dependencies
-      #   run: poetry install
+      - name: Dump job context
+        env:
+          JOB_CONTEXT: ${{ toJson(env) }}
+        run: echo "$JOB_CONTEXT"
 
       #Ruff linter for checking. Replaces manual install and run.
       - uses: astral-sh/ruff-action@v3
+        if: ${{ steps.changed-files.outputs.all_changed_files }}
+        with:
+          src: >-
+            ${{ steps.changed-files.outputs.all_changed_files }}

.github/workflows_orig/publish.yaml

@@ -2,41 +2,41 @@ name: Publish to PyPI
 on:
   push:
     tags:
-      - '*.*.*'
+      - "*.*.*"
 
 jobs:
   publish:
-    runs-on: ubuntu-latest 
+    runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v4
-    - name: Set up Python
-      uses: actions/setup-python@v5
-      with:
-        python-version: '3.13'
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
 
-    - name: Install dependencies
-      run: |
-        python -m pip install --upgrade pip
-        python -m pip install .[build]
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m pip install .[build]
 
-    - name: Build package
-      run: python -m build
+      - name: Build package
+        run: python -m build
 
-    - name: Publish package
-      uses: pypa/gh-action-pypi-publish@release/v1
-      with:
-        user: __token__
-        password: ${{ secrets.PYPI_API_TOKEN }}
+      - name: Publish package
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}
 
-    - name: Test publish package
-      uses: pypa/gh-action-pypi-publish@release/v1
-      with:
-        user: __token__
-        password: ${{ secrets.TESTPYPI_API_TOKEN }}
-        repository-url: https://test.pypi.org/legacy/
+      - name: Test publish package
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.TESTPYPI_API_TOKEN }}
+          repository-url: https://test.pypi.org/legacy/
 
-    - name: Create GitHub Release
-      env:
-        GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-      run: |
-        gh release create ${{ github.ref_name }} ./dist/* --generate-notes
+      - name: Create GitHub Release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release create ${{ github.ref_name }} ./dist/* --generate-notes

.gitignore

@@ -102,3 +102,5 @@ venv.bak/
 
 # mypy
 .mypy_cache/
+
+config.py

.vscode/settings.json

@@ -0,0 +1,27 @@
+{
+  "editor.formatOnSave": true,
+  "editor.mouseWheelZoom": true,
+  "editor.formatOnSaveMode": "file",
+  "editor.wrappingIndent": "same",
+  "editor.wordWrap": "wordWrapColumn",
+  "editor.wordWrapColumn": 120,
+  "python.languageServer": "Pylance",
+  "python.analysis.typeCheckingMode": "standard",
+  "python.analysis.fixAll": [
+    "source.unusedImports"
+  ],
+  "python.analysis.completeFunctionParens": true,
+  "[python]": {
+    "editor.defaultFormatter": "charliermarsh.ruff",
+    "editor.formatOnSave": true,
+    "editor.codeActionsOnSave": {
+      "source.organizeImports": "explicit"
+    },
+  },
+  "ruff.nativeServer": "off",
+  "ruff.lint.enable": true,
+  "ruff.lint.run": "onSave",
+  "files.exclude": {
+    ".ruff_cache": true
+}
+}

common/SQL/hash_db.sql

@@ -0,0 +1,12 @@
+CREATE TABLE IF NOT EXISTS `nevvon_provider_hashes` (
+    `RECORD_id` INT NOT NULL AUTO_INCREMENT PRIMARY KEY,
+    `employee_number` varchar(150) NOT NULL,
+    `phone_number` varchar(150) NOT NULL,
+    `provider_hash` varchar(150) NOT NULL,
+    `org_id` INT,
+    created_at TIMESTAMP NOT NULL DEFAULT NOW(),
+    updated_at TIMESTAMP NOT NULL DEFAULT NOW() ON UPDATE NOW(),
+    deleted_at TIMESTAMP NULL
+);
+ALTER TABLE `nevvon_provider_hashes`
+ADD CONSTRAINT UNIQUE(`org_id`, `employee_number`);

common/common/__init__.py

@@ -0,0 +1 @@
+__version__ = '0.1.0'