@rockcarver/frodo-cli 0.10.4 → 0.11.1-0

package/test/client_cli/en/idm.test.js

@@ -1,111 +1,82 @@
 import cp from 'child_process';
 import { promisify } from 'util';
-import { crudeMultilineTakeUntil, collapseWhitespace } from '../utils/utils';
+import {
+  crudeMultilineTakeUntil,
+  collapseWhitespace,
+  node14Compatibility,
+} from '../utils/utils.js';
+
+node14Compatibility();
 
 const exec = promisify(cp.exec);
 const CMD = 'frodo idm --help';
 const { stdout } = await exec(CMD);
 
 test("CLI help interface for 'idm' Usage should be expected english", async () => {
-    // Arrange
-    const expected = `
+  // Arrange
+  const expected = `
         Usage: frodo idm [options] [command]
     `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('Usage:'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expected);
+  // Act
+  const testLine = stdout
+    .split(/\n/)
+    .find((line) => line.trim().startsWith('Usage:'))
+    .trim();
+  // Assert
+  expect(testLine).toBe(expected);
 });
 
-
 test("CLI help interface 'idm' description at line 2 should be expected english", async () => {
-    // Arrange
-    const expected = `
+  // Arrange
+  const expected = `
         Manage IDM configuration.
     `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .map(line => line.trim())
-        .at(2)
-    // Assert
-    expect(testLine).toBe(expected);
+  // Act
+  const testLine = stdout
+    .split(/\n/)
+    .map((line) => line.trim())
+    .at(2);
+  // Assert
+  expect(testLine).toBe(expected);
 });
 
 test("CLI help interface 'idm commands list' description should be expected english", async () => {
-    // Arrange
-    const expected = `
-        list [options] <host> [user] [password]          List all IDM configuration objects.
+  // Arrange
+  const expected = `
+  list            List all IDM configuration objects.
     `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('list'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expected);
+  // Act
+  const testLine = stdout
+    .split(/\n/)
+    .find((line) => line.trim().startsWith('list'))
+    .trim();
+  // Assert
+  expect(testLine).toBe(expected);
 });
 
 test("CLI help interface 'idm commands export' description should be expected english", async () => {
-    // Arrange
-    const expected = `
-        export [options] <host> [user] [password]        Export an IDM configuration object.
+  // Arrange
+  const expected = `
+  export          Export IDM configuration objects.
     `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('export'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'idm commands exportAllRaw' description should be expected english", async () => {
-    // Arrange
-    const expected = collapseWhitespace(`
-        exportAllRaw [options] <host> [user] [password]  Export all IDM configuration objects into
-                                                         separate JSON files in a directory
-                                                         specified by <directory>
-    `).trim();
-    // Act
-    const testLine = collapseWhitespace(crudeMultilineTakeUntil(
-        stdout,
-        '  exportAllRaw [options] <host> [user] [password]  ',
-        '  exportAll [options] <host> [user] [password]     '
-    ));
-    // Assert
-    expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'idm commands exportAll' description should be expected english", async () => {
-    // Arrange
-    const expected = `
-        exportAll [options] <host> [user] [password]     Export all IDM configuration objects.
-    `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('exportAll [options] <host> [user] [password]     '))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expected);
+  // Act
+  const testLine = stdout
+    .split(/\n/)
+    .find((line) => line.trim().startsWith('export'))
+    .trim();
+  // Assert
+  expect(testLine).toBe(expected);
 });
 
 test("CLI help interface 'idm commands count' description should be expected english multiline", async () => {
-    // Arrange
-    const expected = collapseWhitespace(`
-        count [options] <host> [user] [password]         Count number of managed objects of a given
-    type.
+  // Arrange
+  const expected = collapseWhitespace(`
+  count           Count number of managed objects of a given type.
     `).trim();
-    // Act
-    const testLine = collapseWhitespace(crudeMultilineTakeUntil(
-        stdout,
-        '  count [options] <host> [user] [password]         ',
-        '  help [command]                                   '
-    ));
-    // Assert
-    expect(testLine).toBe(expected);
-});
+  // Act
+  const testLine = collapseWhitespace(
+    crudeMultilineTakeUntil(stdout, '  count           ', '  help [command]  ')
+  );
+  // Assert
+  expect(testLine).toBe(expected);
+});

package/test/client_cli/en/info.test.js

@@ -1,92 +1,100 @@
 import cp from 'child_process';
 import { promisify } from 'util';
-import { crudeMultilineTakeUntil, collapseWhitespace } from '../utils/utils';
+import {
+  crudeMultilineTakeUntil,
+  collapseWhitespace,
+  node14Compatibility,
+} from '../utils/utils.js';
+
+node14Compatibility();
 
 const exec = promisify(cp.exec);
 const CMD = 'frodo info --help';
 const { stdout } = await exec(CMD);
 
 test("CLI help interface for 'info' Usage should be expected english", async () => {
-    // Arrange
-    const expected = `
+  // Arrange
+  const expected = `
         Usage: frodo info [options] <host> [user] [password]
     `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('Usage:'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expected);
+  // Act
+  const testLine = stdout
+    .split(/\n/)
+    .find((line) => line.trim().startsWith('Usage:'))
+    .trim();
+  // Assert
+  expect(testLine).toBe(expected);
 });
 
-
 test("CLI help interface 'info' description at line 2 should be expected english", async () => {
-    // Arrange
-    const expected = `
+  // Arrange
+  const expected = `
         Print versions and tokens.
     `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .map(line => line.trim())
-        .at(2)
-    // Assert
-    expect(testLine).toBe(expected);
+  // Act
+  const testLine = stdout
+    .split(/\n/)
+    .map((line) => line.trim())
+    .at(2);
+  // Assert
+  expect(testLine).toBe(expected);
 });
 
 test("CLI help interface 'info argument host' description should be expected english multiline", async () => {
-    // Arrange
-    const expected = collapseWhitespace(`
+  // 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               '
-    ));
+  // Act
+  const testLine = collapseWhitespace(
+    crudeMultilineTakeUntil(
+      stdout,
+      '  host               ',
+      '  user               '
+    )
+  );
 
-    // Assert
-    expect(testLine).toBe(expected);
+  // Assert
+  expect(testLine).toBe(expected);
 });
 
-
 test("CLI help interface 'info argument user' description should be expected english multiline", async () => {
-    // Arrange
-    const expected = collapseWhitespace(`
+  // 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);
+  // Act
+  const testLine = collapseWhitespace(
+    crudeMultilineTakeUntil(
+      stdout,
+      '  user               ',
+      '  password           '
+    )
+  );
+  // Assert
+  expect(testLine).toBe(expected);
 });
 
 test("CLI help interface 'info argument password' description should be expected english", async () => {
-    // Arrange
-    const expected = `
-    password           Password.
+  // Arrange
+  const expected = `
+  password              Password.
     `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('password'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expected);
+  // Act
+  const testLine = stdout
+    .split(/\n/)
+    .find((line) => line.trim().startsWith('password'))
+    .trim();
+  // Assert
+  expect(testLine).toBe(expected);
 });
 
 test("CLI help interface 'info Options -m, --type' description should be expected english", async () => {
-    // Arrange
-    const expected = collapseWhitespace(`
+  // 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.
@@ -98,28 +106,31 @@ test("CLI help interface 'info Options -m, --type' description should be expecte
                         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);
+  // Act
+  const testLine = collapseWhitespace(
+    crudeMultilineTakeUntil(
+      stdout,
+      '  -m, --type <type>  ',
+      '  -k, --insecure     '
+    )
+  );
+  // Assert
+  expect(testLine).toBe(expected);
 });
 
 test("CLI help interface 'info Options -k, --insecure' description should be expected english", async () => {
-    // Arrange
-    const expected = collapseWhitespace(`
-    -k, --insecure      Allow insecure connections when using SSL/TLS (default: Don't
-                        allow insecure connections)
+  // 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) -s, --scriptFriendly Send output of operation to STDOUT in a script-friendly format (JSON) which can be piped to other commands. User messages/warnings are output to STDERR, and are not piped. For example, to only get bearer token: <<< frodo info my-tenant -s 2>/dev/null | jq -r .bearerToken >>> (default: Output as plain text)
     `);
-    // Act
-    const testLine = collapseWhitespace(crudeMultilineTakeUntil(
-        stdout,
-        '  -k, --insecure     ',
-        '  -h, --help         '
-    ));;
-    // Assert
-    expect(testLine).toBe(expected);
-});
+  // Act
+  const testLine = collapseWhitespace(
+    crudeMultilineTakeUntil(
+      stdout,
+      '  -k, --insecure     ',
+      '  -h, --help         '
+    )
+  );
+  // Assert
+  expect(testLine).toBe(expected);
+});

package/test/client_cli/en/journey-describe.test.js

@@ -0,0 +1,194 @@
+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 journey describe --help';
+const { stdout } = await exec(CMD);
+
+test("CLI help interface for 'journey describe' Usage should be expected english", async () => {
+  // Arrange
+  const expected = `
+  Usage: frodo journey describe [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 'journey describe' description at line 2 should be expected english", async () => {
+  // Arrange
+  const expected = `
+  If -h is supplied, describe the journey/tree indicated by -i, or all journeys/trees in the realm if no -i is supplied, otherwise describe the journey/tree export file indicated by -f.
+    `.trim();
+  // Act
+  const testLine = stdout
+    .split(/\n/)
+    .map((line) => line.trim())
+    .at(2);
+  // Assert
+  expect(testLine).toBe(expected);
+});
+
+test("CLI help interface 'describe 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 'describe 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 'describe 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 'describe 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 'describe 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 'describe option -t, --tree <tree>' description should be expected english", async () => {
+  // Arrange
+  const expectedDescription = `
+  -i, --journey-id <journey> Name of a journey/tree. If specified, -a and -A are ignored.
+    `.trim();
+  // Act
+  const testLine = collapseWhitespace(
+    crudeMultilineTakeUntil(
+      stdout,
+      '  -i, --journey-id <journey>  ',
+      '  -f, --file <file>           '
+    )
+  );
+  // Assert
+  expect(testLine).toBe(expectedDescription);
+});
+
+test("CLI help interface 'describe option -f, --file <file>' description should be expected english", async () => {
+  // Arrange
+  const expectedDescription = `
+  -f, --file <file> Name of the file to write the exported journey(s) to. Ignored with -A.
+    `.trim();
+  // Act
+  const testLine = collapseWhitespace(
+    crudeMultilineTakeUntil(
+      stdout,
+      '  -f, --file <file>           ',
+      '  -h, --help                  '
+    )
+  );
+
+  // Assert
+  expect(testLine).toBe(expectedDescription);
+});
+
+test("CLI help interface 'describe 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              ',
+      '  -i, --journey-id <journey>  '
+    )
+  );
+
+  // Assert
+  expect(testLine).toBe(expected);
+});