diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/model/current/schema/test_case.info.schema.json | 63 | ||||
| -rw-r--r-- | docs/model/current/schema/test_case.info.schema.yaml | 47 | ||||
| -rw-r--r-- | docs/model/current/schema/todos.txt | 8 | ||||
| -rw-r--r-- | docs/model/current/top.rst | 4 |
4 files changed, 37 insertions, 85 deletions
diff --git a/docs/model/current/schema/test_case.info.schema.json b/docs/model/current/schema/test_case.info.schema.json index 7df6caad61..d99dd4766a 100644 --- a/docs/model/current/schema/test_case.info.schema.json +++ b/docs/model/current/schema/test_case.info.schema.json @@ -1,5 +1,5 @@ { - "$id": "https://fd.io/FIXME/CSIT/UTI/test_case/info/1.0.0", + "$id": "https://fd.io/FIXME/CSIT/UTI/test_case/info/1.0.1", "$schema": "https://json-schema.org/draft/2020-12/schema", "description": "Schema for info output of test case.", "allOf": [ @@ -14,11 +14,13 @@ }, "dut_type": { "description": "DUT type used, e.g. VPP or DPDK.", - "type": "string" + "type": "string", + "minLength": 1 }, "dut_version": { "description": "Version string appropriate to DUT type used.", - "type": "string" + "type": "string", + "minLength": 1 }, "end_time": { "description": "UTC date and time in RFC 3339 format, specifying calendar time just before test case ended (at the end of test case teardown).", @@ -183,10 +185,20 @@ "vsap" ] }, + "tg_type": { + "description": "TG type used, e.g. TREX.", + "type": "string", + "minLength": 1 + }, + "tg_version": { + "description": "Version string appropriate to TG type used.", + "type": "string", + "minLength": 1 + }, "version": { "description": "CSIT model version (semver format) the exporting code adhered to.", "type": "string", - "const": "1.0.0" + "const": "1.0.1" } }, "required": [ @@ -206,6 +218,8 @@ "test_name_long", "test_name_short", "test_type", + "tg_type", + "tg_version", "version" ] }, @@ -237,47 +251,6 @@ } } ] - }, - { - "description": "Subschema validating relation between dut_type and dut_version.", - "oneOf": [ - { - "description": "Subschema for tests with no DUT, e.g. TRex self-test.", - "type": "object", - "properties": { - "dut_type": { - "const": "none" - }, - "dut_version": { - "const": "" - } - } - }, - { - "description": "Subschema for DUT type VPP.", - "type": "object", - "properties": { - "dut_type": { - "const": "VPP" - }, - "dut_version": { - "minLength": 1 - } - } - }, - { - "description": "Subschema for DUT type DPDK.", - "type": "object", - "properties": { - "dut_type": { - "const": "DPDK" - }, - "dut_version": { - "minLength": 1 - } - } - } - ] } ], "$defs": { diff --git a/docs/model/current/schema/test_case.info.schema.yaml b/docs/model/current/schema/test_case.info.schema.yaml index 295c2fa7cb..9fd105a972 100644 --- a/docs/model/current/schema/test_case.info.schema.yaml +++ b/docs/model/current/schema/test_case.info.schema.yaml @@ -1,4 +1,4 @@ -# Copyright (c) 2021 Cisco and/or its affiliates. +# Copyright (c) 2022 Cisco and/or its affiliates. # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. # You may obtain a copy of the License at: @@ -13,7 +13,7 @@ --- -$id: https://fd.io/FIXME/CSIT/UTI/test_case/info/1.0.0 +$id: https://fd.io/FIXME/CSIT/UTI/test_case/info/1.0.1 $schema: https://json-schema.org/draft/2020-12/schema description: >- Schema for info output of test case. @@ -32,10 +32,12 @@ allOf: description: >- DUT type used, e.g. VPP or DPDK. type: string + minLength: 1 dut_version: description: >- Version string appropriate to DUT type used. type: string + minLength: 1 end_time: description: >- UTC date and time in RFC 3339 format, specifying calendar time @@ -281,12 +283,22 @@ allOf: - reconf - soak - vsap + tg_type: + description: >- + TG type used, e.g. TREX. + type: string + minLength: 1 + tg_version: + description: >- + Version string appropriate to TG type used. + type: string + minLength: 1 version: description: >- CSIT model version (semver format) the exporting code adhered to. type: string - const: 1.0.0 + const: 1.0.1 required: - duration - dut_type @@ -304,6 +316,8 @@ allOf: - test_name_long - test_name_short - test_type + - tg_type + - tg_version - version - description: >- Subschema validating relation between status and message. @@ -324,33 +338,6 @@ allOf: const: false message: minLength: 1 -- description: >- - Subschema validating relation between dut_type and dut_version. - oneOf: - - description: >- - Subschema for tests with no DUT, e.g. TRex self-test. - type: object - properties: - dut_type: - const: none - dut_version: - const: "" - - description: >- - Subschema for DUT type VPP. - type: object - properties: - dut_type: - const: VPP - dut_version: - minLength: 1 - - description: >- - Subschema for DUT type DPDK. - type: object - properties: - dut_type: - const: DPDK - dut_version: - minLength: 1 $defs: types: diff --git a/docs/model/current/schema/todos.txt b/docs/model/current/schema/todos.txt index 8e63b21a19..91e8bb49bb 100644 --- a/docs/model/current/schema/todos.txt +++ b/docs/model/current/schema/todos.txt @@ -1,6 +1,4 @@ -Export also tg_type and tg_version properties. - Add description with link to methodology for MRR, NDRPDR and SOAK. Add multiplicity field to MRR result, so PAL can detect incomplete samples. @@ -8,9 +6,3 @@ Add multiplicity field to MRR result, so PAL can detect incomplete samples. Add link explaining our L1 bandwidth calculation. Add a link to URL explaining how to decode the hdrh data. - -Do we want to require more structure for dut_version, e.g. at least two dots? - -Should we parse version strings? -E.g.: Turn dut_version from "21.11.0" -into {"major": 21, "minor": 11, "patch": 0}. diff --git a/docs/model/current/top.rst b/docs/model/current/top.rst index d86e3fde4c..ee33a29cd3 100644 --- a/docs/model/current/top.rst +++ b/docs/model/current/top.rst @@ -1,5 +1,5 @@ .. - Copyright (c) 2021 Cisco and/or its affiliates. + Copyright (c) 2022 Cisco and/or its affiliates. Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at: @@ -22,7 +22,7 @@ especially the export side (UTI), not import side (PAL). Version ~~~~~~~ -This document is valid for CSIT model version 1.0.0. +This document is valid for CSIT model version 1.0.1. It is recommended to use semantic versioning: https://semver.org/ That means, if the new model misses a field present in the old model, |