update: add mock for listToString yaml custom tag

Author: unsigned6

src/utils/yaml.ts

@@ -198,6 +198,21 @@ export const includeType = new yaml.Type("!include", {
     },
 });
 
+/**
+ * !listToString YAML tag which concatenate each list item into single string value.
+ * See the tests for example usage.
+ */
+export const listToStringType = new yaml.Type("!listToString", {
+    kind: "scalar",
+    construct(data) {
+        try {
+            return readFromYaml(data);
+        } catch (e) {
+            return data;
+        }
+    },
+});
+
 /**
  * !flatten YAML tag for flattening arrays
  * See the tests for example usage.
@@ -248,6 +263,7 @@ export const concatStringType = new yaml.Type("!concatString", {
 
 export const JsYamlTypes = {
     include: includeType,
+    listToString: listToStringType,
     parameter: parameterType,
     combine: combineType,
     esse: esseType,
@@ -261,6 +277,7 @@ export const JsYamlAllSchemas = yaml.DEFAULT_SCHEMA.extend([
     combineType,
     esseType,
     includeType,
+    listToStringType,
     flattenType,
     readFileType,
     concatStringType,

tests/fixtures/yaml_listToString_tag.yml

@@ -0,0 +1,4 @@
+# listToString content from another Yaml file
+case1:
+    here: original content
+    there: !listToString "tests/fixtures/yaml_parameter_ref.yml#/job/workflow"

tests/utils/yaml.listToString.tests.ts

@@ -0,0 +1,22 @@
+// @ts-nocheck
+import { expect } from "chai";
+import fs from "fs";
+import yaml from "js-yaml";
+
+import { includeType } from "../../src/utils/yaml";
+import { YAML_INCLUDE_FILE } from "../enums";
+
+const includeSchema = yaml.DEFAULT_SCHEMA.extend([includeType]);
+
+describe.only("YAML tag: !listToString", () => {
+    const yamlFixture = fs.readFileSync(YAML_INCLUDE_FILE, "utf8");
+
+    it("should correctly concatenate content from list to string", () => {
+        const parsed = yaml.load(yamlFixture, { schema: includeSchema });
+        const expected = {
+            here: "original content",
+            there: ["run", "stop", "pause"],
+        };
+        expect(parsed.case1).to.be.eql(expected);
+    });
+});