Merge branch 'main' into chore/SOF-6463

Author: azech-hqs

src/utils/index.js

@@ -30,17 +30,17 @@ import { getSchemaWithDependencies } from "./schemas";
 import { getSearchQuerySelector } from "./selector";
 import {
     convertArabicToRoman,
-    generateName,
     randomAlphanumeric,
     removeCommentsFromSourceCode,
     removeEmptyLinesFromString,
     removeNewLinesAndExtraSpaces,
+    renderTextWithSubstitutes,
     toFixedLocale,
 } from "./str";
 import { mapTree } from "./tree";
 import { containsEncodedComponents } from "./url";
 import { getUUID } from "./uuid";
-import { allYAMLSchemas, combineType, esseType, includeType, parameterType } from "./yaml";
+import { JsYamlAllSchemas, JsYamlTypes } from "./yaml";
 
 export {
     compareEntitiesInOrderedSetForSorting,
@@ -81,12 +81,9 @@ export {
     mapTree,
     getSchemaWithDependencies,
     mergeTerminalNodes,
-    combineType,
-    parameterType,
-    allYAMLSchemas,
-    esseType,
-    includeType,
-    generateName,
+    JsYamlTypes,
+    JsYamlAllSchemas,
+    renderTextWithSubstitutes,
     filterEntityList,
     getFilesInDirectory,
     getDirectories,

src/utils/str.js

@@ -105,7 +105,7 @@ export function convertArabicToRoman(num) {
  *     {user001: "John Doe"}
  * ); // "Hello John Doe!"
  */
-export function generateName(template, data, substitutionMap = {}) {
+export function renderTextWithSubstitutes(template, data, substitutionMap = {}) {
     if (!template) return "";
     // Create a copy of data to avoid modifying the original
     const renderData = lodash.cloneDeep(data);

src/utils/yaml.js

@@ -5,7 +5,7 @@ import path from "path";
 
 import { JSONSchemasInterface } from "../JSONSchemasInterface";
 import { safeMakeArray } from "./array";
-import { generateName } from "./str";
+import { renderTextWithSubstitutes } from "./str";
 
 /**
  * Generate objects with combinations of parameters.
@@ -75,7 +75,7 @@ function readFromYaml(ref) {
     const { filePath, objPath } = splitReference(ref);
     const fileContent = fs.readFileSync(path.resolve(filePath), "utf8");
     // eslint-disable-next-line no-use-before-define
-    const parsedContent = yaml.load(fileContent, { schema: allYAMLSchemas });
+    const parsedContent = yaml.load(fileContent, { schema: JsYamlAllSchemas });
 
     return objPath ? lodash.get(parsedContent, objPath) : parsedContent;
 }
@@ -133,7 +133,12 @@ export const combineType = new yaml.Type("!combine", {
 
         const configs = combinations.map((c) => lodash.merge(c, config));
         configs.forEach(
-            (c) => (c.name = generateName(name?.template || name, c, name?.substitutions)),
+            (c) =>
+                (c.name = renderTextWithSubstitutes(
+                    name?.template || name,
+                    c,
+                    name?.substitutions,
+                )),
         );
         return extraConfigs.length ? configs.concat(extraConfigs.flat()) : configs;
     },
@@ -177,7 +182,14 @@ export const includeType = new yaml.Type("!include", {
     },
 });
 
-export const allYAMLSchemas = yaml.DEFAULT_SCHEMA.extend([
+export const JsYamlTypes = {
+    include: includeType,
+    parameter: parameterType,
+    combine: combineType,
+    esse: esseType,
+};
+
+export const JsYamlAllSchemas = yaml.DEFAULT_SCHEMA.extend([
     parameterType,
     combineType,
     esseType,

tests/utils/str.tests.js

@@ -1,14 +1,14 @@
 import { expect } from "chai";
 
-import { generateName } from "../../src/utils";
+import { renderTextWithSubstitutes } from "../../src/utils";
 
-describe("generateName", () => {
+describe("renderTextWithSubstitutes", () => {
     it("should substitute flat properties", () => {
         const template = "Hello {{ user }}!";
         const data = { user: "user001" };
         const substitutionMap = { user001: "John Doe" };
 
-        const result = generateName(template, data, substitutionMap);
+        const result = renderTextWithSubstitutes(template, data, substitutionMap);
 
         expect(result).to.be.equal("Hello John Doe!");
     });
@@ -18,7 +18,7 @@ describe("generateName", () => {
         const data = { parameters: { user: "user001" } };
         const substitutionMap = { user001: "John Doe" };
 
-        const result = generateName(template, data, substitutionMap);
+        const result = renderTextWithSubstitutes(template, data, substitutionMap);
 
         expect(result).to.be.equal("Hello John Doe!");
     });
@@ -28,7 +28,7 @@ describe("generateName", () => {
         const data = { user: "user001" };
         const substitutionMap = {};
 
-        const result = generateName(template, data, substitutionMap);
+        const result = renderTextWithSubstitutes(template, data, substitutionMap);
 
         expect(result).to.be.equal("Hello user001!");
     });
@@ -38,7 +38,7 @@ describe("generateName", () => {
         const data = { user: "user001" };
         const substitutionMap = {};
 
-        const result = generateName(template, data, substitutionMap);
+        const result = renderTextWithSubstitutes(template, data, substitutionMap);
 
         expect(result).to.be.equal("Hello world!");
     });
@@ -48,7 +48,7 @@ describe("generateName", () => {
         const data = { user: "user001" };
         const substitutionMap = {};
 
-        const result = generateName(template, data, substitutionMap);
+        const result = renderTextWithSubstitutes(template, data, substitutionMap);
 
         expect(result).to.be.equal("");
     });
@@ -58,7 +58,7 @@ describe("generateName", () => {
         const data = { user: null };
         const substitutionMap = {};
 
-        const result = generateName(template, data, substitutionMap);
+        const result = renderTextWithSubstitutes(template, data, substitutionMap);
 
         expect(result).to.be.equal("Hello !");
     });