@rockcarver/frodo-cli 0.11.1-0 → 0.11.1-1

package/test/client_cli/en/script-export.test.js

@@ -1,230 +0,0 @@
-import cp from 'child_process';
-import { promisify } from 'util';
-import {
-  crudeMultilineTakeUntil,
-  collapseWhitespace,
-  node14Compatibility,
-} from '../utils/utils.js';
-
-node14Compatibility();
-
-const exec = promisify(cp.exec);
-const CMD = 'frodo script export --help';
-const { stdout } = await exec(CMD);
-
-test("CLI help interface for 'script export' Usage should be expected english", async () => {
-  // Arrange
-  const expected = `
-        Usage: frodo script export [options] <host> [realm] [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 'script export' description at line 2 should be expected english", async () => {
-  // Arrange
-  const expected = `
-        Export scripts.
-    `.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               ',
-      '  realm              '
-    )
-  );
-
-  // Assert
-  expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'export argument realm' description should be expected english multiline", async () => {
-  // Arrange
-  const expected = collapseWhitespace(`
-  realm Realm. Specify realm as '/' for the root realm or 'realm' or '/parent/child' otherwise. (default: "alpha" for Identity Cloud tenants, "/" otherwise.)
-    `);
-  // Act
-  const testLine = collapseWhitespace(
-    crudeMultilineTakeUntil(
-      stdout,
-      '  realm              ',
-      '  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. Has no effect when using a network proxy for https
-  (HTTPS_PROXY=http://<host>:<port>), in that case the proxy must provide this capability. (default: Don't
-  allow insecure connections)
-    `);
-  // Act
-  const testLine = collapseWhitespace(
-    crudeMultilineTakeUntil(
-      stdout,
-      '  -k, --insecure            ',
-      '  -n, --script-name <name>  '
-    )
-  );
-
-  // Assert
-  expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'export option -s, --script <script>' description should be expected english multiline", async () => {
-  // Arrange
-  const expected = collapseWhitespace(`
-  -n, --script-name <name> Name of the script. If specified, -a and -A are ignored.
-    `);
-  // Act
-  const testLine = collapseWhitespace(
-    crudeMultilineTakeUntil(
-      stdout,
-      ' -n, --script-name <name>  ',
-      ' -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 export file.
-    `);
-  // 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 scripts to a single file. Ignored with -i.
-    `);
-  // Act
-  const testLine = collapseWhitespace(
-    crudeMultilineTakeUntil(
-      stdout,
-      ' -a, --all          ',
-      ' -A, --all-separate  '
-    )
-  );
-  // Assert
-  expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'export option -A, --all-separate' description should be expected english", async () => {
-  // Arrange
-  const expected = collapseWhitespace(`
-  -A, --all-separate Export all scripts to separate files (*.script.json) in the current directory. Ignored with -i or -a.
-    `);
-  // Act
-  const testLine = collapseWhitespace(
-    crudeMultilineTakeUntil(
-      stdout,
-      '  -A, --all-separate        ',
-      '  -s, --script <script>     '
-    )
-  );
-  // Assert
-  expect(testLine).toBe(expected);
-});

package/test/client_cli/en/script-import.test.js

@@ -1,176 +0,0 @@
-import cp from 'child_process';
-import { promisify } from 'util';
-import {
-  crudeMultilineTakeUntil,
-  collapseWhitespace,
-  node14Compatibility,
-} from '../utils/utils.js';
-
-node14Compatibility();
-
-const exec = promisify(cp.exec);
-const CMD = 'frodo script import --help';
-const { stdout } = await exec(CMD);
-
-test("CLI help interface for 'script import' Usage should be expected english", async () => {
-  // Arrange
-  const expected = `
-        Usage: frodo script import [options] <host> [realm] [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 'script import' description at line 2 should be expected english", async () => {
-  // Arrange
-  const expected = `
-        Import scripts.
-    `.trim();
-  // Act
-  const testLine = stdout
-    .split(/\n/)
-    .map((line) => line.trim())
-    .at(2);
-  // Assert
-  expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'import 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               ',
-      '  realm              '
-    )
-  );
-
-  // Assert
-  expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'import argument realm' description should be expected english multiline", async () => {
-  // Arrange
-  const expected = collapseWhitespace(`
-  realm Realm. Specify realm as '/' for the root realm or 'realm' or '/parent/child' otherwise. (default: "alpha" for Identity Cloud tenants, "/" otherwise.)
-    `);
-  // Act
-  const testLine = collapseWhitespace(
-    crudeMultilineTakeUntil(
-      stdout,
-      '  realm              ',
-      '  user               '
-    )
-  );
-
-  // Assert
-  expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'import 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 'import 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 'import 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 'import option -k, --insecure' description should be expected english multiline", async () => {
-  // Arrange
-  const expected = collapseWhitespace(`
-  -k, --insecure Allow insecure connections when using SSL/TLS. Has no effect when using a network proxy for https (HTTPS_PROXY=http://<host>:<port>), in that case the proxy must provide this capability. (default: Don't allow insecure connections)
-    `);
-  // Act
-  const testLine = collapseWhitespace(
-    crudeMultilineTakeUntil(
-      stdout,
-      '  -k, --insecure     ',
-      '  -f, --file <file>  '
-    )
-  );
-
-  // Assert
-  expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'import option -f, --file <file>' description should be expected english", async () => {
-  // Arrange
-  const expected = collapseWhitespace(`
-  -f, --file <file>         Name of the file to import.
-    `);
-  // Act
-  const testLine = collapseWhitespace(
-    crudeMultilineTakeUntil(
-      stdout,
-      '  -f, --file <file>         ',
-      '  -n, --script-name <name>  '
-    )
-  );
-  // Assert
-  expect(testLine).toBe(expected);
-});

package/test/client_cli/en/script-list.test.js

@@ -1,159 +0,0 @@
-import cp from 'child_process';
-import { promisify } from 'util';
-import {
-  crudeMultilineTakeUntil,
-  collapseWhitespace,
-  node14Compatibility,
-} from '../utils/utils.js';
-
-node14Compatibility();
-
-const exec = promisify(cp.exec);
-const CMD = 'frodo script list --help';
-const { stdout } = await exec(CMD);
-
-test("CLI help interface for 'script list' Usage should be expected english", async () => {
-  // Arrange
-  const expected = `
-        Usage: frodo script list [options] <host> [realm] [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 'script list' description at line 2 should be expected english", async () => {
-  // Arrange
-  const expected = `
-  List scripts.
-    `.trim();
-  // Act
-  const testLine = stdout
-    .split(/\n/)
-    .map((line) => line.trim())
-    .at(2);
-  // Assert
-  expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'list 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               ',
-      '  realm              '
-    )
-  );
-
-  // Assert
-  expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'list argument realm' description should be expected english multiline", async () => {
-  // Arrange
-  const expected = collapseWhitespace(`
-  realm Realm. Specify realm as '/' for the root realm or 'realm' or '/parent/child' otherwise. (default: "alpha" for Identity Cloud tenants, "/" otherwise.)
-    `);
-  // Act
-  const testLine = collapseWhitespace(
-    crudeMultilineTakeUntil(
-      stdout,
-      '  realm              ',
-      '  user               '
-    )
-  );
-
-  // Assert
-  expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'list 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 'list 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 'list 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 'list option -k, --insecure' description should be expected english multiline", async () => {
-  // Arrange
-  const expected = collapseWhitespace(`
-  -k, --insecure Allow insecure connections when using SSL/TLS. Has no effect when using a network proxy for https (HTTPS_PROXY=http://<host>:<port>), in that case the proxy must provide this capability. (default: Don't allow insecure connections) -l, --long Long with all fields. (default: false)
-    `);
-  // Act
-  const testLine = collapseWhitespace(
-    crudeMultilineTakeUntil(
-      stdout,
-      '  -k, --insecure     ',
-      '  -h, --help         '
-    )
-  );
-
-  // Assert
-  expect(testLine).toBe(expected);
-});

package/test/client_cli/en/script.test.js

@@ -1,79 +0,0 @@
-import cp from 'child_process';
-import { promisify } from 'util';
-import { node14Compatibility } from '../utils/utils.js';
-
-node14Compatibility();
-
-const exec = promisify(cp.exec);
-const CMD = 'frodo script --help';
-const { stdout } = await exec(CMD);
-
-test("CLI help interface for 'script' Usage should be expected english", async () => {
-  // Arrange
-  const expected = `
-        Usage: frodo script [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 'script' description at line 2 should be expected english", async () => {
-  // Arrange
-  const expected = `
-        Manage scripts.
-    `.trim();
-  // Act
-  const testLine = stdout
-    .split(/\n/)
-    .map((line) => line.trim())
-    .at(2);
-  // Assert
-  expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'script commands list' description should be expected english", async () => {
-  // Arrange
-  const expected = `
-  list            List scripts.
-    `.trim();
-  // Act
-  const testLine = stdout
-    .split(/\n/)
-    .find((line) => line.trim().startsWith('list'))
-    .trim();
-  // Assert
-  expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'script commands export' description should be expected english", async () => {
-  // Arrange
-  const expected = `
-  export          Export scripts.
-    `.trim();
-  // Act
-  const testLine = stdout
-    .split(/\n/)
-    .find((line) => line.trim().startsWith('export'))
-    .trim();
-  // Assert
-  expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'script commands import' description should be expected english", async () => {
-  // Arrange
-  const expected = `
-  import          Import scripts.
-    `.trim();
-  // Act
-  const testLine = stdout
-    .split(/\n/)
-    .find((line) => line.trim().startsWith('import'))
-    .trim();
-  // Assert
-  expect(testLine).toBe(expected);
-});

package/test/client_cli/utils/utils.js

@@ -1,63 +0,0 @@
-/* eslint-disable no-param-reassign */
-/**
- * @file A collection of slightly rushed functions to help test the interface
- */
-
-export const range = (start = 0, stop = 1, step = 1) => {
-  const a = [start];
-  let b = start;
-  while (b < stop) {
-    a.push((b += step || 1));
-  }
-  return a;
-};
-
-/**
- * JavaScript Regex constructor does not automatically escape special regex chars, this function fixes that
- */
-const escapeRegExp = (str) => str.replace(/[.*+?^${}()|[\]\\]/g, '\\$&'); // $& means the whole matched string as a token
-
-/**
- * @param str {string} The string to parse
- * @param startsWith {string} The first word to encounter and start taking
- * @param endsAt {string} The last word to encounter and end at
- * A crude multiline only parser which takes from A to B, its likely to be buggy but good enough for testing
- */
-export const crudeMultilineTakeUntil = (str, startsWith, endsAt) =>
-  str
-    .match(
-      new RegExp(
-        `${escapeRegExp(startsWith)}(.*?)${escapeRegExp(endsAt)}`,
-        'gs'
-      )
-    )
-    .join('')
-    .replace(new RegExp(escapeRegExp(endsAt), 'g'), '');
-
-export const collapseWhitespace = (str) => str.replace(/\s+/g, ' ').trim();
-
-// node 14 compatibility
-function at(n) {
-  // ToInteger() abstract op
-  n = Math.trunc(n) || 0;
-  // Allow negative indexing from the end
-  if (n < 0) n += this.length;
-  // OOB access is guaranteed to return undefined
-  if (n < 0 || n >= this.length) return undefined;
-  // Otherwise, this is just normal property access
-  return this[n];
-}
-
-export function node14Compatibility() {
-  if (process.version.startsWith('v14')) {
-    const TypedArray = Reflect.getPrototypeOf(Int8Array);
-    for (const C of [Array, String, TypedArray]) {
-      Object.defineProperty(C.prototype, 'at', {
-        value: at,
-        writable: true,
-        enumerable: false,
-        configurable: true,
-      });
-    }
-  }
-}