xenanetworks / open-automation-rfc-test-suites

🚀 XOA test suite library for network performance benchmarking and more.
https://docs.xenanetworks.com/projects/xoa-core
Apache License 2.0
2 stars 1 forks source link

Unified the result data schema of 2544, 2889, and 3918 #12

Open leonardhyu opened 1 year ago

leonardhyu commented 1 year ago

For users who run xoa tests using Python to easily parse the result data, we need to unify the json schema and include it in the user document.

The reason I am raising this issue is because I am writing the user doc about how to tell if the result data is:

The problem I have found is that we are using different names even at the first level, such as telling if the data is final or live, what result state/status it is.

In 2544

    test_case_type: const.TestType
    test_suite_type: str = "xoa2544"
    result_state: const.ResultState = const.ResultState.PENDING
    tx_rate_percent: Decimal
    is_final: bool = True

In 2889

    status=const.StatisticsStatus.PENDING,
    is_live=is_live,

In 3918


    result_state: ResultState = ResultState.PENDING
    is_final: bool = False