feature: Transaction to Test Suite (#3046)

* feat(backend): Updating transactions to test suites (#3033) * feat(backend): Updating transactions to test suites * feat(backend): Updating transactions to test suites * feat(backend): fixing server * feat(frontend): Transactions to Test Suites * Revert "feat(frontend): Transactions to Test Suites" This reverts commit 392e47c. * feat(backend): update * Feat/transactions to test suites frontend (#3044) * feat(backend): Updating transactions to test suites * feat(backend): Updating transactions to test suites * feat(backend): fixing server * feat(frontend): Transactions to Test Suites * Revert "feat(frontend): Transactions to Test Suites" This reverts commit 392e47c. * feat(backend): update * feat(frontend): Transactions to Test Suites * Fixing test suite id param * Feat/transactions to test suites cli (#3048) * feat(cli): Updating transactions to test suites * feat(cli): Updating transactions to test suites
kubeshop · Aug 11, 2023 · 236abc3 · 236abc3
1 parent 46e04df
commit 236abc3
Show file tree

Hide file tree

Showing 240 changed files with 4,382 additions and 4,214 deletions.
diff --git a/api/openapi.yaml b/api/openapi.yaml
@@ -6,14 +6,14 @@ info:
 servers:
   - url: /api
 paths:
-  # Transactions
-  /transactions:
+  # TestSuites
+  /testsuites:
     get:
       tags:
         - resource-api
-      summary: "Get transactions"
-      description: "get transactions"
-      operationId: getTransactions
+      summary: "Get testsuites"
+      description: "get testsuites"
+      operationId: getTestSuites
       parameters:
         - $ref: "./parameters.yaml#/components/parameters/take"
         - $ref: "./parameters.yaml#/components/parameters/skip"
@@ -26,7 +26,7 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "./transactions.yaml#/components/schemas/TransactionResourceList"
+                $ref: "./testsuites.yaml#/components/schemas/TestSuiteResourceList"
             text/yaml:
               schema:
                 type: object
@@ -36,138 +36,138 @@ paths:
                   items:
                     type: array
                     items:
-                      $ref: "./transactions.yaml#/components/schemas/TransactionResource"
+                      $ref: "./testsuites.yaml#/components/schemas/TestSuiteResource"
         400:
-          description: "invalid query for transactions, some data was sent in incorrect format."
+          description: "invalid query for testsuites, some data was sent in incorrect format."
         500:
-          description: "problem with getting transactions"
+          description: "problem with getting testsuites"
     post:
       tags:
         - resource-api
-      summary: "Create new transaction"
-      description: "Create new transaction"
-      operationId: createTransaction
+      summary: "Create new TestSuite"
+      description: "Create new TestSuite"
+      operationId: createTestSuite
       requestBody:
         content:
           application/json:
             schema:
-              $ref: "./transactions.yaml#/components/schemas/TransactionResource"
+              $ref: "./testsuites.yaml#/components/schemas/TestSuiteResource"
           text/yaml:
             schema:
-              $ref: "./transactions.yaml#/components/schemas/TransactionResource"
+              $ref: "./testsuites.yaml#/components/schemas/TestSuiteResource"
       responses:
         201:
           description: successful operation
           content:
             application/json:
               schema:
-                $ref: "./transactions.yaml#/components/schemas/TransactionResource"
+                $ref: "./testsuites.yaml#/components/schemas/TestSuiteResource"
             text/yaml:
               schema:
-                $ref: "./transactions.yaml#/components/schemas/TransactionResource"
+                $ref: "./testsuites.yaml#/components/schemas/TestSuiteResource"
         400:
-          description: "trying to create a transaction with an already existing ID"
+          description: "trying to create a TestSuite with an already existing ID"
         500:
-          description: "problem creating a transaction"
-  /transactions/{transactionId}:
+          description: "problem creating a TestSuite"
+  /testsuites/{testSuiteId}:
     get:
       tags:
         - resource-api
       parameters:
-        - $ref: "./parameters.yaml#/components/parameters/transactionId"
-      summary: "get transaction"
-      description: "get transaction"
-      operationId: getTransaction
+        - $ref: "./parameters.yaml#/components/parameters/testSuiteId"
+      summary: "get TestSuite"
+      description: "get TestSuite"
+      operationId: getTestSuite
       responses:
         200:
           description: successful operation
           content:
             application/json:
               schema:
-                $ref: "./transactions.yaml#/components/schemas/TransactionResource"
+                $ref: "./testsuites.yaml#/components/schemas/TestSuiteResource"
             text/yaml:
               schema:
-                $ref: "./transactions.yaml#/components/schemas/TransactionResource"
+                $ref: "./testsuites.yaml#/components/schemas/TestSuiteResource"
         404:
-          description: "transaction not found"
+          description: "TestSuite not found"
         500:
-          description: "problem getting an transaction"
+          description: "problem getting an TestSuite"
     put:
       tags:
         - resource-api
       parameters:
-        - $ref: "./parameters.yaml#/components/parameters/transactionId"
-      summary: "update transaction"
-      description: "update transaction action"
-      operationId: updateTransaction
+        - $ref: "./parameters.yaml#/components/parameters/testSuiteId"
+      summary: "update TestSuite"
+      description: "update TestSuite action"
+      operationId: updateTestSuite
       requestBody:
         content:
           application/json:
             schema:
-              $ref: "./transactions.yaml#/components/schemas/TransactionResource"
+              $ref: "./testsuites.yaml#/components/schemas/TestSuiteResource"
           text/yaml:
             schema:
-              $ref: "./transactions.yaml#/components/schemas/TransactionResource"
+              $ref: "./testsuites.yaml#/components/schemas/TestSuiteResource"
       responses:
         200:
           description: successful operation
           content:
             application/json:
               schema:
-                $ref: "./transactions.yaml#/components/schemas/TransactionResource"
+                $ref: "./testsuites.yaml#/components/schemas/TestSuiteResource"
             text/yaml:
               schema:
-                $ref: "./transactions.yaml#/components/schemas/TransactionResource"
+                $ref: "./testsuites.yaml#/components/schemas/TestSuiteResource"
         400:
-          description: "invalid transaction, some data was sent in incorrect format."
+          description: "invalid TestSuite, some data was sent in incorrect format."
         404:
-          description: "transaction not found"
+          description: "TestSuite not found"
         500:
-          description: "problem updating a transaction"
+          description: "problem updating a TestSuite"
     delete:
       tags:
         - resource-api
       parameters:
-        - $ref: "./parameters.yaml#/components/parameters/transactionId"
-      summary: "delete a transaction"
-      description: "delete a transaction"
-      operationId: deleteTransaction
+        - $ref: "./parameters.yaml#/components/parameters/testSuiteId"
+      summary: "delete a TestSuite"
+      description: "delete a TestSuite"
+      operationId: deleteTestSuite
       responses:
         204:
           description: successful operation
         404:
-          description: "transaction not found"
+          description: "TestSuite not found"
         500:
-          description: "problem deleting a transaction"
-  /transactions/{transactionId}/version/{version}:
+          description: "problem deleting a TestSuite"
+  /testsuites/{testSuiteId}/version/{version}:
     get:
       tags:
         - api
       parameters:
-        - $ref: "./parameters.yaml#/components/parameters/transactionId"
+        - $ref: "./parameters.yaml#/components/parameters/testSuiteId"
         - $ref: "./parameters.yaml#/components/parameters/version"
-      summary: "get a transaction specific version"
-      description: "get a transaction specific version"
-      operationId: getTransactionVersion
+      summary: "get a TestSuite specific version"
+      description: "get a TestSuite specific version"
+      operationId: getTestSuiteVersion
       responses:
         200:
           description: successful operation
           content:
             application/json:
               schema:
-                $ref: "./transactions.yaml#/components/schemas/Transaction"
+                $ref: "./testsuites.yaml#/components/schemas/TestSuite"
         500:
           description: "problem with getting a test"
 
-  /transactions/{transactionId}/run:
+  /testsuites/{testSuiteId}/run:
     post:
       tags:
         - api
       parameters:
-        - $ref: "./parameters.yaml#/components/parameters/transactionId"
-      summary: "run transaction"
-      description: "run a particular transaction"
-      operationId: runTransaction
+        - $ref: "./parameters.yaml#/components/parameters/testSuiteId"
+      summary: "run TestSuite"
+      description: "run a particular TestSuite"
+      operationId: runTestSuite
       requestBody:
         content:
           application/json:
@@ -179,17 +179,17 @@ paths:
           content:
             application/json:
               schema:
-                $ref: "./transactions.yaml#/components/schemas/TransactionRun"
+                $ref: "./testsuites.yaml#/components/schemas/TestSuiteRun"
     get:
       tags:
         - api
       parameters:
-        - $ref: "./parameters.yaml#/components/parameters/transactionId"
+        - $ref: "./parameters.yaml#/components/parameters/testSuiteId"
         - $ref: "./parameters.yaml#/components/parameters/take"
         - $ref: "./parameters.yaml#/components/parameters/skip"
-      summary: "Get all runs from a particular transaction"
-      description: "Get all runs from a particular transaction"
-      operationId: getTransactionRuns
+      summary: "Get all runs from a particular TestSuite"
+      description: "Get all runs from a particular TestSuite"
+      operationId: getTestSuiteRuns
       responses:
         200:
           description: OK
@@ -198,41 +198,41 @@ paths:
               schema:
                 type: array
                 items:
-                  $ref: "./transactions.yaml#/components/schemas/TransactionRun"
-  /transactions/{transactionId}/run/{runId}:
+                  $ref: "./testsuites.yaml#/components/schemas/TestSuiteRun"
+  /testsuites/{testSuiteId}/run/{runId}:
     get:
       tags:
         - api
       parameters:
-        - $ref: "./parameters.yaml#/components/parameters/transactionId"
+        - $ref: "./parameters.yaml#/components/parameters/testSuiteId"
         - $ref: "./parameters.yaml#/components/parameters/runId"
-      summary: "Get a specific run from a particular transaction"
-      description: "Get a specific run from a particular transaction"
-      operationId: getTransactionRun
+      summary: "Get a specific run from a particular TestSuite"
+      description: "Get a specific run from a particular TestSuite"
+      operationId: getTestSuiteRun
       responses:
         200:
           description: OK
           content:
             application/json:
               schema:
-                $ref: "./transactions.yaml#/components/schemas/TransactionRun"
+                $ref: "./testsuites.yaml#/components/schemas/TestSuiteRun"
         404:
-          description: transaction run not found
+          description: TestSuite run not found
 
     delete:
       tags:
         - api
       parameters:
-        - $ref: "./parameters.yaml#/components/parameters/transactionId"
+        - $ref: "./parameters.yaml#/components/parameters/testSuiteId"
         - $ref: "./parameters.yaml#/components/parameters/runId"
-      summary: "Delete a specific run from a particular transaction"
-      description: "Delete a specific run from a particular transaction"
-      operationId: deleteTransactionRun
+      summary: "Delete a specific run from a particular TestSuite"
+      description: "Delete a specific run from a particular TestSuite"
+      operationId: deleteTestSuiteRun
       responses:
         204:
           description: OK
         404:
-          description: transaction run not found
+          description: TestSuite run not found
 
   # Tests
   /tests:
@@ -613,7 +613,7 @@ paths:
               schema:
                 $ref: "./expressions.yaml#/components/schemas/ResolveResponseInfo"
 
-  # Resources (Tests, Transactions)
+  # Resources (Tests, TestSuites)
   /resources:
     get:
       tags:
@@ -1066,7 +1066,7 @@ paths:
       tags:
         - resource-api
       summary: "Create a VariableSet"
-      description: "Create a VariableSet that can be used by tests and transactions"
+      description: "Create a VariableSet that can be used by tests and test suites"
       operationId: createVariableSet
       requestBody:
         content:
@@ -1160,7 +1160,7 @@ paths:
         404:
           description: "VariableSet not found"
         500:
-          description: "problem deleting an environment"
+          description: "problem deleting an variable set"
 
   /version:
     get:

diff --git a/api/parameters.yaml b/api/parameters.yaml
@@ -28,12 +28,12 @@ components:
       schema:
         type: integer
 
-    # transaction
-    transactionId:
+    # TestSuite
+    testSuiteId:
       in: path
-      name: transactionId
+      name: testSuiteId
       required: true
-      description: id of the transaction
+      description: id of the TestSuite
       schema:
         type: string
 
@@ -130,7 +130,7 @@ components:
       in: path
       name: variableSetId
       required: true
-      description: "ID of a VariableSet used on Tracetest to inject values into tests and transactions"
+      description: "ID of a VariableSet used on Tracetest to inject values into tests and TestSuites"
       schema:
         type: string
 

diff --git a/api/tests.yaml b/api/tests.yaml
@@ -179,7 +179,7 @@ components:
           description: time in seconds it took for the test to complete, either success or fail. If the test is still running, it will show the time up to the time of the request
         triggerTime:
           type: integer
-          description: time in milliseconds it took for the triggering transaction to complete, either success or fail. If the test is still running, it will show the time up to the time of the request
+          description: time in milliseconds it took for the triggering testSuite to complete, either success or fail. If the test is still running, it will show the time up to the time of the request
         createdAt:
           type: string
           format: date-time
@@ -225,9 +225,9 @@ components:
           type: object
           additionalProperties:
             type: string
-        transactionId:
+        testSuiteId:
           type: string
-        transactionRunId:
+        testSuiteRunId:
           type: string
 
     RunInformation: