Python Test Frameworks
testomat.io plugin for pytest
Section titled “testomat.io plugin for pytest”A powerful pytest plugin that integrates your tests with testomat.io platform for test management, reporting and analytics
Features
Section titled “Features”- ✅ Sync tests with testomat.io
- 📊 Real-time test execution reporting
- 🏷️ Test labeling and categorization
- 📁 Test run grouping and environments
- 📎 Artifact management with S3 integration
- 🔍 Advanced filtering and debugging
uses testomat.io API:
Section titled “uses testomat.io API:”- https://testomatio.github.io/check-tests/ - for sync
- https://testomatio.github.io/reporter/ - for reporting
Table of Contents
Section titled “Table of Contents”Installation
Section titled “Installation”Prerequisites:
- Python 3.10+
- Pytest 6.2.5+
- Active testomat.io account
Install via pip:
pip install pytestomatio
Quick Start
Section titled “Quick Start”Get your API token
Section titled “Get your API token”- Login to testomat.io
- Create project or go to existing project
- Click on “Import Tests from Source Code”
- Copy your project token(starts with “tstmt_“)
Sync tests
Section titled “Sync tests”Synchronize tests to testomat.io:
TESTOMATIO=your_token pytest --testomatio sync
Report tests
Section titled “Report tests”Execute tests and send results to testomat.io:
TESTOMATIO=your_token pytest --testomatio report
Example of test
Section titled “Example of test”To make the experience more consistent, it uses standard pytest markers.
testomat.io test id is a string value that starts with @T
and has 8 symbols after.
from pytest import mark
@mark.testomatio('@T96c700e6')def test_example(): assert 2 + 2 == 4
Advanced usage
Section titled “Advanced usage”Core commands
Section titled “Core commands”Synchronization
Section titled “Synchronization”Synchronize tests to testomat.io and get back test id.
pytest --testomatio sync
Clarification:
- tests will not be executed
- tests can be synced even without
@pytest.mark.testomatio('@T96c700e6')
decorator. - test title in testomat.io == test name in pytest
- test suit title in testomat.io == test file name in pytest
Clean up
Section titled “Clean up”Remove all test ids from source code. Tests will not be executed
pytest --testomatio remove
Report
Section titled “Report”Run pytest and send test results into testomat.io.
Test can be sent to testomat.io without ids in your test code. If testomat.io failed to match tests by title, it will create
new tests for the run
pytest --testomatio report
Run pytest with debug parameter to get test data collected in metadata.json file
pytest --testomatio debug
Launch
Section titled “Launch”Create empty run and obtain its RUN_ID from testomat.io.
pytest --testomatio launch
Finish
Section titled “Finish”Finish running or scheduled run on testomat.io. TESTOMATIO_RUN_ID environment variable is required.
TESTOMATIO_RUN_ID=***run_id*** pytest --testomatio finish
Additional options
Section titled “Additional options”Submitting Test Run Environment
Section titled “Submitting Test Run Environment”To configure test environment, you can use additional option testRunEnv. The configured environment will be added to the test report. Use it with report command:
pytest --testomatio report --testRunEnv "windows11,chrome,1920x1080"
Environment values are comma separated, please use double quotation.
Clearing empty test suites
Section titled “Clearing empty test suites”To automatically clean empty test suites on testomat.io you can use no-empty option. Use it with sync command:
pytest --testomatio sync --no-empty
Disable detaching tests
Section titled “Disable detaching tests”If a test from a previous import was not found on next import it is marked as “detached”. This is done to ensure that deleted tests are not staying in Testomatio while deleted in codebase. To disable this behaviour and don’t mark anything as detached on import use no-detach option. Use it with sync command:
pytest --testomatio sync --no-detach
Keeping original file structure
Section titled “Keeping original file structure”By default, when importing tests, testomat.io does not preserve original file structure. Use option keep-structure with sync command to keep original file structure:
pytest --testomatio sync --keep-structure
Import into given directory
Section titled “Import into given directory”By default, tests are imported into the root of the project. You can use directory option to specify directory to use for test file structure. Use this option with sync command:
pytest --testomatio sync --directory imported_tests
Note: keep-structure option takes precedence over directory option. If both are used keep-structure will be used.
Filter tests by id
Section titled “Filter tests by id”You can filter tests by testomat.io id, using test-id option. You pass single or multiple ids to this option. Use this option with report command:
pytest --testomatio report --test-id "Tc0880217|Tfd1c595c"
Note: Test id should be started from letter “T”
Configuration with environment variables
Section titled “Configuration with environment variables”You can use environment variable to control certain features of testomat.io
Basic configuration
Section titled “Basic configuration”Env variable | What it does | Examples |
---|---|---|
TESTOMATIO | Provides token for pytestomatio to access and push data to testomat.io. Required for sync and report commands | TESTOMATIO=tstmt_***** pytest —testomatio sync |
TESTOMATIO_SYNC_LABELS | Assign labels to a test case when you synchronise test from code with testomat.io. Labels must exist in project and their scope must be enabled for tests | TESTOMATIO_SYNC_LABELS=“number:1,list:one,standalone” pytest —testomatio report |
TESTOMATIO_CODE_STYLE | Code parsing style for test synchronization. If you are not sure, don’t set this variable. Default value is ‘default’ | TESTOMATIO_CODE_STYLE=pep8 pytest —testomatio sync |
TESTOMATIO_CI_DOWNSTREAM | If set, pytestomatio will not set or update build url for a test run. This is useful in scenarios where build url is already set in the test run by Testomat.io for test runs that a created directly on Testomat.io. | TESTOMATIO_CI_DOWNSTREAM=true pytest —testomatio report |
TESTOMATIO_URL | Customize testomat.io url | TESTOMATIO_URL=https://custom.com/ pytest —testomatio report |
BUILD_URL | Overrides build url run tests | BUILD_URL=http://custom.com/ pytest —testomatio report |
Test Run configuration
Section titled “Test Run configuration”Env variable | What it does | Examples |
---|---|---|
TESTOMATIO_TITLE | Name of a test run to create on testomat.io | TESTOMATIO_TITLE=“Nightly Smoke Tests” pytest —testomatio report |
TESTOMATIO_RUN_ID | Id of existing test run to use for sending test results to | TESTOMATIO_RUN_ID=98dfas0 pytest —testomatio report |
TESTOMATIO_RUNGROUP_TITLE | Create a group (folder) for a test run. If group already exists, attach test run to it | TESTOMATIO_RUNGROUP_TITLE=“Release 2.0” pytest —testomatio report |
TESTOMATIO_ENV | Assign environment to a test run, env variant of testRunEnv option. Has a lower precedence than testRunEnv option. | TESTOMATIO_ENV=“linux,chrome,1920x1080” pytest —testomatio report |
TESTOMATIO_LABEL | Assign labels to a test run. Labels must exist in project and their scope must be enabled for runs | TESTOMATIO_LABEL=“smoke,regression” pytest —testomatio report |
TESTOMATIO_UPDATE_CODE | Send code of your test to Testomat.io on each run. If not enabled(default) assumes the code is pushed using sync command | TESTOMATIO_UPDATE_CODE=True pytest —testomatio report |
TESTOMATIO_EXCLUDE_SKIPPED | Exclude skipped tests from the report | TESTOMATIO_EXCLUDE_SKIPPED=1 pytest —testomatio report |
TESTOMATIO_PUBLISH | Publish run after reporting and provide a public URL | TESTOMATIO_PUBLISH=true pytest —testomatio report |
TESTOMATIO_PROCEED | Do not finalize the run | TESTOMATIO_PROCEED=1 pytest —testomatio report |
TESTOMATIO_SHARED_RUN | Report parallel execution to the same run matching it by title. If the run was created more than 20 minutes ago, a new run will be created instead. | TESTOMATIO_TITLE=“Run1” TESTOMATIO_SHARED_RUN=1 pytest —testomatio report |
TESTOMATIO_SHARED_RUN_TIMEOUT | Changes timeout of shared run. After timeout, shared run won`t accept other runs with same name, and new runs will be created. Timeout is set in minutes, default is 20 minutes. | TESTOMATIO_TITLE=“Run1” TESTOMATIO_SHARED_RUN=1 TESTOMATIO_SHARED_RUN_TIMEOUT=10 pytest —testomatio report |
S3 Bucket configuration
Section titled “S3 Bucket configuration”Env variable | Description |
---|---|
S3_REGION | Your S3 region |
S3_ACCESS_KEY_ID | Your S3 access key ID |
S3_SECRET_ACCESS_KEY | Your S3 secret access key |
S3_BUCKET | Your S3 bucket name |
S3_ENDPOINT | Your S3 endpoint |
S3_BUCKET_PATH | Path to your bucket |
TESTOMATIO_PRIVATE_ARTIFACTS | Store artifacts in a bucket privately |
pytest.ini
Section titled “pytest.ini”In case you are using private testomat.io service, create pytest.ini
file in your project root directory. Specify
testomat.io url in it
[pytest]testomatio_url = https://app.testomat.io
Submitting Test Artifacts
Section titled “Submitting Test Artifacts”testomat.io does not store any screenshots, logs or other artifacts.
In order to manage them it is advised to use S3 Buckets (GCP Storage). https://docs.testomat.io/usage/test-artifacts/
Analyser needs to be aware of the cloud storage credentials. There are two options:
- Enable Share credentials with testomat.io Reporter option in testomat.io Settings -> Artifacts.
- Use environment variables
ACCESS_KEY_ID, SECRET_ACCESS_KEY, ENDPOINT, BUCKET, BUCKET_PATH, REGION
You would need to decide when you want to upload your test artifacts to cloud storage
- Upload page screenshot when test fails, using fixtures reference
# content of conftest.pyimport pytestimport randomimport osfrom typing import Dictfrom pytest import StashKey, CollectReportfrom playwright.sync_api import Page
phase_report_key = StashKey[Dict[str, CollectReport]]()
@pytest.hookimpl(wrapper=True, tryfirst=True)def pytest_runtest_makereport(item, call): rep = yield item.stash.setdefault(phase_report_key, {})[rep.when] = rep return rep
@pytest.fixture(scope="function")def handle_artifacts(page: Page, request): yield report = request.node.stash[phase_report_key] if ("call" not in report) or report["setup"].failed or report["call"].failed: random_string = ''.join(random.choices(string.ascii_letters + string.digits, k=8))
filename = f"{random_string}.png" screenshot_path = os.path.join(artifacts_dir, filename) page.screenshot(path=screenshot_path) # file_path - required, path to file to be uploaded # file_bytes - required, bytes of the file to be uploaded # key - required, file name in the s3 bucket # bucket_name - optional,name of the bucket to upload file to. Default value is taken from testomat.io artifact_url = pytest.testomatio.upload_file(screenshot_path, filename) # or # artifact_url = pytest.testomatio.upload_file_object(file_bytes, key, bucket_name) pytest.testomatio.add_artifacts(request.node, [artifact_url]) page.close()
⚠️ Please take into account s3_connector available only after pytest_collection_modifyitems() hook is executed.
- If you prefer to use pytest hooks - add
pytest_runtest_makereport
hook in yourconftest.py
file.
def pytest_runtest_makereport(item, call): artifact_url = pytest.testomatio.upload_file(screenshot_path, filename) pytest.testomatio.add_artifacts([artifact_url])
Cross-Platform Testing
Section titled “Cross-Platform Testing”The plugin supports reporting the same test multiple times in a single run. This is especially useful for Cross-Platform testing, when you run the same test on different environments. To use this feature you need to specify test run environment through TESTOMATIO_ENV environment variable or by using —testRunEnv option. Example:
TESTOMATIO=***api_key*** TESTOMATIO_RUN_ID=***run_id*** pytest --testomatio report --testRunEnv "os:ubuntu, integration"TESTOMATIO=***api_key*** TESTOMATIO_RUN_ID=***run_id*** pytest --testomatio report --testRunEnv "os:windowns, integration"
Executing these commands will include the tests in the same run, but as separate instances. Each test will contain metadata with information about the test run environment.
Note: Only key:value envs will be passed into tests metadata
Contributing
Section titled “Contributing”Use python 3.12
Manual testing
Section titled “Manual testing”- Run unit tests
- import into empty project
- updated test - (resync)
- test run
- test run into a folder
- test run labels, tags
pip install ".[dev]"
python ./smoke.py
- Test things manually
- Verify no regression bugs
cz commit --prerelease beta
cz bump
git push remoteName branchName --tags