feat: Add config-manager push scripts command

src/cli/config-manager/config-manager-pull/config-manager-pull-scripts.ts

@@ -17,6 +17,7 @@ const deploymentTypes = [
   CLOUD_DEPLOYMENT_TYPE_KEY,
   FORGEOPS_DEPLOYMENT_TYPE_KEY,
 ];
+
 const { constants } = frodo.utils;
 const { readRealms } = frodo.realm;
 

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

@@ -0,0 +1,60 @@
+import { frodo } from '@rockcarver/frodo-lib';
+import { Option } from 'commander';
+
+import { configManagerImportScripts } from '../../../configManagerOps/FrConfigScriptOps';
+import { getTokens } from '../../../ops/AuthenticateOps';
+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 scripts',
+    deploymentTypes
+  );
+
+  program
+    .description('Import scripts to forgeops.')
+    .addOption(
+      new Option(
+        '-n, --name <name>',
+        'Script name, import only specified endpoint'
+      )
+    )
+    .addOption(
+      new Option(
+        '-r, --realm <realm>',
+        'Realm name, import only specified realm'
+      )
+    );
+
+  program.action(async (host, realm, user, password, options, command) => {
+    command.handleDefaultArgsAndOpts(
+      host,
+      realm,
+      user,
+      password,
+      options,
+      command
+    );
+
+    if (!(await getTokens(false, true, deploymentTypes))) {
+      process.exitCode = 1;
+      return;
+    }
+
+    const outcome = await configManagerImportScripts(
+      options.realm,
+      options.name
+    );
+    if (!outcome) process.exitCode = 1;
+  });
+
+  return program;
+}

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

@@ -15,6 +15,7 @@ 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 Scripts from './config-manager-push-scripts';
 import TermsAndConditions from './config-manager-push-terms-and-conditions';
 import Themes from './config-manager-push-themes';
 import UiConfig from './config-manager-push-ui-config';
@@ -43,6 +44,6 @@ export default function setup() {
   program.addCommand(UiConfig().name('ui-config'));
   program.addCommand(Authentication().name('authentication'));
   program.addCommand(ConnectorDefinitions().name('connector-definitions'));
-
+  program.addCommand(Scripts().name('scripts'));
   return program;
 }

src/configManagerOps/FrConfigScriptOps.ts

@@ -1,12 +1,13 @@
 import { frodo, state } from '@rockcarver/frodo-lib';
 import { ScriptSkeleton } from '@rockcarver/frodo-lib/types/api/ScriptApi';
+import fs from 'fs';
 
 import { printError, verboseMessage } from '../utils/Console';
 import { realmList, safeFileName } from '../utils/FrConfig';
 
 const { getFilePath, saveJsonToFile, decodeBase64, saveTextToFile } =
   frodo.utils;
-const { readScripts, readScriptByName } = frodo.script;
+const { readScripts, readScriptByName, importScripts } = frodo.script;
 
 type ByName = { scriptName: string };
 type BySkeleton = { ss: ScriptSkeleton };
@@ -219,3 +220,57 @@ export async function configManagerExportScriptsAll(
     return false;
   }
 }
+
+/**
+ * Import script in fr-config-manager format
+ * @param realm option to determine which realm to import
+ * @param name option to import a specific script by name
+ * @returns True if Import was successful
+ */
+export async function configManagerImportScripts(
+  realmName?: string,
+  name?: string
+): Promise<boolean> {
+  try {
+    const realmsDir = getFilePath('realms/');
+    const realms: string[] = realmName
+      ? [realmName]
+      : fs
+          .readdirSync(realmsDir, { withFileTypes: true })
+          .filter((entry) => entry.isDirectory())
+          .map((entry) => entry.name);
+
+    for (const realm of realms) {
+      if (!realmName) state.setRealm(realm);
+
+      const configDir = getFilePath(`realms/${realm}/scripts/scripts-config/`);
+
+      const configFiles = name ? [name] : fs.readdirSync(configDir);
+
+      const scripts = { script: {} };
+
+      for (const file of configFiles) {
+        try {
+          const configPath = `${configDir}/${file}`;
+          if (!fs.existsSync(configPath)) continue;
+          const importData = JSON.parse(fs.readFileSync(configPath, 'utf8'));
+          const fullScriptPath = getFilePath(
+            `realms/${realm}/scripts/${importData.script.file}`
+          );
+          delete importData.script.file;
+          importData.script = fs.readFileSync(fullScriptPath, 'utf8');
+          scripts.script[importData._id] = importData;
+        } catch (error) {
+          printError(error);
+        }
+      }
+
+      await importScripts(null, null, scripts);
+    }
+
+    return true;
+  } catch (error) {
+    printError(error);
+    return false;
+  }
+}

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

@@ -0,0 +1,28 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`CLI help interface for 'config-manager push scripts' should be expected english 1`] = `
+"Usage: frodo config-manager push scripts [options] [host] [realm] [username] [password]
+
+[Experimental] Import scripts to forgeops.
+
+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:
+  -n, --name <name>    Script name, import only specified endpoint
+  -r, --realm <realm>  Realm name, import only specified realm
+  -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

@@ -29,6 +29,7 @@ Commands:
   org-privileges         [Experimental] Import organization privileges config.
   password-policy        [Experimental] Import password-policy objects.
   schedules              [Experimental] Import schedules.
+  scripts                [Experimental] Import scripts to forgeops.
   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-scripts.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 scripts --help';
+const { stdout } = await exec(CMD);
+
+test("CLI help interface for 'config-manager push scripts' should be expected english", async () => {
+    expect(stdout).toMatchSnapshot();
+});

test/e2e/__snapshots__/config-manager-push-scripts.e2e.test.js.snap

@@ -0,0 +1,7 @@
+// Jest Snapshot v1, https://goo.gl/fbAQLP
+
+exports[`frodo config-manager push schedules "frodo config-manager push scripts -D test/e2e/exports/fr-config-manager/forgeops -m forgeops": should import the scripts into forgeops" 1`] = `""`;
+
+exports[`frodo config-manager push schedules "frodo config-manager push scripts -n 832807d9-fb5d-4810-88ef-6e0a1aa89924 -D test/e2e/exports/fr-config-manager/forgeops -m forgeops": should import the scripts into forgeops" 1`] = `""`;
+
+exports[`frodo config-manager push schedules "frodo config-manager push scripts -r alpha -D test/e2e/exports/fr-config-manager/forgeops -m forgeops": should import the scripts into forgeops" 1`] = `""`;

test/e2e/config-manager-push-scripts.e2e.test.js

@@ -0,0 +1,87 @@
+/**
+ * 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 scripts -D test/e2e/exports/fr-config-manager/forgeops -m forgeops
+FRODO_MOCK=record FRODO_NO_CACHE=1 FRODO_HOST=https://nightly.gcp.forgeops.com/am frodo config-manager push scripts -r alpha -D test/e2e/exports/fr-config-manager/forgeops -m forgeops
+FRODO_MOCK=record FRODO_NO_CACHE=1 FRODO_HOST=https://nightly.gcp.forgeops.com/am frodo config-manager push scripts -n 832807d9-fb5d-4810-88ef-6e0a1aa89924.json -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 schedules', () => {
+    test(`"frodo config-manager push scripts -D ${allDirectory} -m forgeops": should import the scripts into forgeops"`, async () => {
+        const CMD = `frodo config-manager push scripts -D ${allDirectory} -m forgeops`;
+        const { stdout } = await exec(CMD, forgeopsEnv);
+        expect(removeAnsiEscapeCodes(stdout)).toMatchSnapshot();
+    });
+    test(`"frodo config-manager push scripts -r alpha -D ${allDirectory} -m forgeops": should import the scripts into forgeops"`, async () => {
+        const CMD = `frodo config-manager push scripts -D ${allDirectory} -m forgeops`;
+        const { stdout } = await exec(CMD, forgeopsEnv);
+        expect(removeAnsiEscapeCodes(stdout)).toMatchSnapshot();
+    });
+    test(`"frodo config-manager push scripts -n 832807d9-fb5d-4810-88ef-6e0a1aa89924 -D ${allDirectory} -m forgeops": should import the scripts into forgeops"`, async () => {
+        const CMD = `frodo config-manager push scripts -D ${allDirectory} -m forgeops`;
+        const { stdout } = await exec(CMD, forgeopsEnv);
+        expect(removeAnsiEscapeCodes(stdout)).toMatchSnapshot();
+    });
+});

test/e2e/exports/fr-config-manager/forgeops/realms/alpha/scripts/scripts-config/832807d9-fb5d-4810-88ef-6e0a1aa89924.json

@@ -0,0 +1,16 @@
+{
+  "_id": "832807d9-fb5d-4810-88ef-6e0a1aa89924",
+  "context": "SCRIPTED_DECISION_NODE",
+  "createdBy": "id=amadmin,ou=user,ou=am-config",
+  "creationDate": 1774470672858,
+  "default": false,
+  "description": "testing",
+  "evaluatorVersion": "2.0",
+  "language": "JAVASCRIPT",
+  "lastModifiedBy": "id=amadmin,ou=user,ou=am-config",
+  "lastModifiedDate": 1774470672858,
+  "name": "testing",
+  "script": {
+    "file": "scripts-content/SCRIPTED_DECISION_NODE/testing.js"
+  }
+}

test/e2e/exports/fr-config-manager/forgeops/realms/alpha/scripts/scripts-content/SCRIPTED_DECISION_NODE/testing.js

@@ -0,0 +1,6 @@
+/*
+  - Data made available by nodes that have already executed are available in the sharedState variable.
+  - The script should set outcome to either "true" or "false".
+ */
+
+// outcome = "true";

test/e2e/exports/fr-config-manager/forgeops/realms/bravo/scripts/scripts-config/01e1a3c0-038b-4c16-956a-6c9d89328cff.json

@@ -0,0 +1,16 @@
+{
+  "_id": "01e1a3c0-038b-4c16-956a-6c9d89328cff",
+  "context": "AUTHENTICATION_TREE_DECISION_NODE",
+  "createdBy": "null",
+  "creationDate": 0,
+  "default": true,
+  "description": "Default global script for a scripted decision node",
+  "evaluatorVersion": "1.0",
+  "language": "JAVASCRIPT",
+  "lastModifiedBy": "null",
+  "lastModifiedDate": 0,
+  "name": "Authentication Tree Decision Node Script",
+  "script": {
+    "file": "scripts-content/AUTHENTICATION_TREE_DECISION_NODE/Authentication Tree Decision Node Script.js"
+  }
+}

test/e2e/exports/fr-config-manager/forgeops/realms/bravo/scripts/scripts-content/AUTHENTICATION_TREE_DECISION_NODE/Authentication Tree Decision Node Script.js

@@ -0,0 +1,6 @@
+/*
+  - Data made available by nodes that have already executed are available in the sharedState variable.
+  - The script should set outcome to either "true" or "false".
+ */
+
+outcome = "true";