Table Of Contents

inet.test.fingerprint.task

This module provides functionality for fingerprint testing of multiple simulations.

The main function is run_fingerprint_tests(). It allows running multiple fingerprint tests matching the provided filter criteria. Fingerprint tests check for regressions in the simulation execution trajectory.

Classes

FingerprintTestGroupTask	Represents multiple test tasks that can be run together.
FingerprintTestTask	Represents a simulation test task that can be run (and re-run) without providing additional parameters.
FingerprintTestTaskResult	Represents a simulation test task result that is collected when a simulation test task is run.
FingerprintTrajectoryTestTask	Represents a self-contained test task that can be run without additional parameters.
FingerprintTrajectoryTestTaskResult	Represents a test task result that is created when a test task is run.
FingerprintUpdateTask	Represents a self-contained operation that captures all necessary information in order to be run.
FingerprintUpdateTaskResult	Represents a task result that is produced when a Task is run. The most important attributes of a task
MultipleFingerprintTestTaskResults	Represents multiple test task results that are created when multiple test tasks are run.
MultipleFingerprintTestTasks	Represents multiple test tasks that can be run together.
MultipleFingerprintUpdateTaskResults	Represents multiple task results that are created when MultipleTasks are run.
MultipleFingerprintUpdateTasks	Represents multiple tasks that can be run together.

Functions

get_fingerprint_test_tasks(**kwargs)	Returns multiple fingerprint test tasks matching the provided filter criteria. The returned tasks can be run by
get_update_correct_fingerprint_tasks(**kwargs)	Returns multiple fingerprint update tasks matching the provided filter criteria. The returned tasks can be run by
run_fingerprint_tests(**kwargs)	Runs one or more fingerprint tests that match the provided filter criteria.
update_correct_fingerprints(**kwargs)	Updates the stored correct fingerprints in the database for one or more fingerprint tests that match the provided

Module Contents

inet.test.fingerprint.task.get_fingerprint_test_tasks(**kwargs)

Returns multiple fingerprint test tasks matching the provided filter criteria. The returned tasks can be run by calling the run method.

Parameters:

kwargs (dict) – The filter criteria parameters are inherited from the get_simulation_tasks method.

Returns (MultipleFingerprintTestTasks):

an object that contains a list of FingerprintTestTask objects matching the provided filter criteria. The result can be run (and re-run) without providing additional parameters.

inet.test.fingerprint.task.get_update_correct_fingerprint_tasks(**kwargs)

Returns multiple fingerprint update tasks matching the provided filter criteria. The returned tasks can be run by calling the run method.

Parameters:

kwargs (dict) – The filter criteria parameters are inherited from the get_simulation_tasks method.

Returns (MultipleFingerprintUpdateTasks):

an object that contains a list of FingerprintUpdateTask objects matching the provided filter criteria. The result can be run (and re-run) without providing additional parameters.

inet.test.fingerprint.task.run_fingerprint_tests(**kwargs)

Runs one or more fingerprint tests that match the provided filter criteria.

Parameters:

kwargs (dict) – The filter criteria parameters are inherited from the get_fingerprint_test_tasks() function.

Returns (MultipleFingerprintTestTaskResults):

an object that contains a list of FingerprintTestTaskResult objects. Each object describes the result of running one test task.

inet.test.fingerprint.task.update_correct_fingerprints(**kwargs)

Updates the stored correct fingerprints in the database for one or more fingerprint tests that match the provided filter criteria.

Parameters:

kwargs (dict) – The filter criteria parameters are inherited from the get_update_correct_fingerprint_tasks() function.

Returns (MultipleFingerprintUpdateTaskResults):

an object that contains a list of FingerprintUpdateTaskResult objects. Each object describes the result of running one update task.

Table Of Contents

• inet.test.fingerprint.task
  • Classes
  • Functions
  • Module Contents
    • get_fingerprint_test_tasks()
    • get_update_correct_fingerprint_tasks()
    • run_fingerprint_tests()
    • update_correct_fingerprints()

Previous

inet.test.fingerprint

Next

inet.test.fingerprint.task.FingerprintTestGroupTask