aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorMilo Casagrande <milo.casagrande@linaro.org>2015-03-04 16:46:49 +0100
committerMilo Casagrande <milo.casagrande@linaro.org>2015-03-04 16:46:49 +0100
commit8f53989cca963caa84a090f8b2e78d5b1749af4d (patch)
tree34e81f8762740612838008dda4e854302df956d8
parentbc854e82a65e0fa61ff229a244957cb886d8cf11 (diff)
doc: Update test schema definitions.
-rw-r--r--doc/schema-test-case.rst6
-rw-r--r--doc/schema-test-set.rst3
-rw-r--r--doc/schema-test-suite.rst6
-rw-r--r--doc/schema/1.0/test_set_post.json4
-rw-r--r--doc/schema/1.0/test_suite_post.json2
5 files changed, 14 insertions, 7 deletions
diff --git a/doc/schema-test-case.rst b/doc/schema-test-case.rst
index 705914e..2da5165 100644
--- a/doc/schema-test-case.rst
+++ b/doc/schema-test-case.rst
@@ -4,11 +4,9 @@ test_case
---------
A test case is the single unit of test that gets executed. Each test must have its
-own ``name`` defined.
+own ``name`` defined and must be associated with a :ref:`test suite <schema_test_suite>`.
-A test case can be associated with only one :ref:`test suite <schema_test_suite>` and one :ref:`test set <schema_test_set>`.
-
-A test case can also register multiple :ref:`measurements <schema_measurement>`.
+A test case can be associated with only one :ref:`test suite <schema_test_suite>` and one :ref:`test set <schema_test_set>`. A test case can also register multiple :ref:`measurements <schema_measurement>`.
.. _schema_test_case_get:
diff --git a/doc/schema-test-set.rst b/doc/schema-test-set.rst
index cb760dd..843b0f5 100644
--- a/doc/schema-test-set.rst
+++ b/doc/schema-test-set.rst
@@ -3,6 +3,9 @@
test_set
--------
+A test set is a collection of :ref:`test cases <schema_test_case>`. Each test set
+must define its own ``name`` and must be associated with a :ref:`test suite <schema_test_suite>`.
+
.. _schema_test_set_get:
GET
diff --git a/doc/schema-test-suite.rst b/doc/schema-test-suite.rst
index a82c7cf..64b38c9 100644
--- a/doc/schema-test-suite.rst
+++ b/doc/schema-test-suite.rst
@@ -3,6 +3,10 @@
test_suite
----------
+A test suite is the collection of :ref:`test sets <schema_test_set>` and :ref:`test cases <schema_test_case>`.
+
+A test suite must define its own ``name`` and must be associated with a :ref:`lab <schema_lab>` and with a :ref:`built defconfig <schema_defconfig>`. The association with the ``defconfig`` object is performed through the ``defconfig_id`` value, the lab association via the lab ``name`` value.
+
.. _schema_test_suite_get:
GET
@@ -36,5 +40,7 @@ More Info
* :ref:`Test set schema <schema_test_set>`
* :ref:`Test case schema <schema_test_case>`
+* :ref:`Defconfig schema <schema_defconfig>`
+* :ref:`Lab schema <schema_lab>`
* :ref:`API results <intro_schema_results>`
* :ref:`Schema time and date <intro_schema_time_date>`
diff --git a/doc/schema/1.0/test_set_post.json b/doc/schema/1.0/test_set_post.json
index fc5cb50..34e5fac 100644
--- a/doc/schema/1.0/test_set_post.json
+++ b/doc/schema/1.0/test_set_post.json
@@ -22,8 +22,8 @@
"type": "string",
"description": "The test suite ID associated with this test set"
},
- "uri": {
- "type": "uri",
+ "definition_uri": {
+ "type": "string",
"description": "The URI where this test set definition is stored"
},
"vcs_commit": {
diff --git a/doc/schema/1.0/test_suite_post.json b/doc/schema/1.0/test_suite_post.json
index 2c2a992..7f38215 100644
--- a/doc/schema/1.0/test_suite_post.json
+++ b/doc/schema/1.0/test_suite_post.json
@@ -83,5 +83,5 @@
"additionalItems": true
}
},
- "required": ["version", "name", "lab_name"]
+ "required": ["version", "name", "lab_name", "defconfig_id"]
}