Sh/cmd output (#71)

* feat: changes deploy output to more closely match too

Temporarily renames the deploy and retrieve commands for testing command output side by side with
toolbelt.  Introduces output formatters for commands to implement.

* refactor: revert temporary renaming for testing

* refactor: add an abstract DeployCommand

* refactor: standardizing all source commands and output

* feat: test updates for code rearrangement

* refactor: move createComponentSet to ComponentSetBuilder.build

moves the createComponentSet method on SourceCommand to its own class with a static build method
since not all source commands need to build a component set.

* refactor: move getPackageDir() to SourceCommand

* fix: update testkit dep

update testkit dep and remove apiversion override

Author: shetzel

CHANGELOG.md

@@ -11,10 +11,9 @@ All notable changes to this project will be documented in this file. See [standa
 
 ### [0.0.10](https://github.com/salesforcecli/plugin-source/compare/v0.0.9...v0.0.10) (2021-04-23)
 
-
 ### Bug Fixes
 
-* new hooks, updated tests ([#69](https://github.com/salesforcecli/plugin-source/issues/69)) ([81e1058](https://github.com/salesforcecli/plugin-source/commit/81e10581456ceccb4b3e07f3d1310bb18bef25ff))
+- new hooks, updated tests ([#69](https://github.com/salesforcecli/plugin-source/issues/69)) ([81e1058](https://github.com/salesforcecli/plugin-source/commit/81e10581456ceccb4b3e07f3d1310bb18bef25ff))
 
 ### [0.0.9](https://github.com/salesforcecli/plugin-source/compare/v0.0.8...v0.0.9) (2021-04-13)
 

command-snapshot.json

@@ -59,6 +59,7 @@
       "packagenames",
       "sourcepath",
       "targetusername",
+      "verbose",
       "wait"
     ]
   }

messages/deploy.json

@@ -11,7 +11,7 @@
     "$ sfdx force:source:deploy -x path/to/package.xml",
     "$ sfdx force:source:deploy -m ApexClass -l RunLocalTests",
     "$ sfdx force:source:deploy -m ApexClass -l RunAllTestsInOrg -c",
-    "$ sfdx force:source:deploy -q 0Af9A00000FTM6pSAH`"
+    "$ sfdx force:source:deploy -q 0Af9A00000FTM6pSAH"
   ],
   "flags": {
     "sourcePath": "comma-separated list of source file paths to deploy",
@@ -24,8 +24,9 @@
     "runTests": "tests to run if --testlevel RunSpecifiedTests",
     "ignoreErrors": "ignore any errors and do not roll back deployment",
     "ignoreWarnings": "whether a warning will allow a deployment to complete successfully",
-    "validateDeployRequestId": "request ID of the validated deployment to run a Quick Deploy",
+    "validateDeployRequestId": "deploy request ID of the validated deployment to run a Quick Deploy",
     "soapDeploy": "deploy metadata with SOAP API instead of REST API"
   },
-  "checkOnlySuccess": "\nSuccessfully validated the deployment"
+  "checkOnlySuccess": "Successfully validated the deployment. %s components deployed and %s tests run.\nUse the --verbose parameter to see detailed output.",
+  "MissingDeployId": "No deploy ID was provided or found in deploy history"
 }

messages/retrieve.json

@@ -14,8 +14,6 @@
   ],
   "flags": {
     "sourcePath": "comma-separated list of source file paths to retrieve",
-    "manifestParamDescription": "file path for manifest (package.xml) of components to retrieve",
-    "metadataParamDescription": "comma-separated list of metadata component names",
     "wait": "wait time for command to finish in minutes",
     "manifest": "file path for manifest (package.xml) of components to retrieve",
     "metadata": "comma-separated list of metadata component names",

package.json

@@ -16,7 +16,7 @@
   "devDependencies": {
     "@oclif/dev-cli": "^1",
     "@oclif/plugin-command-snapshot": "^2.0.0",
-    "@salesforce/cli-plugins-testkit": "^0.0.15",
+    "@salesforce/cli-plugins-testkit": "^0.0.27",
     "@salesforce/dev-config": "^2.1.0",
     "@salesforce/dev-scripts": "^0.9.1",
     "@salesforce/plugin-apex": "^0.1.18",

src/commands/force/source/convert.ts

@@ -6,20 +6,17 @@
  */
 
 import * as os from 'os';
-import { resolve } from 'path';
 import { flags, FlagsConfig } from '@salesforce/command';
 import { Messages } from '@salesforce/core';
-import { MetadataConverter } from '@salesforce/source-deploy-retrieve';
-import { asArray, asString } from '@salesforce/ts-types';
+import { MetadataConverter, ConvertResult } from '@salesforce/source-deploy-retrieve';
+import { getString } from '@salesforce/ts-types';
 import { SourceCommand } from '../../../sourceCommand';
+import { ConvertResultFormatter, ConvertCommandResult } from '../../../formatters/convertResultFormatter';
+import { ComponentSetBuilder } from '../../../componentSetBuilder';
 
 Messages.importMessagesDirectory(__dirname);
 const messages = Messages.loadMessages('@salesforce/plugin-source', 'convert');
 
-type ConvertResult = {
-  location: string;
-};
-
 export class Convert extends SourceCommand {
   public static readonly description = messages.getMessage('description');
   public static readonly examples = messages.getMessage('examples').split(os.EOL);
@@ -55,42 +52,67 @@ export class Convert extends SourceCommand {
     }),
   };
 
-  public async run(): Promise<ConvertResult> {
+  protected convertResult: ConvertResult;
+
+  public async run(): Promise<ConvertCommandResult> {
+    await this.convert();
+    this.resolveSuccess();
+    return this.formatResult();
+  }
+
+  protected async convert(): Promise<void> {
     const paths: string[] = [];
 
-    if (this.flags.sourcepath) {
-      paths.push(...this.flags.sourcepath);
+    const { sourcepath, metadata, manifest, rootdir } = this.flags;
+
+    if (sourcepath) {
+      paths.push(...sourcepath);
     }
 
     // rootdir behaves exclusively to sourcepath, metadata, and manifest... to maintain backwards compatibility
     // we will check here, instead of adding the exclusive option to the flag definition so we don't break scripts
-    if (this.flags.rootdir && !this.flags.sourcepath && !this.flags.metadata && !this.flags.manifest) {
+    if (rootdir && !sourcepath && !metadata && !manifest) {
       // only rootdir option passed
-      paths.push(this.flags.rootdir);
+      paths.push(rootdir);
     }
 
     // no options passed, convert the default package (usually force-app)
-    if (!this.flags.sourcepath && !this.flags.metadata && !this.flags.manifest && !this.flags.rootdir) {
+    if (!sourcepath && !metadata && !manifest && !rootdir) {
       paths.push(this.project.getDefaultPackage().path);
     }
 
-    const cs = await this.createComponentSet({
+    const cs = await ComponentSetBuilder.build({
       sourcepath: paths,
-      manifest: asString(this.flags.manifest),
-      metadata: asArray<string>(this.flags.metadata),
+      manifest: manifest && {
+        manifestPath: this.getFlag<string>('manifest'),
+        directoryPaths: this.getPackageDirs(),
+      },
+      metadata: metadata && {
+        metadataEntries: this.getFlag<string[]>('metadata'),
+        directoryPaths: this.getPackageDirs(),
+      },
     });
 
     const converter = new MetadataConverter();
-    const res = await converter.convert(cs.getSourceComponents().toArray(), 'metadata', {
+    this.convertResult = await converter.convert(cs.getSourceComponents().toArray(), 'metadata', {
       type: 'directory',
-      outputDirectory: asString(this.flags.outputdir),
-      packageName: asString(this.flags.packagename),
+      outputDirectory: this.getFlag<string>('outputdir'),
+      packageName: this.getFlag<string>('packagename'),
     });
+  }
 
-    this.ux.log(messages.getMessage('success', [res.packagePath]));
+  protected resolveSuccess(): void {
+    if (!getString(this.convertResult, 'packagePath')) {
+      this.setExitCode(1);
+    }
+  }
 
-    return {
-      location: resolve(res.packagePath),
-    };
+  protected formatResult(): ConvertCommandResult {
+    const formatter = new ConvertResultFormatter(this.logger, this.ux, this.convertResult);
+
+    if (!this.isJsonOutput()) {
+      formatter.display();
+    }
+    return formatter.getJson();
   }
 }