Virtual environment management with Poetry

Install poetry:

pip install poetry

Use an environment with a certain Python version:

poetry env use 3.12

Install all dependencies:

poetry sync --all-groups

Project Tasks - Poe The Poet plugin

To run the tasks use poe. For example, to run the format task:

poetry run poe format

Any extra CLI arguments will be appended. For example, to indicate a certain test for pytest:

poetry run poe tests -k test_servo.py

Build the module

Activate poetry environment and run the following:

poetry run poe build

Run tests

Create tests/setups/tests_setup.py file with configuration file.

This file is ignored by git and won’t be uploaded to the repository. Example of a setup:

from pathlib import Path

from summit_testing_framework.setups import LocalDriveConfigSpecifier

DEN_NET_E_SETUP = LocalDriveConfigSpecifier.from_ethercat_configuration(
   identifier="den-net-e",
   dictionary=Path("C://Users//some.user//Downloads//den-net-e_eoe_2.7.3.xdf"),
   config_file=Path("C://Users//some.user//Downloads//den_net_e.xcf"),
   firmware_file=Path("C://Users//some.user//Downloads//den-net-e_2.7.3.lfu"),
   ifname="\\Device\\NPF_{675921D7-B64A-4997-9211-D18E2A6DC96A}",
   slave=1,
   boot_in_app=False,
)

For more information, check summit-testing-framework documentation.

Run tests selecting the markers that you want and are appropriate for your setup. Beware that some tests may not be appropriate for the setup that you have and may fail.

Run the tests:

poetry run poe tests -m {markers}