diff options
| author |   jose.lausuch <jose.lausuch@ericsson.com> | 2016-02-24 15:08:38 +0000 |
|---|---|---|
| committer |   Gerrit Code Review <gerrit@172.30.200.206> | 2016-02-24 15:08:38 +0000 |
| commit | 88243900b0645bf6ea34b8f49a22af439adc839c (patch) | |
| tree | aa0f07db73a54c65c9d82c33fd8eb2008c2d5412 /docs/devguide | |
| parent | 331f246f2b8be355ecf07e3e207b66e124af3799 (diff) | |
| parent | 9f02fb0b914b52336d04a5e8e25102a828fe6191 (diff) | |
Merge "Fix Doc errors detected in opnfv-docs-verify and add license"
Diffstat (limited to 'docs/devguide')
| -rw-r--r-- | docs/devguide/index.rst | 40 |
1 files changed, 18 insertions, 22 deletions
diff --git a/docs/devguide/index.rst b/docs/devguide/index.rst index 7f3233c4c..210774be6 100644 --- a/docs/devguide/index.rst +++ b/docs/devguide/index.rst @@ -299,10 +299,8 @@ compare the results versus the installers, the scenario or the labs. You can find more information about the dashboard from Testing Dashboard wiki page `[3]`_. - Overall Architecture --------------------- - +==================== The Test result management in Brahmaputra can be summarized as follows:: +-------------+ +-------------+ +-------------+ @@ -344,8 +342,7 @@ per scenario for Brahmaputra release:: This Dashboard consumes the results retrieved thanks to the Test API. Test API description --------------------- - +==================== The Test API is used to declare pods, projects, test cases and test results. An additional method dashboard has been added to post-process the raw results. The data model is very basic, 4 objects are created: @@ -432,8 +429,8 @@ Pods: | POST | /pods | Declare a new POD | | | | Content-Type: application/json | | | | { | - | | | "name": "pod_foo", | - | | | "creation_date": "YYYY-MM-DD HH:MM:SS"| + | | | "name": "pod_foo", | + | | | "creation_date": "YYYY-MM-DD HH:MM:SS" | | | | } | +--------+--------------------------+-----------------------------------------+ @@ -450,15 +447,15 @@ Projects: | POST | /test_projects | Add a new test project | | | | Content-Type: application/json | | | | { | - | | | "name": "project_foo", | - | | | "description": "whatever you want" | + | | | "name": "project_foo", | + | | | "description": "whatever you want" | | | | } | +--------+--------------------------+-----------------------------------------+ | PUT | /test_projects/{project} | Update a test project | | | | | | | | Content-Type: application/json | | | | { | - | | | <the field(s) you want to modify> | + | | | <the field(s) you want to modify> | | | | } | +--------+--------------------------+-----------------------------------------+ | DELETE | /test_projects/{project} | Delete a test project | @@ -476,17 +473,17 @@ Test cases: | POST | /test_projects/{project}/| Add a new test case to {project} | | | cases | Content-Type: application/json | | | | { | - | | | "name": "case_foo", | - | | | "description": "whatever you want" | - | | | "creation_date": "YYYY-MM-DD HH:MM:SS"| - | | | "url": "whatever you want" | + | | | "name": "case_foo", | + | | | "description": "whatever you want" | + | | | "creation_date": "YYYY-MM-DD HH:MM:SS" | + | | | "url": "whatever you want" | | | | } | +--------+--------------------------+-----------------------------------------+ | PUT | /test_projects/{project}?| Modify a test case of {project} | | | case_name={case} | | | | | Content-Type: application/json | | | | { | - | | | <the field(s) you want to modify> | + | | | <the field(s) you want to modify> | | | | } | +--------+--------------------------+-----------------------------------------+ | DELETE | /test_projects/{project}/| Delete a test case | @@ -523,12 +520,12 @@ Test Results: | POST | /results | Add a new test results | | | | Content-Type: application/json | | | | { | - | | | "project_name": "project_foo", | - | | | "case_name": "case_foo", | - | | | "pod_name": "pod_foo", | - | | | "installer": "installer_foo", | - | | | "version": "scenario_foo", | - | | | "details": <your results> | + | | | "project_name": "project_foo", | + | | | "case_name": "case_foo", | + | | | "pod_name": "pod_foo", | + | | | "installer": "installer_foo", | + | | | "version": "scenario_foo", | + | | | "details": <your results> | | | | } | +--------+--------------------------+-----------------------------------------+ @@ -587,7 +584,6 @@ You can also reuse a python function defined in functest_utils.py:: % (db_url, case_name, pod_name, version, payload), e return False -:: ========== References |