[terra-functional-testing] Add useSeleniumStandalonService option (#646)

* Add useSeleniumStandalonService option.

* Updated all misspellings of useSeleniumStandaloneService.

* Update packages/terra-functional-testing/src/terra-cli/wdio/index.js

Co-authored-by: Derek Yu <[email protected]>

Co-authored-by: Derek Yu <[email protected]>

packages/terra-functional-testing/CHANGELOG.md

@@ -7,6 +7,9 @@
 * Fixed
   * Update specPath in BaseCompare to replace `node_modules` with `tests/wdio`.
 
+* Added
+  * Added useSeleniumStandaloneService option for using the standalone-chrome host instead of the selenium docker service when building in Jenkins.
+
 ## 1.2.0 - (April 23, 2021)
 
 * Added

packages/terra-functional-testing/src/config/utils/getConfigurationOptions.js

@@ -22,15 +22,16 @@ const getConfigurationOptions = (options) => {
     suite,
     theme,
     updateScreenshots,
+    useSeleniumStandaloneService,
   } = options;
 
   return {
     baseUrl: `http://${externalHost || getIpAddress()}:${externalPort || 8080}`,
     capabilities: getCapabilities(browsers, !!gridUrl),
-    hostname: gridUrl || 'localhost',
+    hostname: gridUrl || (useSeleniumStandaloneService ? 'standalone-chrome' : 'localhost'),
     port: gridUrl ? 80 : 4444,
     launcherOptions: {
-      disableSeleniumService: disableSeleniumService || !!gridUrl,
+      disableSeleniumService: disableSeleniumService || useSeleniumStandaloneService || !!gridUrl,
       formFactor,
       gridUrl,
       keepAliveSeleniumDockerService,

packages/terra-functional-testing/src/terra-cli/wdio/index.js

@@ -143,6 +143,11 @@ const cli = {
         describe: 'Whether or not to automatically update all reference screenshots with the latest screenshots.',
         default: false,
       },
+      useSeleniumStandaloneService: {
+        type: 'boolean',
+        describe: 'A flag to use the selenium standalone service instead of the selenium docker service.',
+        default: process.env.USE_SELENIUM_STANDALONE_SERVICE === 'true',
+      },
     })
   ),
   handler: TestRunner.start,

packages/terra-functional-testing/src/terra-cli/wdio/test-runner.js

@@ -46,6 +46,7 @@ class TestRunner {
    * @param {array} options.suite - Overrides specs and runs only the defined suites.
    * @param {string} options.theme - A theme for the test run.
    * @param {boolean} options.updateScreenshots - Updates all reference screenshots with the latest screenshots.
+   * @param {boolean} options.useSeleniumStandaloneService - A flag to use the selenium standalone service instead of the selenium docker service.
    * @returns {Promise} A promise that resolves with the test run exit code.
    */
   static async run(options) {
@@ -86,6 +87,7 @@ class TestRunner {
    * @param {array} options.suite - Overrides specs and runs only the defined suites.
    * @param {string} options.themes - A list of themes for the test run.
    * @param {boolean} options.updateScreenshots - Updates all reference screenshots with the latest screenshots.
+   * @param {boolean} options.useSeleniumStandaloneService - A flag to use the selenium standalone service instead of the selenium docker service.
    */
   static async start(options) {
     const {

packages/terra-functional-testing/tests/jest/config/utils/getConfigurationOptions.test.js

@@ -21,6 +21,7 @@ describe('getCapabilities', () => {
       suite: 'test-suite',
       theme: 'terra-default-theme',
       updateScreenshots: true,
+      useSeleniumStandaloneService: false,
     };
 
     const defaultWebpackPath = path.resolve(process.cwd(), 'webpack.config.js');
@@ -53,6 +54,55 @@ describe('getCapabilities', () => {
     expect(config).toEqual(expectedConfig);
   });
 
+  it('should get configuration with useSeleniumStandaloneService', async () => {
+    const options = {
+      assetServerPort: 8080,
+      browsers: ['chrome'],
+      config: '/path',
+      disableSeleniumService: false,
+      externalHost: 'externalHost',
+      externalPort: 3000,
+      formFactor: 'small',
+      keepAliveSeleniumDockerService: true,
+      locale: 'en',
+      site: 'build',
+      spec: '/spec/',
+      suite: 'test-suite',
+      theme: 'terra-default-theme',
+      updateScreenshots: true,
+      useSeleniumStandaloneService: true,
+    };
+
+    const defaultWebpackPath = path.resolve(process.cwd(), 'webpack.config.js');
+    const capabilities = getCapabilities(options.browsers, !!options.gridUrl);
+
+    const expectedConfig = {
+      baseUrl: `http://${options.externalHost}:${options.externalPort}`,
+      capabilities,
+      hostname: 'standalone-chrome',
+      port: 4444,
+      spec: options.spec,
+      suite: options.suite,
+      launcherOptions: {
+        disableSeleniumService: true,
+        formFactor: options.formFactor,
+        gridUrl: undefined,
+        keepAliveSeleniumDockerService: true,
+        locale: options.locale,
+        port: options.assetServerPort,
+        site: options.site,
+        theme: options.theme,
+        overrideTheme: options.theme,
+        updateScreenshots: true,
+        webpackConfig: defaultWebpackPath,
+      },
+    };
+
+    const config = getConfigurationOptions(options);
+
+    expect(config).toEqual(expectedConfig);
+  });
+
   it('should get configuration with empty options', async () => {
     const defaultWebpackPath = path.resolve(process.cwd(), 'webpack.config.js');
     const capabilities = getCapabilities(undefined, !!undefined);

packages/terra-functional-testing/tests/jest/terra-cli/wdio/__snapshots__/index.test.js.snap

@@ -44,7 +44,10 @@ Options:
   -u, --updateScreenshots               Whether or not to automatically update
                                         all reference screenshots with the
                                         latest screenshots.
-                                                      [boolean] [default: false]"
+                                                      [boolean] [default: false]
+      --useSeleniumStandaloneService    A flag to use the selenium standalone
+                                        service instead of the selenium docker
+                                        service.      [boolean] [default: false]"
 `;
 
 exports[`index declares the wdio terra-cli command with proper top level help 1`] = `

packages/terra-functional-testing/tests/jest/terra-cli/wdio/test-runner.test.js

@@ -52,6 +52,7 @@ describe('Test Runner', () => {
         suite: 'test-suite',
         theme: 'terra-default-theme',
         updateScreenshots: true,
+        useSeleniumStandaloneService: true,
       };
 
       await TestRunner.run(options);
@@ -176,6 +177,7 @@ describe('Test Runner', () => {
         suite: 'test-suite',
         themes: ['terra-default-theme'],
         updateScreenshots: true,
+        useSeleniumStandaloneService: true,
       });
 
       expect(TestRunner.run).toHaveBeenCalledWith({
@@ -194,6 +196,7 @@ describe('Test Runner', () => {
         suite: 'test-suite',
         theme: 'terra-default-theme',
         updateScreenshots: true,
+        useSeleniumStandaloneService: true,
       });
     });
   });