feat: Add config-manager-push service-object command

src/cli/config-manager/config-manager-push/config-manager-push-service-objects.ts

@@ -0,0 +1,51 @@
+import { frodo } from '@rockcarver/frodo-lib';
+
+import { configManagerImportServiceObjects } from '../../../configManagerOps/FrConfigServiceObjectsOps';
+import { getTokens } from '../../../ops/AuthenticateOps';
+import { printMessage, verboseMessage } from '../../../utils/Console';
+import { FrodoCommand } from '../../FrodoCommand';
+
+const { CLOUD_DEPLOYMENT_TYPE_KEY, FORGEOPS_DEPLOYMENT_TYPE_KEY } =
+  frodo.utils.constants;
+
+const deploymentTypes = [
+  CLOUD_DEPLOYMENT_TYPE_KEY,
+  FORGEOPS_DEPLOYMENT_TYPE_KEY,
+];
+
+export default function setup() {
+  const program = new FrodoCommand(
+    'frodo config-manager push service-objects',
+    [],
+    deploymentTypes
+  );
+
+  program
+    .description('Import service objects.')
+
+    .action(async (host, realm, user, password, options, command) => {
+      command.handleDefaultArgsAndOpts(
+        host,
+        realm,
+        user,
+        password,
+        options,
+        command
+      );
+
+      if (await getTokens(false, true, deploymentTypes)) {
+        verboseMessage('Importing service objects');
+        const outcome = await configManagerImportServiceObjects();
+        if (!outcome) process.exitCode = 1;
+      } else {
+        printMessage(
+          'Unrecognized combination of options or no options...',
+          'error'
+        );
+        program.help();
+        process.exitCode = 1;
+      }
+    });
+
+  return program;
+}

src/cli/config-manager/config-manager-push/config-manager-push.ts

@@ -8,6 +8,7 @@ import Locales from './config-manager-push-locales';
 import OrgPrivileges from './config-manager-push-org-privileges';
 import PasswordPolicy from './config-manager-push-password-policy';
 import Schedules from './config-manager-push-schedules';
+import ServiceObjects from './config-manager-push-service-objects';
 import TermsAndConditions from './config-manager-push-terms-and-conditions';
 import Themes from './config-manager-push-themes';
 
@@ -27,6 +28,6 @@ export default function setup() {
   program.addCommand(EmailTemplates().name('email-templates'));
   program.addCommand(Schedules().name('schedules'));
   program.addCommand(OrgPrivileges().name('org-privileges'));
-
+  program.addCommand(ServiceObjects().name('service-objects'));
   return program;
 }

src/configManagerOps/FrConfigServiceObjectsOps.ts

@@ -4,7 +4,7 @@ import fs from 'fs';
 import { printError } from '../utils/Console';
 
 const { getFilePath, saveJsonToFile } = frodo.utils;
-const { queryManagedObjects } = frodo.idm.managed;
+const { queryManagedObjects, updateManagedObject } = frodo.idm.managed;
 /**
  * Export an IDM configuration object in the fr-config-manager format.
  * @param {string} envFile File that defines environment specific variables for replacement during configuration export/import
@@ -117,3 +117,29 @@ export async function configManagerExportServiceObject(
     printError(err, `Error exporting object`);
   }
 }
+export async function configManagerImportServiceObjects(): Promise<boolean> {
+  try {
+    const objectsDir = getFilePath('service-objects/');
+    const objectTypes = fs.readdirSync(objectsDir);
+
+    for (const objectType of objectTypes) {
+      const objectPath = `${objectsDir}/${objectType}`;
+      const objectFiles = fs.readdirSync(objectPath);
+
+      for (const objectFile of objectFiles) {
+        const fullPath = `${objectPath}/${objectFile}`;
+        const readFiles = fs.readFileSync(fullPath, 'utf8');
+        const importData = JSON.parse(readFiles);
+        delete importData._rev;
+        delete importData._refProperties;
+
+        await updateManagedObject(objectType, importData._id, importData);
+      }
+    }
+
+    return true;
+  } catch (err) {
+    printError(err, `Error importing service-objects`);
+  }
+  return false;
+}

test/client_cli/en/__snapshots__/config-manager-push-service-objects.test.js.snap

@@ -0,0 +1,25 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`CLI help interface for 'config-manager push service-objects' should be expected english 1`] = `
+"Usage: frodo config-manager push service-objects [options] [host] [realm] [username] [password]
+
+[Experimental] Import service objects.
+
+Arguments:
+  host              AM base URL, e.g.: https://cdk.iam.example.com/am. To use a
+                    connection profile, just specify a unique substring or
+                    alias.
+  realm             Realm. Specify realm as '/' for the root realm or 'realm' or
+                    '/parent/child' otherwise. (default: "alpha" for Identity
+                    Cloud tenants, "/" otherwise.)
+  username          Username to login with. Must be an admin user with
+                    appropriate rights to manage authentication journeys/trees.
+  password          Password.
+
+Options:
+  -h, --help        Help
+  -hh, --help-more  Help with all options.
+  -hhh, --help-all  Help with all options, environment variables, and usage
+                    examples.
+"
+`;

test/client_cli/en/__snapshots__/config-manager-push.test.js.snap

@@ -23,6 +23,7 @@ Commands:
   org-privileges        [Experimental] Import organization privileges config.
   password-policy       [Experimental] Import password-policy objects.
   schedules             [Experimental] Import schedules.
+  service-objects       [Experimental] Import service objects.
   terms-and-conditions  [Experimental] Import terms and conditions.
   themes                [Experimental] Import themes.
 "

test/client_cli/en/config-manager-push-service-objects.test.js

@@ -0,0 +1,10 @@
+import cp from 'child_process';
+import { promisify } from 'util';
+
+const exec = promisify(cp.exec);
+const CMD = 'frodo config-manager push service-objects --help';
+const { stdout } = await exec(CMD);
+
+test("CLI help interface for 'config-manager push service-objects' should be expected english", async () => {
+    expect(stdout).toMatchSnapshot();
+});

test/e2e/__snapshots__/config-manager-push-service-objects.e2e.test.js.snap

@@ -0,0 +1,3 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`frodo config-manager push service-objects "frodo config-manager push service-objects -D test/e2e/exports/fr-config-manager/forgeops -m forgeops": should import the service objects into forgeops" 1`] = `""`;

test/e2e/config-manager-push-service-objects.e2e.test.js

@@ -0,0 +1,72 @@
+/**
+ * Follow this process to write e2e tests for the CLI project:
+ *
+ * 1. Test if all the necessary mocks for your tests already exist.
+ *    In mock mode, run the command you want to test with the same arguments
+ *    and parameters exactly as you want to test it, for example:
+ *
+ *    $ FRODO_MOCK=1 frodo conn save https://openam-frodo-dev.forgeblocks.com/am volker.scheuber@forgerock.com Sup3rS3cr3t!
+ *
+ *    If your command completes without errors and with the expected results,
+ *    all the required mocks already exist and you are good to write your
+ *    test and skip to step #4.
+ *
+ *    If, however, your command fails and you see errors like the one below,
+ *    you know you need to record the mock responses first:
+ *
+ *    [Polly] [adapter:node-http] Recording for the following request is not found and `recordIfMissing` is `false`.
+ *
+ * 2. Record mock responses for your exact command.
+ *    In mock record mode, run the command you want to test with the same arguments
+ *    and parameters exactly as you want to test it, for example:
+ *
+ *    $ FRODO_MOCK=record frodo conn save https://openam-frodo-dev.forgeblocks.com/am volker.scheuber@forgerock.com Sup3rS3cr3t!
+ *
+ *    Wait until you see all the Polly instances (mock recording adapters) have
+ *    shutdown before you try to run step #1 again.
+ *    Messages like these indicate mock recording adapters shutting down:
+ *
+ *    Polly instance 'conn/4' stopping in 3s...
+ *    Polly instance 'conn/4' stopping in 2s...
+ *    Polly instance 'conn/save/3' stopping in 3s...
+ *    Polly instance 'conn/4' stopping in 1s...
+ *    Polly instance 'conn/save/3' stopping in 2s...
+ *    Polly instance 'conn/4' stopped.
+ *    Polly instance 'conn/save/3' stopping in 1s...
+ *    Polly instance 'conn/save/3' stopped.
+ *
+ * 3. Validate your freshly recorded mock responses are complete and working.
+ *    Re-run the exact command you want to test in mock mode (see step #1).
+ *
+ * 4. Write your test.
+ *    Make sure to use the exact command including number of arguments and params.
+ *
+ * 5. Commit both your test and your new recordings to the repository.
+ *    Your tests are likely going to reside outside the frodo-lib project but
+ *    the recordings must be committed to the frodo-lib project.
+ */
+
+/*
+// ForgeOps
+FRODO_MOCK=record FRODO_NO_CACHE=1 FRODO_HOST=https://nightly.gcp.forgeops.com/am frodo config-manager push service-objects -D test/e2e/exports/fr-config-manager/forgeops -m forgeops
+*/
+
+import cp from 'child_process';
+import { promisify } from 'util';
+import { getEnv, removeAnsiEscapeCodes } from './utils/TestUtils';
+import { forgeops_connection as fc } from './utils/TestConfig';
+
+const exec = promisify(cp.exec);
+
+process.env['FRODO_MOCK'] = '1';
+const forgeopsEnv = getEnv(fc);
+
+const allDirectory = "test/e2e/exports/fr-config-manager/forgeops";
+
+describe('frodo config-manager push service-objects', () => {
+    test(`"frodo config-manager push service-objects -D ${allDirectory} -m forgeops": should import the service objects into forgeops"`, async () => {
+        const CMD = `frodo config-manager push service-objects -D ${allDirectory} -m forgeops`;
+        const { stdout } = await exec(CMD, forgeopsEnv);
+        expect(removeAnsiEscapeCodes(stdout)).toMatchSnapshot();
+    });
+});

test/e2e/exports/fr-config-manager/forgeops/service-objects/role/Test B Role.json

@@ -0,0 +1,5 @@
+{
+  "_id": "2d1d7733-bbe2-4a22-a24e-b8f28f377bab",
+  "_rev": "3bd23670-309b-4186-a573-cf8bda235ea1-278",
+  "name": "Test B Role"
+}

test/e2e/exports/fr-config-manager/forgeops/service-objects/role/test Role.json

@@ -0,0 +1,5 @@
+{
+  "_id": "74a2bb8d-2783-4885-941e-7398b1104fe1",
+  "_rev": "3bd23670-309b-4186-a573-cf8bda235ea1-274",
+  "name": "test Role"
+}

test/e2e/exports/fr-config-manager/forgeops/service-objects/user/aTest.json

@@ -0,0 +1,8 @@
+{
+  "_id": "2a289273-5240-49d1-b6dc-0fa41eb4c45f",
+  "_rev": "3bd23670-309b-4186-a573-cf8bda235ea1-165",
+  "givenName": "anotehr",
+  "mail": "test@email.com",
+  "sn": "test",
+  "userName": "aTest"
+}

test/e2e/exports/fr-config-manager/forgeops/service-objects/user/test.json

@@ -0,0 +1,8 @@
+{
+  "_id": "8ce6f2da-c02c-43e3-9689-7d9b10254f49",
+  "_rev": "969db80c-7f5b-45b6-b594-0c3ba684d6e6-8067",
+  "givenName": "test",
+  "mail": "test@email.com",
+  "sn": "user",
+  "userName": "test"
+}