@rockcarver/frodo-cli 0.10.4 → 0.11.1-2

package/src/ops/utils/OpsUtils.js

@@ -1,76 +0,0 @@
-import storage from '../../storage/SessionStorage.js';
-import * as global from '../../storage/StaticStorage.js';
-
-// TODO: do we really need this? if yes: document
-export function escapeRegExp(str) {
-  return str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string
-}
-
-// TODO: do we really need this? if yes: document
-export function replaceAll(str, find, replace) {
-  return str.replace(new RegExp(escapeRegExp(find), 'g'), replace);
-}
-
-/**
- * Get new name when names collide
- * @param {String} name to apply policy to
- * @returns {String} new name according to policy
- */
-export function applyNameCollisionPolicy(name) {
-  const capturingRegex = /(.* - imported) \(([0-9]+)\)/;
-  const found = name.match(capturingRegex);
-  if (found && found.length > 0 && found.length === 3) {
-    // already renamed one or more times
-    // return the next number
-    return `${found[1]} (${parseInt(found[2], 10) + 1})`;
-  }
-  // first time
-  return `${name} - imported (1)`;
-}
-
-/**
- * Get the name of the managed user object for the current realm
- * @returns {String} the name of the managed user object for the current realm
- */
-export function getRealmManagedUser() {
-  let realmManagedUser = 'user';
-  if (
-    storage.session.getDeploymentType() === global.CLOUD_DEPLOYMENT_TYPE_KEY
-  ) {
-    realmManagedUser = `${storage.session.getRealm()}_user`;
-  }
-  return realmManagedUser;
-}
-
-/**
- * Compare two json objects
- * @param {Object} obj1 object 1
- * @param {Object} obj2 object 2
- * @param {[String]} ignoreKeys array of keys to ignore in comparison
- * @returns {boolean} true if the two json objects have the same length and all the properties have the same value
- */
-export function isEqualJson(obj1, obj2, ignoreKeys = []) {
-  const obj1Keys = Object.keys(obj1).filter((key) => !ignoreKeys.includes(key));
-  const obj2Keys = Object.keys(obj2).filter((key) => !ignoreKeys.includes(key));
-
-  if (obj1Keys.length !== obj2Keys.length) {
-    return false;
-  }
-
-  for (const objKey of obj1Keys) {
-    if (obj1[objKey] !== obj2[objKey]) {
-      if (
-        typeof obj1[objKey] === 'object' &&
-        typeof obj2[objKey] === 'object'
-      ) {
-        if (!isEqualJson(obj1[objKey], obj2[objKey], ignoreKeys)) {
-          return false;
-        }
-      } else {
-        return false;
-      }
-    }
-  }
-
-  return true;
-}

package/src/ops/utils/Wordwrap.js

@@ -1,11 +0,0 @@
-export default function wordwrap(str, len, indent = undefined) {
-  if (!str) return '';
-  return (
-    str.match(
-      new RegExp(
-        `(\\S.{0,${len - 1 - (indent ? indent.length : 0)}})(?=\\s+|$)`,
-        'g'
-      )
-    ) || []
-  ).join(indent ? `\n${indent}` : '\n');
-}

package/src/storage/SessionStorage.js

@@ -1,45 +0,0 @@
-/* eslint-disable no-return-assign */
-import fs from 'fs';
-// import pkg from '../../package.json' assert { type: 'json' };
-
-const pkg = JSON.parse(
-  fs.readFileSync(new URL('../../package.json', import.meta.url))
-);
-
-const _sessionStorage = {};
-
-export default {
-  session: {
-    setItem: (key, value) => (_sessionStorage[key] = value),
-    getItem: (key) => _sessionStorage[key],
-    removeItem: (key) => delete _sessionStorage[key],
-    raw: _sessionStorage,
-    setUsername: (value) => (_sessionStorage.username = value),
-    getUsername: () => _sessionStorage.username,
-    setPassword: (value) => (_sessionStorage.password = value),
-    getPassword: () => _sessionStorage.password,
-    setTenant: (value) => (_sessionStorage.tenant = value),
-    getTenant: () => _sessionStorage.tenant,
-    setDeploymentType: (value) => (_sessionStorage.deploymentType = value),
-    getDeploymentType: () => _sessionStorage.deploymentType,
-    setRealm: (value) => (_sessionStorage.realm = value),
-    getRealm: () => _sessionStorage.realm,
-    setCookieName: (value) => (_sessionStorage.cookieName = value),
-    getCookieName: () => _sessionStorage.cookieName,
-    setCookieValue: (value) => (_sessionStorage.cookieValue = value),
-    getCookieValue: () => _sessionStorage.cookieValue,
-    setBearerToken: (value) => (_sessionStorage.bearerToken = value),
-    getBearerToken: () => _sessionStorage.bearerToken,
-    setLogApiKey: (value) => (_sessionStorage.logApiKey = value),
-    getLogApiKey: () => _sessionStorage.logApiKey,
-    setLogApiSecret: (value) => (_sessionStorage.logApiSecret = value),
-    getLogApiSecret: () => _sessionStorage.logApiSecret,
-    setAmVersion: (value) => (_sessionStorage.amVersion = value),
-    getAmVersion: () => _sessionStorage.amVersion,
-    setFrodoVersion: (value) => (_sessionStorage.frodoVersion = value),
-    getFrodoVersion: () =>
-      _sessionStorage.frodoVersion || `v${pkg.version} [${process.version}]`,
-    setAllowInsecureConnection: (value) => (_sessionStorage.insecure = value),
-    getAllowInsecureConnection: () => _sessionStorage.insecure,
-  },
-};

package/test/client_cli/en/connections.test.js

@@ -1,62 +0,0 @@
-import cp from 'child_process';
-import { promisify } from 'util';
-
-const exec = promisify(cp.exec);
-const CMD = 'frodo connections --help';
-const { stdout } = await exec(CMD);
-
-test("CLI help interface for 'connections' Usage should be expected english", async () => {
-    // Arrange
-    const expected = `
-        Usage: frodo connections [options] [command]
-    `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('Usage:'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expected);
-});
-
-test("CLI help interface connections description at line 2 should be expected english", async () => {
-    // Arrange
-    const expected = `
-        Manage connection profiles.
-    `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .map(line => line.trim())
-        .at(2)
-    // Assert
-    expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'list' description should be expected english", async () => {
-    // Arrange
-    const expected = `
-        list                                         List configured connections.
-    `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('list'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'delete' description should be expected english", async () => {
-    // Arrange
-    const expected = `
-    delete <host>                                Delete an existing connection profile (can also be done by editing '$HOME/.frodorc' in a text editor).
-    `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('delete'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expected);
-});

package/test/client_cli/en/connections_add.test.js

@@ -1,34 +0,0 @@
-import cp from 'child_process';
-import { promisify } from 'util';
-
-const exec = promisify(cp.exec);
-const CMD = 'frodo connections add --help';
-const { stdout } = await exec(CMD);
-
-test("CLI help interface for 'add' Usage should be expected english", async () => {
-    // Arrange
-    const expected = `
-        Usage: frodo connections add [options] <host> <user> <password> [key] [secret]
-    `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('Usage:'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'connections add' description at line 2 should be expected english", async () => {
-    // Arrange
-    const expected = `
-    Add a new connection. You have to specify a URL, username and password at a minimum.
-    `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .map(line => line.trim())
-        .at(2)
-    // Assert
-    expect(testLine).toBe(expected);
-});

package/test/client_cli/en/connections_delete.test.js

@@ -1,34 +0,0 @@
-import cp from 'child_process';
-import { promisify } from 'util';
-
-const exec = promisify(cp.exec);
-const CMD = 'frodo connections delete --help';
-const { stdout } = await exec(CMD);
-
-test("CLI help interface for 'delete' Usage should be expected english", async () => {
-    // Arrange
-    const expected = `
-        Usage: frodo connections delete [options] <host>
-    `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('Usage:'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'connections delete' description at line 2 should be expected english", async () => {
-    // Arrange
-    const expected = `
-    Delete an existing connection profile (can also be done by editing '$HOME/.frodorc' in a text editor).
-    `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .map(line => line.trim())
-        .at(2)
-    // Assert
-    expect(testLine).toBe(expected);
-});

package/test/client_cli/en/connections_list.test.js

@@ -1,34 +0,0 @@
-import cp from 'child_process';
-import { promisify } from 'util';
-
-const exec = promisify(cp.exec);
-const CMD = 'frodo connections list --help';
-const { stdout } = await exec(CMD);
-
-test("CLI help interface for 'list' Usage should be expected english", async () => {
-    // Arrange
-    const expected = `
-        Usage: frodo connections list [options]
-    `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('Usage:'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'connections List' description at line 2 should be expected english", async () => {
-    // Arrange
-    const expected = `
-        List configured connections.
-    `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .map(line => line.trim())
-        .at(2)
-    // Assert
-    expect(testLine).toBe(expected);
-});

package/test/client_cli/en/email_templates.test.js

@@ -1,77 +0,0 @@
-import cp from 'child_process';
-import { promisify } from 'util';
-
-const exec = promisify(cp.exec);
-const CMD = 'frodo email_templates --help';
-const { stdout } = await exec(CMD);
-
-test("CLI help interface for 'email_templates' Usage should be expected english", async () => {
-    // Arrange
-    const expected = `
-        Usage: frodo email_templates [options] [command]
-    `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('Usage:'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expected);
-});
-
-
-test("CLI help interface 'email_templates' description at line 2 should be expected english", async () => {
-    // Arrange
-    const expected = `
-        Manage email templates.
-    `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .map(line => line.trim())
-        .at(2)
-    // Assert
-    expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'email_templates commands list' description should be expected english", async () => {
-    // Arrange
-    const expected = `
-        list [options] <host> [user] [password]    List all the email templates in the system.
-    `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('list'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'email_templates commands export' description should be expected english", async () => {
-    // Arrange
-    const expected = `
-        export [options] <host> [user] [password]  Export email templates.
-    `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('export'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'email_templates commands import' description should be expected english", async () => {
-    // Arrange
-    const expected = `
-        import [options] <host> [user] [password]  Import email template.
-    `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('import'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expected);
-});

package/test/client_cli/en/email_templates_export.test.js

@@ -1,196 +0,0 @@
-import cp from 'child_process';
-import { promisify } from 'util';
-import { crudeMultilineTakeUntil, collapseWhitespace } from '../utils/utils';
-
-const exec = promisify(cp.exec);
-const CMD = 'frodo email_templates export --help';
-const { stdout } = await exec(CMD);
-
-test("CLI help interface for 'email_templates export' Usage should be expected english", async () => {
-    // Arrange
-    const expected = `
-        Usage: frodo email_templates export [options] <host> [user] [password]
-    `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('Usage:'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'email_templates export' description at line 2 should be expected english", async () => {
-    // Arrange
-    const expected = `
-        Export email templates.
-    `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .map(line => line.trim())
-        .at(2)
-    // Assert
-    expect(testLine).toBe(expected);
-});
-
-
-test("CLI help interface 'export argument host' description should be expected english multiline", async () => {
-    // Arrange
-    const expected = collapseWhitespace(`
-    host                Access Management base URL, e.g.:
-                        https://cdk.iam.example.com/am. To use a connection
-                        profile, just specify a unique substring.
-    `);
-    // Act
-    const testLine = collapseWhitespace(crudeMultilineTakeUntil(
-        stdout,
-        '  host               ',
-        '  user              '
-    ));
-
-    // Assert
-    expect(testLine).toBe(expected);
-});
-
-
-test("CLI help interface 'export argument user' description should be expected english multiline", async () => {
-    // Arrange
-    const expected = collapseWhitespace(`
-        user                     Username to login with. Must be an admin user with appropriate
-                                 rights to manage authentication journeys/trees.
-    `);
-    // Act
-    const testLine = collapseWhitespace(crudeMultilineTakeUntil(
-        stdout,
-        '  user               ',
-        '  password           '
-    ));
-
-    // Assert
-    expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'export argument password' description should be expected english", async () => {
-    // Arrange
-    const expectedDescription = `
-        password                   Password.
-    `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('password'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expectedDescription);
-});
-
-test("CLI help interface 'export option -m, --type <type>' description should be expected english multiline", async () => {
-    // Arrange
-    const expected = collapseWhitespace(`
-    -m, --type <type>  Override auto-detected deployment type. Valid values for
-                       type:
-                       classic:  A classic Access Management-only deployment
-                       with custom layout and configuration.
-                       cloud:    A ForgeRock Identity Cloud environment.
-                       forgeops: A ForgeOps CDK or CDM deployment.
-                       The detected or provided deployment type controls certain
-                       behavior like obtaining an Identity Management admin
-                       token or not and whether to export/import referenced
-                       email templates or how to walk through the tenant admin
-                       login flow of Identity Cloud and handle MFA (choices:
-                       "classic", "cloud", "forgeops")
-    `);
-    // Act
-    const testLine = collapseWhitespace(crudeMultilineTakeUntil(
-        stdout,
-        '  -m, --type <type>  ',
-        '  -k, --insecure     '
-    ));
-
-    // Assert
-    expect(testLine).toBe(expected);
-});
-
-
-test("CLI help interface 'export option -k, --insecure' description should be expected english multiline", async () => {
-    // Arrange
-    const expected = collapseWhitespace(`
-        -k, --insecure           Allow insecure connections when using SSL/TLS (default: Don't
-                                 allow insecure connections)
-    `);
-    // Act
-    const testLine = collapseWhitespace(crudeMultilineTakeUntil(
-        stdout,
-        '  -k, --insecure         ',
-        '  -t, --template <template>  ',
-    ));
-
-    // Assert
-    expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'export option -t, --template <template>' description should be expected english multiline", async () => {
-    // Arrange
-    const expected = collapseWhitespace(`
-        -t, --template <template>  Name of email template. If specified, -a and -A
-                                   are ignored.
-    `);
-    // Act
-    const testLine = collapseWhitespace(crudeMultilineTakeUntil(
-        stdout,
-        ' -t, --template <template>  ',
-        ' -f, --file <file>  '
-    ));
-
-    // Assert
-    expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'export option -f, --file <file>' description should be expected english", async () => {
-    // Arrange
-    const expected = collapseWhitespace(`
-        -f, --file <file>  Name of the file to write the exported email template(s) to.
-                           Ignored with -A.
-    `);
-    // Act
-    const testLine = collapseWhitespace(crudeMultilineTakeUntil(
-        stdout,
-        ' -f, --file <file>  ',
-        ' -a, --all          '
-    ));
-    // Assert
-    expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'export option -a, --all' description should be expected english", async () => {
-    // Arrange
-    const expected = collapseWhitespace(`
-    -a, --all          Export all the email templates in the system. Ignored with
-                       -t.
-    `);
-    // Act
-    const testLine = collapseWhitespace(crudeMultilineTakeUntil(
-        stdout,
-        ' -a, --all          ',
-        ' -A, --allSeparate  ',
-    ));
-    // Assert
-    expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'export option -A, --allSeparate' description should be expected english", async () => {
-    // Arrange
-    const expected = collapseWhitespace(`
-        -A, --allSeparate  Export all the email templates as separate
-                           files <template>.json. Ignored with -s or -a.
-    `);
-    // Act
-    const testLine = collapseWhitespace(crudeMultilineTakeUntil(
-        stdout,
-        ' -A, --allSeparate  ',
-        '  -h, --help         ',
-    ));
-    // Assert
-    expect(testLine).toBe(expected);
-});