Opentrons Installed Run App End to End Testing

The purpose of this module is to allow tests to run against the installed Electron run app.

Slices of the tests will be selected as candidates for automation and then performed against the Opentrons run app executable on [Windows,Mac,Linux] and various robot configurations [Real Robot, Emulation, No Robot].

Notes

• This folder is not plugged into the global Make ecosystem of the Opentrons mono repository. This is intentional, the tools in this folder are independent and will likely be used by only a few and are in no way a dependency of any other part of this repository.

Steps

1. Have pyenv installed per DEV_SETUP.md
   1. Install python 3.11
2. Install the Opentrons application on your machine.
   1. https://opentrons.com/ot-app/
   2. This could also be done by building the installer on a branch and installing the App.
      1. for Mac
         1. make -C app-shell dist-osx
3. Install Chromedriver = 1. in the app-testing directory 1. sudo ./ci-tools/mac_get_chromedriver.sh 21.3.1 per the version of electron in the repository root package.json (/opentrons/package.json) for electron 1. Windows sudo .\ci-tools\windows_get_chromedriver.ps1 -version 21.3.1 1. if you experience wget: command not found 1. brew install wget and try again 2. when you run chromedriver --version 1. It should work 2. It should output the below. The chromedriver version must match Electron version we build into the App. 1. ChromeDriver 106.0.5249.181 (7e86549ea18ccbc17d7b600e3cd4190f45db35c7-refs/heads/main@{#1045491})
4. Create .env from example.env cp example.env .env
   1. Fill in values (if there are secrets)
   2. Make sure the paths work on your machine
5. Install pipenv globally against the python version you are using in this module.
   1. pip install -U pipenv
6. In the app-testing directory (make, python, pipenv required on your path)
   1. make teardown
   2. make setup
7. Run all tests
   1. make test
8. Run specific test(s)
   1. pipenv run python -m pytest -k test_labware_landing
      1. See docs on pytest -k flag

Tools

python 3.11.0 - manage python with pyenv pipenv

Locator Tool

Using the python REPL we can launch the app and in real time compose element locator strategies. Then we can execute them, proving they work. This alleviates having to run tests over and over to validate element locator strategies.

Using this tool is imperative to reduce time of development when creating/troubleshooting element locators.

From the app-testing directory

pipenv run python -i locators.py

• clean_exit() should be used to exit the REPL.
• when you add a new Page Object (PO) you must add it to the imports, list of POs, and reload method so that you can change it and then call reload() to use the changes without exiting and restarting the REPL.
• reload() will allow the app to stay open but changes in your PO to be reflected.

sometimes chromedriver does not cleanly exit. pkill -x chromedriver

Emulation

We have made the choice to setup all test runs local and in CI against this emulator config

To use locally setup the emulator

run our expected config

make run file_path=$MONOREPOPATH/app-testing/ci-tools/ot2_with_all_modules.yaml

ctrl-c to stop

remove the containers (this resets calibration, stopping them does not)

make remove file_path=$MONOREPOPATH/app-testing/ci-tools/ot2_with_all_modules.yaml

Gotchas

• Only have 1 robot connected at once.
  • Build locators like you have more than 1 to future proof.

Analysis Test

The analysis test pipenv run pytest -k test_analyses is driven by the comma delimited string variable APP_ANALYSIS_TEST_PROTOCOLS in .env This allows us to run one or many.

Adding protocols

1. add the protocol file named according to the naming convention in the files/protocols appropriate folder
2. add the protocol stem to protocol_files.py
3. add the protocol data as a property to protocols.py
4. run make print-protocols