test(analyses-snapshot): add to docs and update Makefile

analyses-snapshot-testing/Makefile

@@ -98,14 +98,24 @@ build-opentrons-analysis:
 	@echo "If you want to build a different version, run 'make build-opentrons-analysis ANALYSIS_REF=<version>'"
 	docker build --build-arg BASE_IMAGE_NAME=$(BASE_IMAGE_NAME) --build-arg ANALYSIS_REF=$(ANALYSIS_REF) --build-arg CACHEBUST=$(CACHEBUST) -t opentrons-analysis:$(ANALYSIS_REF) -f citools/Dockerfile.analyze citools/.
 
-.PHONY: local-build
-local-build:
+LOCAL_IMAGE_NAME ?= opentrons-analysis:local
+
+.PHONY: build-local
+build-local:
 	@echo "Building docker image for your local opentrons code"
 	@echo "The image will be named opentrons-analysis:local"
 	@echo "For a fresh build, run 'make local-build NO_CACHE=1'"
-	docker build --build-arg BASE_IMAGE_NAME=$(BASE_IMAGE_NAME) $(BUILD_FLAGS) -t opentrons-analysis:local -f citools/Dockerfile.local .. || true
+	docker build --build-arg BASE_IMAGE_NAME=$(BASE_IMAGE_NAME) $(BUILD_FLAGS) -t $(LOCAL_IMAGE_NAME) -f citools/Dockerfile.local .. || true
 	@echo "Build complete"
 
+.PHONY: snapshot-test-local
+snapshot-test-local:
+	export ANALYSIS_REF=$(LOCAL_IMAGE_NAME)
+	@echo "ANALYSIS_REF is $(ANALYSIS_REF)"
+	@echo "PROTOCOL_NAMES is $(PROTOCOL_NAMES)"
+	@echo "OVERRIDE_PROTOCOL_NAMES is $(OVERRIDE_PROTOCOL_NAMES)"
+	$(PYTHON) -m pipenv run pytest -k analyses_snapshot_test -vv 
+
 .PHONY: generate-protocols
 generate-protocols:
 	$(PYTHON) -m pipenv run python -m automation.data.protocol_registry

analyses-snapshot-testing/README.md

@@ -4,7 +4,7 @@
 
 1. Follow the instructions in [DEV_SETUP.md](../DEV_SETUP.md)
 1. `cd analyses-snapshot-testing`
-1. use pyenv to install python 3.12 and set it as the local python version for this directory
+1. use pyenv to install python 3.13 and set it as the local python version for this directory
 1. `make setup`
 1. Have docker installed and ready
 
@@ -72,10 +72,17 @@ cd analyses-snapshot-testing \
 
 > This copies in your local code to the container and runs the analyses battery against it.
 
-1. `make build-base-image`
-1. `make build-local`
-1. `make local-snapshot-test`
+`cd PYENV_ROOT && git pull` - make sure pyenv is up to date so you may install python 3.13.0
+`pyenv install 3.13.0` - install python 3.13.0
+`cd <OPENTRONS_REPO_ROOT>/analyses-snapshot-testing` - navigate to the analyses-snapshot-testing directory
+`pyenv local 3.13.0` - set the local python version to 3.13.0
+`make setup` - install the requirements
+`make build-base-image` - build the base image for the analyses battery
+`make build-local` - on top of the base, copy in the local code and build
+`make snapshot-test-local` - run the analyses battery against the image you just created
+
+> make sure to run `make build-local` after you make changes to the code to update the image
 
 You have the option to specify one or many protocols to run the analyses on. This is also described above [Running the tests against specific protocols](#running-the-tests-against-specific-protocols)
 
-- `make local-snapshot-test PROTOCOL_NAMES=Flex_S_v2_19_Illumina_DNA_PCR_Free OVERRIDE_PROTOCOL_NAMES=none`
+- `make snapshot-test-local PROTOCOL_NAMES=Flex_S_v2_19_Illumina_DNA_PCR_Free OVERRIDE_PROTOCOL_NAMES=none`