Launch arguments

HardPy launches pytest tests. HardPy supports two methods for passing parameters to tests. The recommended method is the start arguments functionality. The other method is writing your own addoption pytest approach.

Start arguments

The hardpy_start_args fixture allows you to pass dynamic parameters to your test runs using the --arg option (CLI) or --hardpy-start-arg option (pytest). This is particularly useful for configuring tests at runtime without changing the code.

Contains examples of how to use dynamic start arguments in tests.

how to start

1. Launch hardpy init start_arguments.
2. Launch CouchDB instance.
3. Modify the files described below.

4. Launch tests with dynamic arguments:

   hardpy run start_arguments
   
   # Using hardpy command
   hardpy start start_arguments --arg test_mode=debug --arg device_id=DUT-007 --arg retry_count=3
   
   # Or using pytest directly
   pytest --hardpy-start-arg test_mode=debug --hardpy-start-arg device_id=DUT-007 --hardpy-start-arg retry_count=3
   

   Alternatively, you can specify start arguments in the pytest.ini file. This is useful for setting default arguments that are always used when running tests.

   [pytest]
   addopts = --hardpy-pt
           --hardpy-db-url http://dev:dev@localhost:5984/
           --hardpy-start-arg test_mode=debug
           --hardpy-start-arg device_id=DUT-007
   

test_1.py

import pytest
import hardpy

def test_with_start_args(hardpy_start_args):

    if hardpy_start_args.get("test_mode") == "debug":
        hardpy.set_message("Running in debug mode")

    device_id = hardpy_start_args.get("device_id")
    if device_id:
        hardpy.set_message(f"Testing device: {device_id}")
        hardpy.set_case_artifact({"device_id": device_id})
    else:
        hardpy.set_message("No device ID provided")

Addoption

Alternative approach using pytest's built-in addoption method for adding custom options. You can read more about it in the pytest documentation.

how to start

1. Launch hardpy init launch_arg.
2. Launch CouchDB instance.
3. Modify the files described below.
4. Launch hardpy run launch_arg.

conftest.py

def pytest_addoption(parser):
    parser.addoption("--my-opt", action="store", help="add my opt")

@pytest.fixture(scope="session")
def my_opt(request):
    return request.config.getoption("--my-opt")

test_1.py

def test_custom_option_1(request):
    custom_value = request.config.getoption("--my-opt")
    print(f"Custom option value: {custom_value}")
    assert custom_value == "hello"

def test_custom_option_2(my_opt):
    print(f"Custom option value: {my_opt}")
    assert my_opt == "hello"

launch test with your parameter

You can launch tests with this command:

pytest --my-opt hello

Alternatively, you can add the parameter --my-opt hello to the pytest.ini file.