@rockcarver/frodo-cli 0.10.4 → 0.11.1-0

package/test/client_cli/en/logs.test.js

@@ -1,79 +1,65 @@
 import cp from 'child_process';
 import { promisify } from 'util';
-import { crudeMultilineTakeUntil, collapseWhitespace } from '../utils/utils';
+import { node14Compatibility } from '../utils/utils.js';
+
+node14Compatibility();
 
 const exec = promisify(cp.exec);
 const CMD = 'frodo logs --help';
 const { stdout } = await exec(CMD);
 
 test("CLI help interface for 'logs' Usage should be expected english", async () => {
-    // Arrange
-    const expected = `
-        Usage: frodo logs [options] [command] <host>
+  // Arrange
+  const expected = `
+  Usage: frodo logs [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 'logs' description at line 2 should be expected english", async () => {
-    // Arrange
-    const expected = `
-        View Identity Cloud logs.
+  // Arrange
+  const expected = `
+  View Identity Cloud logs. If valid tenant admin credentials are specified, a log API key and secret are automatically created for that admin user.
     `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .map(line => line.trim())
-        .at(2)
-    // Assert
-    expect(testLine).toBe(expected);
-});
-
-test("CLI help interface 'logs argument host' description should be expected english", 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.
-    `).trim();
-    // Act
-    const testLine = collapseWhitespace(crudeMultilineTakeUntil(
-        stdout,
-        '  host                                  ',
-        'Options:'
-    ));
-    // Assert
-    expect(collapseWhitespace(testLine)).toBe(expected);
+  // Act
+  const testLine = stdout
+    .split(/\n/)
+    .map((line) => line.trim())
+    .at(2);
+  // Assert
+  expect(testLine).toBe(expected);
 });
 
 test("CLI help interface 'logs commands list' description should be expected english", async () => {
-    // Arrange
-    const expected = `
-        list [options] <host> [key] [secret]  List available ID Cloud log sources.
+  // Arrange
+  const expected = `
+  list            List available ID Cloud log sources.
     `.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 'logs commands tail' description should be expected english", async () => {
-    // Arrange
-    const expected = `
-        tail [options] <host> [key] [secret]  Tail Identity Cloud logs.
+  // Arrange
+  const expected = `
+        tail            Tail Identity Cloud logs.
     `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('tail'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expected);
-});
+  // Act
+  const testLine = stdout
+    .split(/\n/)
+    .find((line) => line.trim().startsWith('tail'))
+    .trim();
+  // Assert
+  expect(testLine).toBe(expected);
+});

package/test/client_cli/en/root.test.js

@@ -1,91 +1,93 @@
 import cp from 'child_process';
 import { promisify } from 'util';
+import { node14Compatibility } from '../utils/utils.js';
+
+node14Compatibility();
 
 const exec = promisify(cp.exec);
 const CMD = 'frodo --help';
 const { stdout } = await exec(CMD);
 
-test("CLI help interface 'connections' description should be expected english", async () => {
-    // Arrange
-    const expectedDescription = `
-        connections                              Manage connection profiles.
+test("CLI help interface 'connection' description should be expected english", async () => {
+  // Arrange
+  const expectedDescription = `
+  conn|connection                          Manage connection profiles.
     `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('connections'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expectedDescription);
+  // Act
+  const testLine = stdout
+    .split(/\n/)
+    .find((line) => line.trim().startsWith('conn'))
+    .trim();
+  // Assert
+  expect(testLine).toBe(expectedDescription);
 });
 
 test("CLI help interface 'info' description should be expected english", async () => {
-    // Arrange
-    const expectedDescription = `
+  // Arrange
+  const expectedDescription = `
         info [options] <host> [user] [password]  Print versions and tokens.
     `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('info'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expectedDescription);
+  // Act
+  const testLine = stdout
+    .split(/\n/)
+    .find((line) => line.trim().startsWith('info'))
+    .trim();
+  // Assert
+  expect(testLine).toBe(expectedDescription);
 });
 
 test("CLI help interface 'journey' description should be expected english", async () => {
-    // Arrange
-    const expectedDescription = `
+  // Arrange
+  const expectedDescription = `
         journey                                  Manage journeys/trees.
     `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('journey'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expectedDescription);
+  // Act
+  const testLine = stdout
+    .split(/\n/)
+    .find((line) => line.trim().startsWith('journey'))
+    .trim();
+  // Assert
+  expect(testLine).toBe(expectedDescription);
 });
 
 test("CLI help interface 'script' description should be expected english", async () => {
-    // Arrange
-    const expectedDescription = `
+  // Arrange
+  const expectedDescription = `
         script                                   Manage scripts.
     `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('script'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expectedDescription);
+  // Act
+  const testLine = stdout
+    .split(/\n/)
+    .find((line) => line.trim().startsWith('script'))
+    .trim();
+  // Assert
+  expect(testLine).toBe(expectedDescription);
 });
 
 test("CLI help interface 'idm' description should be expected english", async () => {
-    // Arrange
-    const expectedDescription = `
+  // Arrange
+  const expectedDescription = `
         idm                                      Manage IDM configuration.
     `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('idm'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expectedDescription);
+  // Act
+  const testLine = stdout
+    .split(/\n/)
+    .find((line) => line.trim().startsWith('idm'))
+    .trim();
+  // Assert
+  expect(testLine).toBe(expectedDescription);
 });
 
-
 test("CLI help interface 'logs' description should be expected english", async () => {
-    // Arrange
-    const expectedDescription = `
-        logs <host>                              View Identity Cloud logs.
+  // Arrange
+  const expectedDescription = `
+  logs                                     List/View Identity Cloud logs
     `.trim();
-    // Act
-    const testLine = stdout
-        .split(/\n/)
-        .find(line => line.trim().startsWith('logs'))
-        .trim();
-    // Assert
-    expect(testLine).toBe(expectedDescription);
-});
+  // Act
+  const testLine = stdout
+    .split(/\n/)
+    .find((line) => line.trim().startsWith('logs'))
+    .trim();
+  // Assert
+  expect(testLine).toBe(expectedDescription);
+});

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

@@ -0,0 +1,230 @@
+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

@@ -0,0 +1,176 @@
+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);
+});