Add pytest test suite and separate custom Github Actions

.github/workflows/ci.yml

@@ -4,54 +4,16 @@ on: [push, pull_request]
 
 jobs:
 
-  test-action:
+  test-cli:
 
-    name: Test Github Action
+    name: Test CLI
 
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v3
-    - name: List prerequisites non-recursively
-      id: non-recursive-prerequisites
-      uses: ./
-      with:
-        working-directory: test
-        target: test1
-    - name: Check non-recursive prerequisites
-      run: |
-        test "${{ steps.non-recursive-prerequisites.outputs.prerequisites }}" = "prereq"
-        echo ${{ steps.non-recursive-prerequisites.outputs.hash }}
-    - name: List recursive prerequisites
-      id: recursive-prerequisites
-      uses: ./
-      with:
-        working-directory: test
-        target: test1
-        flags: --recursive
-    - name: Check recursive prerequisites
-      run: |
-        test "${{ steps.recursive-prerequisites.outputs.prerequisites }}" = "preprereq1 preprereq2"
-        echo ${{ steps.recursive-prerequisites.outputs.hash }}
-    - name: Hash directory prerequisite
-      id: hash-dir-prerequisite
-      uses: ./
-      with:
-        working-directory: test
-        target: test2
-        flags: --recursive
-    - name: Check directory prerequisite hash
-      run: |
-        test "${{ steps.hash-dir-prerequisite.outputs.prerequisites }}" = "dirprereq"
-        test "${{ steps.hash-dir-prerequisite.outputs.hash }}" = "c64a77871513eadd52ec0e278bfbac1db866b77f66ebe91725b378b8bf43e29c"
+    - uses: actions/checkout@v4
     - name: Install package
       run: |
-        python -m pip install .
-    - name: List dependent targets non-recursively
-      working-directory: test
-      run: |
-        test $(list-dependent-make-targets preprereq1) = prereq
-    - name: List dependent targets recursively
-      working-directory: test
-      run: |
-        test "$(list-dependent-make-targets preprereq1 -r | xargs)" = ".DEFAULT_GOAL prereq test1"
+        python -m pip install .[test]
+    - name: Run tests
+      run: pytest

README.md

@@ -1,5 +1,9 @@
 # pymakeutils
 
-A collection of CLI utilities and actions to extract information from Makefiles:
-- list-make-prerequisites: List all prerequisites of a target (optionally recursively)
-- list-dependent-make-targets: List all targets that depend on a certain prerequisite (optionally recursively)
+A collection of CLI utilities to extract information from Makefiles:
+- `list-make-prerequisites`: List all prerequisites of a target (optionally recursively)
+- `list-dependent-make-targets`: List all targets that depend on a certain prerequisite (optionally recursively)
+
+## Related GitHub Actions
+- [colluca/list-make-prerequisites](https://github.com/colluca/list-make-prerequisites): List a target's prerequisites and their combined hash
+- [colluca/make-prerequisites-changed](https://github.com/colluca/make-prerequisites-changed): Check whether any of a target's prerequisites changed since a base commit

pyproject.toml

@@ -23,7 +23,13 @@ where = ["src"]
 [tool.setuptools.dynamic]
 dependencies = { file = ["requirements.txt"] }
 
+[project.optional-dependencies]
+test = ["pytest"]
+
 # Expose your scripts as console commands
 [project.scripts]
 list-make-prerequisites = "pymakeutils.list_make_prerequisites:main"
-list-dependent-make-targets = "pymakeutils.list_dependent_make_targets:main"
+list-dependent-make-targets = "pymakeutils.list_dependent_make_targets:main"
+
+[tool.pytest.ini_options]
+testpaths = ["test"]

test/test_cli.py

@@ -0,0 +1,40 @@
+"""Tests for the list-make-prerequisites and list-dependent-make-targets CLIs.
+
+Both CLIs are exercised as subprocesses (rather than calling their `main()`
+directly) so that the tests also cover argument parsing and console-script
+wiring, running against the Makefile fixtures in this directory.
+"""
+
+import subprocess
+from pathlib import Path
+
+FIXTURES_DIR = Path(__file__).parent
+
+
+def run_cli(*args):
+    result = subprocess.run(
+        args, cwd=FIXTURES_DIR, capture_output=True, text=True, check=True)
+    return result.stdout.strip()
+
+
+def test_list_prerequisites_non_recursive():
+    assert run_cli('list-make-prerequisites', 'test1') == 'prereq'
+
+
+def test_list_prerequisites_recursive():
+    prerequisites = run_cli('list-make-prerequisites', 'test1', '--recursive').splitlines()
+    assert prerequisites == ['preprereq1', 'preprereq2']
+
+
+def test_hash_directory_prerequisite():
+    hash_value = run_cli('list-make-prerequisites', 'test2', '--recursive', '--hash')
+    assert hash_value == 'c64a77871513eadd52ec0e278bfbac1db866b77f66ebe91725b378b8bf43e29c'
+
+
+def test_list_dependent_targets_non_recursive():
+    assert run_cli('list-dependent-make-targets', 'preprereq1') == 'prereq'
+
+
+def test_list_dependent_targets_recursive():
+    targets = run_cli('list-dependent-make-targets', 'preprereq1', '--recursive').splitlines()
+    assert targets == ['.DEFAULT_GOAL', 'prereq', 'test1']