Change key creation strategy for CI/CD pytest cache (#88)

Ickerday · web-flow · commit 6a686d082df3 · 2026-03-13T16:04:47.000+01:00
* Change key creation strategy for pytest cache

* Fix tests, add cache for pip

* Adjust pytest settings

* Cleanup in Makefile

* Disable pytest cache on master and develop branches

* Remove accepting less specific cache hits

* Newline
diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -18,6 +18,7 @@ jobs:
         uses: actions/setup-python@a309ff8b426b58ec0e2a45f0f869d46889d02405
         with:
           python-version: ${{ matrix.python-version }}
+          cache: "pip"
       - name: Install dependencies
         run: python -m pip install '.[openai, anthropic]' --group test
 
@@ -38,13 +39,13 @@ jobs:
           INTERNAL_AI_BASE_URL: ${{ secrets.INTERNAL_AI_BASE_URL }}
 
       - name: Restore pytest cache
+        if: ${{ github.ref }} != "refs/heads/master" && ${{ github.ref }} != "refs/heads/develop"
         uses: actions/cache@565629816435f6c0b50676926c9b05c254113c0c
         with:
           path: .pytest_cache
           key: pytest-cache-${{ runner.os }}-py${{ matrix.python-version }}-${{ github.ref_name }}-${{ github.sha }}
           restore-keys: |
             pytest-cache-${{ runner.os }}-py${{ matrix.python-version }}-${{ github.ref_name }}-
-            pytest-cache-${{ runner.os }}-py${{ matrix.python-version }}-
       - name: Run unit tests
         run: make test-unit
       - name: Run entire test suite
diff --git a/Makefile b/Makefile
@@ -1,50 +1,52 @@
-#
-# Conveniences for splunk-sdk development
-#
+### Conveniences for splunk-sdk-python development
 
-CONTAINER_NAME := "splunk"
-
-# VIRTUALENV MANAGEMENT
+## VIRTUALENV MANAGEMENT
 
 # https://docs.astral.sh/uv/reference/cli/#uv-run--upgrade
-# --no-config is used to skip all the internal Splunk package indexes
+# --no-config skips our Splunk package index
 .PHONY: uv-sync
 uv-sync:
-	@echo "[splunk-sdk] Make sure to tun this only in the repo root!"
-	uv sync --all-groups --all-extras --no-config
+	uv sync --no-config
 
 .PHONY: uv-upgrade
 uv-upgrade:
-	@echo "[splunk-sdk] Make sure to run this only in the repo root!"
-	uv sync --all-groups --all-extras --upgrade --no-config
+	uv sync --no-config --upgrade
 
 .PHONY: clean
-clean: 
+clean:
 	rm -rf ./build ./dist ./.venv ./.ruff_cache ./.pytest_cache ./splunk_sdk.egg-info ./__pycache__ ./**/__pycache__
 
 .PHONY: docs
 docs:
 	make -C ./docs html
 
+## TESTING
+
+# -ra generates a report on all failed tests
+# -vv lets us see what failed and why the rest of the suite is running
+PYTEST_CMD := python -m pytest --no-header -ra -vv
+
 .PHONY: test
 test:
-	# Previously failing tests go first
-	python -m pytest --ff ./tests
+	$(PYTEST_CMD) ./tests
 
 .PHONY: test-unit
 test-unit:
-	# Previously failing tests go first
-	python -m pytest --ff ./tests/unit
+	$(PYTEST_CMD) ./tests/unit
 
 .PHONY: test-integration
 test-integration:
-	# Previously failing tests go first
-	python -m pytest --ff ./tests/integration ./tests/system
+# Previously failing tests go first
+	$(PYTEST_CMD) --ff ./tests/integration ./tests/system
 
 .PHONY: test-ai
 test-ai:
-	# Previously failing tests go first
-	python -m pytest --ff ./tests/integration/ai ./tests/unit/ai
+	$(PYTEST_CMD) ./tests/integration/ai ./tests/unit/ai
+
+## DOCKER
+
+CONTAINER_NAME := splunk
+SPLUNK_HOME := /opt/splunk
 
 .PHONY: docker-up
 docker-up:
@@ -81,8 +83,8 @@ docker-refresh: docker-remove docker-start
 
 .PHONY: docker-splunk-restart
 docker-splunk-restart:
-	docker exec -it splunk sudo sh -c '/opt/splunk/bin/splunk restart --run-as-root'
+	docker exec -it $(CONTAINER_NAME) sudo sh -c '$(SPLUNK_HOME)/bin/splunk restart --run-as-root'
 
 .PHONY: docker-tail-python-log
 docker-tail-python-log:
-	docker exec splunk sudo tail /opt/splunk/var/log/splunk/python.log
+	docker exec -it $(CONTAINER_NAME) sudo tail $(SPLUNK_HOME)/var/log/splunk/python.log
