Add alias support

src/cli/FrodoCommand.ts

@@ -16,9 +16,9 @@ import {
 
 const { DEFAULT_REALM_KEY, DEPLOYMENT_TYPES } = frodo.utils.constants;
 
-const hostArgument = new Argument(
+export const hostArgument = new Argument(
   '[host]',
-  'AM base URL, e.g.: https://cdk.iam.example.com/am. To use a connection profile, just specify a unique substring.'
+  'AM base URL, e.g.: https://cdk.iam.example.com/am. To use a connection profile, just specify a unique substring or alias.'
 );
 
 const realmArgument = new Argument(

src/cli/app/app-list.ts

@@ -28,7 +28,7 @@ export default function setup() {
         ] +
         `  List applications using a connection profile (identified by the full AM base URL):\n` +
         `  $ frodo app list ${s.amBaseUrl}\n`['brightCyan'] +
-        `  List applications using a connection profile (identified by a unique substring of the AM base URL):\n` +
+        `  List applications using a connection profile (identified by a unique substring of the AM base URL or a saved alias):\n` +
         `  $ frodo app list ${s.connId}\n`['brightCyan']
     )
     .action(

src/cli/conn/conn-alias-add.ts

@@ -0,0 +1,34 @@
+import { frodo } from '@rockcarver/frodo-lib';
+
+import { printError } from '../../utils/Console';
+import { FrodoCommand, hostArgument } from '../FrodoCommand';
+
+export default function setup() {
+  const program = new FrodoCommand('frodo conn alias add', [
+    'host',
+    'realm',
+    'username',
+    'password',
+    'type',
+    'insecure',
+    'curlirize',
+  ]);
+
+  program
+    .description('Add connection profile alias.')
+    .argument('alias', 'Alias name for this connection profile.')
+    .addArgument(hostArgument)
+    .action(
+      async (alias: any, host: string, options: any, command: FrodoCommand) => {
+        command.handleDefaultArgsAndOpts(alias, host, options, command);
+        try {
+          frodo.conn.setConnectionProfileAlias(host, alias);
+        } catch (error) {
+          printError(error);
+          process.exitCode = 1;
+        }
+      }
+    );
+
+  return program;
+}

src/cli/conn/conn-alias-delete.ts

@@ -0,0 +1,29 @@
+import { frodo } from '@rockcarver/frodo-lib';
+
+import { printError } from '../../utils/Console';
+import { FrodoCommand } from '../FrodoCommand';
+
+export default function setup() {
+  const program = new FrodoCommand('frodo conn alias delete', [
+    'realm',
+    'username',
+    'password',
+    'type',
+    'insecure',
+    'curlirize',
+  ]);
+
+  program
+    .description('Delete connection profile alias.')
+    .action(async (host: string, options: any, command: FrodoCommand) => {
+      command.handleDefaultArgsAndOpts(host, options, command);
+      try {
+        frodo.conn.deleteConnectionProfileAlias(host);
+      } catch (error) {
+        printError(error);
+        process.exitCode = 1;
+      }
+    });
+
+  return program;
+}

src/cli/conn/conn-alias.ts

@@ -0,0 +1,19 @@
+import { FrodoStubCommand } from '../FrodoCommand';
+import AddCmd from './conn-alias-add.js';
+import DeleteCmd from './conn-alias-delete.js';
+
+export default function setup() {
+  const program = new FrodoStubCommand('frodo conn alias');
+
+  program.description('Manage connection aliases.');
+
+  program.addCommand(
+    AddCmd().name('add').description('Add connection profile alias.')
+  );
+
+  program.addCommand(
+    DeleteCmd().name('delete').description('Delete connection profile alias.')
+  );
+
+  return program;
+}

src/cli/conn/conn-save.ts

@@ -50,17 +50,28 @@
         'Map of headers: {"host":"am.example.com:8081"}.'
       )
     )
+    .addOption(
+      new Option('--alias [name]', 'Alias name for this connection profile.')
+    )
     .addHelpText(
       'after',
       `Usage Examples:\n` +
         `  Create a connection profile with a new log API key and secret and a new service account:\n` +
         `  $ frodo conn save ${s.amBaseUrl} ${s.username} '${s.password}'\n`[
           'brightCyan'
         ] +
+        `  Create a connection profile with a new log API key and secret and a new service account and set an alias:\n` +
+        `  $ frodo conn save --alias ${s.alias} ${s.amBaseUrl} ${s.username} '${s.password}'\n`[
+          'brightCyan'
+        ] +
         `  Save an existing service account to an existing or new connection profile:\n` +
         `  $ frodo conn save --sa-id ${s.saId} --sa-jwk-file ${s.saJwkFile} ${s.amBaseUrl}\n`[
           'brightCyan'
         ] +
+        `  Save an existing service account to an existing or new connection profile and set an alias:\n` +
+        `  $ frodo conn save --alias ${s.alias} --sa-id ${s.saId} --sa-jwk-file ${s.saJwkFile} ${s.amBaseUrl}\n`[
+          'brightCyan'
+        ] +
         `  Save an existing service account to an existing connection profile (partial host URL only updates an existing profile):\n` +
         `  $ frodo conn save --sa-id ${s.saId} --sa-jwk-file ${s.saJwkFile} ${s.connId}\n`[
           'brightCyan'
@@ -103,6 +114,9 @@
           verboseMessage(
             `Saving connection profile for tenant ${state.getHost()}...`
           );
+          if (options.alias) {
+            state.setAlias(options.alias);
+          }
           // if cloud deployment add service account
           if (
             options.validate &&

src/cli/conn/conn.ts

@@ -1,4 +1,5 @@
 import { FrodoStubCommand } from '../FrodoCommand';
+import AliasCmd from './conn-alias.js';
 import DeleteCmd from './conn-delete.js';
 import DescribeCmd from './conn-describe.js';
 import ListCmd from './conn-list.js';
@@ -13,6 +14,8 @@ export default function setup() {
 
   program.addCommand(SaveCmd().name('save'));
 
+  program.addCommand(AliasCmd().name('alias'));
+
   program.addCommand(DeleteCmd().name('delete'));
 
   program.addCommand(DescribeCmd().name('describe'));

src/cli/info/info.ts

@@ -34,9 +34,9 @@ export default function setup() {
         ] +
         `  Show human-readable output and login using a connection profile (identified by the full AM base URL):\n` +
         `  $ frodo info ${s.amBaseUrl}\n`['brightCyan'] +
-        `  Show human-readable output and login using a connection profile (identified by a unique substring of the AM base URL):\n` +
+        `  Show human-readable output and login using a connection profile (identified by a unique substring of the AM base URL or a saved alias):\n` +
         `  $ frodo info ${s.connId}\n`['brightCyan'] +
-        `  Show JSON output and login using the AM base URL's unique substring to identify the connection profile:\n` +
+        `  Show JSON output and login using the AM base URL's unique substring or a saved alias to identify the connection profile:\n` +
         `  $ frodo info --json ${s.connId}\n`['brightCyan']
     )
     .action(async (host, user, password, options, command) => {

src/cli/server/server-delete.ts

@@ -22,7 +22,7 @@ export default function setup() {
     .addOption(
       new Option(
         '-u, --server-url <server-url>',
-        'Server url. Can be a unique substring of the full url (if not unique, it will error out). If specified, only one server is deleted and the options -a and -A are ignored.'
+        'Server url. Can be a unique substring of the full url (if not unique, it will error out) or a saved alias. If specified, only one server is deleted and the options -a and -A are ignored.'
       )
     )
     .addOption(new Option('-a, --all', 'Delete all servers. Ignored with -i.'))

src/cli/server/server-describe.ts

@@ -21,7 +21,7 @@ export default function setup() {
     .addOption(
       new Option(
         '-u, --server-url <server-url>',
-        'Server url. Can be a unique substring of the full url (if not unique, it will error out).'
+        'Server url. Can be a unique substring of the full url (if not unique, it will error out) or a saved alias.'
       )
     )
     .action(

src/cli/server/server-export.ts

@@ -28,7 +28,7 @@ export default function setup() {
     .addOption(
       new Option(
         '-u, --server-url <server-url>',
-        'Server url. Can be a unique substring of the full url (if not unique, it will error out). If specified, only one server is exported and the options -a and -A are ignored.'
+        'Server url. Can be a unique substring of the full url (if not unique, it will error out) or a saved alias. If specified, only one server is exported and the options -a and -A are ignored.'
       )
     )
     .addOption(new Option('-f, --file <file>', 'Name of the export file.'))

src/cli/server/server-import.ts

@@ -29,7 +29,7 @@ export default function setup() {
     .addOption(
       new Option(
         '-u, --server-url <server-url>',
-        'Server url. Can be a unique substring of the full url (if not unique, it will error out). If specified, only one server is imported and the options -a and -A are ignored.'
+        'Server url. Can be a unique substring of the full url (if not unique, it will error out) or a saved alias. If specified, only one server is imported and the options -a and -A are ignored.'
       )
     )
     .addOption(new Option('-f, --file <file>', 'Name of the file to import.'))

src/cli/shell/shell.ts

@@ -57,7 +57,7 @@ export default function setup() {
         ] +
         `  Launch a frodo shell using a connection profile (identified by the full AM base URL):\n` +
         `  $ frodo shell ${s.amBaseUrl}\n`['brightCyan'] +
-        `  Launch a frodo shell using a connection profile (identified by a unique substring of the AM base URL):\n` +
+        `  Launch a frodo shell using a connection profile (identified by a unique substring of the AM base URL or a saved alias):\n` +
         `  $ frodo shell ${s.connId}\n`['brightCyan']
     )
     .addOption(

src/help/SampleData.ts

@@ -1,4 +1,5 @@
 export const amBaseUrl = 'https://openam-matrix.id.forgerock.io/am';
+export const alias = 'MyConnection';
 export const connId = 'matrix';
 export const username = '[email protected]';
 export const password = 'Blu3P!ll3d';

src/ops/ConnectionProfileOps.ts

@@ -31,13 +31,15 @@ export function listConnectionProfiles(long: boolean = false): void {
       if (long) {
         const table = createTable([
           'Host',
+          'Alias',
           'Service Account',
           'Username',
           'Log API Key',
         ]);
         Object.keys(connectionsData).forEach((c) => {
           table.push([
             c,
+            connectionsData[c].alias,
             connectionsData[c].svcacctName || connectionsData[c].svcacctId,
             connectionsData[c].username,
             connectionsData[c].logApiKey,
@@ -51,7 +53,7 @@ export function listConnectionProfiles(long: boolean = false): void {
         // getUniqueNames(5, Object.keys(connectionsData));
       }
       printMessage(
-        'Any unique substring of a saved host can be used as the value for host parameter in all commands',
+        'Any unique substring or alias of a saved host can be used as the value for host parameter in all commands',
         'info'
       );
     }
@@ -63,7 +65,7 @@ export function listConnectionProfiles(long: boolean = false): void {
 
 /**
  * Describe connection profile
- * @param {string} host Host URL or unique substring
+ * @param {string} host Host URL, unique substring, or alias
  * @param {boolean} showSecrets Whether secrets should be shown in clear text or not
  */
 export async function describeConnectionProfile(
@@ -130,6 +132,7 @@ export async function describeConnectionProfile(
     }
     const keyMap = {
       tenant: 'Host',
+      alias: 'Alias',
       deploymentType: 'Deployment Type',
       username: 'Username',
       password: 'Password',

test/client_cli/en/__snapshots__/admin-add-autoid-static-user-mapping.test.js.snap

@@ -10,7 +10,7 @@ Arguments:
   host                                 AM base URL, e.g.:
                                        https://cdk.iam.example.com/am. To use a
                                        connection profile, just specify a
-                                       unique substring.
+                                       unique substring or alias.
   username                             Username to login with. Must be an admin
                                        user with appropriate rights to manage
                                        authentication journeys/trees.

test/client_cli/en/__snapshots__/admin-create-oauth2-client-with-admin-privileges.test.js.snap

@@ -9,7 +9,7 @@ Arguments:
   host                                 AM base URL, e.g.:
                                        https://cdk.iam.example.com/am. To use a
                                        connection profile, just specify a
-                                       unique substring.
+                                       unique substring or alias.
   realm                                Realm. Specify realm as '/' for the root
                                        realm or 'realm' or '/parent/child'
                                        otherwise. (default: "alpha" for

test/client_cli/en/__snapshots__/admin-get-access-token.test.js.snap

@@ -9,7 +9,7 @@ Arguments:
   host                                 AM base URL, e.g.:
                                        https://cdk.iam.example.com/am. To use a
                                        connection profile, just specify a
-                                       unique substring.
+                                       unique substring or alias.
   realm                                Realm. Specify realm as '/' for the root
                                        realm or 'realm' or '/parent/child'
                                        otherwise. (default: "alpha" for

test/client_cli/en/__snapshots__/admin-grant-oauth2-client-admin-privileges.test.js.snap

@@ -9,7 +9,7 @@ Arguments:
   host                                 AM base URL, e.g.:
                                        https://cdk.iam.example.com/am. To use a
                                        connection profile, just specify a
-                                       unique substring.
+                                       unique substring or alias.
   realm                                Realm. Specify realm as '/' for the root
                                        realm or 'realm' or '/parent/child'
                                        otherwise. (default: "alpha" for

test/client_cli/en/__snapshots__/admin-hide-generic-extension-attributes.test.js.snap

@@ -9,7 +9,7 @@ Arguments:
   host                                 AM base URL, e.g.:
                                        https://cdk.iam.example.com/am. To use a
                                        connection profile, just specify a
-                                       unique substring.
+                                       unique substring or alias.
   realm                                Realm. Specify realm as '/' for the root
                                        realm or 'realm' or '/parent/child'
                                        otherwise. (default: "alpha" for

test/client_cli/en/__snapshots__/admin-list-oauth2-clients-with-admin-privileges.test.js.snap

@@ -9,7 +9,7 @@ Arguments:
   host                                 AM base URL, e.g.:
                                        https://cdk.iam.example.com/am. To use a
                                        connection profile, just specify a
-                                       unique substring.
+                                       unique substring or alias.
   realm                                Realm. Specify realm as '/' for the root
                                        realm or 'realm' or '/parent/child'
                                        otherwise. (default: "alpha" for

test/client_cli/en/__snapshots__/admin-list-oauth2-clients-with-custom-privileges.test.js.snap

@@ -9,7 +9,7 @@ Arguments:
   host                                 AM base URL, e.g.:
                                        https://cdk.iam.example.com/am. To use a
                                        connection profile, just specify a
-                                       unique substring.
+                                       unique substring or alias.
   realm                                Realm. Specify realm as '/' for the root
                                        realm or 'realm' or '/parent/child'
                                        otherwise. (default: "alpha" for

test/client_cli/en/__snapshots__/admin-list-static-user-mappings.test.js.snap

@@ -9,7 +9,7 @@ Arguments:
   host                                 AM base URL, e.g.:
                                        https://cdk.iam.example.com/am. To use a
                                        connection profile, just specify a
-                                       unique substring.
+                                       unique substring or alias.
   realm                                Realm. Specify realm as '/' for the root
                                        realm or 'realm' or '/parent/child'
                                        otherwise. (default: "alpha" for

test/client_cli/en/__snapshots__/admin-remove-static-user-mapping.test.js.snap

@@ -9,7 +9,7 @@ Arguments:
   host                                 AM base URL, e.g.:
                                        https://cdk.iam.example.com/am. To use a
                                        connection profile, just specify a
-                                       unique substring.
+                                       unique substring or alias.
   realm                                Realm. Specify realm as '/' for the root
                                        realm or 'realm' or '/parent/child'
                                        otherwise. (default: "alpha" for

test/client_cli/en/__snapshots__/admin-repair-org-model.test.js.snap

@@ -9,7 +9,7 @@ Arguments:
   host                                 AM base URL, e.g.:
                                        https://cdk.iam.example.com/am. To use a
                                        connection profile, just specify a
-                                       unique substring.
+                                       unique substring or alias.
   realm                                Realm. Specify realm as '/' for the root
                                        realm or 'realm' or '/parent/child'
                                        otherwise. (default: "alpha" for

test/client_cli/en/__snapshots__/admin-revoke-oauth2-client-admin-privileges.test.js.snap

@@ -9,7 +9,7 @@ Arguments:
   host                                 AM base URL, e.g.:
                                        https://cdk.iam.example.com/am. To use a
                                        connection profile, just specify a
-                                       unique substring.
+                                       unique substring or alias.
   realm                                Realm. Specify realm as '/' for the root
                                        realm or 'realm' or '/parent/child'
                                        otherwise. (default: "alpha" for

test/client_cli/en/__snapshots__/admin-show-generic-extension-attributes.test.js.snap

@@ -9,7 +9,7 @@ Arguments:
   host                                 AM base URL, e.g.:
                                        https://cdk.iam.example.com/am. To use a
                                        connection profile, just specify a
-                                       unique substring.
+                                       unique substring or alias.
   realm                                Realm. Specify realm as '/' for the root
                                        realm or 'realm' or '/parent/child'
                                        otherwise. (default: "alpha" for

test/client_cli/en/__snapshots__/agent-delete.test.js.snap

@@ -9,7 +9,7 @@ Arguments:
   host                                 AM base URL, e.g.:
                                        https://cdk.iam.example.com/am. To use a
                                        connection profile, just specify a
-                                       unique substring.
+                                       unique substring or alias.
   realm                                Realm. Specify realm as '/' for the root
                                        realm or 'realm' or '/parent/child'
                                        otherwise. (default: "alpha" for

test/client_cli/en/__snapshots__/agent-describe.test.js.snap

@@ -9,7 +9,7 @@ Arguments:
   host                                 AM base URL, e.g.:
                                        https://cdk.iam.example.com/am. To use a
                                        connection profile, just specify a
-                                       unique substring.
+                                       unique substring or alias.
   realm                                Realm. Specify realm as '/' for the root
                                        realm or 'realm' or '/parent/child'
                                        otherwise. (default: "alpha" for

test/client_cli/en/__snapshots__/agent-export.test.js.snap

@@ -9,7 +9,7 @@ Arguments:
   host                                 AM base URL, e.g.:
                                        https://cdk.iam.example.com/am. To use a
                                        connection profile, just specify a
-                                       unique substring.
+                                       unique substring or alias.
   realm                                Realm. Specify realm as '/' for the root
                                        realm or 'realm' or '/parent/child'
                                        otherwise. (default: "alpha" for