Merge pull request #7 from ferreteleco/feature/python-ci-tests

Adds python CI Unit Testing action template

Author: ferreteleco

CHANGELOG.md

@@ -24,6 +24,21 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/)
 
 -
 
+## [**1.1.0**] - 2023-03-13
+
+### Added
+
+- Cookiecutter action for CI Unit testing in python (Poetry, pytest based).
+
+### Changed
+
+- Improved post gen. hooks, now tells to look for the checklist.
+- Improved existing documentation to reflect changes.
+
+### Fixed
+
+- Minor errors in C++ CI UT template.
+
 ## [**1.0.0**] - 2023-03-12
 
 ### Added

README.md

@@ -4,7 +4,7 @@ This repository can be used for adding Github Actions and templates to an existi
 
 ## Version
 
-Current version is 1.0.0 and was set according to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+Current version is 1.1.0 and was set according to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 Project's version should be updated, when applicable:
 
@@ -33,7 +33,7 @@ $ cookiecutter cookie-github
 ```
 
 NOTE: alternatively, you can use [Cookieninja](https://github.com/cookieninja-generator/cookieninja),
-  forked and more updated version of Cookiecutter with backward compatibility.
+forked and more updated version of Cookiecutter with backward compatibility.
 
 ## Variables
 
@@ -45,9 +45,11 @@ you will be prompted to fill in the following values:
 - **add_PR_template:** this flags controls wether or not to add a PR template in the generated
   folder.
 - **add_ci_action_unit_tests_runner:** this variable controls whether or not to create an action to
-  run unit tests in the repository. The available options are:
+  run unit tests in the repository. The available choices are:
     - none (no action created).
     - cpp, which creates an action for Catch2 based unit tests, built using CMake.
+    - python, which creates an action for Python code unit tests, executed with pytest over a 
+      project built with Poetry.
 
 ## Contributing
 

cookiecutter.json

@@ -7,6 +7,10 @@
     true,
     false
   ],
-  "add_ci_action_unit_tests_runner": ["none", "cpp"],
+  "add_ci_action_unit_tests_runner": [
+    "none",
+    "cpp",
+    "python"
+  ],
   "__github_folder": ".github"
 }

hooks/post_gen_project.py

@@ -39,6 +39,10 @@ def add_ci_action_unit_tests_runner():
         ci_test_workflow_files_path = Path("_", "workflows", target_ci_tests_action)
         copytree(ci_test_workflow_files_path, destination)
 
+        print("\n\n#################################################################")
+        print("# Please check gen. checklist in order to adjust CI UT basic action #")
+        print("#################################################################\n\n")
+
     else:
         LOG.info("Skipping CI action for running unit tests file generation (%s selected) ...", target_ci_tests_action)
 

{{ cookiecutter.__github_folder }}/_/workflows/cpp/ci-tests-cpp.yml

@@ -20,15 +20,16 @@ env:
   ##############################################################################
 
 jobs:
-  run_experiment:
+  run_unit_tests:
     ############################################################################
     # Please fill in with the Runner(s) in which to execute this action
-    ############################################################################
-    runs-on: [ubuntu-22.04]
+    # Ref. https://docs.github.com/en/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow
+    # Ref. https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners    ############################################################################
+    runs-on: ubuntu-22.04
     ############################################################################
 
     container:
-      image: $TARGET_DOCKER_IMAGE
+      image: {{ '${{ env.TARGET_DOCKER_IMAGE }}' }}
 
       ##########################################################################
       # Please uncomment and fill the following if the image comes from a private repository
@@ -39,24 +40,34 @@ jobs:
       #     password: {{ '${{ secrets.RepositoryPass }}' }}
       ##########################################################################
 
+    ############################################################################
+    # Minimum permissions required by EnricoMi/publish-unit-test-result-action@v2
+    # Ref. https://github.com/EnricoMi/publish-unit-test-result-action#support-fork-repositories-and-dependabot-branches
+    ############################################################################
+    permissions:
+          contents: read
+          issues: read
+          checks: write
+          pull-requests: write
+
     steps:
-      - uses: actions/checkout@v2
+      - uses: actions/checkout@v3
 
       - name: Build tests
         working-directory: .
         run: |
           cmake -S . -B build
-          cmake --build build -t $TEST_TARGET_NAME
+          cmake --build build -t {{ '${{ env.TEST_TARGET_NAME }}' }}
 
       - name: Run tests
         working-directory: .
         run: |
-          ./build/test/$TEST_TARGET_NAME --reporter junit -o ci-result-junit.xml
+          ./build/test/{{ '${{ env.TEST_TARGET_NAME }}' }} --reporter junit -o junit/ci-result-junit.xml
 
       - name: Publish Unit Test Results
-        uses: EnricoMi/publish-unit-test-result-action@v1
+        uses: EnricoMi/publish-unit-test-result-action@v2
         if: success()
         with:
-          files: ci-result-junit.xml
+          files: junit/ci-result-junit.xml
           action_fail: true
           action_fail_on_inconclusive: true

{{ cookiecutter.__github_folder }}/_/workflows/python/ci-tests-python.yml

@@ -0,0 +1,78 @@
+name: ci-tests-python
+on:
+  push:
+  pull_request:
+    branches:
+      - master
+
+env:
+  ##############################################################################
+  # Please fill in:
+  # (Ref. https://docs.github.com/en/github-ae@latest/actions/learn-github-actions/variables)
+  ##############################################################################
+  # Target python version intended to use to run tests into. Defaults to 3.10.2
+  ##############################################################################
+  TARGET_PYTHON_VERSION: 3.10.2
+  ##############################################################################
+  # Target folder where tests reside. Defaults to "tests"
+  ##############################################################################
+  TESTS_DIRECTORY: tests
+  ##############################################################################
+
+jobs:
+  run_unit_tests:
+    ############################################################################
+    # Please fill in with the Runner(s) in which to execute this action
+    # Ref. https://docs.github.com/en/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow
+    # Ref. https://docs.github.com/en/actions/using-github-hosted-runners/about-github-hosted-runners
+    ############################################################################
+    runs-on: ubuntu-20.04
+    ############################################################################
+
+    ############################################################################
+    # Minimum permissions required by EnricoMi/publish-unit-test-result-action@v2
+    # Ref. https://github.com/EnricoMi/publish-unit-test-result-action#support-fork-repositories-and-dependabot-branches
+    ############################################################################
+    permissions:
+          contents: read
+          issues: read
+          checks: write
+          pull-requests: write
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Setup Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: {{ '${{ env.TARGET_PYTHON_VERSION }}' }}
+
+      - name: Install poetry
+        run: |
+          python -m pip install pipx && python -m pipx install poetry
+
+      - name: Configure poetry
+        run: |
+          poetry config virtualenvs.in-project true
+
+      - name: Cache the virtualenv
+        uses: actions/cache@v3
+        with:
+          path: ./.venv
+          key: {{ '${{ runner.os }}' }}-venv-{{ '${{ hashFiles(\'**/poetry.lock\') }}' }}
+
+      - name: Install dependencies
+        run: |
+          poetry install
+
+      - name: Run tests
+        run: |
+          poetry run python -m pytest {{ '${{ env.TESTS_DIRECTORY }}' }} --doctest-modules --junit-xml=junit/ci-result-junit.xml
+
+      - name: Publish Unit Test Results
+        uses: EnricoMi/publish-unit-test-result-action@v2
+        if: success()
+        with:
+          files: junit/ci-result-junit.xml
+          action_fail: true
+          action_fail_on_inconclusive: true

{{ cookiecutter.__github_folder }}/_/workflows/python/python-unit-test-action-checklist.md

@@ -0,0 +1,12 @@
+# Unit Testing GH Action configuration checklist (python)
+
+Be sure to properly fine-tune the generated action (ci-tests-python.yml) before committing
+it to the remote repository.
+
+## Checklist
+
+- [ ] The intended branch and triggers are correct (default: *on push / PR to master branch*).
+- [ ] The target python version has been configured (defaults to *3.10.2*).
+- [ ] The target test directory where tests live has been defined (defaults to *tests*).
+- [ ] The target runner(s) in which to run the CI Unit Testing workflow have been configured
+      (defaults to *ubuntu-22.04*, hosted by GH).