TestBase: Add new API Packages_RunTest (#4725)

* Add new action API * Add example * Fix style error
Azure · Sep 4, 2021 · e2d02f1 · e2d02f1
1 parent 83164b4
commit e2d02f1
Show file tree

Hide file tree

Showing 6 changed files with 142 additions and 0 deletions.
diff --git a/...estbase/resource-manager/Microsoft.TestBase/stable/2021-09-01/examples/PackageCreate.json b/...estbase/resource-manager/Microsoft.TestBase/stable/2021-09-01/examples/PackageCreate.json
@@ -124,6 +124,7 @@
             {
               "testType": "OutOfBoxTest",
               "validationRunStatus": "Passed",
+              "validationResultId": "/subscriptions/476f61a4-952c-422a-b4db-568a828f35df/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/TestResult-51d71a5f-e012-4192-88f7-bd12e0bac2b0",
               "isActive": true,
               "commands": [
                 {
@@ -225,6 +226,7 @@
             {
               "testType": "OutOfBoxTest",
               "validationRunStatus": "Passed",
+              "validationResultId": "/subscriptions/476f61a4-952c-422a-b4db-568a828f35df/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/TestResult-51d71a5f-e012-4192-88f7-bd12e0bac2b0",
               "isActive": true,
               "commands": [
                 {

diff --git a/...n/testbase/resource-manager/Microsoft.TestBase/stable/2021-09-01/examples/PackageGet.json b/...n/testbase/resource-manager/Microsoft.TestBase/stable/2021-09-01/examples/PackageGet.json
@@ -49,6 +49,7 @@
             {
               "testType": "OutOfBoxTest",
               "validationRunStatus": "Passed",
+              "validationResultId": "/subscriptions/476f61a4-952c-422a-b4db-568a828f35df/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/TestResult-51d71a5f-e012-4192-88f7-bd12e0bac2b0",
               "isActive": true,
               "commands": [
                 {

diff --git a/...stbase/resource-manager/Microsoft.TestBase/stable/2021-09-01/examples/PackageRunTest.json b/...stbase/resource-manager/Microsoft.TestBase/stable/2021-09-01/examples/PackageRunTest.json
@@ -0,0 +1,25 @@
+{
+  "parameters": {
+    "subscriptionId": "476f61a4-952c-422a-b4db-568a828f35df",
+    "resourceGroupName": "contoso-rg1",
+    "testBaseAccountName": "contoso-testBaseAccount1",
+    "packageName": "contoso-package2",
+    "api-version": "2021-09-01",
+    "parameters": {
+      "testType": "OutOfBoxTest",
+      "osUpdateType": "SecurityUpdate",
+      "osName": "Windows 10 21H1",
+      "releaseName": "2021.05 B"
+    }
+  },
+  "responses": {
+    "200": {},
+    "202": {
+      "headers": {
+        "Azure-AsyncOperation": "https://management.azure.com/subscriptions/476f61a4-952c-422a-b4db-568a828f35df/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2021-09-01",
+        "Location": "https://management.azure.com/subscriptions/476f61a4-952c-422a-b4db-568a828f35df/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/operationResults/dGVjaGVkX01hbmFnZVJvbGVfNWRiNGI3Ng==?api-version=2021-09-01"
+      }
+    },
+    "204": {}
+  }
+}
diff --git a/...estbase/resource-manager/Microsoft.TestBase/stable/2021-09-01/examples/PackageUpdate.json b/...estbase/resource-manager/Microsoft.TestBase/stable/2021-09-01/examples/PackageUpdate.json
@@ -122,6 +122,7 @@
             {
               "testType": "OutOfBoxTest",
               "validationRunStatus": "Passed",
+              "validationResultId": "/subscriptions/476f61a4-952c-422a-b4db-568a828f35df/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/TestResult-51d71a5f-e012-4192-88f7-bd12e0bac2b0",
               "isActive": true,
               "commands": [
                 {

diff --git a/...testbase/resource-manager/Microsoft.TestBase/stable/2021-09-01/examples/PackagesList.json b/...testbase/resource-manager/Microsoft.TestBase/stable/2021-09-01/examples/PackagesList.json
@@ -59,6 +59,7 @@
                 {
                   "testType": "OutOfBoxTest",
                   "validationRunStatus": "Passed",
+                  "validationResultId": "/subscriptions/476f61a4-952c-422a-b4db-568a828f35df/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package1/testResults/TestResult-51d71a5f-e012-4192-88f7-bd12e0bac2b0",
                   "isActive": true,
                   "commands": [
                     {
@@ -114,6 +115,7 @@
                 {
                   "testType": "FunctionalTest",
                   "validationRunStatus": "Passed",
+                  "validationResultId": "/subscriptions/476f61a4-952c-422a-b4db-568a828f35df/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package1/testResults/TestResult-51d71a5f-e012-4192-88f7-bd12e0bac2b0",
                   "isActive": true,
                   "commands": [
                     {
@@ -186,6 +188,7 @@
                 {
                   "testType": "OutOfBoxTest",
                   "validationRunStatus": "Passed",
+                  "validationResultId": "/subscriptions/476f61a4-952c-422a-b4db-568a828f35df/resourceGroups/contoso-rg1/providers/Microsoft.TestBase/testBaseAccounts/contoso-testBaseAccount1/packages/contoso-package2/testResults/TestResult-51d71a5f-e012-4192-88f7-bd12e0bac2b0",
                   "isActive": true,
                   "commands": [
                     {

diff --git a/specification/testbase/resource-manager/Microsoft.TestBase/stable/2021-09-01/testbase.json b/specification/testbase/resource-manager/Microsoft.TestBase/stable/2021-09-01/testbase.json
@@ -1309,6 +1309,72 @@
         }
       }
     },
+    "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/packages/{packageName}/runTest": {
+      "post": {
+        "tags": [
+          "Test Base Package"
+        ],
+        "operationId": "Packages_RunTest",
+        "description": "Trigger a test run on the package.",
+        "parameters": [
+          {
+            "name": "parameters",
+            "in": "body",
+            "schema": {
+              "$ref": "#/definitions/PackageRunTestParameters"
+            },
+            "description": "The parameters supplied to the Test Base Package to start a Test Run."
+          },
+          {
+            "$ref": "#/parameters/SubscriptionIdParameter"
+          },
+          {
+            "$ref": "#/parameters/ResourceGroupParameter"
+          },
+          {
+            "$ref": "#/parameters/TestBaseAccountNameParameter"
+          },
+          {
+            "$ref": "#/parameters/PackageNameParameter"
+          },
+          {
+            "$ref": "#/parameters/ApiVersionParameter"
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "The test is triggered successfully."
+          },
+          "202": {
+            "description": "The request to trigger a test was accepted. Follow the Location header to poll for final outcome.",
+            "headers": {
+              "Azure-AsyncOperation": {
+                "description": "URL to query for status of the operation.",
+                "type": "string"
+              },
+              "Location": {
+                "description": "URL to query for status of the operation.",
+                "type": "string"
+              }
+            }
+          },
+          "204": {
+            "description": "The test is triggered successfully."
+          },
+          "default": {
+            "description": "Error response describing why the operation failed.",
+            "schema": {
+              "$ref": "#/definitions/ErrorResponse"
+            }
+          }
+        },
+        "x-ms-examples": {
+          "PackageRunTest": {
+            "$ref": "./examples/PackageRunTest.json"
+          }
+        }
+      }
+    },
     "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TestBase/testBaseAccounts/{testBaseAccountName}/testSummaries": {
       "get": {
         "tags": [
@@ -3036,6 +3102,45 @@
       "type": "object",
       "description": "Description of a Check Name availability response properties."
     },
+    "PackageRunTestParameters": {
+      "description": "The parameters supplied to the Test Base Package to start a Test Run.",
+      "type": "object",
+      "properties": {
+        "testType": {
+          "$ref": "#/definitions/TestType",
+          "description": "The type of the test."
+        },
+        "osUpdateType": {
+          "type": "string",
+          "description": "Specifies the OS update type to test against.",
+          "default": "SecurityUpdate",
+          "enum": [
+            "SecurityUpdate",
+            "FeatureUpdate"
+          ],
+          "x-ms-enum": {
+            "name": "osUpdateType",
+            "modelAsString": true
+          }
+        },
+        "osName": {
+          "type": "string",
+          "description": "The operating system name. e.g. Windows 10 1809."
+        },
+        "releaseName": {
+          "type": "string",
+          "description": "The name of the tested release (OS update)."
+        },
+        "flightingRing": {
+          "type": "string",
+          "description": "The flighting ring, only for release of feature updates."
+        }
+      },
+      "required": [
+        "testType",
+        "osName"
+      ]
+    },
     "PackageListResult": {
       "description": "A list of Test Base Packages.",
       "type": "object",
@@ -3249,6 +3354,11 @@
             "modelAsString": true
           }
         },
+        "validationResultId": {
+          "readOnly": true,
+          "type": "string",
+          "description": "Resource identifier of the validation test result."
+        },
         "isActive": {
           "type": "boolean",
           "description": "Indicates if this test is active.It doesn't schedule test for not active Test."