Merge pull request #2183 from keboola/petr-hosek-PSGO-898_run_test

Don't test deprecated templates
keboola · Jan 6, 2025 · dee70fd · dee70fd
2 parents dd9c9b0 + 9da82fb
commit dee70fd
Show file tree

Hide file tree

Showing 33 changed files with 322 additions and 8 deletions.
diff --git a/internal/pkg/service/cli/cmd/template/test/run/cmd.go b/internal/pkg/service/cli/cmd/template/test/run/cmd.go
@@ -36,14 +36,6 @@ func Command(p dependencies.Provider) *cobra.Command {
 				return err
 			}
 
-			// Options
-			options := testOp.Options{
-				LocalOnly:  f.LocalOnly,
-				RemoteOnly: f.RemoteOnly,
-				TestName:   f.TestName,
-				Verbose:    f.Verbose,
-			}
-
 			// Get dependencies
 			d, err := p.LocalCommandScope(cmd.Context(), f.StorageAPIHost, dependencies.WithDefaultStorageAPIHost())
 			if err != nil {
@@ -71,6 +63,10 @@ func Command(p dependencies.Provider) *cobra.Command {
 				templates = append(templates, tmpl)
 			} else {
 				for _, t := range repo.Templates() {
+					// Don't test deprecated templates
+					if t.Deprecated {
+						continue
+					}
 					v, err := t.DefaultVersionOrErr()
 					if err != nil {
 						return errors.Errorf(`loading default version for template "%s" failed: %w`, t.ID, err)
@@ -83,6 +79,14 @@ func Command(p dependencies.Provider) *cobra.Command {
 				}
 			}
 
+			// Options
+			options := testOp.Options{
+				LocalOnly:  f.LocalOnly,
+				RemoteOnly: f.RemoteOnly,
+				TestName:   f.TestName,
+				Verbose:    f.Verbose,
+			}
+
 			// Test templates
 			errs := errors.NewMultiError()
 			for _, tmpl := range templates {

diff --git a/test/cli/template-test-run/local-all/in/.keboola/repository.json b/test/cli/template-test-run/local-all/in/.keboola/repository.json
@@ -38,6 +38,22 @@
           "path": "v2"
         }
       ]
+    },
+    {
+      "id": "template-3",
+      "name": "My Template 3",
+      "deprecated": true,
+      "description": "Full workflow to ...",
+      "versions": [
+        {
+          "version": "2.0.0",
+          "description": "notes",
+          "stable": false,
+          "components": [
+            "keboola.ex-facebook"
+          ]
+        }
+      ]
     }
   ]
 }
diff --git a/test/cli/template-test-run/local-all/in/template-3/v2/src/README.md b/test/cli/template-test-run/local-all/in/template-3/v2/src/README.md
@@ -0,0 +1,4 @@
+### My Template
+
+Full workflow to ...
+
diff --git a/test/cli/template-test-run/local-all/in/template-3/v2/src/description.md b/test/cli/template-test-run/local-all/in/template-3/v2/src/description.md
@@ -0,0 +1,10 @@
+# My Template
+
+## Extended description 
+- of a template for demo purposes 
+- from the examples in the API documentation
+
+## Some Example
+```
+    with.a.code()
+```
diff --git a/...late-test-run/local-all/in/template-3/v2/src/extractor/ex-generic-v2/empty/config.jsonnet b/...late-test-run/local-all/in/template-3/v2/src/extractor/ex-generic-v2/empty/config.jsonnet
@@ -0,0 +1,7 @@
+{
+  parameters: {
+    api: {
+      baseUrl: Input("ex-generic-v2-api-base-url"),
+    },
+  },
+}
diff --git a/...run/local-all/in/template-3/v2/src/extractor/ex-generic-v2/empty/description.md b/...run/local-all/in/template-3/v2/src/extractor/ex-generic-v2/empty/description.md
@@ -0,0 +1 @@
+test fixture
diff --git a/...mplate-test-run/local-all/in/template-3/v2/src/extractor/ex-generic-v2/empty/meta.jsonnet b/...mplate-test-run/local-all/in/template-3/v2/src/extractor/ex-generic-v2/empty/meta.jsonnet
@@ -0,0 +1,3 @@
+{
+  name: "empty",
+}
diff --git a/test/cli/template-test-run/local-all/in/template-3/v2/src/inputs.jsonnet b/test/cli/template-test-run/local-all/in/template-3/v2/src/inputs.jsonnet
@@ -0,0 +1,25 @@
+{
+  stepsGroups: [
+    {
+      description: "Default Group",
+      required: "all",
+      steps: [
+        {
+          icon: "common:settings",
+          name: "Default Step",
+          description: "Default Step",
+          inputs: [
+            {
+              id: "ex-generic-v2-api-base-url",
+              name: "Api BaseUrl",
+              description: "a",
+              type: "string",
+              kind: "input",
+              default: "https://jsonplaceholder.typicode.com",
+            },
+          ],
+        },
+      ],
+    },
+  ],
+}
diff --git a/test/cli/template-test-run/local-all/in/template-3/v2/src/manifest.jsonnet b/test/cli/template-test-run/local-all/in/template-3/v2/src/manifest.jsonnet
@@ -0,0 +1,10 @@
+{
+  configurations: [
+    {
+      componentId: "ex-generic-v2",
+      id: ConfigId("empty"),
+      path: "extractor/ex-generic-v2/empty",
+      rows: [],
+    },
+  ],
+}
diff --git a/...emplate-test-run/local-all/in/template-3/v2/tests/one/expected-out/.keboola/manifest.json b/...emplate-test-run/local-all/in/template-3/v2/tests/one/expected-out/.keboola/manifest.json
@@ -0,0 +1,59 @@
+{
+  "version": 2,
+  "project": {
+    "id": __PROJECT_ID__,
+    "apiHost": "__STORAGE_API_HOST__"
+  },
+  "allowTargetEnv": false,
+  "sortBy": "id",
+  "naming": {
+    "branch": "{branch_name}",
+    "config": "{component_type}/{component_id}/{config_name}",
+    "configRow": "rows/{config_row_name}",
+    "schedulerConfig": "schedules/{config_name}",
+    "sharedCodeConfig": "_shared/{target_component_id}",
+    "sharedCodeConfigRow": "codes/{config_row_name}",
+    "variablesConfig": "variables",
+    "variablesValuesRow": "values/{config_row_name}",
+    "dataAppConfig": "app/{component_id}/{config_name}"
+  },
+  "allowedBranches": [
+    "*"
+  ],
+  "ignoredComponents": [],
+  "templates": {
+    "repositories": [
+      {
+        "type": "dir",
+        "name": "keboola",
+        "url": "../repository",
+        "ref": "main"
+      }
+    ]
+  },
+  "branches": [
+    {
+      "id": 1,
+      "path": "main",
+      "metadata": {
+        "KBC.KAC.templates.instances": "[{\"instanceId\":\"%s\",\"instanceName\":\"test\",\"templateId\":\"template-2\",\"repositoryName\":\"keboola\",\"version\":\"2.0.0\",\"created\":{\"date\":\"%s\",\"tokenId\":\"%s\"},\"updated\":{\"date\":\"%s\",\"tokenId\":\"%s\"}}]"
+      }
+    }
+  ],
+  "configurations": [
+    {
+      "branchId": 1,
+      "componentId": "ex-generic-v2",
+      "id": "%s",
+      "path": "extractor/ex-generic-v2/empty",
+      "metadata": {
+        "KBC.KAC.templates.configId": "{\"idInTemplate\":\"empty\"}",
+        "KBC.KAC.templates.configInputs": "[{\"input\":\"ex-generic-v2-api-base-url\",\"key\":\"parameters.api.baseUrl\"}]",
+        "KBC.KAC.templates.instanceId": "%s",
+        "KBC.KAC.templates.repository": "keboola",
+        "KBC.KAC.templates.templateId": "template-2"
+      },
+      "rows": []
+    }
+  ]
+}
diff --git a/...plate-test-run/local-all/in/template-3/v2/tests/one/expected-out/description.md b/...plate-test-run/local-all/in/template-3/v2/tests/one/expected-out/description.md
@@ -0,0 +1 @@
+
diff --git a/...-test-run/local-all/in/template-3/v2/tests/one/expected-out/main/description.md b/...-test-run/local-all/in/template-3/v2/tests/one/expected-out/main/description.md
diff --git a/...ll/in/template-3/v2/tests/one/expected-out/main/extractor/ex-generic-v2/empty/config.json b/...ll/in/template-3/v2/tests/one/expected-out/main/extractor/ex-generic-v2/empty/config.json
@@ -0,0 +1,7 @@
+{
+  "parameters": {
+    "api": {
+      "baseUrl": "base/url"
+    }
+  }
+}
diff --git a/...e-3/v2/tests/one/expected-out/main/extractor/ex-generic-v2/empty/description.md b/...e-3/v2/tests/one/expected-out/main/extractor/ex-generic-v2/empty/description.md
@@ -0,0 +1 @@
+test fixture
diff --git a/...-all/in/template-3/v2/tests/one/expected-out/main/extractor/ex-generic-v2/empty/meta.json b/...-all/in/template-3/v2/tests/one/expected-out/main/extractor/ex-generic-v2/empty/meta.json
@@ -0,0 +1,4 @@
+{
+  "name": "empty",
+  "isDisabled": false
+}
diff --git a/test/cli/template-test-run/local-all/in/template-3/v2/tests/one/expected-out/main/meta.json b/test/cli/template-test-run/local-all/in/template-3/v2/tests/one/expected-out/main/meta.json
@@ -0,0 +1,4 @@
+{
+  "name": "Main",
+  "isDefault": true
+}
diff --git a/test/cli/template-test-run/local-all/in/template-3/v2/tests/one/inputs.json b/test/cli/template-test-run/local-all/in/template-3/v2/tests/one/inputs.json
@@ -0,0 +1,3 @@
+{
+  "ex-generic-v2-api-base-url": "base/url"
+}
diff --git a/test/cli/template-test-run/local-all/out/.keboola/repository.json b/test/cli/template-test-run/local-all/out/.keboola/repository.json
@@ -38,6 +38,22 @@
           "path": "v2"
         }
       ]
+    },
+    {
+      "id": "template-3",
+      "name": "My Template 3",
+      "deprecated": true,
+      "description": "Full workflow to ...",
+      "versions": [
+        {
+          "version": "2.0.0",
+          "description": "notes",
+          "stable": false,
+          "components": [
+            "keboola.ex-facebook"
+          ]
+        }
+      ]
     }
   ]
 }
diff --git a/test/cli/template-test-run/local-all/out/template-3/v2/src/README.md b/test/cli/template-test-run/local-all/out/template-3/v2/src/README.md
@@ -0,0 +1,4 @@
+### My Template
+
+Full workflow to ...
+
diff --git a/test/cli/template-test-run/local-all/out/template-3/v2/src/description.md b/test/cli/template-test-run/local-all/out/template-3/v2/src/description.md
@@ -0,0 +1,10 @@
+# My Template
+
+## Extended description 
+- of a template for demo purposes 
+- from the examples in the API documentation
+
+## Some Example
+```
+    with.a.code()
+```
diff --git a/...ate-test-run/local-all/out/template-3/v2/src/extractor/ex-generic-v2/empty/config.jsonnet b/...ate-test-run/local-all/out/template-3/v2/src/extractor/ex-generic-v2/empty/config.jsonnet
@@ -0,0 +1,7 @@
+{
+  parameters: {
+    api: {
+      baseUrl: Input("ex-generic-v2-api-base-url"),
+    },
+  },
+}
diff --git a/...un/local-all/out/template-3/v2/src/extractor/ex-generic-v2/empty/description.md b/...un/local-all/out/template-3/v2/src/extractor/ex-generic-v2/empty/description.md
@@ -0,0 +1 @@
+test fixture
diff --git a/...plate-test-run/local-all/out/template-3/v2/src/extractor/ex-generic-v2/empty/meta.jsonnet b/...plate-test-run/local-all/out/template-3/v2/src/extractor/ex-generic-v2/empty/meta.jsonnet
@@ -0,0 +1,3 @@
+{
+  name: "empty",
+}
diff --git a/test/cli/template-test-run/local-all/out/template-3/v2/src/inputs.jsonnet b/test/cli/template-test-run/local-all/out/template-3/v2/src/inputs.jsonnet
@@ -0,0 +1,25 @@
+{
+  stepsGroups: [
+    {
+      description: "Default Group",
+      required: "all",
+      steps: [
+        {
+          icon: "common:settings",
+          name: "Default Step",
+          description: "Default Step",
+          inputs: [
+            {
+              id: "ex-generic-v2-api-base-url",
+              name: "Api BaseUrl",
+              description: "a",
+              type: "string",
+              kind: "input",
+              default: "https://jsonplaceholder.typicode.com",
+            },
+          ],
+        },
+      ],
+    },
+  ],
+}
diff --git a/test/cli/template-test-run/local-all/out/template-3/v2/src/manifest.jsonnet b/test/cli/template-test-run/local-all/out/template-3/v2/src/manifest.jsonnet
@@ -0,0 +1,10 @@
+{
+  configurations: [
+    {
+      componentId: "ex-generic-v2",
+      id: ConfigId("empty"),
+      path: "extractor/ex-generic-v2/empty",
+      rows: [],
+    },
+  ],
+}
diff --git a/...mplate-test-run/local-all/out/template-3/v2/tests/one/expected-out/.keboola/manifest.json b/...mplate-test-run/local-all/out/template-3/v2/tests/one/expected-out/.keboola/manifest.json
@@ -0,0 +1,59 @@
+{
+  "version": 2,
+  "project": {
+    "id": __PROJECT_ID__,
+    "apiHost": "__STORAGE_API_HOST__"
+  },
+  "allowTargetEnv": false,
+  "sortBy": "id",
+  "naming": {
+    "branch": "{branch_name}",
+    "config": "{component_type}/{component_id}/{config_name}",
+    "configRow": "rows/{config_row_name}",
+    "schedulerConfig": "schedules/{config_name}",
+    "sharedCodeConfig": "_shared/{target_component_id}",
+    "sharedCodeConfigRow": "codes/{config_row_name}",
+    "variablesConfig": "variables",
+    "variablesValuesRow": "values/{config_row_name}",
+    "dataAppConfig": "app/{component_id}/{config_name}"
+  },
+  "allowedBranches": [
+    "*"
+  ],
+  "ignoredComponents": [],
+  "templates": {
+    "repositories": [
+      {
+        "type": "dir",
+        "name": "keboola",
+        "url": "../repository",
+        "ref": "main"
+      }
+    ]
+  },
+  "branches": [
+    {
+      "id": 1,
+      "path": "main",
+      "metadata": {
+        "KBC.KAC.templates.instances": "[{\"instanceId\":\"%s\",\"instanceName\":\"test\",\"templateId\":\"template-2\",\"repositoryName\":\"keboola\",\"version\":\"2.0.0\",\"created\":{\"date\":\"%s\",\"tokenId\":\"%s\"},\"updated\":{\"date\":\"%s\",\"tokenId\":\"%s\"}}]"
+      }
+    }
+  ],
+  "configurations": [
+    {
+      "branchId": 1,
+      "componentId": "ex-generic-v2",
+      "id": "%s",
+      "path": "extractor/ex-generic-v2/empty",
+      "metadata": {
+        "KBC.KAC.templates.configId": "{\"idInTemplate\":\"empty\"}",
+        "KBC.KAC.templates.configInputs": "[{\"input\":\"ex-generic-v2-api-base-url\",\"key\":\"parameters.api.baseUrl\"}]",
+        "KBC.KAC.templates.instanceId": "%s",
+        "KBC.KAC.templates.repository": "keboola",
+        "KBC.KAC.templates.templateId": "template-2"
+      },
+      "rows": []
+    }
+  ]
+}
diff --git a/...late-test-run/local-all/out/template-3/v2/tests/one/expected-out/description.md b/...late-test-run/local-all/out/template-3/v2/tests/one/expected-out/description.md
@@ -0,0 +1 @@
+
diff --git a/...test-run/local-all/out/template-3/v2/tests/one/expected-out/main/description.md b/...test-run/local-all/out/template-3/v2/tests/one/expected-out/main/description.md
diff --git a/...l/out/template-3/v2/tests/one/expected-out/main/extractor/ex-generic-v2/empty/config.json b/...l/out/template-3/v2/tests/one/expected-out/main/extractor/ex-generic-v2/empty/config.json
@@ -0,0 +1,7 @@
+{
+  "parameters": {
+    "api": {
+      "baseUrl": "base/url"
+    }
+  }
+}
diff --git a/...e-3/v2/tests/one/expected-out/main/extractor/ex-generic-v2/empty/description.md b/...e-3/v2/tests/one/expected-out/main/extractor/ex-generic-v2/empty/description.md
@@ -0,0 +1 @@
+test fixture
diff --git a/...all/out/template-3/v2/tests/one/expected-out/main/extractor/ex-generic-v2/empty/meta.json b/...all/out/template-3/v2/tests/one/expected-out/main/extractor/ex-generic-v2/empty/meta.json
@@ -0,0 +1,4 @@
+{
+  "name": "empty",
+  "isDisabled": false
+}
diff --git a/test/cli/template-test-run/local-all/out/template-3/v2/tests/one/expected-out/main/meta.json b/test/cli/template-test-run/local-all/out/template-3/v2/tests/one/expected-out/main/meta.json
@@ -0,0 +1,4 @@
+{
+  "name": "Main",
+  "isDefault": true
+}
diff --git a/test/cli/template-test-run/local-all/out/template-3/v2/tests/one/inputs.json b/test/cli/template-test-run/local-all/out/template-3/v2/tests/one/inputs.json
@@ -0,0 +1,3 @@
+{
+  "ex-generic-v2-api-base-url": "base/url"
+}