feat: implement uploading new logs to Sauce with all test statuses

Author: wswebcreation

package-lock.json

@@ -37,8 +37,9 @@
   ],
   "author": "Vojta Jina <[email protected]>",
   "dependencies": {
+    "fs-extra": "^9.0.1",
     "global-agent": "^2.1.8",
-    "saucelabs": "^4.3.0",
+    "saucelabs": "^4.5.1",
     "webdriverio": "^6.1.9"
   },
   "license": "MIT",

package.json

@@ -2,6 +2,11 @@ import {SauceLabsOptions} from 'saucelabs'
 import {BrowserObject} from "webdriverio";
 
 type SauceBaseOption = Pick<SauceLabsOptions, 'headless' | 'region'>
+interface Results {
+  status: string;
+  message: string;
+  screenshot: string;
+}
 
 /**
  * This interface describes a browser that has been launched with Saucelabs. This is helpful
@@ -17,8 +22,8 @@ export interface SaucelabsBrowser extends SauceBaseOption {
   /** Saucelabs access key that has been used to launch this browser. */
   accessKey: string;
 
-  /** Saucelabs driver instance to communicate with this browser. */
-  driver: BrowserObject
+  /** All test results will be stored here **/
+  results: Results[];
 }
 
 /** Type that describes the BrowserMap injection token. */

src/browser-info.ts

@@ -1,4 +1,6 @@
 import {remote, BrowserObject} from 'webdriverio';
+import SauceLabs from 'saucelabs';
+import {mkdirSync, removeSync, writeFileSync} from 'fs-extra';
 import {processConfig} from "../process-config";
 import {BrowserMap} from "../browser-info";
 
@@ -73,7 +75,7 @@ export function SaucelabsLauncher(args,
                 accessKey: seleniumCapabilities.key,
                 region: seleniumCapabilities.region,
                 headless: seleniumCapabilities.headless,
-                driver,
+                results:[],
             });
 
             await driver.url(pageUrl);
@@ -88,7 +90,30 @@ export function SaucelabsLauncher(args,
     this.on('kill', async (done: () => void) => {
         try {
             const driver = connectedDrivers.get(this.id);
+            const {sessionId} = driver;
             await driver.deleteSession();
+
+            const browserData = browserMap.get(this.id);
+            const api = new SauceLabs({
+                user: browserData.username,
+                key: browserData.accessKey,
+                region: browserData.region,
+            });
+
+            // Wait until the vm is destroyed and the assets are stored
+            await new Promise(resolve => setTimeout(() => resolve(), 5000));
+            // Create a tmp dir
+            mkdirSync(sessionId);
+            writeFileSync(`${sessionId}/log.json`, JSON.stringify(browserData.results, null, 2));
+            // Update the log assets
+            // @ts-ignore
+            await api.uploadJobAssets(
+                sessionId,
+                { files: [`${sessionId}/log.json`] },
+            );
+            // remove the temporary folder
+            removeSync(sessionId);
+
         } catch (e) {
             // We need to ignore the exception here because we want to make sure that Karma is still
             // able to retry connecting if Saucelabs itself terminated the session (and not Karma)

src/launcher/launcher.ts

@@ -27,13 +27,20 @@ export function SaucelabsReporter(logger, browserMap: BrowserMap) {
   // This fires when a single test is executed and will update the run in sauce labs with an annotation
   // of the test including the status of the test
   this.onSpecComplete = function(browser, result) {
-    const driver = browserMap.get(browser.id).driver
     const status = result.success ? '✅' : '❌'
 
-    pendingUpdates.push(driver.execute(`sauce:context=${status}: ${result.fullName}`))
+    browserMap.get(browser.id).results.push({
+      status: 'info',
+      message: `${status} ${result.fullName}`,
+      screenshot: null
+    })
 
     if(!result.success && result.log.length > 0){
-      pendingUpdates.push(driver.execute(`sauce:context=${result.log[0]}`))
+      browserMap.get(browser.id).results.push({
+        status: 'info',
+        message: `${result.log[0]}`,
+        screenshot: null
+      })
     }
   }