diff options
| -rw-r--r-- | functest/api/swagger/creds.yaml | 55 | ||||
| -rw-r--r-- | functest/api/swagger/creds_action.yaml | 97 | ||||
| -rw-r--r-- | functest/api/swagger/envs.yaml | 37 | ||||
| -rw-r--r-- | functest/api/swagger/envs_action.yaml | 69 | ||||
| -rw-r--r-- | functest/api/swagger/task.yaml | 59 | ||||
| -rw-r--r-- | functest/api/swagger/task_log.yaml | 56 | ||||
| -rw-r--r-- | functest/api/swagger/testcase.yaml | 54 | ||||
| -rw-r--r-- | functest/api/swagger/testcase_run.yaml | 77 | ||||
| -rw-r--r-- | functest/api/swagger/testcases.yaml | 29 | ||||
| -rw-r--r-- | functest/api/swagger/testcases_in_tier.yaml | 41 | ||||
| -rw-r--r-- | functest/api/swagger/tier.yaml | 47 | ||||
| -rw-r--r-- | functest/api/swagger/tiers.yaml | 29 | ||||
| -rw-r--r-- | tox.ini | 2 |
13 files changed, 328 insertions, 324 deletions
diff --git a/functest/api/swagger/creds.yaml b/functest/api/swagger/creds.yaml index da3b2d900..eec7cb345 100644 --- a/functest/api/swagger/creds.yaml +++ b/functest/api/swagger/creds.yaml @@ -1,35 +1,36 @@ +--- Show credentials This api offers the interface to show credentials. The credentials dict will be returned. --- tags: - - Creds + - Creds definitions: - Credentials: - type: object - properties: - creds_name: - $ref: '#/definitions/Name' - Name: - type: dict + Credentials: + type: object + properties: + creds_name: + $ref: '#/definitions/Name' + Name: + type: dict responses: - 200: - description: Show credentials - schema: - $ref: '#/definitions/Credentials' - examples: - "OS_AUTH_URL": "https://192.16.1.222:5000/v3" - "OS_AUTH_VERSION": "3" - "OS_CACERT": "/home/opnfv/functest/conf/os_cacert" - "OS_ENDPOINT_TYPE": "publicURL" - "OS_IDENTITY_API_VERSION": "3" - "OS_INTERFACE": "publicURL" - "OS_NO_CACHE": "1" - "OS_PASSWORD": "990232e0885da343ac805528522d" - "OS_PROJECT_DOMAIN_NAME": "Default" - "OS_PROJECT_NAME": "admin" - "OS_REGION_NAME": "RegionOne" - "OS_TENANT_NAME": "admin" - "OS_USERNAME": "admin" - "OS_USER_DOMAIN_NAME": "Default" + 200: + description: Show credentials + schema: + $ref: '#/definitions/Credentials' + examples: + "OS_AUTH_URL": "https://192.16.1.222:5000/v3" + "OS_AUTH_VERSION": "3" + "OS_CACERT": "/home/opnfv/functest/conf/os_cacert" + "OS_ENDPOINT_TYPE": "publicURL" + "OS_IDENTITY_API_VERSION": "3" + "OS_INTERFACE": "publicURL" + "OS_NO_CACHE": "1" + "OS_PASSWORD": "990232e0885da343ac805528522d" + "OS_PROJECT_DOMAIN_NAME": "Default" + "OS_PROJECT_NAME": "admin" + "OS_REGION_NAME": "RegionOne" + "OS_TENANT_NAME": "admin" + "OS_USERNAME": "admin" + "OS_USER_DOMAIN_NAME": "Default" diff --git a/functest/api/swagger/creds_action.yaml b/functest/api/swagger/creds_action.yaml index d67d082da..7e7653bb5 100644 --- a/functest/api/swagger/creds_action.yaml +++ b/functest/api/swagger/creds_action.yaml @@ -1,57 +1,56 @@ +--- Update openrc This api offers the interface to Update openstack.creds. - -action: update_openrc --- tags: - - Creds + - Creds parameters: - - in: body - name: body - description: this is the input json dict - schema: - required: - - action - - args - properties: - action: - type: string - description: this is action for creds - default: update_openrc - args: - schema: - required: - - openrc - properties: - openrc: - type: string - description: this is the test case name - default: - "OS_AUTH_URL": "http://192.16.1.222:5000/v3" - "OS_ENDPOINT_TYPE": "publicURL" - "OS_IDENTITY_API_VERSION": "3" - "OS_INTERFACE": "publicURL" - "OS_PASSWORD": "admn" - "OS_PROJECT_DOMAIN_NAME": "Default" - "OS_PROJECT_NAME": "admin" - "OS_REGION_NAME": "RegionOne" - "OS_TENANT_NAME": "admin" - "OS_USERNAME": "admin" - "OS_USER_DOMAIN_NAME": "Default" + - in: body + name: body + description: this is the input json dict + schema: + required: + - action + - args + properties: + action: + type: string + description: this is action for creds + default: update_openrc + args: + schema: + required: + - openrc + properties: + openrc: + type: string + description: this is the test case name + default: + "OS_AUTH_URL": "http://192.16.1.222:5000/v3" + "OS_ENDPOINT_TYPE": "publicURL" + "OS_IDENTITY_API_VERSION": "3" + "OS_INTERFACE": "publicURL" + "OS_PASSWORD": "admn" + "OS_PROJECT_DOMAIN_NAME": "Default" + "OS_PROJECT_NAME": "admin" + "OS_REGION_NAME": "RegionOne" + "OS_TENANT_NAME": "admin" + "OS_USERNAME": "admin" + "OS_USER_DOMAIN_NAME": "Default" definitions: - Credentials: - type: object - properties: - creds_name: - $ref: '#/definitions/Name' - Name: - type: dict + Credentials: + type: object + properties: + creds_name: + $ref: '#/definitions/Name' + Name: + type: dict responses: - 200: - description: Update openrc - schema: - $ref: '#/definitions/Credentials' - examples: - 'status': 0 - 'result': 'Update openrc successfully' + 200: + description: Update openrc + schema: + $ref: '#/definitions/Credentials' + examples: + 'status': 0 + 'result': 'Update openrc successfully' diff --git a/functest/api/swagger/envs.yaml b/functest/api/swagger/envs.yaml index e723deb3f..4ff50c86c 100644 --- a/functest/api/swagger/envs.yaml +++ b/functest/api/swagger/envs.yaml @@ -1,26 +1,27 @@ +--- Show environment This api offers the interface to show environment. The environment dict will be returned. --- tags: - - Envs + - Envs definitions: - Environment: - type: object - properties: - creds_name: - $ref: '#/definitions/Name' - Name: - type: dict + Environment: + type: object + properties: + creds_name: + $ref: '#/definitions/Name' + Name: + type: dict responses: - 200: - description: Show environment - schema: - $ref: '#/definitions/Environment' - examples: - "DEBUG FLAG": "false" - "INSTALLER": "compass, 192.168.200.2" - "POD": "unknown_pod" - "SCENARIO": "os-nosdn-nofeature-noha" - "STATUS": "ready" + 200: + description: Show environment + schema: + $ref: '#/definitions/Environment' + examples: + "DEBUG FLAG": "false" + "INSTALLER": "compass, 192.168.200.2" + "POD": "unknown_pod" + "SCENARIO": "os-nosdn-nofeature-noha" + "STATUS": "ready" diff --git a/functest/api/swagger/envs_action.yaml b/functest/api/swagger/envs_action.yaml index 46faa6dea..3ad6c880d 100644 --- a/functest/api/swagger/envs_action.yaml +++ b/functest/api/swagger/envs_action.yaml @@ -1,43 +1,42 @@ +--- Update hosts info This api offers the interface to update hosts info. - -action: update_hosts --- tags: - - Envs + - Envs parameters: - - in: body - name: body - description: this is the input json dict - schema: - required: - - action - - args - properties: - action: - type: string - description: this is action for envs - default: update_hosts - args: - type: string - description: Hosts info to be updated - default: - "identity.ac.dz.com": "8.20.11.22" - "image.ac.dz.com": "8.20.11.22" + - in: body + name: body + description: this is the input json dict + schema: + required: + - action + - args + properties: + action: + type: string + description: this is action for envs + default: update_hosts + args: + type: string + description: Hosts info to be updated + default: + "identity.ac.dz.com": "8.20.11.22" + "image.ac.dz.com": "8.20.11.22" definitions: - Environment: - type: object - properties: - creds_name: - $ref: '#/definitions/Name' - Name: - type: dict + Environment: + type: object + properties: + creds_name: + $ref: '#/definitions/Name' + Name: + type: dict responses: - 200: - description: Update hosts info - schema: - $ref: '#/definitions/Environment' - examples: - 'status': 0 - 'result': 'Update hosts info successfully'
\ No newline at end of file + 200: + description: Update hosts info + schema: + $ref: '#/definitions/Environment' + examples: + 'status': 0 + 'result': 'Update hosts info successfully' diff --git a/functest/api/swagger/task.yaml b/functest/api/swagger/task.yaml index abf68a0d6..3375b9065 100644 --- a/functest/api/swagger/task.yaml +++ b/functest/api/swagger/task.yaml @@ -1,38 +1,37 @@ +--- Get the result of the specified task This api offers the interface to get the result of the specified task. - --- tags: - - Tasks + - Tasks parameters: - - name: task_id - description: task id - in: path - type: string - required: true + - name: task_id + description: task id + in: path + type: string + required: true definitions: - Task: - type: object - properties: - creds_name: - $ref: '#/definitions/Result' - Result: - type: dict + Task: + type: object + properties: + creds_name: + $ref: '#/definitions/Result' + Result: + type: dict responses: - 200: - description: Get the result of the specified task - schema: - $ref: '#/definitions/Task' - examples: - "result": { - "case_name": "vping_ssh", - "env_info": { - "build_tag": null, - "ci_loop": "weekly", - "installer": "compass", - "scenario": "os-nosdn-nofeature-noha" }, - "result": "PASS", - "task_id": "1a9f3c5d-ce0b-4354-862e-dd08b26fc484"} - "status": 2 - + 200: + description: Get the result of the specified task + schema: + $ref: '#/definitions/Task' + examples: + "result": { + "case_name": "vping_ssh", + "env_info": { + "build_tag": null, + "ci_loop": "weekly", + "installer": "compass", + "scenario": "os-nosdn-nofeature-noha"}, + "result": "PASS", + "task_id": "1a9f3c5d-ce0b-4354-862e-dd08b26fc484"} + "status": 2 diff --git a/functest/api/swagger/task_log.yaml b/functest/api/swagger/task_log.yaml index adaaaf407..120a8f6f7 100644 --- a/functest/api/swagger/task_log.yaml +++ b/functest/api/swagger/task_log.yaml @@ -1,35 +1,37 @@ +--- Get the log of the specified task This api offers the interface to get the log of the specified task. - --- tags: - - Tasks + - Tasks parameters: - - name: task_id - description: task id - in: path - type: string - required: true + - name: task_id + description: task id + in: path + type: string + required: true definitions: - Task: - type: object - properties: - creds_name: - $ref: '#/definitions/Result' - Result: - type: dict + Task: + type: object + properties: + creds_name: + $ref: '#/definitions/Result' + Result: + type: dict responses: - 200: - description: Get the log of the specified task - schema: - $ref: '#/definitions/Task' - examples: - "result": { - "data": [ - "2017-09-14 06:46:26,106 - functest.ci.run_tests - DEBUG - Sourcing the OpenStack RC file... ", - "2017-09-14 06:46:26,107 - functest.ci.run_tests - DEBUG - Test args: connection_check ", - "2017-09-14 06:46:26,107 - functest.ci.run_tests - INFO - Running test case 'connection_check'... ", - "..."]} - "status": 2 - + 200: + description: Get the log of the specified task + schema: + $ref: '#/definitions/Task' + examples: + "result": { + "data": [ + "2017-09-14 06:46:26,106 - functest.ci.run_tests - DEBUG ", + "- Sourcing the OpenStack RC file... ", + "2017-09-14 06:46:26,107 - functest.ci.run_tests - DEBUG ", + "- Test args: connection_check ", + "2017-09-14 06:46:26,107 - functest.ci.run_tests - INFO ", + "- Running test case 'connection_check'... ", + "..."]} + "status": 2 diff --git a/functest/api/swagger/testcase.yaml b/functest/api/swagger/testcase.yaml index 70ee1af1a..34c13d217 100644 --- a/functest/api/swagger/testcase.yaml +++ b/functest/api/swagger/testcase.yaml @@ -1,36 +1,36 @@ +--- Show the info of one testcase This api offers the interface to show the detailed info of one testcase. The info of one testcase will be returned. --- tags: - - Testcases + - Testcases parameters: - - name: testcase_name - description: testcase name - in: path - type: string - required: true + - name: testcase_name + description: testcase name + in: path + type: string + required: true definitions: - Testcases: - type: object - properties: - case_name: - $ref: '#/definitions/Tests' - Tests: - type: dict + Testcases: + type: object + properties: + case_name: + $ref: '#/definitions/Tests' + Tests: + type: dict responses: - 200: - description: Show the detailed info of one testcase - schema: - $ref: '#/definitions/Testcases' - examples: - "testcase": "" - "blocking": - "criteria": - "dependency": { - "installer": "", - "scenario": "" - } - "description": "" - "enabled": + 200: + description: Show the detailed info of one testcase + schema: + $ref: '#/definitions/Testcases' + examples: + "testcase": "" + "blocking": + "criteria": + "dependency": { + "installer": "", + "scenario": ""} + "description": "" + "enabled": diff --git a/functest/api/swagger/testcase_run.yaml b/functest/api/swagger/testcase_run.yaml index d451457d1..7b254c86b 100644 --- a/functest/api/swagger/testcase_run.yaml +++ b/functest/api/swagger/testcase_run.yaml @@ -1,47 +1,46 @@ +--- Run a test case This api offers the interface to run a test case - -action: run_test_case --- tags: - - Testcases + - Testcases parameters: - - in: body - name: body - description: this is the input json dict - schema: - required: - - action - - args - properties: - action: - type: string - description: this is action for creds - default: run_test_case - args: - schema: - required: - - testcase - properties: - testcase: - type: string - description: this is the test case name - default: - vping_ssh + - in: body + name: body + description: this is the input json dict + schema: + required: + - action + - args + properties: + action: + type: string + description: this is action for creds + default: run_test_case + args: + schema: + required: + - testcase + properties: + testcase: + type: string + description: this is the test case name + default: + vping_ssh definitions: - Testcases: - type: object - properties: - creds_name: - $ref: '#/definitions/Tests' - Tests: - type: dict + Testcases: + type: object + properties: + creds_name: + $ref: '#/definitions/Tests' + Tests: + type: dict responses: - 200: - description: Run a test case - schema: - $ref: '#/definitions/Testcases' - examples: - 'task_id': '94c8ec94-d873-466f-a205-bf592f31ff5b' - 'testcase': 'vping_ssh' + 200: + description: Run a test case + schema: + $ref: '#/definitions/Testcases' + examples: + 'task_id': '94c8ec94-d873-466f-a205-bf592f31ff5b' + 'testcase': 'vping_ssh' diff --git a/functest/api/swagger/testcases.yaml b/functest/api/swagger/testcases.yaml index 56d9d71f4..1dea21524 100644 --- a/functest/api/swagger/testcases.yaml +++ b/functest/api/swagger/testcases.yaml @@ -1,22 +1,23 @@ +--- List all test cases This api offers the interface to list all test cases The testcases list will be returned --- tags: - - Testcases + - Testcases definitions: - Testcases: - type: object - properties: - creds_name: - $ref: '#/definitions/Tests' - Tests: - type: dict + Testcases: + type: object + properties: + creds_name: + $ref: '#/definitions/Tests' + Tests: + type: dict responses: - 200: - description: List all test cases - schema: - $ref: '#/definitions/Testcases' - examples: - "testcases": [] + 200: + description: List all test cases + schema: + $ref: '#/definitions/Testcases' + examples: + "testcases": [] diff --git a/functest/api/swagger/testcases_in_tier.yaml b/functest/api/swagger/testcases_in_tier.yaml index f64508264..af195ceb5 100644 --- a/functest/api/swagger/testcases_in_tier.yaml +++ b/functest/api/swagger/testcases_in_tier.yaml @@ -1,29 +1,30 @@ +--- List all testcases within given tier This api offers the interface to list all testcases within given tier. All testcases within given tier will be returned. --- tags: - - Tiers + - Tiers parameters: - - name: tier_name - description: tier name - in: path - type: string - required: true + - name: tier_name + description: tier name + in: path + type: string + required: true definitions: - Testcases: - type: object - properties: - creds_name: - $ref: '#/definitions/Tests' - Tests: - type: dict + Testcases: + type: object + properties: + creds_name: + $ref: '#/definitions/Tests' + Tests: + type: dict responses: - 200: - description: List all testcases within given tier - schema: - $ref: '#/definitions/Testcases' - examples: - "tier": "" - "testcases": [] + 200: + description: List all testcases within given tier + schema: + $ref: '#/definitions/Testcases' + examples: + "tier": "" + "testcases": [] diff --git a/functest/api/swagger/tier.yaml b/functest/api/swagger/tier.yaml index 8616afb5f..250cddf77 100644 --- a/functest/api/swagger/tier.yaml +++ b/functest/api/swagger/tier.yaml @@ -1,32 +1,33 @@ +--- Show the info of one tier This api offers the interface to show the detailed info of one tier. The info of one tier will be returned. --- tags: - - Tiers + - Tiers parameters: - - name: tier_name - description: tier name - in: path - type: string - required: true + - name: tier_name + description: tier name + in: path + type: string + required: true definitions: - Tiers: - type: object - properties: - creds_name: - $ref: '#/definitions/Name' - Name: - type: string + Tiers: + type: object + properties: + creds_name: + $ref: '#/definitions/Name' + Name: + type: string responses: - 200: - description: Show the detailed info of one tier - schema: - $ref: '#/definitions/Tiers' - examples: - "tier": "" - "ci_loop": "" - "description": "" - "order": - "testcases": [] + 200: + description: Show the detailed info of one tier + schema: + $ref: '#/definitions/Tiers' + examples: + "tier": "" + "ci_loop": "" + "description": "" + "order": + "testcases": [] diff --git a/functest/api/swagger/tiers.yaml b/functest/api/swagger/tiers.yaml index 8a71c3798..d42b2cd98 100644 --- a/functest/api/swagger/tiers.yaml +++ b/functest/api/swagger/tiers.yaml @@ -1,22 +1,23 @@ +--- List all tiers This api offers the interface to list all tiers. The tiers list will be returned. --- tags: - - Tiers + - Tiers definitions: - Tiers: - type: object - properties: - creds_name: - $ref: '#/definitions/Tier' - Tier: - type: dict + Tiers: + type: object + properties: + creds_name: + $ref: '#/definitions/Tier' + Tier: + type: dict responses: - 200: - description: List all tiers - schema: - $ref: '#/definitions/Tiers' - examples: - "tiers": "" + 200: + description: List all tiers + schema: + $ref: '#/definitions/Tiers' + examples: + "tiers": "" @@ -48,11 +48,11 @@ commands = basepython = python2.7 files = docker + functest/api functest/ci functest/opnfv_tests/vnf commands = yamllint {[testenv:yamllint]files} - - yamllint functest/api [testenv:py35] dirs = |