fix: enable help for category statuses (#12216)

* fix: enable help for category statuses * test: add e2e test for status with help
aws-amplify · Apr 18, 2023 · 73dc361 · 73dc361
1 parent f3c9a16
commit 73dc361
Show file tree

Hide file tree

Showing 5 changed files with 127 additions and 7 deletions.
diff --git a/packages/amplify-cli-core/src/help/commands-info.ts b/packages/amplify-cli-core/src/help/commands-info.ts
@@ -374,17 +374,71 @@ export const commandsInfo: Array<CommandInfo> = [
     ],
     subCommands: [
       {
-        subCommand: '[category]',
-        subCommandDescription: 'Shows the state of local resources not yet pushed to the cloud',
-        subCommandUsage: 'amplify status [category] [-v | --verbose]',
+        subCommand: 'notifications',
+        subCommandDescription: 'Lists the enabled/disabled statuses of the available notification channels',
+        subCommandUsage: 'amplify notifications status',
+        subCommandFlags: [],
+      },
+      {
+        subCommand: 'api',
+        subCommandDescription: 'Displays the current status of your API',
+        subCommandUsage: 'amplify api status [-acm <table-name>]',
         subCommandFlags: [
           {
-            short: 'v',
-            long: 'verbose',
-            flagDescription: 'Shows verbose details, including cloudformation differences',
+            short: 'acm',
+            long: '',
+            flagDescription: 'Displays the access control matrix',
           },
         ],
       },
+      {
+        subCommand: 'auth',
+        subCommandDescription: 'Displays the current status of your auth resource',
+        subCommandUsage: 'amplify auth status',
+        subCommandFlags: [],
+      },
+      {
+        subCommand: 'custom',
+        subCommandDescription: 'Displays the current status of your custom resource',
+        subCommandUsage: 'amplify custom status',
+        subCommandFlags: [],
+      },
+      {
+        subCommand: 'storage',
+        subCommandDescription: 'Displays the current status of your storage resource',
+        subCommandUsage: 'amplify storage status',
+        subCommandFlags: [],
+      },
+      {
+        subCommand: 'analytics',
+        subCommandDescription: 'Displays the current status of your analytics resource',
+        subCommandUsage: 'amplify analytics status',
+        subCommandFlags: [],
+      },
+      {
+        subCommand: 'function',
+        subCommandDescription: 'Displays the current status of your function resource',
+        subCommandUsage: 'amplify function status',
+        subCommandFlags: [],
+      },
+      {
+        subCommand: 'hosting',
+        subCommandDescription: 'Displays the current status of your hosting',
+        subCommandUsage: 'amplify hosting status',
+        subCommandFlags: [],
+      },
+      {
+        subCommand: 'interactions',
+        subCommandDescription: 'Displays the current status of your interactions resource',
+        subCommandUsage: 'amplify interactions status',
+        subCommandFlags: [],
+      },
+      {
+        subCommand: 'predictions',
+        subCommandDescription: 'Displays the current status of your predictions resource',
+        subCommandUsage: 'amplify predictions status',
+        subCommandFlags: [],
+      },
     ],
   },
   {

diff --git a/packages/amplify-cli/src/input-manager.ts b/packages/amplify-cli/src/input-manager.ts
@@ -1,5 +1,5 @@
 // normalize command line arguments, allow verb / noun place switch
-import { constants, PluginPlatform, pathManager, stateManager } from 'amplify-cli-core';
+import { constants, PluginPlatform, pathManager, stateManager, commandsInfo } from 'amplify-cli-core';
 import { getPluginsWithName, getAllPluginNames } from './plugin-manager';
 import { InputVerificationResult } from './domain/input-verification-result';
 import { insertAmplifyIgnore } from './extensions/amplify-helpers/git-manager';
@@ -84,6 +84,21 @@ function preserveHelpInformation(input: CLIInput): CLIInput {
       subCommands.unshift(input.plugin);
     }
   }
+
+  if (input.command == 'status' && input.options) {
+    const statusSubcommands = commandsInfo
+      .find((commandInfo) => commandInfo.command == 'status')
+      ?.subCommands.map((subCommandInfo) => subCommandInfo.subCommand);
+    const potentialStatusSubcommands: Array<string> = statusSubcommands ? statusSubcommands : [];
+    const optionKeys = Object.keys(input.options);
+    for (const potentialSubcommand of potentialStatusSubcommands) {
+      if (optionKeys.includes(potentialSubcommand)) {
+        subCommands.push(potentialSubcommand);
+        break;
+      }
+    }
+  }
+
   if (input.options) {
     input.options[constants.HELP] = true;
     delete input.options[constants.HELP_SHORT];

diff --git a/packages/amplify-e2e-core/src/utils/help.ts b/packages/amplify-e2e-core/src/utils/help.ts
@@ -0,0 +1,17 @@
+import { getCLIPath, nspawn as spawn } from '..';
+
+export const statusWithHelp = async (cwd: string, expectedContents: Array<string>): Promise<void> => {
+  const chain = spawn(getCLIPath(), ['status', '-h'], { cwd, stripColors: true });
+  for (const expectedLine of expectedContents) {
+    chain.wait(expectedLine);
+  }
+  await chain.runAsync();
+};
+
+export const statusForCategoryWithHelp = async (cwd: string, category: string, expectedContents: Array<string>): Promise<void> => {
+  const chain = spawn(getCLIPath(), ['status', category, '-h'], { cwd, stripColors: true });
+  for (const expectedLine of expectedContents) {
+    chain.wait(expectedLine);
+  }
+  await chain.runAsync();
+};
diff --git a/packages/amplify-e2e-core/src/utils/index.ts b/packages/amplify-e2e-core/src/utils/index.ts
@@ -27,6 +27,7 @@ export * from './transformConfig';
 export * from './admin-ui';
 export * from './hooks';
 export * from './git-operations';
+export * from './help';
 
 /**
  * Whether the current environment is CircleCI or not

diff --git a/packages/amplify-e2e-tests/src/__tests__/help.test.ts b/packages/amplify-e2e-tests/src/__tests__/help.test.ts
@@ -0,0 +1,33 @@
+import {
+  createNewProjectDir,
+  initJSProjectWithProfile,
+  deleteProject,
+  deleteProjectDir,
+  statusWithHelp,
+  statusForCategoryWithHelp,
+  addS3AndAuthWithAuthOnlyAccess,
+  amplifyPushAuth,
+} from '@aws-amplify/amplify-e2e-core';
+
+describe('help happy paths', () => {
+  let projRoot: string;
+  beforeAll(async () => {
+    projRoot = await createNewProjectDir('help-happy-paths');
+    await initJSProjectWithProfile(projRoot, {});
+    await addS3AndAuthWithAuthOnlyAccess(projRoot);
+    await amplifyPushAuth(projRoot);
+  });
+
+  afterAll(async () => {
+    await deleteProject(projRoot);
+    deleteProjectDir(projRoot);
+  });
+
+  test('amplify status', async () => {
+    await statusWithHelp(projRoot, ['USAGE', 'amplify status [-v | --verbose]']);
+  });
+
+  test('amplify status storage', async () => {
+    await statusForCategoryWithHelp(projRoot, 'storage', ['USAGE', 'amplify storage status']);
+  });
+});