Skip to content

Provided Fixtures

The HIL system provides several built-in PyTest fixtures that can be used by any test. In most cases, fixtures don't return a value at all, or if they do, it's a simple scalar value or an object. However, these fixtures follow the factory fixtures model, where a fixture returns a function that can be called. Within HIL, all three of these fixtures behave as functions after requesting them in your test:

1
2
3
4
5
6
def test_system(hil_extras_get_path):  # Request the fixture here

    ...
    # Call it just like a function
    fw_path = hil_extras_get_path("fw.hex")
    ...

To use these fixtures, request them in your test function using the name listed and use the passed in object as a callable function.

API Reference

hil_extras_get_path(path)

Get the absolute file system path for the given extras file.

Parameters:

Name Type Description Default
path str

Name of extra, including any relative path items

 required

Returns:

Type Description
str

Absolute file system path of given extra

hil_results_get_path(filename)

Get the absolute file system path for the given results file.

Parameters:

Name Type Description Default
filename str

Name of file, without any relative or absolute path elements

 required

Returns:

Type Description
str

Absolute file system path of given file name

hil_results_open(file, mode='w', buffering=-1, encoding=None, errors=None, newline=None, closefd=True, opener=None)

Open a file that will eventually be used as a HIL result file. This function takes the same parameters as the built-in open() function, but the name must not contain any path elements, e.g. "test.txt". See documentation for the built-in open() function for full paramter descriptions.