Wdio reporter output dir (#694)

* Wdio Reporter output Directory * Revert "Wdio Reporter output Directory" This reverts commit 7dfbda6. * Wdio reporter output dir * Changelog, docs * rename doc file * Doc update
cerner · Aug 16, 2021 · aa0a99a · aa0a99a
1 parent 7f0966c
commit aa0a99a
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 5 deletions.
diff --git a/packages/terra-functional-testing/CHANGELOG.md b/packages/terra-functional-testing/CHANGELOG.md
@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+* Changed
+  * Update fileReporter to accept outputDir config option
+
 ## 2.2.0 - (August 13, 2021)
 
 * Added

diff --git a/packages/terra-functional-testing/src/reporters/file-output-reporter/index.js b/packages/terra-functional-testing/src/reporters/file-output-reporter/index.js
@@ -11,12 +11,14 @@ class FileOutputReporter extends SpecReporter {
   constructor(options) {
     super({ stdout: true, ...options });
     this.runners = [];
+    this.outputDir = options.outputDir || 'wdio';
     this.resultJsonObject = {
       startDate: '',
       type: 'wdio',
       locale: '',
       formFactor: '',
       theme: '',
+      cloudRegion: '',
       output: {},
       endDate: '',
     };
@@ -36,7 +38,7 @@ class FileOutputReporter extends SpecReporter {
    * @return null;
    */
   setResultsDir() {
-    this.resultsDir = path.join(process.cwd(), 'tests', 'wdio', 'reports');
+    this.resultsDir = path.join(process.cwd(), 'tests', this.outputDir, 'reports');
   }
 
   /**
@@ -64,6 +66,7 @@ class FileOutputReporter extends SpecReporter {
       formFactor,
       locale,
       theme,
+      cloudRegion,
     } = options;
 
     const fileNameConf = ['fileOutput'];
@@ -83,6 +86,10 @@ class FileOutputReporter extends SpecReporter {
       fileNameConf.push(browserName);
     }
 
+    if (cloudRegion) {
+      fileNameConf.push(cloudRegion);
+    }
+
     if (cid) {
       fileNameConf.push(cid);
     }
@@ -99,6 +106,7 @@ class FileOutputReporter extends SpecReporter {
       formFactor,
       locale,
       theme,
+      cloudRegion,
     } = options;
 
     if (locale) {
@@ -112,6 +120,10 @@ class FileOutputReporter extends SpecReporter {
     if (formFactor) {
       this.resultJsonObject.formFactor = formFactor;
     }
+
+    if (cloudRegion) {
+      this.resultJsonObject.cloudRegion = cloudRegion;
+    }
   }
 
   /**
@@ -188,13 +200,19 @@ class FileOutputReporter extends SpecReporter {
           const { cid, capabilities } = runner;
           const { browserName } = capabilities;
           const { config } = global.browser;
-          const { formFactor, locale, theme } = config.launcherOptions;
+          const {
+            formFactor,
+            locale,
+            theme,
+            cloudRegion,
+          } = config.launcherOptions;
           const options = {
             browserName,
             cid,
             formFactor,
             locale,
             theme,
+            cloudRegion,
           };
 
           this.buildFileName(options);

diff --git a/packages/terra-functional-testing/tests/jest/reporters/file-output-reporter/index.test.js b/packages/terra-functional-testing/tests/jest/reporters/file-output-reporter/index.test.js
@@ -14,6 +14,7 @@ describe('FileOutputReporter', () => {
           formFactor: 'tiny',
           locale: 'en',
           theme: 'default',
+          cloudRegion: 'dev',
         },
       },
     };
@@ -35,6 +36,7 @@ describe('FileOutputReporter', () => {
       expect(reporter.resultJsonObject).toHaveProperty('startDate');
       expect(reporter.resultJsonObject).toHaveProperty('endDate');
       expect(reporter.resultJsonObject).toHaveProperty('type');
+      expect(reporter.resultJsonObject).toHaveProperty('cloudRegion');
       expect(typeof reporter.resultJsonObject.output).toEqual('object');
     });
 
@@ -54,6 +56,12 @@ describe('FileOutputReporter', () => {
         const reporter = new FileOutputReporter({ writeStream: {} });
         expect(reporter.resultsDir).toEqual(expect.stringContaining('tests/wdio/reports'));
       });
+
+      it('set provided outputDir ', () => {
+        fs.existsSync.mockReturnValue(false);
+        const reporter = new FileOutputReporter({ writeStream: {}, outputDir: 'other' });
+        expect(reporter.resultsDir).toEqual(expect.stringContaining('tests/other/reports'));
+      });
     });
 
     describe('ensures results dir exists', () => {
@@ -138,6 +146,22 @@ describe('FileOutputReporter', () => {
 
       expect(reporter.fileName).toEqual('fileOutput-en-default-tiny-chrome-0-1');
     });
+
+    it('sets file name with locale, theme, formFactor, browser, cloudRegion, and cid', () => {
+      const reporter = new FileOutputReporter({ writeStream: {} });
+      const options = {
+        browserName: 'chrome',
+        cid: '0-1',
+        formFactor: 'tiny',
+        locale: 'en',
+        theme: 'default',
+        cloudRegion: 'dev',
+      };
+
+      reporter.buildFileName(options);
+
+      expect(reporter.fileName).toEqual('fileOutput-en-default-tiny-chrome-dev-0-1');
+    });
   });
 
   describe('updateResultObject', () => {
@@ -200,6 +224,7 @@ describe('FileOutputReporter', () => {
           locale: 'en',
           theme: 'terra-default-theme',
           formFactor: 'small',
+          cloudRegion: 'dev',
         },
       },
     };

diff --git a/packages/terra-toolkit-docs/CHANGELOG.md b/packages/terra-toolkit-docs/CHANGELOG.md
@@ -13,6 +13,7 @@
   * Pulling in next mvb of webpack-config-terra.
 
 * Added
+  * Update FileOutputReporter docs to include cloudRegion
   * webpack-config-terra v2 upgrade guide.
   * Removed polyfill doc.
 

diff --git a/...g/wdio-reporters.3/FileOutputReporter.mdx → ...o-reporters.3/FileOutputReporter.tool.mdx b/...g/wdio-reporters.3/FileOutputReporter.mdx → ...o-reporters.3/FileOutputReporter.tool.mdx
@@ -4,7 +4,7 @@ Wdio File Output Reporter is a reporter that logs wdio test output to separate f
 
 - Date and time of when the tests are started and when they are finished
 
-- Locale, Form Factor, and Theme of the tests
+- Locale, Form Factor, Theme, and Cloud Region (if provided by full stack wdio configuration) of the tests
 
 - Name of the tests and whether they've succeeded or failed
 
@@ -16,8 +16,8 @@ Wdio File Output Reporter assumes mono-repo will have packages directory in the
 
 ## Report Format
 
-- The name of the log file for non-monorepo will be **result-\<locale>-\<theme>-\<form-factor>-\<browser>-\<cid>-\<repo-name>.json**(eg: result-en-huge-chrome-0-1-terra-toolkit-boneyard.json)
+- The name of the log file for non-monorepo will be **result-\<locale>-\<theme>-\<form-factor>-\<browser>-\<cloudRegion>-\<cid>-\<repo-name>.json**(eg: result-en-huge-chrome-dev-0-1-terra-toolkit-boneyard.json)
 
-- The name of the log file for mono-repo will be **result-\<locale>-\<theme>-\<form-factor>-\<browser>-\<cid>-\<Package-name>.json**(eg: fileOutput-en-terra-default-theme-large-chrome-1-0-terra-functional-testing.json)
+- The name of the log file for mono-repo will be **result-\<locale>-\<theme>-\<form-factor>-\<browser>-\<cloudRegion>-\<cid>-\<Package-name>.json**(eg: fileOutput-en-terra-default-theme-large-chrome-dev-1-0-terra-functional-testing.json)
 
 - Example output  [a relative link](fileOutput-reporter-sample-result.json)
diff --git a/...ite/tool/terra-functional-testing/wdio-reporters.3/fileOutput-reporter-sample-result.json b/...ite/tool/terra-functional-testing/wdio-reporters.3/fileOutput-reporter-sample-result.json
@@ -3,6 +3,7 @@
   "locale": "en",
   "theme": "terra-default-theme",
   "formFactor": "large",
+  "cloudRegion": "dev",
   "output": [
     "------------------------------------------------------------------\n[chrome 69.0.3497.100 Linux #1-0] Spec: /Users/sn081183/Desktop/terra/terra-toolkit/packages/terra-functional-testing/tests/wdio/dispatch-custom-event-spec.js\n[chrome 69.0.3497.100 Linux #1-0] Running: chrome (v69.0.3497.100) on Linux\n[chrome 69.0.3497.100 Linux #1-0] Session ID: 28abf34875b0ae678fd50f6219b85036\n[chrome 69.0.3497.100 Linux #1-0]\n[chrome 69.0.3497.100 Linux #1-0] dispatchCustomEvent\n[chrome 69.0.3497.100 Linux #1-0]    ✓ sends a custom event that injects a string into a paragraph\n[chrome 69.0.3497.100 Linux #1-0]\n"
   ],