Merging development in master for Release 0.3.0 (#28)

riteshnahar · Mayank Nehru · mayank.nehru · web-flow · commit 50bdcbe40770 · 2020-09-11T21:44:31.000+05:30
* PRO-16810: ProvarDX Incorrect Help messages (#23) - Updated help messages for runtests, validate commands displayed on running `sfdx provar --help` - Updated company name in LICENSE.md * PRO-16923: ProvarDX runtests fails to handle special characters in Scratch Org Passwords properly (#25) * PRO-16923: ProvarDX runtests fails to handle special characters in Scratch Org Passwords properly * PRO-16923: Special characters were causing issues on different OS so encoded the password * PRO-16897: ProvarDX: Runtests secrets flag override incorrectly documented * PRO-16897: ProvarDX: Runtests secrets flag override incorrectly documented * PRO-16890 : Enforce required flags for provar:metadatacache (#26) * PRO-16890 : Enforce required flags for provar:metadatacache The command started executing even when required flags were not given. Changed that to give error in typescript itself. Also made changes to make sure that the flags work correctly in tandem. * PRO-16890 : Implement review comments and add change log * PRO-16890 : Implement review comments Corrected conditional checks to use "===" & '!==' for comparison and renamed variables with self explanatory names * PRO-16890 : Implement review comments Co-authored-by: mayank.nehru <mayank.nehru@HP-Mayanknehru> * PRO-17213: ProvarDX 0.3.0 release (#27) Bumped version to 0.3.0 Co-authored-by: Mayank Nehru <mayank.nehru@provartesting.com> Co-authored-by: mayank.nehru <mayank.nehru@HP-Mayanknehru> Co-authored-by: ProvarTesting <6640365+ProvarTesting@users.noreply.github.com>
diff --git a/.gitignore b/.gitignore
@@ -8,4 +8,3 @@
 node_modules
 /.circleci
 /.sfdx
-/.vscode
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -0,0 +1,35 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "type": "node",
+            "request": "attach",
+            "name": "Attach to Remote",
+            "address": "127.0.0.1",
+            "port": 9229
+        },
+        {
+            "name": "Unit Tests",
+            "type": "node",
+            "request": "launch",
+            "protocol": "inspector",
+            "program": "${workspaceRoot}/node_modules/.bin/_mocha",
+            "args": [
+                "--require",
+                "test/helpers/init.js",
+                "--require",
+                "ts-node/register",
+                "--require",
+                "source-map-support/register",
+                "--recursive",
+                "--reporter",
+                "spec",
+                "test/**/*.test.ts"
+            ],
+            "cwd": "${workspaceRoot}"
+        }
+    ]
+}
diff --git a/.vscode/provardx-copyright.code-snippets b/.vscode/provardx-copyright.code-snippets
@@ -0,0 +1,15 @@
+{
+	"Insert Copyright Header": {
+		"prefix": "copyright",
+		"body": [
+		  "/*",
+		  " * Copyright (c) 2020 Make Positive Provar Ltd",
+		  " * All rights reserved.",
+		  " * Licensed under the BSD 3-Clause license.",
+		  " * For full license text, see LICENSE.md file in the repo root or https://opensource.org/licenses/BSD-3-Clause",
+		  " */",
+		  "$0"
+		],
+		"description": "Insert the Provar copyright header"
+	  }
+}
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,6 +5,25 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.3.0] - 2020-09-11
+
+### Fixed
+
+-   ProvarDX runtests, metadatacache command fails in case we are having special characters in Scratch Org password
+-   Enforced the required flags for ProvarDX metadatacache command
+-   Fixed the working of flags for ProvarDX metadatacache command in tandem
+
+### Changed
+
+-   ProvarDX trademark changes
+-   Updated help messages for runtests
+
+### Added
+
+-   Added .vscode folder containing
+    -   `launch.json`: debug configuration for vscode
+    -   `provardx-copyright.code-snippets`: used to add copyright tag on source files
+
 ## [0.2.2] - 2020-08-04
 
 ### Changed
diff --git a/README.md b/README.md
@@ -1,6 +1,6 @@
-# provartesting/provardx
+# ProvarDX™
 
-ProvarDX is a Salesforce CLI Plugin for existing Provar customer to allow them to execute Provar Test Cases from the command line, leveraging the Salesforce CLI and SalesforceDX applications. This provides an alternative mechanism for running test cases than running under ANT.
+ProvarDX™ is a Salesforce CLI Plugin for existing Provar customer to allow them to execute Provar Test Cases from the command line, leveraging the Salesforce CLI and SalesforceDX applications. This provides an alternative mechanism for running test cases than running under ANT.
 You must be a Provar customer with a valid paid license to write and maintain your test cases.
 
 [![Version](https://img.shields.io/npm/v/@provartesting/provardx.svg)](https://npmjs.org/package/@provartesting/provardx)
@@ -126,7 +126,7 @@ OPTIONS
                                                        must be in JSON format and conform to the provardx-properties
                                                        JSON schema.
 
-  -s, --secrets=secrets                                Specify path to secrets file
+  -s, --secrets=secrets                                Specify a secrets encryption key for accessing the chosen project/environment.
 
   --json                                               format output as json
 
diff --git a/messages/runtests.json b/messages/runtests.json
@@ -5,6 +5,6 @@
     "connectionOverridefile": "Connection file in the format provardx-connection-schema.json providing a mapping between the Provar project Connection names and the target users to be used.",
     "cachePathFlagDescription": "Specify relative or full file path for where a metadata cache has already been downloaded using either a VCS extract or metadata ProvarDX command.",
     "metadataLevelFlagDescription": "Specify permitted values reload (get all metadata - default) | refresh (only download changes). This overrides any settings made in the propertyfile.",
-    "secretsFlagDescription": "Specify path to secrets file",
+    "secretsFlagDescription": "Specify a secrets encryption key for accessing the chosen project/environment.",
     "loglevelFlagDescription": "Specify the level of feedback provided during the compilation (see above) and execution."
 }
diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
     "name": "@provartesting/provardx",
     "description": "A plugin for the Salesforce CLI to run provar testcases",
-    "version": "0.2.2",
+    "version": "0.3.0",
     "author": "Provar",
     "bugs": "https://github.com/ProvarTesting/provardx/issues",
     "dependencies": {
diff --git a/src/commands/provar/metadatacache.ts b/src/commands/provar/metadatacache.ts
@@ -81,6 +81,22 @@ export default class MetadataCache extends SfdxCommand {
         const connections: string = this.flags.connections;
         const connectionoverrides: string = this.flags.connectionoverrides;
 
+        if (
+            !metadataLevel || !cachePath
+        ) {
+            this.ux.error(
+                "ERROR running provar:metadatacache :  Please specify a cachepath and metadatalevel"
+            );
+            return {};
+        }
+
+        if (!["Reload", "Refresh", "Reuse"].includes(metadataLevel)) {
+            this.ux.error(
+                "ERROR running provar:metadatacache : Please specify a valid metadata level(-m flag). Valid levels are : 'Reuse', 'Refresh' and 'Reload'"
+            );
+            return {};
+        }
+
         const provarDxUtils: ProvarDXUtility = new ProvarDXUtility();
         const isValid: boolean = provarDxUtils.validatePropertiesJson(
             propertyFile
@@ -96,7 +112,7 @@ export default class MetadataCache extends SfdxCommand {
             provarDxUtils.hasDuplicateConnectionOverride(propertiesInstance)
         ) {
             this.ux.error(
-                "Invalid property file. Run command sfdx provar:validate' to know the validation errors"
+                "ERROR running provar:metadatacache : Please specify a valid property file. Run command sfdx provar:validate' to know the validation errors"
             );
             return {};
         }
@@ -117,26 +133,26 @@ export default class MetadataCache extends SfdxCommand {
         const userInfo = await provarDxUtils.getDxUsersInfo(
             properties.connectionOverride
         );
-        if (userInfo == null) {
+        if (userInfo === null && !connections) {
             this.ux.error(
                 '[ERROR] No valid user org found to download metadata. Terminating command.'
             );
             return {};
         }
 
-        const userInfoString = provarDxUtils.prepareRawProperties(
+        const userInfoString = connections && userInfo === null ? "NA" : provarDxUtils.prepareRawProperties(
             JSON.stringify({ dxUsers: userInfo })
         );
         const jarPath = properties.provarHome + '/provardx/provardx.jar';
         execSync(
             'java -cp "' +
-                jarPath +
-                '" com.provar.provardx.DxCommandExecuter ' +
-                updateProperties +
-                ' ' +
-                userInfoString +
-                ' ' +
-                'Metadata',
+            jarPath +
+            '" com.provar.provardx.DxCommandExecuter ' +
+            updateProperties +
+            ' ' +
+            userInfoString +
+            ' ' +
+            'Metadata',
             { stdio: 'inherit' }
         );
         return {};
@@ -167,15 +183,30 @@ export default class MetadataCache extends SfdxCommand {
         properties: any,
         connectionOverride: string
     ): void {
-        if (!connectionOverride) {
+        if (!connectionOverride && !properties.connectionName) {
             return;
         }
-        const overrides = connectionOverride.split(',');
-        const connOver = [];
-        for (const override of overrides) {
-            const v = override.split(':');
-            connOver.push({ connection: v[0], username: v[1] });
+
+        if (properties.connectionName && properties.connectionOverride) {
+            const overrides = properties.connectionName.split(',');
+            const connOver = [];
+            for (const override of properties.connectionOverride) {
+                if (overrides.indexOf(override.connection) !== -1) {
+                    connOver.push(override);
+                }
+            }
+            properties.connectionOverride = connOver;
+        }
+
+        if (connectionOverride) {
+            const overrides = connectionOverride.split(',');
+            for (const override of overrides) {
+                const overrideDetails = override.split(':');
+                const prop = properties.connectionOverride.find(f => f.connection === overrideDetails[0]);
+                if(prop){
+                    prop.username = overrideDetails[1];
+                }
+            }
         }
-        properties.connectionOverride = connOver;
     }
 }
diff --git a/src/utilities/ProvarDXUtility.ts b/src/utilities/ProvarDXUtility.ts
@@ -169,9 +169,7 @@ export default class ProvarDXUtility {
 
     private handleSpecialCharacters(password: string): string {
         if (password) {
-            password = password.split('&').join('"&"');
-            password = password.split('|').join('"|"');
-            password = password.split('^').join('"^"');
+            password = encodeURIComponent(password);
         }
         return password;
     }

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,6 @@`
`5`	`5`	`"connectionOverridefile": "Connection file in the format provardx-connection-schema.json providing a mapping between the Provar project Connection names and the target users to be used.",`
`6`	`6`	`"cachePathFlagDescription": "Specify relative or full file path for where a metadata cache has already been downloaded using either a VCS extract or metadata ProvarDX command.",`
`7`	`7`	`"metadataLevelFlagDescription": "Specify permitted values reload (get all metadata - default) \| refresh (only download changes). This overrides any settings made in the propertyfile.",`
`8`		`- "secretsFlagDescription": "Specify path to secrets file",`
	`8`	`+ "secretsFlagDescription": "Specify a secrets encryption key for accessing the chosen project/environment.",`
`9`	`9`	`"loglevelFlagDescription": "Specify the level of feedback provided during the compilation (see above) and execution."`
`10`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "@provartesting/provardx",`
`3`	`3`	`"description": "A plugin for the Salesforce CLI to run provar testcases",`
`4`		`- "version": "0.2.2",`
	`4`	`+ "version": "0.3.0",`
`5`	`5`	`"author": "Provar",`
`6`	`6`	`"bugs": "https://github.com/ProvarTesting/provardx/issues",`
`7`	`7`	`"dependencies": {`
Original file line number	Diff line number	Diff line change
`@@ -169,9 +169,7 @@ export default class ProvarDXUtility {`
`169`	`169`
`170`	`170`	`private handleSpecialCharacters(password: string): string {`
`171`	`171`	`if (password) {`
`172`		`- password = password.split('&').join('"&"');`
`173`		`- password = password.split('\|').join('"\|"');`
`174`		`- password = password.split('^').join('"^"');`
	`172`	`+ password = encodeURIComponent(password);`
`175`	`173`	`}`
`176`	`174`	`return password;`
`177`	`175`	`}`