@provartesting/provardx-cli 0.0.7-beta → 1.1.1

package/lib/constants/propertyFileSchema.js

@@ -1,248 +0,0 @@
-/*
- * Copyright (c) 2024 Provar Limited.
- * 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
- */
-const nonEmptyStringRegex = /^(?!\s+$)./;
-export const propertyFileSchema = {
-    $schema: 'http://json-schema.org/draft-07/schema#',
-    $id: 'http://provartesting.com/provardx-props.schema.json',
-    title: 'ProvarDX-Properties',
-    description: 'A ProvarDX Property File',
-    type: 'object',
-    required: ['provarHome', 'projectPath', 'resultsPath', 'metadata', 'environment'],
-    dependentRequired: {
-        attachmentProperties: 'emailProperties',
-    },
-    properties: {
-        provarHome: {
-            description: 'Contains the location that the Provar installation was unzipped. ​This attribute is not required if there is a full Provar installation in the default location, or if PROVAR_HOME Environment Variable is set',
-            type: 'string',
-            pattern: nonEmptyStringRegex,
-        },
-        projectPath: {
-            description: 'The fully qualified path of the Test Project containing the tests to be run.  This is the folder that contains the .testproject file',
-            type: 'string',
-            pattern: nonEmptyStringRegex,
-        },
-        smtpPath: {
-            description: 'The fully qualified path of the .smtp folder to which Provar will use to send emails',
-            type: 'string',
-        },
-        resultsPath: {
-            description: 'The fully qualified path of the folder to which Provar will write the test results',
-            type: 'string',
-            pattern: nonEmptyStringRegex,
-        },
-        resultsPathDisposition: {
-            description: 'Controls the result folder disposition.',
-            type: 'string',
-            enum: ['Increment', 'Replace', 'Fail'],
-        },
-        testOutputLevel: {
-            description: 'Controls the amount of test output logged to the DX test log.',
-            type: 'string',
-            enum: ['BASIC', 'DETAILED', 'DIAGNOSTIC'],
-        },
-        pluginOutputlevel: {
-            description: 'Controls the amount of plugin output logged to the DX test log.',
-            type: 'string',
-            enum: ['SEVERE', 'WARNING', 'INFO', 'FINE', 'FINER', 'FINEST'],
-        },
-        excludeCallable: {
-            description: 'Indicates whether Callable Test Cases should be omitted from execution (true) or included in execution (false)',
-            type: 'boolean',
-        },
-        stopOnError: {
-            description: 'Indicates whether the Test Run should abort automatically if any test failure is encountered',
-            type: 'boolean',
-        },
-        connectionRefreshType: {
-            description: 'Controls the Metadata at Connection level',
-            type: 'string',
-        },
-        lightningMode: {
-            description: 'Indicates org is lightning or not',
-            type: 'boolean',
-        },
-        metadata: {
-            description: 'Controls the Salesforce Metadata usage.',
-            type: 'object',
-            properties: {
-                metadataLevel: {
-                    description: 'Controls the Salesforce Metadata usage',
-                    type: 'string',
-                    enum: ['Reuse', 'Reload', 'Refresh'],
-                },
-                cachePath: {
-                    description: 'The fully qualified path of the folder that will be used for storing the metadata cache',
-                    type: 'string',
-                    pattern: nonEmptyStringRegex,
-                },
-            },
-            required: ['metadataLevel', 'cachePath'],
-        },
-        environment: {
-            description: '',
-            type: 'object',
-            properties: {
-                testEnvironment: {
-                    description: 'The name of the Test Environment that the test run should be executed against. Test Environments are defined in Test Settings',
-                    type: 'string',
-                },
-                webBrowser: {
-                    description: 'The web browser to be used for UI testing',
-                    type: 'string',
-                    enum: ['Chrome', 'Safari', 'Edge', 'Edge_Legacy', 'Firefox', 'IE', 'Chrome_Headless'],
-                },
-                webBrowserConfig: {
-                    description: 'The web browser window size. Browser configurations are defined in Test Settings',
-                    type: 'string',
-                    pattern: nonEmptyStringRegex,
-                },
-                webBrowserProviderName: {
-                    description: 'Web browser provider name.',
-                    type: 'string',
-                    pattern: nonEmptyStringRegex,
-                },
-                webBrowserDeviceName: {
-                    description: 'Web browser device name',
-                    type: 'string',
-                    pattern: nonEmptyStringRegex,
-                },
-            },
-            required: ['webBrowser', 'webBrowserConfig', 'webBrowserProviderName', 'webBrowserDeviceName'],
-        },
-        testprojectSecrets: {
-            description: 'Test project secret encryption password.',
-            type: 'string',
-        },
-        environmentsSecrets: {
-            description: 'Test environment secret encryption password.',
-            type: 'array',
-            items: {
-                type: 'object',
-                properties: {
-                    name: { type: 'string' },
-                    secretsPassword: { type: 'string' },
-                },
-            },
-        },
-        testplanFeatures: {
-            description: 'Test plan features.',
-            type: 'array',
-            items: {
-                type: 'object',
-                properties: {
-                    name: { type: 'string' },
-                    type: { type: 'string' },
-                    enabled: { type: 'string' },
-                },
-            },
-        },
-        emailProperties: {
-            description: 'One or more email recipients defining settings for sending email upon test execution completion',
-            type: 'object',
-            properties: {
-                sendEmail: {
-                    description: 'Indicates whether an email should be sent after test run execution',
-                    type: 'string',
-                },
-                primaryRecipients: {
-                    description: 'The primary email addresses which should receive the email',
-                    type: 'string',
-                },
-                ccRecipients: {
-                    description: 'he email addresses which should be CC’d in the email',
-                    type: 'string',
-                },
-                bccRecipients: {
-                    description: 'The email addresses which should be BCC’d in the email',
-                    type: 'string',
-                },
-            },
-            required: ['sendEmail', 'primaryRecipients'],
-        },
-        testPlan: {
-            description: 'List of test plan names to be executed, wildcards are permitted',
-            type: 'array',
-            items: {
-                type: 'string',
-            },
-        },
-        attachmentProperties: {
-            description: 'Attributes defining what to include in PDF while attaching PDF report under email upon test execution completion',
-            type: 'object',
-            properties: {
-                includeAllFailuresInSummary: {
-                    description: 'Property to include every test step failure in PDF summary',
-                    type: 'string',
-                },
-                includeBdd: {
-                    description: 'Property to include testCase summary for bdd/design steps',
-                    type: 'string',
-                },
-                includeTestCaseShowSummary: {
-                    description: 'Property to include summaryBlockInfo in PDF report',
-                    type: 'string',
-                },
-                includeScreenshotThumbnail: {
-                    description: 'Property to include Screenshot thumbnail (small image representation) for steps screenshots are there',
-                    type: 'string',
-                },
-                includeBasicLogs: {
-                    description: 'Property to include basic logging only in PDF report',
-                    type: 'string',
-                },
-                includeDetailLogs: {
-                    description: 'Property to include detailed logging only in PDF report',
-                    type: 'string',
-                },
-                includeTestStepTime: {
-                    description: 'Property to include time for every test step execution in PDF report',
-                    type: 'string',
-                },
-                includeFullScreenShot: {
-                    description: 'Property to include full screenshot for every step in PDF report',
-                    type: 'string',
-                },
-                includeNoScreenshot: {
-                    description: 'Property to include no screenshot in PDF report',
-                    type: 'string',
-                },
-                includeDiagnosticTrace: {
-                    description: 'Property to include Diagnostic level logging in PDF report',
-                    type: 'string',
-                },
-                includeTestCasePathHierarchy: {
-                    description: 'Property to include testcase path hierachy of testcase execution in PDF report',
-                    type: 'string',
-                },
-                includeSkipped: {
-                    description: 'Property to include details of skipped test steps while testcase execution in PDF report',
-                    type: 'string',
-                },
-            },
-        },
-        testCase: {
-            description: 'One or more fileset elements defining the .testcase files to be run.  You can specify individual Test Case files, folders containing Test Case files or a combination of both',
-            type: 'array',
-            items: {
-                type: 'string',
-            },
-        },
-        connectionOverride: {
-            description: 'name:value pairs where the first entry is the provar Connection name and the second is a SFDX username/user-alias to substitute',
-            type: 'array',
-            items: {
-                type: 'object',
-                properties: {
-                    connection: { type: 'string' },
-                    username: { type: 'string' },
-                },
-            },
-        },
-    },
-};
-//# sourceMappingURL=propertyFileSchema.js.map

package/lib/constants/propertyFileSchema.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"propertyFileSchema.js","sourceRoot":"","sources":["../../src/constants/propertyFileSchema.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AACH,MAAM,mBAAmB,GAAG,YAAY,CAAC;AAEzC,MAAM,CAAC,MAAM,kBAAkB,GAAG;IAChC,OAAO,EAAE,yCAAyC;IAClD,GAAG,EAAE,qDAAqD;IAC1D,KAAK,EAAE,qBAAqB;IAC5B,WAAW,EAAE,0BAA0B;IACvC,IAAI,EAAE,QAAQ;IACd,QAAQ,EAAE,CAAC,YAAY,EAAE,aAAa,EAAE,aAAa,EAAE,UAAU,EAAE,aAAa,CAAC;IACjF,iBAAiB,EAAE;QACjB,oBAAoB,EAAE,iBAAiB;KACxC;IACD,UAAU,EAAE;QACV,UAAU,EAAE;YACV,WAAW,EACT,gNAAgN;YAClN,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,mBAAmB;SAC7B;QACD,WAAW,EAAE;YACX,WAAW,EACT,sIAAsI;YACxI,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,mBAAmB;SAC7B;QACD,QAAQ,EAAE;YACR,WAAW,EAAE,sFAAsF;YACnG,IAAI,EAAE,QAAQ;SACf;QACD,WAAW,EAAE;YACX,WAAW,EAAE,oFAAoF;YACjG,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,mBAAmB;SAC7B;QACD,sBAAsB,EAAE;YACtB,WAAW,EAAE,yCAAyC;YACtD,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,WAAW,EAAE,SAAS,EAAE,MAAM,CAAC;SACvC;QACD,eAAe,EAAE;YACf,WAAW,EAAE,+DAA+D;YAC5E,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,OAAO,EAAE,UAAU,EAAE,YAAY,CAAC;SAC1C;QACD,iBAAiB,EAAE;YACjB,WAAW,EAAE,iEAAiE;YAC9E,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,CAAC,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,EAAE,OAAO,EAAE,QAAQ,CAAC;SAC/D;QACD,eAAe,EAAE;YACf,WAAW,EACT,gHAAgH;YAClH,IAAI,EAAE,SAAS;SAChB;QACD,WAAW,EAAE;YACX,WAAW,EAAE,8FAA8F;YAC3G,IAAI,EAAE,SAAS;SAChB;QACD,qBAAqB,EAAE;YACrB,WAAW,EAAE,2CAA2C;YACxD,IAAI,EAAE,QAAQ;SACf;QACD,aAAa,EAAE;YACb,WAAW,EAAE,mCAAmC;YAChD,IAAI,EAAE,SAAS;SAChB;QACD,QAAQ,EAAE;YACR,WAAW,EAAE,yCAAyC;YACtD,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,aAAa,EAAE;oBACb,WAAW,EAAE,wCAAwC;oBACrD,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,OAAO,EAAE,QAAQ,EAAE,SAAS,CAAC;iBACrC;gBACD,SAAS,EAAE;oBACT,WAAW,EAAE,yFAAyF;oBACtG,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,mBAAmB;iBAC7B;aACF;YACD,QAAQ,EAAE,CAAC,eAAe,EAAE,WAAW,CAAC;SACzC;QACD,WAAW,EAAE;YACX,WAAW,EAAE,EAAE;YACf,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,eAAe,EAAE;oBACf,WAAW,EACT,+HAA+H;oBACjI,IAAI,EAAE,QAAQ;iBACf;gBACD,UAAU,EAAE;oBACV,WAAW,EAAE,2CAA2C;oBACxD,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,CAAC,QAAQ,EAAE,QAAQ,EAAE,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,IAAI,EAAE,iBAAiB,CAAC;iBACtF;gBACD,gBAAgB,EAAE;oBAChB,WAAW,EAAE,kFAAkF;oBAC/F,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,mBAAmB;iBAC7B;gBACD,sBAAsB,EAAE;oBACtB,WAAW,EAAE,4BAA4B;oBACzC,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,mBAAmB;iBAC7B;gBACD,oBAAoB,EAAE;oBACpB,WAAW,EAAE,yBAAyB;oBACtC,IAAI,EAAE,QAAQ;oBACd,OAAO,EAAE,mBAAmB;iBAC7B;aACF;YACD,QAAQ,EAAE,CAAC,YAAY,EAAE,kBAAkB,EAAE,wBAAwB,EAAE,sBAAsB,CAAC;SAC/F;QACD,kBAAkB,EAAE;YAClB,WAAW,EAAE,0CAA0C;YACvD,IAAI,EAAE,QAAQ;SACf;QACD,mBAAmB,EAAE;YACnB,WAAW,EAAE,8CAA8C;YAC3D,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACxB,eAAe,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;iBACpC;aACF;SACF;QACD,gBAAgB,EAAE;YAChB,WAAW,EAAE,qBAAqB;YAClC,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACxB,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACxB,OAAO,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;iBAC5B;aACF;SACF;QACD,eAAe,EAAE;YACf,WAAW,EAAE,iGAAiG;YAC9G,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,SAAS,EAAE;oBACT,WAAW,EAAE,oEAAoE;oBACjF,IAAI,EAAE,QAAQ;iBACf;gBACD,iBAAiB,EAAE;oBACjB,WAAW,EAAE,4DAA4D;oBACzE,IAAI,EAAE,QAAQ;iBACf;gBACD,YAAY,EAAE;oBACZ,WAAW,EAAE,sDAAsD;oBACnE,IAAI,EAAE,QAAQ;iBACf;gBACD,aAAa,EAAE;oBACb,WAAW,EAAE,wDAAwD;oBACrE,IAAI,EAAE,QAAQ;iBACf;aACF;YACD,QAAQ,EAAE,CAAC,WAAW,EAAE,mBAAmB,CAAC;SAC7C;QACD,QAAQ,EAAE;YACR,WAAW,EAAE,iEAAiE;YAC9E,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;aACf;SACF;QACD,oBAAoB,EAAE;YACpB,WAAW,EACT,kHAAkH;YACpH,IAAI,EAAE,QAAQ;YACd,UAAU,EAAE;gBACV,2BAA2B,EAAE;oBAC3B,WAAW,EAAE,4DAA4D;oBACzE,IAAI,EAAE,QAAQ;iBACf;gBACD,UAAU,EAAE;oBACV,WAAW,EAAE,2DAA2D;oBACxE,IAAI,EAAE,QAAQ;iBACf;gBACD,0BAA0B,EAAE;oBAC1B,WAAW,EAAE,oDAAoD;oBACjE,IAAI,EAAE,QAAQ;iBACf;gBACD,0BAA0B,EAAE;oBAC1B,WAAW,EACT,uGAAuG;oBACzG,IAAI,EAAE,QAAQ;iBACf;gBACD,gBAAgB,EAAE;oBAChB,WAAW,EAAE,sDAAsD;oBACnE,IAAI,EAAE,QAAQ;iBACf;gBACD,iBAAiB,EAAE;oBACjB,WAAW,EAAE,yDAAyD;oBACtE,IAAI,EAAE,QAAQ;iBACf;gBACD,mBAAmB,EAAE;oBACnB,WAAW,EAAE,sEAAsE;oBACnF,IAAI,EAAE,QAAQ;iBACf;gBACD,qBAAqB,EAAE;oBACrB,WAAW,EAAE,kEAAkE;oBAC/E,IAAI,EAAE,QAAQ;iBACf;gBACD,mBAAmB,EAAE;oBACnB,WAAW,EAAE,iDAAiD;oBAC9D,IAAI,EAAE,QAAQ;iBACf;gBACD,sBAAsB,EAAE;oBACtB,WAAW,EAAE,4DAA4D;oBACzE,IAAI,EAAE,QAAQ;iBACf;gBACD,4BAA4B,EAAE;oBAC5B,WAAW,EAAE,gFAAgF;oBAC7F,IAAI,EAAE,QAAQ;iBACf;gBACD,cAAc,EAAE;oBACd,WAAW,EAAE,0FAA0F;oBACvG,IAAI,EAAE,QAAQ;iBACf;aACF;SACF;QACD,QAAQ,EAAE;YACR,WAAW,EACT,+KAA+K;YACjL,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;aACf;SACF;QACD,kBAAkB,EAAE;YAClB,WAAW,EACT,iIAAiI;YACnI,IAAI,EAAE,OAAO;YACb,KAAK,EAAE;gBACL,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,UAAU,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC9B,QAAQ,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;iBAC7B;aACF;SACF;KACF;CACF,CAAC"}

package/lib/constants/sfCommandConstants.d.ts

@@ -1,5 +0,0 @@
-export declare enum sfCommandConstants {
-    DISPLAY_USER_INFO = "sf org display user --json --target-org ",
-    GENERATE_PASSWORD = "sf org generate password --target-org ",
-    DX_COMMAND_EXECUTER = " com.provar.provardx.DxCommandExecuter "
-}

package/lib/constants/sfCommandConstants.js

@@ -1,7 +0,0 @@
-export var sfCommandConstants;
-(function (sfCommandConstants) {
-    sfCommandConstants["DISPLAY_USER_INFO"] = "sf org display user --json --target-org ";
-    sfCommandConstants["GENERATE_PASSWORD"] = "sf org generate password --target-org ";
-    sfCommandConstants["DX_COMMAND_EXECUTER"] = " com.provar.provardx.DxCommandExecuter ";
-})(sfCommandConstants || (sfCommandConstants = {}));
-//# sourceMappingURL=sfCommandConstants.js.map

package/lib/constants/sfCommandConstants.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"sfCommandConstants.js","sourceRoot":"","sources":["../../src/constants/sfCommandConstants.ts"],"names":[],"mappings":"AAAA,MAAM,CAAN,IAAY,kBAIX;AAJD,WAAY,kBAAkB;IAC5B,oFAA8D,CAAA;IAC9D,kFAA4D,CAAA;IAC5D,qFAA+D,CAAA;AACjE,CAAC,EAJW,kBAAkB,KAAlB,kBAAkB,QAI7B"}

package/messages/provar.automation.project.compile.md

@@ -1,21 +0,0 @@
-# summary
-
-Compile PageObject and PageControl Java source files into object code.
-
-# description
-
-Compile PageObject and PageControl Java source files into object code.
-
-# examples
-
-Compile the project using the configuration set in the properties file.
-
-- <%= config.bin %> <%= command.id %>
-
-# success_message
-
-The project was compiled successfully.
-
-# error.MultipleFailure
-
-%s

package/messages/provar.automation.setup.md

@@ -1,23 +0,0 @@
-# summary
-
-Download and Install Provar Automation.
-
-# description
-
-Download and Install Provar Automation.
-
-# examples
-
-- <%= config.bin %> <%= command.id %>
-
-# flags.version.summary
-
-Provar Automation build version number.
-
-# error.MultipleFailure
-
-%s
-
-# success_message
-
-Provar Automation was set up successfully. Please, remember to set the property “provarHome” to the relative path “ProvarHome”.

package/messages/provar.automation.test.run.md

@@ -1,19 +0,0 @@
-# summary
-
-Run the tests as specified in the loaded properties file.
-
-# description
-
-Run the tests as specified in the loaded properties file.
-
-# examples
-
-- <%= config.bin %> <%= command.id %>
-
-# error.MultipleFailure
-
-%s
-
-# success_message
-
-The tests were run successfully.

package/messages/provar.metadata.download.md

@@ -1,23 +0,0 @@
-# summary
-
-Download any required metadata for a specified Provar Salesforce connection.
-
-# description
-
-Download any required metadata for a specified Provar Salesforce connection.
-
-# examples
-
-- <%= config.bin %> <%= command.id %>
-
-# flags.connections.summary
-
-Comma-separated list of names of Provar Salesforce connections to use, as defined in the project.
-
-# error.MultipleFailure
-
-%s
-
-# success_message
-
-The metadata was downloaded successfully.