inet.test.fingerprint.task.FingerprintTestTask¶
- class inet.test.fingerprint.task.FingerprintTestTask(sim_time_limit=None, ingredients='tplx', fingerprint=None, test_result=None, name='fingerprint test', action='Checking fingerprint', task_result_class=FingerprintTestTaskResult, **kwargs)¶
Bases:
inet.test.simulation.SimulationTestTaskRepresents a simulation test task that can be run (and re-run) without providing additional parameters.
Please note that undocumented features are not supposed to be called by the user.
Initializes a new task object.
- Parameters:
name (string) – A human readable short description of the task, usually a noun.
action (string) – A human readable short description of the operation the task is carrying out, usually a verb.
task_result_class (string) – The Python class name of the produced task result object.
- rerun(**kwargs)¶
Runs the task again.
- Returns (
TaskResult): The task result.
- Returns (
- run(test_result_filter=None, exclude_test_result_filter='SKIP', output_stream=sys.stdout, **kwargs)¶
Runs the task.
- Parameters:
dry_run (bool) – Specifies to skip the actual running of the task but do everything else.
keyboard_interrupt_handler (
inet.common.KeyboardInterruptHandleror None) – Provides a class that will handle keyboard interrupts. This allows seamless exit from running multiple tasks.handle_exception (bool) – Specifies if exceptions are caught and processed or passed to the caller.
- Returns (
TaskResult): The task result.
- run_protected(output_stream=sys.stdout, **kwargs)¶
Runs the task in the protected environment wrapped by
run(). This method is expected to be overridden by derived classes. The default implementation simply returns a task result with “DONE” result code.- Parameters:
kwargs (dict) – Not used in this implementation.
- Returns (
TaskResult): The task result.