Merge pull request #1014 from ricardozanini/issue-983

Fix #983 - Add CTK workflow features to CI/CD validation

Author: cdavernas

.ci/validation/package-lock.json

@@ -0,0 +1,66 @@
+/*
+ * Copyright 2023-Present The Serverless Workflow Specification Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { SWSchemaValidator } from "./index";
+import fs from "node:fs";
+import path from "node:path";
+
+SWSchemaValidator.prepareSchemas();
+
+const ctkDir = path.join(__dirname, "..", "..", "..", "ctk", "features");
+
+function extractYamlBlocks(content: string): string[] {
+    const yamlBlockRegex = /"""yaml\s([\s\S]*?)\s"""/gm;  // Match YAML blocks
+    let match;
+    const yamlBlocks: string[] = [];
+
+    while ((match = yamlBlockRegex.exec(content)) !== null) {
+        yamlBlocks.push(match[1]);
+    }
+
+    return yamlBlocks;
+}
+
+const workflows = fs.readdirSync(ctkDir)
+    .filter((file) => file.endsWith(".feature"))
+    .flatMap((file) => {
+        const filePath = path.join(ctkDir, file);
+        const fileContent = fs.readFileSync(filePath, SWSchemaValidator.defaultEncoding);
+
+        const yamlBlocks = extractYamlBlocks(fileContent);
+
+        return yamlBlocks
+            .map((yamlText) => SWSchemaValidator.yamlToJSON(yamlText))
+            .filter((workflow) => typeof workflow === "object")
+            .filter((workflow) => "document" in workflow)
+            .filter((workflow) => "dsl" in workflow.document)
+            .map((workflow) => ({ workflow, file }));
+    });
+
+describe(`Validate workflows from .feature files`, () => {
+    test.each(workflows)('$workflow.document.name (from $file)', ({ workflow, file }) => {
+        const results = SWSchemaValidator.validateSchema(workflow);
+
+        if (results?.errors) {
+            console.warn(
+                `Schema validation failed for workflow "${workflow.document.name}" in file "${file}" with:`,
+                JSON.stringify(results.errors, null, 2)
+            );
+        }
+
+        expect(results?.valid).toBeTruthy();
+    });
+});

.ci/validation/src/ctk.test.ts

@@ -11,6 +11,7 @@ Feature: Composite Task
       dsl: '1.0.0'
       namespace: default
       name: fork
+      version: '1.0.0'
     do:
       - branchWithCompete:
           fork:

ctk/features/branch.feature

@@ -14,6 +14,7 @@ Feature: Call Task
       dsl: '1.0.0'
       namespace: default
       name: http-call-with-content-output
+      version: '1.0.0'
     do:
       - findPet:
           call: http
@@ -42,6 +43,7 @@ Feature: Call Task
       dsl: '1.0.0'
       namespace: default
       name: http-call-with-response-output
+      version: '1.0.0'
     do:
       - getPet:
           call: http
@@ -69,6 +71,7 @@ Feature: Call Task
       dsl: '1.0.0'
       namespace: default
       name: http-call-with-basic-auth
+      version: '1.0.0'
     do:
       - login:
           call: http
@@ -98,6 +101,7 @@ Feature: Call Task
       dsl: '1.0.0'
       namespace: default
       name: openapi-call-with-content-output
+      version: '1.0.0'
     do:
       - findPet:
           call: openapi
@@ -126,6 +130,7 @@ Feature: Call Task
       dsl: '1.0.0'
       namespace: default
       name: openapi-call-with-response-output
+      version: '1.0.0'
     do:
       - getPet:
           call: openapi

ctk/features/call.feature

@@ -11,6 +11,7 @@ Feature: Data Flow
       dsl: '1.0.0'
       namespace: default
       name: output-filtering
+      version: '1.0.0'
     do:
       - setPlayerId:
           input:
@@ -38,6 +39,7 @@ Feature: Data Flow
       dsl: '1.0.0'
       namespace: default
       name: output-filtering
+      version: '1.0.0'
     do:
       - getPet:
           call: http
@@ -66,6 +68,7 @@ Feature: Data Flow
       dsl: '1.0.0'
       namespace: default
       name: non-object-output
+      version: '1.0.0'
     do:
       - getPetById1:
           call: http

ctk/features/data-flow.feature

@@ -11,6 +11,7 @@ Feature: Composite Task
       dsl: '1.0.0'
       namespace: default
       name: do
+      version: '1.0.0'
     do:
       - compositeExample:
           do:

ctk/features/do.feature

@@ -11,6 +11,7 @@ Feature: Emit Task
       dsl: '1.0.0'
       namespace: default
       name: emit
+      version: '1.0.0'
     do:
       - emitEvent:
           emit:

ctk/features/emit.feature

@@ -10,6 +10,7 @@ Feature: Flow Directive
       dsl: '1.0.0'
       namespace: default
       name: implicit-sequence
+      version: '1.0.0'
     do:
       - setRed:
           set:
@@ -37,6 +38,7 @@ Feature: Flow Directive
       dsl: '1.0.0'
       namespace: default
       name: explicit-sequence
+      version: '1.0.0'
     do:
       - setRed:
           set:

ctk/features/flow.feature

@@ -13,6 +13,7 @@ Feature: For Task
       dsl: '1.0.0'
       namespace: default
       name: for
+      version: '1.0.0'
     do:
       - loopColors:
           for:

ctk/features/for.feature

@@ -10,6 +10,7 @@ Feature: Raise Task
       dsl: '1.0.0'
       namespace: default
       name: raise-custom-error
+      version: '1.0.0'
     do:
       - raiseError:
           raise: