@rockcarver/frodo-cli 2.0.0-4 → 2.0.0-41

package/esm/ops/PolicyOps.js

@@ -1,7 +1,27 @@
 import { frodo, state } from '@rockcarver/frodo-lib';
 import fs from 'fs';
-import { createObjectTable, createProgressBar, debugMessage, failSpinner, printMessage, showSpinner, stopProgressBar, succeedSpinner, updateProgressBar } from '../utils/Console';
-import { getTypedFilename, saveJsonToFile, titleCase } from '../utils/ExportImportUtils';
+import { createObjectTable, createProgressIndicator, createTable, debugMessage, failSpinner, printMessage, showSpinner, stopProgressIndicator, succeedSpinner, updateProgressIndicator } from '../utils/Console';
+const {
+  getRealmName,
+  getTypedFilename,
+  saveJsonToFile,
+  titleCase,
+  getFilePath,
+  getWorkingDirectory
+} = frodo.utils;
+const {
+  readPolicies,
+  readPoliciesByPolicySet,
+  readPolicy,
+  exportPolicy,
+  exportPolicies,
+  exportPoliciesByPolicySet,
+  importPolicy,
+  importFirstPolicy,
+  importPolicies,
+  deletePolicy
+} = frodo.authz.policy;
+
 /**
  * List policies
  * @param {boolean} long list with details
@@ -10,10 +30,16 @@ import { getTypedFilename, saveJsonToFile, titleCase } from '../utils/ExportImpo
 export async function listPolicies(long = false) {
   let outcome = false;
   try {
-    const policies = await frodo.authz.policy.getPolicies();
+    const policies = await readPolicies();
     policies.sort((a, b) => a._id.localeCompare(b._id));
-    for (const policy of policies) {
-      if (!long) {
+    if (long) {
+      const table = createTable(['Id', 'Description', 'Status']);
+      for (const policy of policies) {
+        table.push([`${policy._id}`, `${policy.description}`, policy.active ? 'active'['brightGreen'] : 'inactive'['brightRed']]);
+      }
+      printMessage(table.toString(), 'data');
+    } else {
+      for (const policy of policies) {
         printMessage(`${policy._id}`, 'data');
       }
     }
@@ -34,10 +60,16 @@ export async function listPolicies(long = false) {
 export async function listPoliciesByPolicySet(policySetId, long = false) {
   let outcome = false;
   try {
-    const policies = await frodo.authz.policy.getPoliciesByPolicySet(policySetId);
+    const policies = await readPoliciesByPolicySet(policySetId);
     policies.sort((a, b) => a._id.localeCompare(b._id));
-    for (const policy of policies) {
-      if (!long) {
+    if (long) {
+      const table = createTable(['Id', 'Description', 'Status']);
+      for (const policy of policies) {
+        table.push([`${policy._id}`, `${policy.description}`, policy.active ? 'active'['brightGreen'] : 'inactive'['brightRed']]);
+      }
+      printMessage(table.toString(), 'data');
+    } else {
+      for (const policy of policies) {
         printMessage(`${policy._id}`, 'data');
       }
     }
@@ -57,7 +89,7 @@ export async function listPoliciesByPolicySet(policySetId, long = false) {
  */
 export async function describePolicy(policyId, json = false) {
   let outcome = false;
-  const policySet = await frodo.authz.policy.getPolicy(policyId);
+  const policySet = await readPolicy(policyId);
   outcome = true;
   if (json) {
     printMessage(policySet, 'data');
@@ -73,23 +105,17 @@ export async function describePolicy(policyId, json = false) {
  * @param {string} policyId policy id/name
  * @returns {Promise<boolean>} true if successful, false otherwise
  */
-export async function deletePolicy(policyId) {
+export async function deletePolicyById(policyId) {
   debugMessage(`cli.PolicyOps.deletePolicy: begin`);
   showSpinner(`Deleting ${policyId}...`);
   let outcome = false;
-  const errors = [];
   try {
     debugMessage(`Deleting policy ${policyId}`);
-    await frodo.authz.policy.deletePolicy(policyId);
-  } catch (error) {
-    printMessage(`Error deleting policy ${policyId}: ${error}`, 'error');
-  }
-  if (errors.length) {
-    const errorMessages = errors.map(error => error.message).join('\n');
-    failSpinner(`Error deleting ${policyId}: ${errorMessages}`);
-  } else {
+    await deletePolicy(policyId);
     succeedSpinner(`Deleted ${policyId}.`);
     outcome = true;
+  } catch (error) {
+    failSpinner(`Error deleting policy ${policyId}: ${error}`);
   }
   debugMessage(`cli.PolicyOps.deletePolicy: end [outcome=${outcome}]`);
   return outcome;
@@ -104,26 +130,27 @@ export async function deletePolicies() {
   let outcome = false;
   const errors = [];
   let policies = [];
+  let indicatorId;
   try {
     showSpinner(`Retrieving all policies...`);
     try {
-      policies = await frodo.authz.policy.getPolicies();
+      policies = await readPolicies();
       succeedSpinner(`Found ${policies.length} policies.`);
     } catch (error) {
       error.message = `Error retrieving all policies: ${error.message}`;
       failSpinner(error.message);
       throw error;
     }
-    if (policies.length) createProgressBar(policies.length, `Deleting ${policies.length} policies...`);
+    if (policies.length) indicatorId = createProgressIndicator('determinate', policies.length, `Deleting ${policies.length} policies...`);
     for (const policy of policies) {
       const policyId = policy._id;
       try {
         debugMessage(`Deleting policy ${policyId}`);
-        await frodo.authz.policy.deletePolicy(policyId);
-        updateProgressBar(`Deleted ${policyId}`);
+        await deletePolicy(policyId);
+        updateProgressIndicator(indicatorId, `Deleted ${policyId}`);
       } catch (error) {
         error.message = `Error deleting policy ${policyId}: ${error}`;
-        updateProgressBar(error.message);
+        updateProgressIndicator(indicatorId, error.message);
         errors.push(error);
       }
     }
@@ -133,9 +160,9 @@ export async function deletePolicies() {
   } finally {
     if (errors.length) {
       const errorMessages = errors.map(error => error.message).join('\n');
-      if (policies.length) stopProgressBar(`Error deleting all policies: ${errorMessages}`);
+      if (policies.length) stopProgressIndicator(indicatorId, `Error deleting all policies: ${errorMessages}`);
     } else {
-      if (policies.length) stopProgressBar(`Deleted ${policies.length} policies.`);
+      if (policies.length) stopProgressIndicator(indicatorId, `Deleted ${policies.length} policies.`);
       outcome = true;
     }
   }
@@ -153,26 +180,27 @@ export async function deletePoliciesByPolicySet(policySetId) {
   let outcome = false;
   const errors = [];
   let policies = [];
+  let indicatorId;
   try {
     showSpinner(`Retrieving all policies from policy set ${policySetId}...`);
     try {
-      policies = await frodo.authz.policy.getPoliciesByPolicySet(policySetId);
+      policies = await readPoliciesByPolicySet(policySetId);
       succeedSpinner(`Found ${policies.length} policies in policy set ${policySetId}.`);
     } catch (error) {
       error.message = `Error retrieving all policies from policy set ${policySetId}: ${error.message}`;
       failSpinner(error.message);
       throw error;
     }
-    if (policies.length) createProgressBar(policies.length, `Deleting ${policies.length} policies from policy set ${policySetId}...`);
+    if (policies.length) indicatorId = createProgressIndicator('determinate', policies.length, `Deleting ${policies.length} policies from policy set ${policySetId}...`);
     for (const policy of policies) {
       const policyId = policy._id;
       try {
         debugMessage(`Deleting policy ${policyId}`);
-        await frodo.authz.policy.deletePolicy(policyId);
-        updateProgressBar(`Deleted ${policyId}`);
+        await deletePolicy(policyId);
+        updateProgressIndicator(indicatorId, `Deleted ${policyId}`);
       } catch (error) {
         error.message = `Error deleting policy ${policyId} from policy set ${policySetId}: ${error}`;
-        updateProgressBar(error.message);
+        updateProgressIndicator(indicatorId, error.message);
         errors.push(error);
       }
     }
@@ -182,9 +210,9 @@ export async function deletePoliciesByPolicySet(policySetId) {
   } finally {
     if (errors.length) {
       const errorMessages = errors.map(error => error.message).join('\n');
-      if (policies.length) stopProgressBar(`Error deleting all policies from policy set ${policySetId}: ${errorMessages}`);
+      if (policies.length) stopProgressIndicator(indicatorId, `Error deleting all policies from policy set ${policySetId}: ${errorMessages}`);
     } else {
-      if (policies.length) stopProgressBar(`Deleted ${policies.length} policies.`);
+      if (policies.length) stopProgressIndicator(indicatorId, `Deleted ${policies.length} policies.`);
       outcome = true;
     }
   }
@@ -196,10 +224,11 @@ export async function deletePoliciesByPolicySet(policySetId) {
  * Export policy to file
  * @param {string} policyId policy id/name
  * @param {string} file file name
+ * @param {boolean} includeMeta true to include metadata, false otherwise. Default: true
  * @param {ApplicationExportOptions} options export options
  * @returns {Promise<boolean>} true if successful, false otherwise
  */
-export async function exportPolicyToFile(policyId, file, options = {
+export async function exportPolicyToFile(policyId, file, includeMeta = true, options = {
   deps: true,
   prereqs: false,
   useStringArrays: true
@@ -212,9 +241,10 @@ export async function exportPolicyToFile(policyId, file, options = {
     if (file) {
       fileName = file;
     }
-    const exportData = await frodo.authz.policy.exportPolicy(policyId, options);
-    saveJsonToFile(exportData, fileName);
-    succeedSpinner(`Exported ${policyId} to ${fileName}.`);
+    const filePath = getFilePath(fileName, true);
+    const exportData = await exportPolicy(policyId, options);
+    saveJsonToFile(exportData, filePath, includeMeta);
+    succeedSpinner(`Exported ${policyId} to ${filePath}.`);
     outcome = true;
   } catch (error) {
     failSpinner(`Error exporting ${policyId}: ${error.message}`);
@@ -226,10 +256,11 @@ export async function exportPolicyToFile(policyId, file, options = {
 /**
  * Export policies to file
  * @param {string} file file name
+ * @param {boolean} includeMeta true to include metadata, false otherwise. Default: true
  * @param {PolicyExportOptions} options export options
  * @returns {Promise<boolean>} true if successful, false otherwise
  */
-export async function exportPoliciesToFile(file, options = {
+export async function exportPoliciesToFile(file, includeMeta = true, options = {
   deps: true,
   prereqs: false,
   useStringArrays: true
@@ -238,13 +269,14 @@ export async function exportPoliciesToFile(file, options = {
   debugMessage(`cli.PolicyOps.exportPoliciesToFile: begin`);
   showSpinner(`Exporting all policy sets...`);
   try {
-    let fileName = getTypedFilename(`all${titleCase(frodo.helper.utils.getRealmName(state.getRealm()))}Policies`, 'policy.authz');
+    let fileName = getTypedFilename(`all${titleCase(getRealmName(state.getRealm()))}Policies`, 'policy.authz');
     if (file) {
       fileName = file;
     }
-    const exportData = await frodo.authz.policy.exportPolicies(options);
-    saveJsonToFile(exportData, fileName);
-    succeedSpinner(`Exported all policy sets to ${fileName}.`);
+    const filePath = getFilePath(fileName, true);
+    const exportData = await exportPolicies(options);
+    saveJsonToFile(exportData, filePath, includeMeta);
+    succeedSpinner(`Exported all policy sets to ${filePath}.`);
     outcome = true;
   } catch (error) {
     failSpinner(`Error exporting policy sets: ${error.message}`);
@@ -257,10 +289,11 @@ export async function exportPoliciesToFile(file, options = {
  * Export policies to file
  * @param {string} policySetId policy set id/name
  * @param {string} file file name
+ * @param {boolean} includeMeta true to include metadata, false otherwise. Default: true
  * @param {PolicyExportOptions} options export options
  * @returns {Promise<boolean>} true if successful, false otherwise
  */
-export async function exportPoliciesByPolicySetToFile(policySetId, file, options = {
+export async function exportPoliciesByPolicySetToFile(policySetId, file, includeMeta = true, options = {
   deps: true,
   prereqs: false,
   useStringArrays: true
@@ -269,13 +302,14 @@ export async function exportPoliciesByPolicySetToFile(policySetId, file, options
   debugMessage(`cli.PolicyOps.exportPoliciesToFile: begin`);
   showSpinner(`Exporting all policy sets...`);
   try {
-    let fileName = getTypedFilename(`all${titleCase(frodo.helper.utils.getRealmName(state.getRealm())) + titleCase(policySetId)}Policies`, 'policy.authz');
+    let fileName = getTypedFilename(`all${titleCase(getRealmName(state.getRealm())) + titleCase(policySetId)}Policies`, 'policy.authz');
     if (file) {
       fileName = file;
     }
-    const exportData = await frodo.authz.policy.exportPoliciesByPolicySet(policySetId, options);
-    saveJsonToFile(exportData, fileName);
-    succeedSpinner(`Exported all policy sets to ${fileName}.`);
+    const filePath = getFilePath(fileName, true);
+    const exportData = await exportPoliciesByPolicySet(policySetId, options);
+    saveJsonToFile(exportData, filePath, includeMeta);
+    succeedSpinner(`Exported all policy sets to ${filePath}.`);
     outcome = true;
   } catch (error) {
     failSpinner(`Error exporting policy sets: ${error.message}`);
@@ -286,34 +320,36 @@ export async function exportPoliciesByPolicySetToFile(policySetId, file, options
 
 /**
  * Export all policies to separate files
+ * @param {boolean} includeMeta true to include metadata, false otherwise. Default: true
  * @param {PolicyExportOptions} options export options
  * @returns {Promise<boolean>} true if successful, false otherwise
  */
-export async function exportPoliciesToFiles(options = {
+export async function exportPoliciesToFiles(includeMeta = true, options = {
   deps: true,
   prereqs: false,
   useStringArrays: true
 }) {
   debugMessage(`cli.PolicyOps.exportPoliciesToFiles: begin`);
   const errors = [];
+  let indicatorId;
   try {
-    const policies = await frodo.authz.policy.getPolicies();
-    createProgressBar(policies.length, 'Exporting policy sets...');
+    const policies = await readPolicies();
+    indicatorId = createProgressIndicator('determinate', policies.length, 'Exporting policy sets...');
     for (const policy of policies) {
       const file = getTypedFilename(policy._id, 'policy.authz');
       try {
-        const exportData = await frodo.authz.policy.exportPolicy(policy._id, options);
-        saveJsonToFile(exportData, file);
-        updateProgressBar(`Exported ${policy._id}.`);
+        const exportData = await exportPolicy(policy._id, options);
+        saveJsonToFile(exportData, getFilePath(file, true), includeMeta);
+        updateProgressIndicator(indicatorId, `Exported ${policy._id}.`);
       } catch (error) {
         errors.push(error);
-        updateProgressBar(`Error exporting ${policy._id}.`);
+        updateProgressIndicator(indicatorId, `Error exporting ${policy._id}.`);
       }
     }
-    stopProgressBar(`Export complete.`);
+    stopProgressIndicator(indicatorId, `Export complete.`);
   } catch (error) {
     errors.push(error);
-    stopProgressBar(`Error exporting policy sets to files`);
+    stopProgressIndicator(indicatorId, `Error exporting policy sets to files`);
   }
   debugMessage(`cli.PolicyOps.exportPoliciesToFiles: end`);
   return 0 === errors.length;
@@ -321,34 +357,36 @@ export async function exportPoliciesToFiles(options = {
 
 /**
  * Export all policies to separate files
+ * @param {boolean} includeMeta true to include metadata, false otherwise. Default: true
  * @param {PolicyExportOptions} options export options
  * @returns {Promise<boolean>} true if successful, false otherwise
  */
-export async function exportPoliciesByPolicySetToFiles(policySetId, options = {
+export async function exportPoliciesByPolicySetToFiles(policySetId, includeMeta = true, options = {
   deps: true,
   prereqs: false,
   useStringArrays: true
 }) {
   debugMessage(`cli.PolicyOps.exportPoliciesToFiles: begin`);
   const errors = [];
+  let indicatorId;
   try {
-    const policies = await frodo.authz.policy.getPoliciesByPolicySet(policySetId);
-    createProgressBar(policies.length, `Exporting policies in policy set ${policySetId}...`);
+    const policies = await readPoliciesByPolicySet(policySetId);
+    indicatorId = createProgressIndicator('determinate', policies.length, `Exporting policies in policy set ${policySetId}...`);
     for (const policy of policies) {
       const file = getTypedFilename(policy._id, 'policy.authz');
       try {
-        const exportData = await frodo.authz.policy.exportPolicy(policy._id, options);
-        saveJsonToFile(exportData, file);
-        updateProgressBar(`Exported ${policy._id}.`);
+        const exportData = await exportPolicy(policy._id, options);
+        saveJsonToFile(exportData, getFilePath(file, true), includeMeta);
+        updateProgressIndicator(indicatorId, `Exported ${policy._id}.`);
       } catch (error) {
         errors.push(error);
-        updateProgressBar(`Error exporting ${policy._id}.`);
+        updateProgressIndicator(indicatorId, `Error exporting ${policy._id}.`);
       }
     }
-    stopProgressBar(`Export complete.`);
+    stopProgressIndicator(indicatorId, `Export complete.`);
   } catch (error) {
     errors.push(error);
-    stopProgressBar(`Error exporting policy sets to files`);
+    stopProgressIndicator(indicatorId, `Error exporting policy sets to files`);
   }
   debugMessage(`cli.PolicyOps.exportPoliciesToFiles: end`);
   return 0 === errors.length;
@@ -369,9 +407,9 @@ export async function importPolicyFromFile(policyId, file, options = {
   debugMessage(`cli.PolicyOps.importPolicyFromFile: begin`);
   showSpinner(`Importing ${policyId}...`);
   try {
-    const data = fs.readFileSync(file, 'utf8');
+    const data = fs.readFileSync(getFilePath(file), 'utf8');
     const fileData = JSON.parse(data);
-    await frodo.authz.policy.importPolicy(policyId, fileData, options);
+    await importPolicy(policyId, fileData, options);
     outcome = true;
     succeedSpinner(`Imported ${policyId}.`);
   } catch (error) {
@@ -394,15 +432,16 @@ export async function importFirstPolicyFromFile(file, options = {
 }) {
   let outcome = false;
   debugMessage(`cli.PolicySetOps.importFirstPolicyFromFile: begin`);
-  showSpinner(`Importing ${file}...`);
+  const filePath = getFilePath(file);
+  showSpinner(`Importing first policy from ${filePath}...`);
   try {
-    const data = fs.readFileSync(file, 'utf8');
+    const data = fs.readFileSync(filePath, 'utf8');
     const fileData = JSON.parse(data);
-    await frodo.authz.policy.importFirstPolicy(fileData, options);
+    const policy = await importFirstPolicy(fileData, options);
     outcome = true;
-    succeedSpinner(`Imported ${file}.`);
+    succeedSpinner(`Imported first policy with id '${policy._id}' from ${filePath}.`);
   } catch (error) {
-    failSpinner(`Error importing ${file}.`);
+    failSpinner(`Error importing first policy from ${filePath}.`);
     printMessage(error, 'error');
   }
   debugMessage(`cli.PolicySetOps.importFirstPolicyFromFile: end`);
@@ -421,15 +460,16 @@ export async function importPoliciesFromFile(file, options = {
 }) {
   let outcome = false;
   debugMessage(`cli.PolicyOps.importPoliciesFromFile: begin`);
-  showSpinner(`Importing ${file}...`);
+  const filePath = getFilePath(file);
+  showSpinner(`Importing ${filePath}...`);
   try {
-    const data = fs.readFileSync(file, 'utf8');
+    const data = fs.readFileSync(filePath, 'utf8');
     const fileData = JSON.parse(data);
-    await frodo.authz.policy.importPolicies(fileData, options);
+    await importPolicies(fileData, options);
     outcome = true;
-    succeedSpinner(`Imported ${file}${options.policySetName ? ' into policy set ' + options.policySetName : '.'}`);
+    succeedSpinner(`Imported ${filePath}${options.policySetName ? ' into policy set ' + options.policySetName : '.'}`);
   } catch (error) {
-    failSpinner(`Error importing ${file}${options.policySetName ? ' into policy set ' + options.policySetName : '.'}`);
+    failSpinner(`Error importing ${filePath}${options.policySetName ? ' into policy set ' + options.policySetName : '.'}`);
     printMessage(error, 'error');
   }
   debugMessage(`cli.PolicyOps.importPoliciesFromFile: end`);
@@ -446,11 +486,12 @@ export async function importPoliciesFromFiles(options = {
   prereqs: false
 }) {
   const errors = [];
+  let indicatorId;
   try {
     debugMessage(`cli.PolicyOps.importPoliciesFromFiles: begin`);
-    const names = fs.readdirSync('.');
-    const files = names.filter(name => name.toLowerCase().endsWith('.policy.authz.json'));
-    createProgressBar(files.length, 'Importing policies...');
+    const names = fs.readdirSync(getWorkingDirectory());
+    const files = names.filter(name => name.toLowerCase().endsWith('.policy.authz.json')).map(name => getFilePath(name));
+    indicatorId = createProgressIndicator('determinate', files.length, 'Importing policies...');
     let total = 0;
     for (const file of files) {
       try {
@@ -458,21 +499,21 @@ export async function importPoliciesFromFiles(options = {
         const fileData = JSON.parse(data);
         const count = Object.keys(fileData.policyset).length;
         total += count;
-        await frodo.authz.policy.importPolicies(fileData, options);
-        updateProgressBar(`Imported ${count} policies from ${file}`);
+        await importPolicies(fileData, options);
+        updateProgressIndicator(indicatorId, `Imported ${count} policies from ${file}`);
       } catch (error) {
         errors.push(error);
-        updateProgressBar(`Error importing policies from ${file}`);
+        updateProgressIndicator(indicatorId, `Error importing policies from ${file}`);
         printMessage(error, 'error');
       }
     }
-    stopProgressBar(`Finished importing ${total} policies from ${files.length} files.`);
+    stopProgressIndicator(indicatorId, `Finished importing ${total} policies from ${files.length} files.`);
   } catch (error) {
     errors.push(error);
-    stopProgressBar(`Error importing policies from files.`);
+    stopProgressIndicator(indicatorId, `Error importing policies from files.`);
     printMessage(error, 'error');
   }
   debugMessage(`cli.PolicyOps.importPoliciesFromFiles: end`);
   return 0 === errors.length;
 }
-//# sourceMappingURL=PolicyOps.js.map
+//# sourceMappingURL=PolicyOps.js.map