Merge pull request #1530 from contentstack/feat/DX-1168-custom-role-a…

…udit feat: add custom role support in audit plugin
contentstack · Aug 29, 2024 · 5f9468f · 5f9468f
2 parents eb80fab + ce833d5
commit 5f9468f
Show file tree

Hide file tree

Showing 17 changed files with 334 additions and 51 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/contentstack-audit/README.md b/packages/contentstack-audit/README.md
@@ -19,7 +19,7 @@ $ npm install -g @contentstack/cli-audit
 $ csdx COMMAND
 running command...
 $ csdx (--version|-v)
-@contentstack/cli-audit/1.6.5 darwin-arm64 node-v22.2.0
+@contentstack/cli-audit/1.7.0 darwin-arm64 node-v22.2.0
 $ csdx --help [COMMAND]
 USAGE
   $ csdx COMMAND
@@ -52,12 +52,13 @@ Perform audits and find possible errors in the exported Contentstack data
 
 ```
 USAGE
-  $ csdx audit [--report-path <value>] [--modules content-types|global-fields|entries|extensions|workflows]
-    [--columns <value> | ] [--sort <value>] [--filter <value>] [--csv | --no-truncate]
+  $ csdx audit [--report-path <value>] [--modules
+    content-types|global-fields|entries|extensions|workflows|custom-roles] [--columns <value> | ] [--sort <value>]
+    [--filter <value>] [--csv | --no-truncate]
 
 FLAGS
   --modules=<option>...  Provide the list of modules to be audited
-                         <options: content-types|global-fields|entries|extensions|workflows>
+                         <options: content-types|global-fields|entries|extensions|workflows|custom-roles>
   --report-path=<value>  Path to store the audit reports
 
 TABLE FLAGS
@@ -92,8 +93,8 @@ Perform audits and fix possible errors in the exported Contentstack data.
 
 ```
 USAGE
-  $ csdx audit:fix [--report-path <value>] [--modules content-types|global-fields|entries|extensions|workflows]
-    [--copy-path <value> --copy-dir] [--fix-only
+  $ csdx audit:fix [--report-path <value>] [--modules
+    content-types|global-fields|entries|extensions|workflows|custom-roles] [--copy-path <value> --copy-dir] [--fix-only
     reference|global_field|json:rte|json:extension|blocks|group|content_types] [--columns <value> | ] [--sort <value>]
     [--filter <value>] [--csv | --no-truncate]
 
@@ -103,7 +104,7 @@ FLAGS
   --fix-only=<option>...  Provide the list of fix options
                           <options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
   --modules=<option>...   Provide the list of modules to be audited
-                          <options: content-types|global-fields|entries|extensions|workflows>
+                          <options: content-types|global-fields|entries|extensions|workflows|custom-roles>
   --report-path=<value>   Path to store the audit reports
 
 TABLE FLAGS
@@ -140,12 +141,13 @@ Perform audits and find possible errors in the exported Contentstack data
 
 ```
 USAGE
-  $ csdx cm:stacks:audit [--report-path <value>] [--modules content-types|global-fields|entries|extensions|workflows]
-    [--columns <value> | ] [--sort <value>] [--filter <value>] [--csv | --no-truncate]
+  $ csdx cm:stacks:audit [--report-path <value>] [--modules
+    content-types|global-fields|entries|extensions|workflows|custom-roles] [--columns <value> | ] [--sort <value>]
+    [--filter <value>] [--csv | --no-truncate]
 
 FLAGS
   --modules=<option>...  Provide the list of modules to be audited
-                         <options: content-types|global-fields|entries|extensions|workflows>
+                         <options: content-types|global-fields|entries|extensions|workflows|custom-roles>
   --report-path=<value>  Path to store the audit reports
 
 TABLE FLAGS
@@ -182,8 +184,8 @@ Perform audits and fix possible errors in the exported Contentstack data.
 
 ```
 USAGE
-  $ csdx cm:stacks:audit:fix [--report-path <value>] [--modules content-types|global-fields|entries|extensions|workflows]
-    [--copy-path <value> --copy-dir] [--fix-only
+  $ csdx cm:stacks:audit:fix [--report-path <value>] [--modules
+    content-types|global-fields|entries|extensions|workflows|custom-roles] [--copy-path <value> --copy-dir] [--fix-only
     reference|global_field|json:rte|json:extension|blocks|group|content_types] [--columns <value> | ] [--sort <value>]
     [--filter <value>] [--csv | --no-truncate]
 
@@ -193,7 +195,7 @@ FLAGS
   --fix-only=<option>...  Provide the list of fix options
                           <options: reference|global_field|json:rte|json:extension|blocks|group|content_types>
   --modules=<option>...   Provide the list of modules to be audited
-                          <options: content-types|global-fields|entries|extensions|workflows>
+                          <options: content-types|global-fields|entries|extensions|workflows|custom-roles>
   --report-path=<value>   Path to store the audit reports
 
 TABLE FLAGS

diff --git a/packages/contentstack-audit/package.json b/packages/contentstack-audit/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@contentstack/cli-audit",
-  "version": "1.6.5",
+  "version": "1.7.0",
   "description": "Contentstack audit plugin",
   "author": "Contentstack CLI",
   "homepage": "https://github.com/contentstack/cli",

diff --git a/packages/contentstack-audit/src/audit-base-command.ts b/packages/contentstack-audit/src/audit-base-command.ts
@@ -20,6 +20,7 @@ import {
   RefErrorReturnType,
   WorkflowExtensionsRefErrorReturnType,
 } from './types';
+import CustomRoles from './modules/custom-roles';
 
 export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseCommand> {
   private currentCommand!: CommandNames;
@@ -56,6 +57,7 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       missingCtRefsInWorkflow,
       missingSelectFeild,
       missingMandatoryFields,
+      missingRefInCustomRoles
     } = await this.scanAndFix();
 
     this.showOutputOnScreen([
@@ -69,13 +71,15 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
     this.showOutputOnScreenWorkflowsAndExtension([
       { module: 'Entries Mandatory Field', missingRefs: missingMandatoryFields },
     ]);
+    this.showOutputOnScreenWorkflowsAndExtension([{ module: 'Custom Roles', missingRefs: missingRefInCustomRoles }]);
     if (
       !isEmpty(missingCtRefs) ||
       !isEmpty(missingGfRefs) ||
       !isEmpty(missingEntryRefs) ||
       !isEmpty(missingCtRefsInWorkflow) ||
       !isEmpty(missingCtRefsInExtensions) ||
-      !isEmpty(missingSelectFeild)
+      !isEmpty(missingSelectFeild) ||
+      !isEmpty(missingRefInCustomRoles) 
     ) {
       if (this.currentCommand === 'cm:stacks:audit') {
         this.log(this.$t(auditMsg.FINAL_REPORT_PATH, { path: this.sharedConfig.reportPath }), 'warn');
@@ -102,7 +106,8 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       !isEmpty(missingEntryRefs) ||
       !isEmpty(missingCtRefsInWorkflow) ||
       !isEmpty(missingCtRefsInExtensions) ||
-      !isEmpty(missingSelectFeild)
+      !isEmpty(missingSelectFeild) || 
+      !isEmpty(missingRefInCustomRoles)
     );
   }
 
@@ -121,7 +126,8 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       missingCtRefsInWorkflow,
       missingSelectFeild,
       missingEntry,
-      missingMandatoryFields;
+      missingMandatoryFields,
+      missingRefInCustomRoles;
 
     for (const module of this.sharedConfig.flags.modules || this.sharedConfig.modules) {
       print([
@@ -174,6 +180,10 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
           missingCtRefsInExtensions = await new Extensions(cloneDeep(constructorParam)).run();
           await this.prepareReport(module, missingCtRefsInExtensions);
           break;
+        case 'custom-roles':
+          missingRefInCustomRoles = await new CustomRoles(cloneDeep(constructorParam)).run();
+          await this.prepareReport(module, missingRefInCustomRoles);
+          break;
       }
 
       print([
@@ -198,6 +208,7 @@ export abstract class AuditBaseCommand extends BaseCommand<typeof AuditBaseComma
       missingCtRefsInWorkflow,
       missingSelectFeild,
       missingMandatoryFields,
+      missingRefInCustomRoles,
     };
   }
 

diff --git a/packages/contentstack-audit/src/config/index.ts b/packages/contentstack-audit/src/config/index.ts
@@ -2,7 +2,7 @@ const config = {
   showTerminalOutput: true,
   skipRefs: ['sys_assets'],
   skipFieldTypes: ['taxonomy', 'group'],
-  modules: ['content-types', 'global-fields', 'entries', 'extensions', 'workflows'],
+  modules: ['content-types', 'global-fields', 'entries', 'extensions', 'workflows', 'custom-roles'],
   'fix-fields': ['reference', 'global_field', 'json:rte', 'json:extension', 'blocks', 'group', 'content_types'],
   moduleConfig: {
     'content-types': {
@@ -35,6 +35,11 @@ const config = {
       dirName: 'extensions',
       fileName: 'extensions.json',
     },
+    'custom-roles': {
+      name: 'custom-roles',
+      dirName: 'custom-roles',
+      fileName: 'custom-roles.json',
+    },
   },
   entries: {
     systemKeys: [

diff --git a/packages/contentstack-audit/src/messages/index.ts b/packages/contentstack-audit/src/messages/index.ts
@@ -19,6 +19,7 @@ const commonMsg = {
   EXTENSION_FIX_WARN: `The extension associated with UID {uid} and title '{title}' will be removed.`,
   EXTENSION_FIX_CONFIRMATION: `Would you like to overwrite existing file?`,
   WF_BRANCH_REMOVAL: `Removing the branch '{branch} from workflow with UID {uid} and name {name} will be removed.'`,
+  CR_BRANCH_REMOVAL: `Removing the branch '{branch} from custom role with UID {uid} and name {name} will be removed.'`,
 };
 
 const auditMsg = {
@@ -35,6 +36,7 @@ const auditMsg = {
   SCAN_EXT_SUCCESS_MSG: "Successfully completed scanning the {module} titled '{title}' with UID '{uid}'",
   AUDIT_CMD_DESCRIPTION: 'Perform audits and find possible errors in the exported Contentstack data',
   SCAN_WF_SUCCESS_MSG: 'Successfully completed the scanning of workflow with UID {uid} and name {name}.',
+  SCAN_CR_SUCCESS_MSG: 'Successfully completed the scanning of custom role with UID {uid} and name {name}.',
 };
 
 const auditFixMsg = {