ci/cd + dependencies

Author: pythoninthegrass

.github/workflows/python_test.yml

@@ -0,0 +1,79 @@
+# https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python
+# https://github.com/actions/setup-python/blob/main/docs/advanced-usage.md#caching-packages
+# https://www.peterbe.com/plog/install-python-poetry-github-actions-faster
+
+name: python_test
+
+on: [push, workflow_dispatch]                               # pull_request, push, workflow_dispatch
+
+jobs:
+  ci:
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11"]
+        os: ["ubuntu-latest"]
+        arch: ['x64']
+
+    runs-on: ${{ matrix.os }}
+
+    steps:
+    - name: checkout repo content
+      uses: actions/checkout@v3
+    # TODO: debug 'cache not found for input keys dotlocal-Linux-8e1cebf...'
+    - name: load cached $HOME/.local
+      uses: actions/cache@v2.1.6
+      id: cash-money
+      with:
+        path: ~/.local
+        key: dotlocal-${{ runner.os }}-${{ hashFiles('.github/workflows/python_test.yml') }}
+    # - run: echo '${{ steps.cash-money.outputs.cache-hit }}'     # true if cache-hit occured on the primary key
+    - name: set variables
+      run: |
+        BASE_DIR=$(cat BASE_DIR)
+        echo "BASE_DIR=$BASE_DIR" >> $GITHUB_ENV
+    - name: Read .tool-versions                                 # dynamic versions
+      uses: marocchino/tool-versions-action@v1
+      id: versions
+      with:
+        path: ${{ env.BASE_DIR }}/.tool-versions
+    - name: shuffle files
+      run: |
+        cat ${{ env.BASE_DIR }}/.tool-versions | awk '/python/ {print $NF}' >> ${{ env.BASE_DIR }}/.python-version
+        [[ -e "$(pwd)/pyproject.toml" ]] && mv "$(pwd)/pyproject.toml" "$(pwd)/pyproject.toml.bak"
+        cp "${{ env.BASE_DIR }}/pyproject.toml" $(pwd)/
+    - name: setup python
+      uses: actions/setup-python@v4
+      with:
+        python-version-file: ${{ env.BASE_DIR }}/.python-version
+        cache: 'pip'
+    - name: setup poetry
+      uses: snok/install-poetry@v1
+      id: cp310
+      with:
+        version: ${{ steps.versions.outputs.poetry }}
+        virtualenvs-create: true
+        virtualenvs-in-project: true
+        virtualenvs-path: ${{ env.BASE_DIR }}
+        installer-parallel: true
+    - name: load cached venv
+      id: cached-poetry-dependencies
+      uses: actions/cache@v2.1.6
+      with:
+        path: ${{ env.BASE_DIR }}/.venv
+        key: venv-${{ runner.os }}-${{ hashFiles('**/poetry.lock') }}-${{ hashFiles('.github/workflows/python_test.yml') }}
+    - name: install virtualenv
+      run: |
+        cd ${{ env.BASE_DIR }}
+        poetry install
+      if: steps.cached-poetry-dependencies.outputs.cache-hit != 'true'
+    - name: Lint with flake8
+      run: |
+        # stop the build if there are Python syntax errors or undefined names
+        poetry run flake8 ${{ env.BASE_DIR }} --count --select=E9,F63,F7,F82 --show-source --statistics
+        # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
+        poetry run flake8 ${{ env.BASE_DIR }} --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+    # TODO: write tests
+    - name: Test with pytest
+      run: |
+        # exit code 5 == 'collected 0 items'
+        poetry run pytest ${{ env.BASE_DIR }}

.github/workflows/run_script.yml

@@ -1,3 +1,5 @@
+# https://github.com/actions/setup-python/blob/main/docs/advanced-usage.md#caching-packages
+
 name: run_script
 
 on: [workflow_dispatch]     # pull_request, push, workflow_dispatch
@@ -18,34 +20,38 @@ jobs:
     steps:
     - name: checkout repo content
       uses: actions/checkout@v3
-    # dynamic versions
-    - name: Read .tool-versions
+    - name: Read .tool-versions                             # dynamic versions
       uses: marocchino/tool-versions-action@v1
       id: versions
     - name: setup python
       uses: actions/setup-python@v4
+      id: cp310
       with:
         python-version: ${{ steps.versions.outputs.python }}
         architecture: ${{ matrix.arch }}
-    - name: run poetry image
-      uses: abatilo/actions-poetry@v2.0.0
-      with:
-        poetry-version: ${{ steps.versions.outputs.poetry }}
-    # - name: install gh cli
-    #   shell: bash
-    #   run: |
-    #     curl -fsSL https://cli.github.com/packages/githubcli-archive-keyring.gpg | sudo dd of=/usr/share/keyrings/githubcli-archive-keyring.gpg
-    #     sudo chmod go+r /usr/share/keyrings/githubcli-archive-keyring.gpg
-    #     echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/githubcli-archive-keyring.gpg] https://cli.github.com/packages stable main" | sudo tee /etc/apt/sources.list.d/github-cli.list > /dev/null
-    #     sudo apt update
-    #     sudo apt install --no-install-recommends -y gh
+        cache: 'poetry'                                     # cache dependencies
+    - run: echo '${{ steps.cp310.outputs.cache-hit }}'      # true if cache-hit occured on the primary key
+    - name: Install poetry & dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install poetry
+        poetry install
     - name: run script
       shell: bash
       env:
-        # github token needed for gh cli
-        # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        # GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}       # gh cli
         username: ${{ secrets.USERNAME }}
       run: |
-        python -m pip install --upgrade pip
-        poetry install
         poetry run python hello.py
+
+
+steps:
+- uses: actions/checkout@v3
+- name: Install poetry
+  run: pipx install poetry
+- uses: actions/setup-python@v4
+  with:
+    python-version: '3.9'
+    cache: 'poetry'
+- run: poetry install
+- run: poetry run pytest

BASE_DIR

@@ -0,0 +1 @@
+./cwd

ci_dir.py

@@ -0,0 +1,46 @@
+#!/usr/bin/env python3
+
+import subprocess
+from pathlib import Path
+
+"""
+Over-engineered python solution to local directory for GitHub Actions.
+
+cf. bash:
+    w=$(basename $(echo $PWD)); echo "./${w}" > ../BASE_DIR
+"""
+
+# get path of working directory
+cwd = Path.cwd()
+
+# basename of working directory
+cwd_bn = cwd.name
+
+# add './' prefix to cwd_bn
+rel = "./" + cwd_bn
+
+# add 'CWD=' prefix to rel
+cwd_str = "CWD=" + rel
+
+# call git via subprocess to find name of repo
+abs = subprocess.check_output(["git", "rev-parse", "--show-toplevel"]).decode("utf-8").strip()
+
+# split at last '/' and assign last element to repo
+raw = abs.split("/")
+repo = raw[-1]
+
+# path to relative directory
+up = str(Path(f"{repo}/{rel}"))
+
+# dot path to working directory
+dot = f"{rel}"
+
+# list locations right aligned up to n chars (needed for absolute path)
+# print(f"abs: {abs:>30}")
+# print(f"cwd: {up:>30}")
+# print(f"dot: {dot:>30}")
+# print(f"tld: {repo:>30}")
+
+# write dot to "{abs}/WORKDIR"
+with open(f"{abs}/BASE_DIR", "w") as f:
+    f.write(dot)

pyproject.toml

@@ -21,6 +21,54 @@ dnspython = "^2.2.1"
 [tool.poetry.dev-dependencies]
 icecream = "^2.1.1"
 
+[tool.black]
+line-length = 130
+target-version = ['py310']
+include = '\.pyi?$'
+exclude = '''
+/(
+	\.git
+| \.hg
+| \.mypy_cache
+| \.tox
+| \.venv
+| _build
+| buck-out
+| build
+)/
+'''
+
+[flake8]
+max-line-length = 130
+extend-ignore = ["E203", "E251", "E266", "E302", "E305", "E401", "E402", "E501", "W503", "F403", "F401"]
+
+[tool.interrogate]
+ignore-init-method = true
+ignore-init-module = false
+ignore-magic = false
+ignore-semiprivate = false
+ignore-private = false
+ignore-property-decorators = false
+ignore-module = true
+ignore-nested-functions = false
+ignore-nested-classes = true
+ignore-setters = false
+fail-under = 95
+exclude = ["setup.py", "docs", "build"]
+ignore-regex = ["^get$", "^mock_.*", ".*BaseClass.*"]
+verbose = 0
+quiet = false
+whitelist-regex = []
+color = true
+generate-badge = "."
+badge-format = "svg"
+
+[tool.isort]
+atomic = true
+profile = "black"
+line_length = 130
+skip_gitignore = true
+
 [build-system]
 requires = ["poetry-core>=1.0.0"]
 build-backend = "poetry.core.masonry.api"