Skip to content

TestCaseScenario

Source code in docs_src/capo_iotdeviceadvisor/types/test_case_scenario.py
class TestCaseScenario(TypedDict, closed=True):
    test_case_scenario_id: NotRequired[
        "capo_iotdeviceadvisor.types.test_case_scenario_id.TestCaseScenarioId"
    ]
    """<p>Provides test case scenario ID.</p>"""
    test_case_scenario_type: NotRequired[
        "capo_iotdeviceadvisor.types.test_case_scenario_type.TestCaseScenarioType"
    ]
    """<p>Provides test case scenario type. Type is one of the following:</p> <ul> <li> <p>Advanced</p> </li> <li> <p>Basic</p> </li> </ul>"""
    status: NotRequired[
        "capo_iotdeviceadvisor.types.test_case_scenario_status.TestCaseScenarioStatus"
    ]
    """<p>Provides the test case scenario status. Status is one of the following:</p> <ul> <li> <p> <code>PASS</code>: Test passed.</p> </li> <li> <p> <code>FAIL</code>: Test failed.</p> </li> <li> <p> <code>PENDING</code>: Test has not started running but is scheduled.</p> </li> <li> <p> <code>RUNNING</code>: Test is running.</p> </li> <li> <p> <code>STOPPING</code>: Test is performing cleanup steps. You will see this status only if you stop a suite run.</p> </li> <li> <p> <code>STOPPED</code> Test is stopped. You will see this status only if you stop a suite run.</p> </li> <li> <p> <code>PASS_WITH_WARNINGS</code>: Test passed with warnings.</p> </li> <li> <p> <code>ERORR</code>: Test faced an error when running due to an internal issue.</p> </li> </ul>"""
    failure: NotRequired["capo_iotdeviceadvisor.types.failure.Failure"]
    """<p>Provides test case scenario failure result.</p>"""
    system_message: NotRequired[
        "capo_iotdeviceadvisor.types.system_message.SystemMessage"
    ]
    """<p>Provides test case scenario system messages if any.</p>"""

failure instance-attribute

failure: NotRequired[Failure]

Provides test case scenario failure result.

status instance-attribute

status: NotRequired[TestCaseScenarioStatus]

Provides the test case scenario status. Status is one of the following:

  • PASS: Test passed.

  • FAIL: Test failed.

  • PENDING: Test has not started running but is scheduled.

  • RUNNING: Test is running.

  • STOPPING: Test is performing cleanup steps. You will see this status only if you stop a suite run.

  • STOPPED Test is stopped. You will see this status only if you stop a suite run.

  • PASS_WITH_WARNINGS: Test passed with warnings.

  • ERORR: Test faced an error when running due to an internal issue.

system_message instance-attribute

system_message: NotRequired[SystemMessage]

Provides test case scenario system messages if any.

test_case_scenario_id instance-attribute

test_case_scenario_id: NotRequired[TestCaseScenarioId]

Provides test case scenario ID.

test_case_scenario_type instance-attribute

test_case_scenario_type: NotRequired[TestCaseScenarioType]

Provides test case scenario type. Type is one of the following:

  • Advanced

  • Basic