extra: dojo CLI (#48)

Author: fopina

.github/workflows/test.yml

@@ -37,7 +37,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        python-version: ['3.9', '3.12']
+        python-version: ['3.9', '3.10', '3.12']
     steps:
       - name: Checkout
         uses: actions/checkout@v4
@@ -50,7 +50,7 @@ jobs:
       - name: Install dependencies
         run: |
           pip install uv
-          uv sync --dev
+          uv sync --dev --extra cli
 
       - name: Run unit tests
         run: |
@@ -71,12 +71,12 @@ jobs:
       - name: Set up Python
         uses: actions/setup-python@v5
         with:
-          python-version: "3.10"
+          python-version: "3.12"
 
       - name: Install dependencies
         run: |
           pip install uv
-          uv sync --dev
+          uv sync --dev --extra cli
 
       - name: Run e2e tests
         run: |

.gitignore

@@ -103,7 +103,7 @@ celerybeat.pid
 
 # Environments
 .env
-.venv
+.venv*
 env/
 /venv/
 ENV/

AGENTS.md

@@ -68,6 +68,8 @@ The codebase is mostly generated. The important mental model is:
 - `tests/data/`
   Fixtures for integration scenarios, such as import/reimport payloads.
 
+ALWAYS use unittest.TestCase to write new tests unless you really cannot.
+
 ### Local integration environment
 
 - `support/integration/docker-compose.yml`

CONTRIBUTING.md

@@ -3,7 +3,7 @@
 This project uses `uv`, so set up the virtualenv by running
 
 ```
-uv sync --dev
+uv sync --dev --extra cli
 ```
 
 Use `make test` to make sure all tests pass before pushing.

Makefile

@@ -6,6 +6,21 @@ lint-check:
 	uv run ruff format --diff
 	uv run ruff check
 
+.venv39: export VIRTUAL_ENV=.venv39
+.venv39:
+	uv sync --dev --extra cli --python 3.9 --active
+
+test39: .venv39
+test39: export VIRTUAL_ENV=.venv39
+test39:
+	uv run --active pytest --cov
+
+test39-e2e: .venv39
+test39-e2e: export VIRTUAL_ENV=.venv39
+test39-e2e: export DD_INTEGRATION_TESTS=1
+test39-e2e:
+	uv run --active pytest tests/integration/test_e2e.py
+
 test:
 	if [ -n "$(GITHUB_RUN_ID)" ]; then \
 		uv run pytest --cov --cov-report=xml --junitxml=junit.xml -o junit_family=legacy; \

defectdojo_api_generated/cli/__main__.py

@@ -0,0 +1,36 @@
+"""Command-line entrypoint for defectdojo_api_generated."""
+
+import importlib
+import pkgutil
+import sys
+from pathlib import Path
+
+
+def discover_commands():
+    # str() required because of py3.10
+    for _, module_name, _ in pkgutil.iter_modules([str(Path(__file__).parent / 'commands')]):
+        importlib.import_module(f'{__package__}.commands.{module_name}')
+
+
+def load_cli():
+    try:
+        from .commands.cli import CLI
+    except ModuleNotFoundError as exc:
+        print(
+            'The DefectDojo CLI requires extra dependencies. '
+            'Install them using "defectdojo-api-generated[cli]" as package',
+            file=sys.stderr,
+        )
+        raise SystemExit(1) from exc
+
+    return CLI
+
+
+def main():
+    CLI = load_cli()
+    discover_commands()
+    CLI.click()
+
+
+if __name__ == '__main__':
+    main()