@contrail/cli 2.3.4 → 2.4.0-alpha

package/dist/helpers/app/app-config-validators.spec.js

@@ -1,11 +1,16 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 const app_config_validators_1 = require("./app-config-validators");
+const validResult = {
+    errors: [],
+    warnings: [],
+};
 describe('appVersionValidator', () => {
     it('should return an error if "version" field is missing', () => {
         const appDeclaration = {};
         const expectedError = {
-            error: 'Missing "version" field". Semantic App Version looks like "1.0.0". Use "contrail app version [patch|minor|major]" to update the app version.',
+            errors: [app_config_validators_1.ERROR_MESSAGES.missingVersionField],
+            warnings: [],
         };
         const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
         expect(validationResult).toEqual(expectedError);
@@ -15,7 +20,8 @@ describe('appVersionValidator', () => {
             version: 'invalidVersion',
         };
         const expectedError = {
-            error: 'Invalid app version. Semantic App Version looks like "1.0.0". Use "contrail app version [patch|minor|major]" to update the app version.',
+            errors: [app_config_validators_1.ERROR_MESSAGES.invalidAppVersion],
+            warnings: [],
         };
         const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
         expect(validationResult).toEqual(expectedError);
@@ -25,14 +31,18 @@ describe('appVersionValidator', () => {
             version: '1.0.0',
         };
         const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
-        expect(validationResult).toBeUndefined();
+        expect(validationResult).toEqual(validResult);
     });
     it('should gracefully handle bad versions', () => {
         const appDeclaration = {
             version: '1',
         };
+        const expectedError = {
+            errors: [app_config_validators_1.ERROR_MESSAGES.invalidAppVersion],
+            warnings: [],
+        };
         const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
-        expect(validationResult.error).toEqual('Invalid app version. Semantic App Version looks like "1.0.0". Use "contrail app version [patch|minor|major]" to update the app version.');
+        expect(validationResult).toEqual(expectedError);
     });
 });
 it('should return an error if "version" field is not a string', () => {
@@ -40,7 +50,8 @@ it('should return an error if "version" field is not a string', () => {
         version: 123,
     };
     const expectedError = {
-        error: '"version" field is not a string. Expecting a version like "1.0.0". Manually update the "version" field to be a string in the app.yml file.',
+        errors: [app_config_validators_1.ERROR_MESSAGES.invalidVersionField],
+        warnings: [],
     };
     const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
     expect(validationResult).toEqual(expectedError);
@@ -50,7 +61,8 @@ it('should return an error if "version" field is empty', () => {
         version: '',
     };
     const expectedError = {
-        error: 'Missing "version" field". Semantic App Version looks like "1.0.0". Use "contrail app version [patch|minor|major]" to update the app version.',
+        errors: [app_config_validators_1.ERROR_MESSAGES.missingVersionField],
+        warnings: [],
     };
     const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
     expect(validationResult).toEqual(expectedError);
@@ -60,7 +72,8 @@ it('should return an error if app version has invalid format', () => {
         version: '1.0',
     };
     const expectedError = {
-        error: 'Invalid app version. Semantic App Version looks like "1.0.0". Use "contrail app version [patch|minor|major]" to update the app version.',
+        errors: [app_config_validators_1.ERROR_MESSAGES.invalidAppVersion],
+        warnings: [],
     };
     const validationResult = (0, app_config_validators_1.appVersionValidator)(appDeclaration);
     expect(validationResult).toEqual(expectedError);
@@ -71,35 +84,227 @@ describe('visibilityValidator', () => {
             visibility: 'invalidVisibility',
         };
         const expectedError = {
-            error: 'Invalid visibility. Visibility must be "public" or "private".',
+            errors: [app_config_validators_1.ERROR_MESSAGES.invalidVisibility],
+            warnings: [],
         };
         const validationResult = (0, app_config_validators_1.visibilityValidator)(appDeclaration);
         expect(validationResult).toEqual(expectedError);
     });
-    it('should return an error if app is private and not hidden', () => {
+    it('should not return an error if visibility is "public"', () => {
         const appDeclaration = {
-            visibility: 'private',
+            visibility: 'public',
+        };
+        const validationResult = (0, app_config_validators_1.visibilityValidator)(appDeclaration);
+        expect(validationResult).toEqual(validResult);
+    });
+    it('should warn if "hidden" field is present (deprecated)', () => {
+        const appDeclaration = {
+            visibility: 'public',
             hidden: true,
         };
-        const expectedError = {
-            error: 'Apps can not be private and hidden.',
+        const warningResult = {
+            errors: [],
+            warnings: [app_config_validators_1.ERROR_MESSAGES.deprecatedHiddenField],
         };
         const validationResult = (0, app_config_validators_1.visibilityValidator)(appDeclaration);
-        expect(validationResult).toEqual(expectedError);
+        expect(validationResult).toEqual(warningResult);
     });
-    it('should not return an error if visibility is "public"', () => {
+});
+describe('validateAccessGrants', () => {
+    it('should warn if app is set to public and "accessGrants" field is present', () => {
         const appDeclaration = {
             visibility: 'public',
+            accessGrants: [
+                {
+                    orgSlug: 'org1',
+                    permissions: ['install'],
+                },
+            ],
         };
-        const validationResult = (0, app_config_validators_1.visibilityValidator)(appDeclaration);
-        expect(validationResult).toBeUndefined();
+        const warningResult = {
+            errors: [],
+            warnings: [app_config_validators_1.ERROR_MESSAGES.ignoredAccessGrants],
+        };
+        const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
+        expect(validationResult).toEqual(warningResult);
     });
-    it('should not return an error if app is private and hidden', () => {
+    it('should return an error if app is private and "accessGrants" field is present but invalid', () => {
         const appDeclaration = {
             visibility: 'private',
-            hidden: false,
+            accessGrants: [
+                {
+                    orgSlug: '',
+                    permissions: ['install'],
+                },
+                {
+                    orgSlug: 'org2',
+                    permissions: ['install'],
+                },
+            ],
         };
-        const validationResult = (0, app_config_validators_1.visibilityValidator)(appDeclaration);
-        expect(validationResult).toBeUndefined();
+        const expectedError = {
+            errors: [app_config_validators_1.ERROR_MESSAGES.invalidOrgSlug],
+            warnings: [],
+        };
+        const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
+        expect(validationResult).toEqual(expectedError);
+    });
+    it('should not return an error if app is private and "accessGrants" field is present and valid', () => {
+        const appDeclaration = {
+            visibility: 'private',
+            accessGrants: [
+                {
+                    orgSlug: 'org1',
+                    permissions: ['install'],
+                },
+            ],
+        };
+        const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
+        expect(validationResult).toEqual(validResult);
+    });
+    it('should return valid if accessGrants is an empty array', () => {
+        const appDeclaration = {
+            visibility: 'private',
+            accessGrants: [],
+        };
+        const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
+        expect(validationResult).toEqual(validResult);
+    });
+    it('should return valid if accessGrants is an array with valid orgSlug and permissions', () => {
+        const appDeclaration = {
+            visibility: 'private',
+            accessGrants: [
+                {
+                    orgSlug: 'org1',
+                    permissions: ['install'],
+                },
+            ],
+        };
+        const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
+        expect(validationResult).toEqual(validResult);
+    });
+    it('should return invalid if accessGrants is not an array', () => {
+        const appDeclaration = {
+            visibility: 'private',
+            accessGrants: 'invalid',
+        };
+        const expectedError = {
+            errors: [app_config_validators_1.ERROR_MESSAGES.accessGrantsArray],
+            warnings: [],
+        };
+        const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
+        expect(validationResult).toEqual(expectedError);
+    });
+    it('should return invalid if orgSlug is missing in one of the accessGrants objects', () => {
+        const appDeclaration = {
+            visibility: 'private',
+            accessGrants: [
+                {
+                    orgSlug: '',
+                    permissions: ['install'],
+                },
+                {
+                    orgSlug: 'org2',
+                    permissions: ['install'],
+                },
+            ],
+        };
+        const expectedError = {
+            errors: [app_config_validators_1.ERROR_MESSAGES.invalidOrgSlug],
+            warnings: [],
+        };
+        const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
+        expect(validationResult).toEqual(expectedError);
+    });
+    it('should return invalid if permissions is not an array or empty in one of the accessGrants objects', () => {
+        const appDeclaration = {
+            visibility: 'private',
+            accessGrants: [
+                {
+                    orgSlug: 'org1',
+                    permissions: 'invalid',
+                },
+                {
+                    orgSlug: 'org2',
+                    permissions: [],
+                },
+            ],
+        };
+        const expectedError = {
+            errors: [app_config_validators_1.ERROR_MESSAGES.emptyPermissionsArray, app_config_validators_1.ERROR_MESSAGES.emptyPermissionsArray],
+            warnings: [],
+        };
+        const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
+        expect(validationResult).toEqual(expectedError);
+    });
+    it('should return invalid if invalid permission is found in one of the accessGrants objects', () => {
+        const appDeclaration = {
+            visibility: 'private',
+            accessGrants: [
+                {
+                    orgSlug: 'org1',
+                    permissions: ['install', 'invalid'],
+                },
+                {
+                    orgSlug: 'org2',
+                    permissions: ['install'],
+                },
+            ],
+        };
+        const expectedError = {
+            errors: [app_config_validators_1.ERROR_MESSAGES.invalidPermission('invalid')],
+            warnings: [],
+        };
+        const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
+        expect(validationResult).toEqual(expectedError);
+    });
+    it('should return error if case-insensitive permission is found in accessGrants object', () => {
+        const appDeclaration = {
+            visibility: 'private',
+            accessGrants: [
+                {
+                    orgSlug: 'org1',
+                    permissions: ['Install'],
+                },
+            ],
+        };
+        const expectedError = {
+            errors: [app_config_validators_1.ERROR_MESSAGES.invalidPermission('Install')],
+            warnings: [],
+        };
+        const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
+        expect(validationResult).toEqual(expectedError);
+    });
+    it('should return invalid if orgSlug is missing from the accessGrants object', () => {
+        const appDeclaration = {
+            visibility: 'private',
+            accessGrants: [
+                {
+                    permissions: ['install'],
+                },
+            ],
+        };
+        const expectedError = {
+            errors: [app_config_validators_1.ERROR_MESSAGES.invalidOrgSlug],
+            warnings: [],
+        };
+        const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
+        expect(validationResult).toEqual(expectedError);
+    });
+    it('should return invalid if permissions is missing from the accessGrants object', () => {
+        const appDeclaration = {
+            visibility: 'private',
+            accessGrants: [
+                {
+                    orgSlug: 'org2',
+                },
+            ],
+        };
+        const expectedError = {
+            errors: [app_config_validators_1.ERROR_MESSAGES.emptyPermissionsArray],
+            warnings: [],
+        };
+        const validationResult = (0, app_config_validators_1.validateAccessGrants)(appDeclaration);
+        expect(validationResult).toEqual(expectedError);
     });
 });

package/dist/helpers/app/app-deployer.js

@@ -4,7 +4,6 @@ exports.createNodePackage = exports.AppDeployer = void 0;
 const tslib_1 = require("tslib");
 const sdk_1 = require("@contrail/sdk");
 const chalk_1 = tslib_1.__importDefault(require("chalk"));
-const auth_1 = require("../../auth/auth");
 const actions_deployer_1 = require("./actions-deployer");
 const app_template_parsers_1 = require("./app-template-parsers");
 const workflow_template_definition_deployer_1 = require("../workflow-template-definitions/workflow-template-definition-deployer");
@@ -43,8 +42,7 @@ class AppDeployer {
         return app;
     }
     async getExistingApp(appDeclaration) {
-        const orgId = auth_1.Auth.config.orgId;
-        const apps = await (0, apps_1.getAvailableApps)({ orgId });
+        const apps = await (0, apps_1.getAvailableApps)();
         return apps.find((app) => app.identifier === appDeclaration.appIdentifier);
     }
     async createNewApp(appDeclaration) {
@@ -59,12 +57,16 @@ class AppDeployer {
         if (appDeclaration?.triggers) {
             triggerKeyDefinitions = app_template_parsers_1.TriggerKeyDefinitionParser.buildTriggersArray(appDeclaration);
         }
+        let accessGrants = [];
+        if (appDeclaration?.accessGrants) {
+            accessGrants = await app_template_parsers_1.AccessGrantsParser.buildAccessGrants(appDeclaration);
+        }
         const newApp = {
             identifier: appDeclaration.appIdentifier,
             name: appDeclaration.appName,
             version: appDeclaration.version,
             public: appDeclaration.visibility === 'public',
-            hidden: appDeclaration.hidden,
+            accessGrants,
             description: appDeclaration.appDescription,
             publisher: appDeclaration.publisher,
             thumbnail: appDeclaration.thumbnail,
@@ -101,6 +103,10 @@ class AppDeployer {
         if (appDeclaration?.triggers) {
             triggerKeyDefinitions = app_template_parsers_1.TriggerKeyDefinitionParser.buildTriggersArray(appDeclaration);
         }
+        let accessGrants = [];
+        if (appDeclaration?.accessGrants) {
+            accessGrants = await app_template_parsers_1.AccessGrantsParser.buildAccessGrants(appDeclaration);
+        }
         // does appDeclaration have dockerImageRef
         const isDocker = Object.hasOwnProperty.call(appDeclaration, 'dockerImageRef');
         let appCodePackageId;
@@ -116,7 +122,7 @@ class AppDeployer {
             name: appDeclaration.appName,
             version: appDeclaration.version,
             public: appDeclaration.visibility === 'public',
-            hidden: appDeclaration.hidden,
+            accessGrants,
             description: appDeclaration.appDescription,
             publisher: appDeclaration.publisher,
             thumbnail: appDeclaration.thumbnail,
@@ -201,8 +207,7 @@ async function createNodePackage(appIdentifier, debug, dryRun) {
             return {};
         }
         logger_1.default.info('Uploading package to S3...');
-        let apps = await entitiesClient.get({ entityName: 'app', criteria: { hidden: true } });
-        apps = apps.concat(await entitiesClient.get({ entityName: 'app', criteria: { private: true } }));
+        let apps = await entitiesClient.get({ entityName: 'app' });
         const thisApp = apps.find((x) => x.identifier === appIdentifier);
         if (!thisApp) {
             throw new Error('App not found');

package/dist/helpers/app/app-template-parsers.d.ts

@@ -1,5 +1,5 @@
 import { ExternalLink } from '@contrail/entity-types';
-import { AppDeclaration, TriggerKeyDefinition, ConfigPropertyElements } from '../../interfaces';
+import { AppDeclaration, TriggerKeyDefinition, ConfigPropertyElements, AppAccessGrant } from '../../interfaces';
 export declare class TriggerKeyDefinitionParser {
     static buildTriggersArray(appDeclaration: AppDeclaration): Array<TriggerKeyDefinition>;
 }
@@ -9,3 +9,6 @@ export declare class ConfigPropertiesParser {
 export declare class ExternalLinkParser {
     static validateAndGetExternalLinks(externalLinks: ExternalLink[]): ExternalLink[];
 }
+export declare class AccessGrantsParser {
+    static buildAccessGrants(appDeclaration: AppDeclaration): Promise<AppAccessGrant[]>;
+}

package/dist/helpers/app/app-template-parsers.js

@@ -1,6 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ExternalLinkParser = exports.ConfigPropertiesParser = exports.TriggerKeyDefinitionParser = void 0;
+exports.AccessGrantsParser = exports.ExternalLinkParser = exports.ConfigPropertiesParser = exports.TriggerKeyDefinitionParser = void 0;
+const interfaces_1 = require("../../interfaces");
+const sdk_1 = require("@contrail/sdk");
 class TriggerKeyDefinitionParser {
     static buildTriggersArray(appDeclaration) {
         const triggers = [];
@@ -73,3 +75,28 @@ class ExternalLinkParser {
     }
 }
 exports.ExternalLinkParser = ExternalLinkParser;
+class AccessGrantsParser {
+    static async buildAccessGrants(appDeclaration) {
+        const accessGrants = [];
+        const currentUser = await (0, sdk_1.getCurrentUser)();
+        let currentOrgId = sdk_1.Auth.config.orgId;
+        if (!currentOrgId) {
+            let currentOrg = currentUser.orgs.find((o) => o.orgSlug === sdk_1.Auth.config.orgSlug);
+            currentOrgId = currentOrg.orgId;
+        }
+        const orgs = await new sdk_1.Entities().get({
+            entityName: 'org',
+        });
+        for (const accessGrant of appDeclaration.accessGrants) {
+            const recipientOrg = orgs.find((o) => o.slug === accessGrant.orgSlug);
+            const grant = {
+                issuerReference: `org:${currentOrgId}`,
+                recipientReference: `org:${recipientOrg.id}`,
+                scope: interfaces_1.AppAccessGrantScope.install,
+            };
+            accessGrants.push(grant);
+        }
+        return accessGrants;
+    }
+}
+exports.AccessGrantsParser = AccessGrantsParser;

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

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