Feature/amplify enhanced status

packages/amplify-cli-core/src/cliViewAPI.ts

@@ -0,0 +1,67 @@
+//Use this file to store all types used between the CLI commands and the view/display functions
+// CLI=>(command-handler)==[CLI-View-API]=>(ux-handler/report-handler)=>output-stream
+import chalk from 'chalk';
+export interface CLIParams {
+    cliCommand : string;
+    cliSubcommands: string[]|undefined;
+    cliOptions : {[key:string] : any};
+}
+//Resource Table filter and display params (params used for summary/display view of resource table)
+export class ViewResourceTableParams {
+    public command : string;
+    public verbose : boolean; //display table in verbose mode
+    public help : boolean; //display help for the command
+    public categoryList : string[]|[] //categories to  display
+    public filteredResourceList : any //resources to *not* display - TBD define union of valid types
+    getCategoryFromCLIOptions( cliOptions : object ){
+        if ( cliOptions ){
+            return (Object.keys(cliOptions).filter( key => (key != 'verbose') && (key !== 'yes') )).map(category => category.toLowerCase());
+        } else {
+            return [];
+        }
+    }
+    styleHeader(str : string) {
+        return chalk.italic(chalk.bgGray.whiteBright(str));
+    }
+    styleCommand( str : string) {
+        return chalk.greenBright(str);
+    }
+    styleOption( str : string) {
+        return chalk.yellowBright(str);
+    }
+    stylePrompt( str : string ){
+        return chalk.bold(chalk.yellowBright(str));
+    }
+    styleNOOP( str : string){
+        return chalk.italic(chalk.grey(str));
+    }
+    public getStyledHelp(){
+      return `
+${this.styleHeader("NAME")}
+${this.styleCommand("amplify status")} --  Shows the state of local resources not yet pushed to the cloud (Create/Update/Delete)
+
+${this.styleHeader("SYNOPSIS")}
+${this.styleCommand("amplify status")} [${this.styleCommand("-v")} [${this.styleOption("category ...")}] ] 
+
+${this.styleHeader("DESCRIPTION")}
+The amplify status command displays the difference between the deployed state and the local state of the application.
+The following options are available: 
+
+${this.styleNOOP("no options")}        : (Summary mode) Displays the summary of local state vs deployed state of the application
+${this.styleCommand("-v [category ...]")} : (Verbose mode) Displays the cloudformation diff for all resources for the specificed category. 
+                    If no category is provided, it shows the diff for all categories.
+                    usage:
+                    ${this.stylePrompt("#\>")} ${this.styleCommand("amplify status -v")}
+                    ${this.stylePrompt("#\>")} ${this.styleCommand("status -v ")}${this.styleOption( "api storage")}
+
+        `
+    }
+
+    public constructor( cliParams : CLIParams ){
+        this.command = cliParams.cliCommand;
+        this.verbose = (cliParams.cliOptions?.verbose === true );
+        this.categoryList = this.getCategoryFromCLIOptions( cliParams.cliOptions );
+        this.filteredResourceList = []; //TBD - add support to provide resources
+        this.help = (cliParams.cliSubcommands)?cliParams.cliSubcommands.includes("help"):false;
+    }
+}

packages/amplify-cli-core/src/index.ts

@@ -1,3 +1,4 @@
+import { ViewResourceTableParams, CLIParams } from './cliViewAPI';
 import { ServiceSelection } from './serviceSelection';
 
 export * from './cfnUtilities';
@@ -21,6 +22,7 @@ export * from './utils';
 export * from './banner-message';
 export * from './cliGetCategories';
 export * from './cliRemoveResourcePrompt';
+export * from "./cliViewAPI";
 
 // Temporary types until we can finish full type definition across the whole CLI
 
@@ -164,6 +166,7 @@ export interface AmplifyProjectConfig {
 
 export type $TSCopyJob = any;
 
+
 // Temporary interface until Context refactor
 interface AmplifyToolkit {
   confirmPrompt: (prompt: string, defaultValue?: boolean) => Promise<boolean>;
@@ -216,6 +219,7 @@ interface AmplifyToolkit {
   showHelp: (header: string, commands: { name: string; description: string }[]) => $TSAny;
   showHelpfulProviderLinks: () => $TSAny;
   showResourceTable: () => $TSAny;
+  showStatusTable:( resourceTableParams : ViewResourceTableParams )=> $TSAny; //Enhanced Status with CFN-Diff
   serviceSelectionPrompt: (
     context: $TSContext,
     category: string,

packages/amplify-cli/src/__tests__/commands/status.test.ts

@@ -0,0 +1,65 @@
+import { UnknownArgumentError } from 'amplify-cli-core';
+
+
+describe('amplify status: ', () => {
+    const mockExit = jest.fn();
+    jest.mock('amplify-cli-core', () => ({
+      exitOnNextTick: mockExit,
+      UnknownArgumentError: UnknownArgumentError,
+    }));
+    const { run } = require('../../commands/status');
+    const runStatusCmd = run;
+
+    it('status run method should exist', () => {
+        expect(runStatusCmd).toBeDefined();
+    });
+
+    it('status run method should call context.amplify.showStatusTable', async () => {
+        const mockContextNoCLArgs = {
+          amplify: {
+            showStatusTable: jest.fn(),
+          },
+          parameters: {
+            array: [],
+          },
+        };
+        runStatusCmd(mockContextNoCLArgs)
+        expect(mockContextNoCLArgs.amplify.showStatusTable).toBeCalled();
+      });
+
+    it('status -v run method should call context.amplify.showStatusTable', async () => {
+        const mockContextWithVerboseOptionAndCLArgs = {
+            amplify: {
+              showStatusTable: jest.fn(),
+            },
+            input :{
+                command: "status",
+                options: {
+                    verbose : true
+                }
+            }
+        };
+        runStatusCmd(mockContextWithVerboseOptionAndCLArgs)
+        expect(mockContextWithVerboseOptionAndCLArgs.amplify.showStatusTable).toBeCalled();
+    });
+
+    it('status -v <category>* run method should call context.amplify.showStatusTable', async () => {
+        const mockContextWithVerboseOptionWithCategoriesAndCLArgs = {
+            amplify: {
+              showStatusTable: jest.fn(),
+            },
+            input :{
+                command: "status",
+                options: {
+                    verbose : true,
+                    api : true,
+                    storage : true
+                }
+            }
+        };
+        runStatusCmd(mockContextWithVerboseOptionWithCategoriesAndCLArgs)
+        expect(mockContextWithVerboseOptionWithCategoriesAndCLArgs.amplify.showStatusTable).toBeCalled();
+    });
+
+
+})

packages/amplify-cli/src/commands/status.ts

@@ -1,10 +1,22 @@
+import { constructCloudWatchEventComponent } from "amplify-category-function/src/provider-utils/awscloudformation/utils/cloudformationHelpers";
+import { ViewResourceTableParams, CLIParams } from "amplify-cli-core/lib/cliViewAPI";
+
+
 export const run = async context => {
-  await context.amplify.showResourceTable();
-  await context.amplify.showHelpfulProviderLinks(context);
-  await showAmplifyConsoleHostingStatus(context);
+  const cliParams:CLIParams  = { cliCommand : context?.input?.command,
+                                 cliSubcommands: context?.input?.subCommands,
+                                 cliOptions : context?.input?.options }
+  const view = new ViewResourceTableParams( cliParams );
+  if ( context?.input?.subCommands?.includes("help")){
+     console.log( view.getStyledHelp())
+  } else {
+    await context.amplify.showStatusTable( view );
+    await context.amplify.showHelpfulProviderLinks(context);
+    await showAmplifyConsoleHostingStatus(context);
+  }
 };
 
-async function showAmplifyConsoleHostingStatus(context) {
+async function showAmplifyConsoleHostingStatus( context) {
   const pluginInfo = context.amplify.getCategoryPluginInfo(context, 'hosting', 'amplifyhosting');
   if (pluginInfo && pluginInfo.packageLocation) {
     const { status } = require(pluginInfo.packageLocation);

packages/amplify-cli/src/domain/amplify-toolkit.ts

@@ -41,6 +41,7 @@ export class AmplifyToolkit {
   private _showHelp: any;
   private _showHelpfulProviderLinks: any;
   private _showResourceTable: any;
+  private _showStatusTable: any;
   private _serviceSelectionPrompt: any;
   private _updateProjectConfig: any;
   private _updateamplifyMetaAfterResourceUpdate: any;
@@ -258,6 +259,13 @@ export class AmplifyToolkit {
       this._showResourceTable || require(path.join(this._amplifyHelpersDirPath, 'resource-status')).showResourceTable;
     return this._showResourceTable;
   }
+
+  get showStatusTable(): any {
+    this._showStatusTable =
+    this._showStatusTable || require(path.join(this._amplifyHelpersDirPath, 'resource-status')).showStatusTable;
+    return this._showStatusTable;
+  }
+
   get serviceSelectionPrompt(): any {
     this._serviceSelectionPrompt =
       this._serviceSelectionPrompt || require(path.join(this._amplifyHelpersDirPath, 'service-select-prompt')).serviceSelectionPrompt;