👷 Provide requirements.txt

Problem:
- Repositories that have python tests need to provide their own
  `requirements.txt` to drive `pip install`.

Solution:
- Provide a `requirements.txt` that will enable running python tests.

Author: elbeno

.github/workflows/test.yml

@@ -48,19 +48,6 @@ jobs:
           sudo apt install -y asciidoctor
           sudo gem install asciidoctor asciidoctor-diagram rouge
 
-      - name: Install cmake-format
-        run: |
-          pipx install cmakelang
-          pipx inject cmakelang pyyaml
-
-      - name: Install python quality tools
-        run: |
-          pipx install pytest
-          pipx inject pytest pytest-xdist hypothesis
-          pipx install mypy
-          pipx install black
-          echo "/opt/pipx_bin" >> $GITHUB_PATH
-
       - name: Checkout target branch
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
         with:
@@ -73,6 +60,21 @@ jobs:
       - name: Checkout PR branch
         uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
 
+      - name: Install python test requirements
+        run: |
+          python3 -m venv ${{github.workspace}}/test_venv
+          source ${{github.workspace}}/test_venv/bin/activate
+          pip install -r ${{github.workspace}}/requirements.txt
+          echo "${{github.workspace}}/test_venv/bin" >> $GITHUB_PATH
+
+      - name: Install cmake-format
+        run: |
+          pip install cmakelang pyyaml
+
+      - name: Install python quality tools
+        run: |
+          pip install mypy black
+
       - name: Restore CPM cache
         env:
           cache-name: cpm-cache-0

cmake/main.cmake

@@ -26,6 +26,8 @@ option(INFRA_PROVIDE_CLANG_TIDY "Provide .clang-tidy file" ON)
 option(INFRA_PROVIDE_CMAKE_FORMAT "Provide .cmake-format.yaml file" ON)
 option(INFRA_PROVIDE_PRESETS "Provide cmake presets and toolchains" ON)
 option(INFRA_PROVIDE_MULL "Provide mull.yml file" ON)
+option(INFRA_PROVIDE_PYTEST_REQS
+       "Provide pip requirements.txt for python tests" ON)
 option(INFRA_PROVIDE_GITIGNORE "Add provided things to .gitignore" ON)
 option(INFRA_USE_SYMLINKS "Use symlinks to provide common files" ON)
 

cmake/setup.cmake

@@ -41,6 +41,11 @@ function(make_gitignore)
                 list(APPEND GITIGNORE_CONTENTS "mull.yml")
             endif()
         endif()
+        if(INFRA_PROVIDE_PYTEST_REQS)
+            if(NOT EXISTS "${CMAKE_SOURCE_DIR}/requirements.txt")
+                list(APPEND GITIGNORE_CONTENTS "requirements.txt")
+            endif()
+        endif()
     endif()
 
     string(REPLACE ";" "\n" GITIGNORE_CONTENTS "${GITIGNORE_CONTENTS}")
@@ -112,6 +117,9 @@ if(PROJECT_SOURCE_DIR STREQUAL CMAKE_SOURCE_DIR)
     if(INFRA_PROVIDE_MULL)
         put_in_project_dir("mull.yml")
     endif()
+    if(INFRA_PROVIDE_PYTEST_REQS)
+        put_in_project_dir("requirements.txt")
+    endif()
 
     if(INFRA_PROVIDE_GITHUB_WORKFLOWS)
         execute_process(COMMAND ${CMAKE_COMMAND} -E make_directory

docs/options.adoc

@@ -30,6 +30,12 @@ level, and a `toolchains` directory.
 
 When `ON`, this repository provides a `mull.yml` file at the root level.
 
+*`INFRA_PROVIDE_PYTEST_REQS`*
+
+When `ON`, this repository provides a `requirements.txt` file at the root level.
+When used with `pip install -r requirements.txt` this provides the packages
+sufficient to run python tests.
+
 *`INFRA_PROVIDE_GITIGNORE`*
 
 When `ON`, this repository provides a `.gitignore` file at the root level. It

docs/testing.adoc

@@ -68,6 +68,10 @@ dependencies that are not part of the CMake dependency tree. A `conftest.py`
 file in the same directory as any of the `FILE`​s is automatically discovered as
 such a dependency.
 
+NOTE: Python tests use several testing packages; these can be installed using
+`requirements.txt` which is provided through the `INFRA_PROVIDE_PYTEST_REQS`
+option.
+
 === Fuzz tests
 
 [source,cmake]

requirements.txt

@@ -0,0 +1,15 @@
+# The contents of this file can be generated at latest versions available by running:
+#
+# $ python3 -m venv ./test_venv
+# $ source ./test_venv/bin/activate
+# $ pip install pytest pytest-xdist hypothesis | tail -n1 | cut -d' ' -f 3- | tr ' ' '\n' | sed 's/\(.*\)-\(.*\)/\1==\2/'
+#
+attrs==24.2.0
+execnet==2.1.1
+hypothesis==6.115.3
+iniconfig==2.0.0
+packaging==24.1
+pluggy==1.5.0
+pytest==8.3.3
+pytest-xdist==3.6.1
+sortedcontainers==2.4.0