@contrail/cli 3.4.1 → 3.4.2

package/dist/helpers/projects/helpers.d.ts

@@ -1,3 +1,3 @@
-import { ProjectConfiguration } from '../../interfaces';
-export declare function getProjectFile(fileName: any): ProjectConfiguration;
-export declare function exportProject(name: any): Promise<void>;
+import { ProjectConfiguration } from '../../interfaces';
+export declare function getProjectFile(fileName: any): ProjectConfiguration;
+export declare function exportProject(name: any): Promise<void>;

package/dist/helpers/projects/helpers.js

@@ -1,167 +1,167 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.exportProject = exports.getProjectFile = void 0;
-const tslib_1 = require("tslib");
-const path = tslib_1.__importStar(require("path"));
-const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
-const fs_1 = tslib_1.__importDefault(require("fs"));
-const sdk_1 = require("@contrail/sdk");
-const util_1 = require("@contrail/util");
-const logger_1 = tslib_1.__importDefault(require("../../logger"));
-function getProjectFile(fileName) {
-    const CURRENT_DIR = process.cwd();
-    try {
-        const fullPath = path.join(CURRENT_DIR, fileName);
-        logger_1.default.info(`Getting file from path: ${fullPath}`);
-        const doc = js_yaml_1.default.load(fs_1.default.readFileSync(fullPath, 'utf8'));
-        return doc.projectConfiguration;
-    }
-    catch (e) {
-        throw new Error(`ERROR PARSING YAML: ${e}`);
-    }
-}
-exports.getProjectFile = getProjectFile;
-async function exportProject(name) {
-    const allWorkspaces = await new sdk_1.Entities().get({
-        entityName: 'workspace',
-        useSearch: false,
-    });
-    const workspace = allWorkspaces.find((w) => w.name === name);
-    if (!workspace) {
-        throw new Error('Project was not found.');
-    }
-    const projectConfiguration = {
-        projectName: workspace.name,
-        identifier: workspace.identifier,
-        principals: [],
-        commonConfig: {},
-        assortments: [],
-        subFolders: [],
-    };
-    projectConfiguration.principals = await getFolderPrincipals(workspace);
-    const allAssortments = [];
-    await getAssortmentsAndSubFolders(workspace.id, projectConfiguration.assortments, projectConfiguration.subFolders, allAssortments);
-    await convertRelationshipsInFolders(projectConfiguration, allAssortments);
-    saveData({ projectConfiguration: projectConfiguration }, name);
-}
-exports.exportProject = exportProject;
-async function getAssortmentsAndSubFolders(parentId, assortments, subFolders, allAssortments) {
-    const workspaceAssortments = await new sdk_1.Entities().get({
-        entityName: 'assortment',
-        criteria: {
-            workspaceId: parentId,
-        },
-    });
-    const integrationAssortments = workspaceAssortments; //?.filter(a => a.assortmentType === 'INTEGRATION');
-    if (integrationAssortments?.length > 0) {
-        allAssortments.push(...integrationAssortments);
-        for (const a of integrationAssortments) {
-            const integrationAssortmentsCopy = util_1.ObjectUtil.cloneDeep(a);
-            deleteNonUserKeys(integrationAssortmentsCopy);
-            const assortmentType = a.assortmentType === 'INTEGRATION' ? 'ASSORTMENT' : a.assortmentType;
-            const converted = {
-                identifier: a.identifier,
-                name: a.name,
-                type: assortmentType,
-                sourceAssortmentIdentifier: [],
-                sourceAssortmentIds: a.sourceAssortmentIds,
-                composedFromAssortmentIdentifiers: [],
-                composedFromAssortmentIds: a.composedFromAssortmentIds,
-                assortmentAtts: Object.assign({}, integrationAssortmentsCopy),
-            };
-            assortments.push(converted);
-        }
-    }
-    logger_1.default.info('workspaceFolderLinks call');
-    const workspaceFolderLinks = await new sdk_1.Entities().get({
-        entityName: 'workspace-entity',
-        criteria: {
-            workspaceId: parentId,
-            entityType: 'workspace',
-        },
-        relations: ['entity'],
-    });
-    const workspaceFolders = workspaceFolderLinks?.map((wfl) => wfl.entity);
-    if (workspaceFolders?.length > 0) {
-        for (const folder of workspaceFolders) {
-            const converted = {
-                identifier: folder.identifier,
-                name: folder.name,
-                principals: [],
-                assortments: [],
-                subFolders: [],
-            };
-            converted.principals = await getFolderPrincipals(folder);
-            await getAssortmentsAndSubFolders(folder.id, converted.assortments, converted.subFolders, allAssortments);
-            subFolders.push(converted);
-        }
-    }
-}
-function convertRelationshipsInFolders(folder, allAssortments) {
-    if (!(allAssortments.length > 0)) {
-        return;
-    }
-    convertRelationshipsToIdentifiers(folder.assortments, allAssortments);
-    for (const f of folder.subFolders) {
-        convertRelationshipsInFolders(f, allAssortments);
-    }
-}
-function convertRelationshipsToIdentifiers(assortments, allAssortments) {
-    if (!(allAssortments.length > 0)) {
-        return;
-    }
-    for (const assortment of assortments) {
-        if (assortment.sourceAssortmentIds) {
-            assortment.sourceAssortmentIdentifier = assortment.sourceAssortmentIds.map((id) => allAssortments.find((a) => a.id === id)?.identifier);
-        }
-        delete assortment.sourceAssortmentIds;
-        if (assortment.composedFromAssortmentIds) {
-            assortment.composedFromAssortmentIdentifiers = assortment.composedFromAssortmentIds.map((id) => allAssortments.find((a) => a.id === id)?.identifier);
-        }
-        delete assortment.composedFromAssortmentIds;
-    }
-}
-async function getFolderPrincipals(folder) {
-    const principals = [];
-    if (!folder.policyOwner) {
-        return ['INHERIT'];
-    }
-    const workspacePrincipals = await new sdk_1.Entities().get({
-        entityName: 'workspace-principal',
-        criteria: { workspaceId: folder.id },
-        relations: ['principal'],
-    });
-    for (const workspacePrincipal of workspacePrincipals) {
-        if (workspacePrincipal.principal.email) {
-            principals.push(`${workspacePrincipal.principal.email}|${workspacePrincipal.role}`);
-        }
-        else {
-            principals.push(`${workspacePrincipal.principal.name}|${workspacePrincipal.role}`);
-        }
-    }
-    return principals;
-}
-function deleteNonUserKeys(assortment) {
-    delete assortment.name;
-    delete assortment.identifier;
-    delete assortment.assortmentType;
-    delete assortment.createdById;
-    delete assortment.createdForReference;
-    delete assortment.createdOn;
-    delete assortment.entityType;
-    delete assortment.id;
-    delete assortment.orgId;
-    delete assortment.rootWorkspaceId;
-    delete assortment.composedFromAssortmentIds;
-    delete assortment.sourceAssortmentIds;
-    delete assortment.typeId;
-    delete assortment.typePath;
-    delete assortment.updatedById;
-    delete assortment.updatedOn;
-    delete assortment.workspaceId;
-}
-function saveData(data, name) {
-    const yamlStr = js_yaml_1.default.dump(data);
-    const CURRENT_DIR = process.cwd();
-    fs_1.default.writeFileSync(path.join(CURRENT_DIR, `${name}-export.yml`), yamlStr, 'utf8');
-}
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.exportProject = exports.getProjectFile = void 0;
+const tslib_1 = require("tslib");
+const path = tslib_1.__importStar(require("path"));
+const js_yaml_1 = tslib_1.__importDefault(require("js-yaml"));
+const fs_1 = tslib_1.__importDefault(require("fs"));
+const sdk_1 = require("@contrail/sdk");
+const util_1 = require("@contrail/util");
+const logger_1 = tslib_1.__importDefault(require("../../logger"));
+function getProjectFile(fileName) {
+    const CURRENT_DIR = process.cwd();
+    try {
+        const fullPath = path.join(CURRENT_DIR, fileName);
+        logger_1.default.info(`Getting file from path: ${fullPath}`);
+        const doc = js_yaml_1.default.load(fs_1.default.readFileSync(fullPath, 'utf8'));
+        return doc.projectConfiguration;
+    }
+    catch (e) {
+        throw new Error(`ERROR PARSING YAML: ${e}`);
+    }
+}
+exports.getProjectFile = getProjectFile;
+async function exportProject(name) {
+    const allWorkspaces = await new sdk_1.Entities().get({
+        entityName: 'workspace',
+        useSearch: false,
+    });
+    const workspace = allWorkspaces.find((w) => w.name === name);
+    if (!workspace) {
+        throw new Error('Project was not found.');
+    }
+    const projectConfiguration = {
+        projectName: workspace.name,
+        identifier: workspace.identifier,
+        principals: [],
+        commonConfig: {},
+        assortments: [],
+        subFolders: [],
+    };
+    projectConfiguration.principals = await getFolderPrincipals(workspace);
+    const allAssortments = [];
+    await getAssortmentsAndSubFolders(workspace.id, projectConfiguration.assortments, projectConfiguration.subFolders, allAssortments);
+    await convertRelationshipsInFolders(projectConfiguration, allAssortments);
+    saveData({ projectConfiguration: projectConfiguration }, name);
+}
+exports.exportProject = exportProject;
+async function getAssortmentsAndSubFolders(parentId, assortments, subFolders, allAssortments) {
+    const workspaceAssortments = await new sdk_1.Entities().get({
+        entityName: 'assortment',
+        criteria: {
+            workspaceId: parentId,
+        },
+    });
+    const integrationAssortments = workspaceAssortments; //?.filter(a => a.assortmentType === 'INTEGRATION');
+    if (integrationAssortments?.length > 0) {
+        allAssortments.push(...integrationAssortments);
+        for (const a of integrationAssortments) {
+            const integrationAssortmentsCopy = util_1.ObjectUtil.cloneDeep(a);
+            deleteNonUserKeys(integrationAssortmentsCopy);
+            const assortmentType = a.assortmentType === 'INTEGRATION' ? 'ASSORTMENT' : a.assortmentType;
+            const converted = {
+                identifier: a.identifier,
+                name: a.name,
+                type: assortmentType,
+                sourceAssortmentIdentifier: [],
+                sourceAssortmentIds: a.sourceAssortmentIds,
+                composedFromAssortmentIdentifiers: [],
+                composedFromAssortmentIds: a.composedFromAssortmentIds,
+                assortmentAtts: Object.assign({}, integrationAssortmentsCopy),
+            };
+            assortments.push(converted);
+        }
+    }
+    logger_1.default.info('workspaceFolderLinks call');
+    const workspaceFolderLinks = await new sdk_1.Entities().get({
+        entityName: 'workspace-entity',
+        criteria: {
+            workspaceId: parentId,
+            entityType: 'workspace',
+        },
+        relations: ['entity'],
+    });
+    const workspaceFolders = workspaceFolderLinks?.map((wfl) => wfl.entity);
+    if (workspaceFolders?.length > 0) {
+        for (const folder of workspaceFolders) {
+            const converted = {
+                identifier: folder.identifier,
+                name: folder.name,
+                principals: [],
+                assortments: [],
+                subFolders: [],
+            };
+            converted.principals = await getFolderPrincipals(folder);
+            await getAssortmentsAndSubFolders(folder.id, converted.assortments, converted.subFolders, allAssortments);
+            subFolders.push(converted);
+        }
+    }
+}
+function convertRelationshipsInFolders(folder, allAssortments) {
+    if (!(allAssortments.length > 0)) {
+        return;
+    }
+    convertRelationshipsToIdentifiers(folder.assortments, allAssortments);
+    for (const f of folder.subFolders) {
+        convertRelationshipsInFolders(f, allAssortments);
+    }
+}
+function convertRelationshipsToIdentifiers(assortments, allAssortments) {
+    if (!(allAssortments.length > 0)) {
+        return;
+    }
+    for (const assortment of assortments) {
+        if (assortment.sourceAssortmentIds) {
+            assortment.sourceAssortmentIdentifier = assortment.sourceAssortmentIds.map((id) => allAssortments.find((a) => a.id === id)?.identifier);
+        }
+        delete assortment.sourceAssortmentIds;
+        if (assortment.composedFromAssortmentIds) {
+            assortment.composedFromAssortmentIdentifiers = assortment.composedFromAssortmentIds.map((id) => allAssortments.find((a) => a.id === id)?.identifier);
+        }
+        delete assortment.composedFromAssortmentIds;
+    }
+}
+async function getFolderPrincipals(folder) {
+    const principals = [];
+    if (!folder.policyOwner) {
+        return ['INHERIT'];
+    }
+    const workspacePrincipals = await new sdk_1.Entities().get({
+        entityName: 'workspace-principal',
+        criteria: { workspaceId: folder.id },
+        relations: ['principal'],
+    });
+    for (const workspacePrincipal of workspacePrincipals) {
+        if (workspacePrincipal.principal.email) {
+            principals.push(`${workspacePrincipal.principal.email}|${workspacePrincipal.role}`);
+        }
+        else {
+            principals.push(`${workspacePrincipal.principal.name}|${workspacePrincipal.role}`);
+        }
+    }
+    return principals;
+}
+function deleteNonUserKeys(assortment) {
+    delete assortment.name;
+    delete assortment.identifier;
+    delete assortment.assortmentType;
+    delete assortment.createdById;
+    delete assortment.createdForReference;
+    delete assortment.createdOn;
+    delete assortment.entityType;
+    delete assortment.id;
+    delete assortment.orgId;
+    delete assortment.rootWorkspaceId;
+    delete assortment.composedFromAssortmentIds;
+    delete assortment.sourceAssortmentIds;
+    delete assortment.typeId;
+    delete assortment.typePath;
+    delete assortment.updatedById;
+    delete assortment.updatedOn;
+    delete assortment.workspaceId;
+}
+function saveData(data, name) {
+    const yamlStr = js_yaml_1.default.dump(data);
+    const CURRENT_DIR = process.cwd();
+    fs_1.default.writeFileSync(path.join(CURRENT_DIR, `${name}-export.yml`), yamlStr, 'utf8');
+}

package/dist/helpers/types/csv-parser.d.ts

@@ -1 +1 @@
-export declare function getCSVFromFile(loadFileId: string): Promise<any[]>;
+export declare function getCSVFromFile(loadFileId: string): Promise<any[]>;

package/dist/helpers/types/csv-parser.js

@@ -1,59 +1,59 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getCSVFromFile = void 0;
-const tslib_1 = require("tslib");
-const csvtojson_1 = tslib_1.__importDefault(require("csvtojson"));
-const client = tslib_1.__importStar(require("https"));
-const sdk_1 = require("@contrail/sdk");
-const logger_1 = tslib_1.__importDefault(require("../../logger"));
-async function getCSVFromFile(loadFileId) {
-    let file;
-    try {
-        file = await new sdk_1.Entities().get({ entityName: 'file', id: loadFileId });
-        logger_1.default.info(`Got file: ${file}`);
-    }
-    catch (e) {
-        logger_1.default.info(`Failed to get file: ${loadFileId}`, JSON.stringify(e));
-        throw new Error(`Failed to get file: ${loadFileId} - ${JSON.stringify(e)}`);
-    }
-    if (!file || !file.downloadUrl) {
-        logger_1.default.info(`File: ${loadFileId} does not have a downloadUrl`);
-        throw new Error(`File: ${loadFileId} does not have a downloadUrl`);
-    }
-    // get csv
-    let response;
-    try {
-        response = await new Promise((resolve, reject) => {
-            client
-                .get(file.downloadUrl, function (res) {
-                logger_1.default.info(`Status code: ${res.statusCode}`);
-                logger_1.default.info(`Status text: ${res.statusMessage}`);
-                let body = '';
-                res.on('data', (data) => {
-                    body += data.toString();
-                });
-                res.on('end', () => {
-                    logger_1.default.debug('Response body:');
-                    logger_1.default.debug(body);
-                    resolve(body);
-                });
-            })
-                .on('error', function (e) {
-                logger_1.default.error(e);
-                reject(e);
-            });
-        });
-    }
-    catch (e) {
-        logger_1.default.info(`Failed to get data from downloadUrl: ${file.downloadUrl} ${JSON.stringify(e)}`);
-        throw e;
-    }
-    if (!response) {
-        logger_1.default.info('Response is empty');
-        throw new Error('Response is empty');
-    }
-    const csvJson = await (0, csvtojson_1.default)({ flatKeys: true }).fromString(response);
-    // logger.info('csvJson', csvJson);
-    return csvJson;
-}
-exports.getCSVFromFile = getCSVFromFile;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getCSVFromFile = void 0;
+const tslib_1 = require("tslib");
+const csvtojson_1 = tslib_1.__importDefault(require("csvtojson"));
+const client = tslib_1.__importStar(require("https"));
+const sdk_1 = require("@contrail/sdk");
+const logger_1 = tslib_1.__importDefault(require("../../logger"));
+async function getCSVFromFile(loadFileId) {
+    let file;
+    try {
+        file = await new sdk_1.Entities().get({ entityName: 'file', id: loadFileId });
+        logger_1.default.info(`Got file: ${file}`);
+    }
+    catch (e) {
+        logger_1.default.info(`Failed to get file: ${loadFileId}`, JSON.stringify(e));
+        throw new Error(`Failed to get file: ${loadFileId} - ${JSON.stringify(e)}`);
+    }
+    if (!file || !file.downloadUrl) {
+        logger_1.default.info(`File: ${loadFileId} does not have a downloadUrl`);
+        throw new Error(`File: ${loadFileId} does not have a downloadUrl`);
+    }
+    // get csv
+    let response;
+    try {
+        response = await new Promise((resolve, reject) => {
+            client
+                .get(file.downloadUrl, function (res) {
+                logger_1.default.info(`Status code: ${res.statusCode}`);
+                logger_1.default.info(`Status text: ${res.statusMessage}`);
+                let body = '';
+                res.on('data', (data) => {
+                    body += data.toString();
+                });
+                res.on('end', () => {
+                    logger_1.default.debug('Response body:');
+                    logger_1.default.debug(body);
+                    resolve(body);
+                });
+            })
+                .on('error', function (e) {
+                logger_1.default.error(e);
+                reject(e);
+            });
+        });
+    }
+    catch (e) {
+        logger_1.default.info(`Failed to get data from downloadUrl: ${file.downloadUrl} ${JSON.stringify(e)}`);
+        throw e;
+    }
+    if (!response) {
+        logger_1.default.info('Response is empty');
+        throw new Error('Response is empty');
+    }
+    const csvJson = await (0, csvtojson_1.default)({ flatKeys: true }).fromString(response);
+    // logger.info('csvJson', csvJson);
+    return csvJson;
+}
+exports.getCSVFromFile = getCSVFromFile;

package/dist/helpers/types/option-set-helper.d.ts

@@ -0,0 +1,9 @@
+import { ReducedOptionSet } from '../../interfaces';
+export declare class OptionSetHelper {
+    /** This will load OptionSets from either a single file or a directory of files.
+     * Those files must be .yml or .yaml and contain either a single ReducedOptionSet or an array of ReducedOptionSets.
+     * @param fileLocation: string either a file or directory
+     * @returns ReducedOptionSet[] all the option sets found in the file(s)
+     */
+    loadOptionSets(fileLocation: any): ReducedOptionSet[];
+}

package/dist/helpers/types/option-set-helper.js

@@ -0,0 +1,48 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.OptionSetHelper = void 0;
+const tslib_1 = require("tslib");
+const path = tslib_1.__importStar(require("path"));
+const fs = tslib_1.__importStar(require("fs"));
+const yaml = tslib_1.__importStar(require("js-yaml"));
+class OptionSetHelper {
+    /** This will load OptionSets from either a single file or a directory of files.
+     * Those files must be .yml or .yaml and contain either a single ReducedOptionSet or an array of ReducedOptionSets.
+     * @param fileLocation: string either a file or directory
+     * @returns ReducedOptionSet[] all the option sets found in the file(s)
+     */
+    loadOptionSets(fileLocation) {
+        const TARGET_DIR = process.cwd();
+        try {
+            const optionSets = [];
+            const fullPath = path.resolve(path.join(TARGET_DIR, fileLocation));
+            const isDir = fs.statSync(fullPath).isDirectory();
+            if (isDir) {
+                const files = fs.readdirSync(fullPath);
+                for (const file of files) {
+                    const doc = yaml.load(fs.readFileSync(path.join(fullPath, file), 'utf8'));
+                    if (Array.isArray(doc)) {
+                        optionSets.push(...doc);
+                    }
+                    else {
+                        optionSets.push(doc);
+                    }
+                }
+            }
+            else {
+                const doc = yaml.load(fs.readFileSync(fullPath, 'utf8'));
+                if (Array.isArray(doc)) {
+                    optionSets.push(...doc);
+                }
+                else {
+                    optionSets.push(doc);
+                }
+            }
+            return optionSets;
+        }
+        catch (e) {
+            throw new Error(`ERROR PARSING YAML: ${e}`);
+        }
+    }
+}
+exports.OptionSetHelper = OptionSetHelper;

package/dist/helpers/types/option-set-helper.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/helpers/types/option-set-helper.spec.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const option_set_helper_1 = require("./option-set-helper");
+const fs = tslib_1.__importStar(require("fs"));
+// Mock the fs module
+jest.mock('fs');
+const mockedFs = fs;
+describe('OptionSetHelper', () => {
+    beforeEach(() => {
+        // Reset all mocks before each test
+        jest.clearAllMocks();
+    });
+    describe('loadOptionSets', () => {
+        it('should load option sets from a directory', () => {
+            // Mock fs.statSync to return a directory
+            mockedFs.statSync.mockReturnValue({
+                isDirectory: () => true,
+            });
+            // Mock fs.readdirSync to return file names
+            mockedFs.readdirSync.mockReturnValue(['optionSet1.yml', 'optionSet2.yml']);
+            // Mock fs.readFileSync to return YAML content
+            mockedFs.readFileSync
+                .mockReturnValueOnce('name: OptionSet1\nvalues: [value1, value2]')
+                .mockReturnValueOnce('name: OptionSet2\nvalues: [value3, value4]');
+            const osh = new option_set_helper_1.OptionSetHelper();
+            const result = osh.loadOptionSets('test/fixtures/optionSets');
+            expect(Array.isArray(result)).toBe(true);
+            expect(result).toHaveLength(2);
+        });
+        it('should load option sets from a single file', () => {
+            // Mock fs.statSync to return a file (not directory)
+            mockedFs.statSync.mockReturnValue({
+                isDirectory: () => false,
+            });
+            // Mock fs.readFileSync to return YAML content for a single file
+            mockedFs.readFileSync.mockReturnValue('name: SingleOptionSet\nvalues: [value1, value2]');
+            const osh = new option_set_helper_1.OptionSetHelper();
+            const result = osh.loadOptionSets('test/fixtures/singleOptionSet.yml');
+            expect(Array.isArray(result)).toBe(true);
+            expect(result).toHaveLength(1);
+        });
+        it('should handle array of option sets in a single file', () => {
+            // Mock fs.statSync to return a file (not directory)
+            mockedFs.statSync.mockReturnValue({
+                isDirectory: () => false,
+            });
+            // Mock fs.readFileSync to return YAML content with array
+            mockedFs.readFileSync.mockReturnValue(`
+        - name: OptionSet1
+          values: [value1, value2]
+        - name: OptionSet2  
+          values: [value3, value4]
+      `);
+            const osh = new option_set_helper_1.OptionSetHelper();
+            const result = osh.loadOptionSets('test/fixtures/multipleOptionSets.yml');
+            expect(Array.isArray(result)).toBe(true);
+            expect(result).toHaveLength(2);
+        });
+        it('should throw error when file parsing fails', () => {
+            // Mock fs.statSync to throw an error
+            mockedFs.statSync.mockImplementation(() => {
+                throw new Error('File not found');
+            });
+            const osh = new option_set_helper_1.OptionSetHelper();
+            expect(() => osh.loadOptionSets('nonexistent')).toThrow('ERROR PARSING YAML: Error: File not found');
+        });
+    });
+});

package/dist/helpers/types/parseOptionSetsLocalFiles.spec.d.ts

@@ -1 +1 @@
-export {};
+export {};