Add swagger support for Rest API

JIRA: FUNCTEST-854

Change-Id: Ic010604d3ba0cc46092cf2a1ae8bb41afa73c920
Signed-off-by: Linda Wang <wangwulin@huawei.com>

12 files changed, 416 insertions, 0 deletions

diff --git a/functest/api/swagger/creds.yaml b/functest/api/swagger/creds.yaml
new file mode 100644
index 00000000..da3b2d90
--- /dev/null
+++ b/functest/api/swagger/creds.yaml
@@ -0,0 +1,35 @@
+Show credentials
+
+This api offers the interface to show credentials.
+The credentials dict will be returned.
+---
+tags:
+  - Creds
+definitions:
+  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"
diff --git a/functest/api/swagger/creds_action.yaml b/functest/api/swagger/creds_action.yaml
new file mode 100644
index 00000000..d67d082d
--- /dev/null
+++ b/functest/api/swagger/creds_action.yaml
@@ -0,0 +1,57 @@
+Update openrc
+
+This api offers the interface to Update openstack.creds.
+
+action: update_openrc
+---
+tags:
+  - 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"
+definitions:
+  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'
diff --git a/functest/api/swagger/envs.yaml b/functest/api/swagger/envs.yaml
new file mode 100644
index 00000000..e723deb3
--- /dev/null
+++ b/functest/api/swagger/envs.yaml
@@ -0,0 +1,26 @@
+Show environment
+
+This api offers the interface to show environment.
+The environment dict will be returned.
+---
+tags:
+  - Envs
+definitions:
+  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"
diff --git a/functest/api/swagger/envs_action.yaml b/functest/api/swagger/envs_action.yaml
new file mode 100644
index 00000000..1add066e
--- /dev/null
+++ b/functest/api/swagger/envs_action.yaml
@@ -0,0 +1,37 @@
+Prepare environment or Update hosts info
+
+This api offers the interface to prepare environment or update hosts info.
+
+action: prepare
+action: update_hosts
+---
+tags:
+  - Envs
+parameters:
+  - in: body
+    name: body
+    description: this is the input json dict
+    schema:
+      required:
+        - action
+      properties:
+        action:
+          type: string
+          description: this is action for envs
+          default: prepare
+definitions:
+  Environment:
+    type: object
+    properties:
+      creds_name:
+          $ref: '#/definitions/Name'
+  Name:
+    type: dict
+responses:
+  200:
+    description: Prepare environment
+    schema:
+      $ref: '#/definitions/Environment'
+    examples:
+      'status': 0
+      'result': 'Prapare env successfully'
diff --git a/functest/api/swagger/task.yaml b/functest/api/swagger/task.yaml
new file mode 100644
index 00000000..abf68a0d
--- /dev/null
+++ b/functest/api/swagger/task.yaml
@@ -0,0 +1,38 @@
+Get the result of the specified task
+
+This api offers the interface to get the result of the specified task.
+
+---
+tags:
+  - Tasks
+parameters:
+  - 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
+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
+
diff --git a/functest/api/swagger/task_log.yaml b/functest/api/swagger/task_log.yaml
new file mode 100644
index 00000000..adaaaf40
--- /dev/null
+++ b/functest/api/swagger/task_log.yaml
@@ -0,0 +1,35 @@
+Get the log of the specified task
+
+This api offers the interface to get the log of the specified task.
+
+---
+tags:
+  - Tasks
+parameters:
+  - 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
+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
+
diff --git a/functest/api/swagger/testcase.yaml b/functest/api/swagger/testcase.yaml
new file mode 100644
index 00000000..70ee1af1
--- /dev/null
+++ b/functest/api/swagger/testcase.yaml
@@ -0,0 +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
+parameters:
+  - 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
+responses:
+  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
new file mode 100644
index 00000000..d451457d
--- /dev/null
+++ b/functest/api/swagger/testcase_run.yaml
@@ -0,0 +1,47 @@
+Run a test case
+
+This api offers the interface to run a test case
+
+action: run_test_case
+---
+tags:
+  - 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
+definitions:
+  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'
diff --git a/functest/api/swagger/testcases.yaml b/functest/api/swagger/testcases.yaml
new file mode 100644
index 00000000..56d9d71f
--- /dev/null
+++ b/functest/api/swagger/testcases.yaml
@@ -0,0 +1,22 @@
+List all test cases
+
+This api offers the interface to list all test cases
+The testcases list will be returned
+---
+tags:
+  - Testcases
+definitions:
+  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": []
diff --git a/functest/api/swagger/testcases_in_tier.yaml b/functest/api/swagger/testcases_in_tier.yaml
new file mode 100644
index 00000000..f6450826
--- /dev/null
+++ b/functest/api/swagger/testcases_in_tier.yaml
@@ -0,0 +1,29 @@
+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
+parameters:
+  - 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
+responses:
+  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
new file mode 100644
index 00000000..8616afb5
--- /dev/null
+++ b/functest/api/swagger/tier.yaml
@@ -0,0 +1,32 @@
+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
+parameters:
+  - 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
+responses:
+  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
new file mode 100644
index 00000000..8a71c379
--- /dev/null
+++ b/functest/api/swagger/tiers.yaml
@@ -0,0 +1,22 @@
+List all tiers
+
+This api offers the interface to list all tiers.
+The tiers list will be returned.
+---
+tags:
+  - Tiers
+definitions:
+  Tiers:
+    type: object
+    properties:
+      creds_name:
+          $ref: '#/definitions/Tier'
+  Tier:
+    type: dict
+responses:
+  200:
+      description: List all tiers
+      schema:
+          $ref: '#/definitions/Tiers'
+      examples:
+          "tiers": ""