Merge pull request #75 from Exabyte-io/feature/SOF-6862

feature/SOF-6862: add listToString yaml custom tag

Author: unsigned6

src/utils/yaml.ts

@@ -1,9 +1,9 @@
 // @ts-nocheck
 // TODO: remove ts-nocheck
-import fs from "fs";
-import yaml from "js-yaml";
-import lodash from "lodash";
-import path from "path";
+import * as fs from "fs";
+import * as yaml from "js-yaml";
+import * as lodash from "lodash";
+import * as path from "path";
 
 import { esseSchema, JSONSchemasInterface } from "../JSONSchemasInterface";
 import { safeMakeArray } from "./array";
@@ -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: "sequence",
+    construct(data) {
+        try {
+            return data.filter((d) => typeof d === "string").join("");
+        } 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/enums.ts

@@ -2,6 +2,7 @@ import * as path from "path";
 
 export const FIXTURES_DIR = path.resolve(__dirname, "./fixtures");
 export const YAML_COMBINE_FILE = path.resolve(FIXTURES_DIR, "yaml_combine_tag.yml");
+export const YAML_LIST_TO_STRING_FILE = path.resolve(FIXTURES_DIR, "yaml_listToString_tag.yml");
 export const YAML_PARAMETER_FILE = path.resolve(FIXTURES_DIR, "yaml_parameter_tag.yml");
 export const YAML_ESSE_FILE = path.resolve(FIXTURES_DIR, "yaml_esse_tag.yml");
 export const YAML_INCLUDE_FILE = path.resolve(FIXTURES_DIR, "yaml_include_tag.yml");

tests/fixtures/yaml_listToString_tag.yml

@@ -0,0 +1,14 @@
+# listToString content from another Yaml file
+case1:
+    here: original content
+    there: !listToString
+        - one # comment 1
+        - two # comment 2
+case2:
+    here: original content
+    there: !listToString
+        - one # comment 1
+        - 1 # non-string ignored
+        - some: 1 # object also skipped
+          other: "object"
+        - two # comment 2

tests/utils/yaml.listToString.tests.ts

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