From 257a8f777648fdda4a5284fc1f661f2ae3db1e95 Mon Sep 17 00:00:00 2001 From: Derek Maggio Date: Tue, 5 Mar 2024 10:53:26 -0800 Subject: [PATCH] Fix formatting --- app-testing/README.md | 33 +++++++++++++++++++++------------ app-testing/example.env | 1 + 2 files changed, 22 insertions(+), 12 deletions(-) diff --git a/app-testing/README.md b/app-testing/README.md index 199f9d342f3e..c3be77d34fa8 100644 --- a/app-testing/README.md +++ b/app-testing/README.md @@ -86,31 +86,38 @@ The analyses snapshot test runs protocol analysis using `TARGET` branch or tag t #### Protocol Files Location -The set of protocols to analyze is defined inside of `app-testing/.env` file, under the `APP_ANALYSIS_TEST_PROTOCOLS` variable. These protocols must exist inside of `app-testing/files/protocols` folder. +The set of protocols to analyze is defined inside of `app-testing/.env` file, under the `APP_ANALYSIS_TEST_PROTOCOLS` variable. These protocols must exist inside of `app-testing/files/protocols` folder. - Protocol Designer protocols go in the `json` folder - Python protocols go in the `python` folder. #### Analysis Snapshots Location -Analysis snapshots are located inside of `app-testing/tests/__snapshots__/analyses_snapshot_test` folder. +Analysis snapshots are located inside of `app-testing/tests/__snapshots__/analyses_snapshot_test` folder. #### Running Analysis Snapshot Tests Locally -To run analysis snapshot tests locally, you run - - ```bash - TARGET="" make snapshot-test - ``` +To run analysis snapshot tests locally, you must first build the Docker image by running the following command: + +```bash +TARGET="" make build-opentrons-analysis +``` + +Then to run the analysis snapshot test, you can run the following command: + +```bash +TARGET="" make snapshot-test +``` + This will run the analyses snapshot test using the `TARGET` branch or tag, and compare the results against your local analysis snapshots located inside `app-testing/tests/__snapshots__/analyses_snapshot_test`. #### Updating Analysis Snapshots If you want to update the analysis snapshots, you can run the following command: - ```bash - TARGET="" make snapshot-test-update - ``` +```bash +TARGET="" make snapshot-test-update +``` This will take the results of the analysis snapshot test using the `TARGET` branch or tag, and update the local analysis snapshots located inside `app-testing/tests/__snapshots__/analyses_snapshot_test`. @@ -123,9 +130,11 @@ Given the scenario that you want to see if the latest version of `chore_release- `TARGET` - is chore_release-v7.2.0. "I want to run analysis against `chore_release-v7.2.0`" `TEST_SOURCE` - This one varies a bit on what it can be. The question to ask is, "Where are the snapshots that you want to compare against?" + - If you want to compare against the current analysis snapshots for this release, then TEST_SOURCE is chore_release-v7.2.0. - If you want to compare against the previous release branch, then TEST_SOURCE is chore_release-v7.1.0. - If you want to compare your in-progress release branch against the previous release branch, then TEST_SOURCE is ``. - run the Workflow Dispatch job - - `gh workflow run 'Analyses Snapshot Test' --ref chore_release-v7.2.0 -f TARGET=chore_release-v7.2.0 -f TEST_SOURCE=chore_release-v7.1.0` +run the Workflow Dispatch job + +- `gh workflow run 'Analyses Snapshot Test' --ref chore_release-v7.2.0 -f TARGET=chore_release-v7.2.0 -f TEST_SOURCE=chore_release-v7.1.0` diff --git a/app-testing/example.env b/app-testing/example.env index 3979b53e2705..980dc6335d8a 100644 --- a/app-testing/example.env +++ b/app-testing/example.env @@ -97,6 +97,7 @@ APP_ANALYSIS_TEST_PROTOCOLS=" # Not running this file because the error handling to catch that # the flex is only supported on API versions 2.15 and above, does not exist +# Will be fixed with https://opentrons.atlassian.net/browse/RDEVOPS-71 # Flex_None_None_TC_2_14_verifyThermocyclerLoadedSlots # run one