@wdio/sauce-service 8.27.0 → 8.28.0

package/build/ci.d.ts

@@ -0,0 +1,2 @@
+export declare const CI: import("./types.js").CI;
+//# sourceMappingURL=ci.d.ts.map

package/build/ci.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ci.d.ts","sourceRoot":"","sources":["../src/ci.ts"],"names":[],"mappings":"AAkEA,eAAO,MAAM,EAAE,yBAA6B,CAAA"}

package/build/ci.js

@@ -0,0 +1,57 @@
+const GITHUB = {
+    matcher: () => !!process.env.GITHUB_ACTIONS,
+    ci: {
+        repo: process.env.GITHUB_REPOSITORY ?? '',
+        refName: process.env.GITHUB_HEAD_REF ?? process.env.GITHUB_REF_NAME ?? '',
+        sha: process.env.GITHUB_SHA ?? '',
+        user: process.env.GITHUB_ACTOR ?? '',
+    },
+};
+const GITLAB = {
+    matcher: () => !!process.env.GITLAB_CI,
+    ci: {
+        repo: process.env.CI_PROJECT_PATH ?? '',
+        refName: process.env.CI_COMMIT_REF_NAME ?? '',
+        sha: process.env.CI_COMMIT_SHA ?? '',
+        user: process.env.GITLAB_USER_LOGIN ?? '',
+    },
+};
+const JENKINS = {
+    matcher: () => !!process.env.JENKINS_URL,
+    ci: {
+        repo: process.env.GIT_URL ?? '',
+        refName: process.env.GIT_BRANCH ?? '',
+        sha: process.env.GIT_COMMIT ?? '',
+        user: '',
+    },
+};
+const BITBUCKET = {
+    matcher: () => !!process.env.BITBUCKET_BUILD_NUMBER,
+    ci: {
+        repo: process.env.BITBUCKET_REPO_FULL_NAME ?? '',
+        refName: process.env.BITBUCKET_BRANCH ?? '',
+        sha: process.env.BITBUCKET_COMMIT ?? '',
+        user: process.env.BITBUCKET_STEP_TRIGGERER_UUID ?? '',
+    },
+};
+const CIRCLECI = {
+    matcher: () => !!process.env.CIRCLECI,
+    ci: {
+        repo: process.env.CIRCLE_REPOSITORY_URL ?? '',
+        refName: process.env.CIRCLE_BRANCH ?? '',
+        sha: process.env.CIRCLE_SHA1 ?? '',
+        user: process.env.CIRCLE_USERNAME ?? '',
+    },
+};
+const DEFAULT = {
+    matcher: () => true,
+    ci: {
+        repo: '',
+        refName: '',
+        sha: '',
+        user: '',
+    },
+};
+const providers = [GITHUB, GITLAB, JENKINS, BITBUCKET, CIRCLECI];
+const provider = providers.find((p) => p.matcher());
+export const CI = provider?.ci ?? DEFAULT.ci;

package/build/service.d.ts

@@ -9,12 +9,14 @@ export default class SauceService implements Services.ServiceInstance {
     private _failures;
     private _isServiceEnabled;
     private _isJobNameSet;
+    private _testStartTime;
     private _options;
     private _api;
     private _browser?;
     private _isRDC?;
     private _suiteTitle?;
     private _cid;
+    private _testRuns;
     constructor(options: SauceServiceConfig, _capabilities: Capabilities.RemoteCapability, _config: Options.Testrunner);
     /**
      * gather information about runner
@@ -69,5 +71,9 @@ export default class SauceService implements Services.ServiceInstance {
      */
     setAnnotation(annotation: string): Promise<unknown>;
     private _setJobName;
+    private _getStatusForTestRun;
+    private _getOsName;
+    private _collectTestRun;
+    private _updateJobIdInTestRuns;
 }
 //# sourceMappingURL=service.d.ts.map

package/build/service.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAGA,OAAO,EACH,OAAO,IAAI,SAAS,EAGvB,MAAM,WAAW,CAAA;AAElB,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAI9E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAMpD,MAAM,CAAC,OAAO,OAAO,YAAa,YAAW,QAAQ,CAAC,eAAe;IAgB7D,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,OAAO;IAhBnB,OAAO,CAAC,QAAQ,CAAI;IACpB,OAAO,CAAC,oBAAoB,CAAI;IAChC,OAAO,CAAC,SAAS,CAAI;IACrB,OAAO,CAAC,iBAAiB,CAAO;IAChC,OAAO,CAAC,aAAa,CAAQ;IAE7B,OAAO,CAAC,QAAQ,CAAoB;IACpC,OAAO,CAAC,IAAI,CAAmB;IAC/B,OAAO,CAAC,QAAQ,CAAC,CAAsD;IACvE,OAAO,CAAC,MAAM,CAAC,CAAS;IACxB,OAAO,CAAC,WAAW,CAAC,CAAQ;IAC5B,OAAO,CAAC,IAAI,CAAK;gBAGb,OAAO,EAAE,kBAAkB,EACnB,aAAa,EAAE,YAAY,CAAC,gBAAgB,EAC5C,OAAO,EAAE,OAAO,CAAC,UAAU;IAOvC;;OAEG;IACH,aAAa,CAAE,CAAC,EAAE,OAAO,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM;IAkBxE,MAAM,CAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,kBAAkB;IAazF,WAAW,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAepC,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI;IAgCvC,UAAU,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAMnC,OAAO,CAAC,eAAe;IAKvB,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU;IAuClF,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU;IAarE;;OAEG;IACG,aAAa,CAAE,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;IAc5D;;;OAGG;IACH,cAAc,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IASjC,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU;IAS7C;;;;;;;OAOG;IACH,aAAa,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,YAAY;IAOtE;;OAEG;IACG,KAAK,CAAE,MAAM,EAAE,MAAM;IAqC3B;;;;OAIG;YACW,WAAW;IAezB,QAAQ,CAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAmB9C,SAAS,CAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,UAAQ,EAAE,WAAW,CAAC,EAAE,MAAM;IAMlG;;OAEG;IACH,OAAO,CAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,UAAQ,EAAE,WAAW,CAAC,EAAE,MAAM;IAgDvE;;OAEG;IACG,aAAa,CAAE,UAAU,EAAE,MAAM;YAezB,WAAW;CAe5B"}
+{"version":3,"file":"service.d.ts","sourceRoot":"","sources":["../src/service.ts"],"names":[],"mappings":"AAGA,OAAO,EACH,OAAO,IAAI,SAAS,EAMvB,MAAM,WAAW,CAAA;AAElB,OAAO,KAAK,EAAE,QAAQ,EAAE,YAAY,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,aAAa,CAAA;AAI9E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,YAAY,CAAA;AAOpD,MAAM,CAAC,OAAO,OAAO,YAAa,YAAW,QAAQ,CAAC,eAAe;IAmB7D,OAAO,CAAC,aAAa;IACrB,OAAO,CAAC,OAAO;IAnBnB,OAAO,CAAC,QAAQ,CAAI;IACpB,OAAO,CAAC,oBAAoB,CAAI;IAChC,OAAO,CAAC,SAAS,CAAI;IACrB,OAAO,CAAC,iBAAiB,CAAO;IAChC,OAAO,CAAC,aAAa,CAAQ;IAC7B,OAAO,CAAC,cAAc,CAAM;IAE5B,OAAO,CAAC,QAAQ,CAAoB;IACpC,OAAO,CAAC,IAAI,CAAmB;IAC/B,OAAO,CAAC,QAAQ,CAAC,CAAsD;IACvE,OAAO,CAAC,MAAM,CAAC,CAAS;IACxB,OAAO,CAAC,WAAW,CAAC,CAAQ;IAC5B,OAAO,CAAC,IAAI,CAAK;IAEjB,OAAO,CAAC,SAAS,CAAsB;gBAGnC,OAAO,EAAE,kBAAkB,EACnB,aAAa,EAAE,YAAY,CAAC,gBAAgB,EAC5C,OAAO,EAAE,OAAO,CAAC,UAAU;IAUvC;;OAEG;IACH,aAAa,CAAE,CAAC,EAAE,OAAO,CAAC,UAAU,EAAE,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM;IAkBxE,MAAM,CAAE,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,OAAO,EAAE,WAAW,CAAC,OAAO,GAAG,WAAW,CAAC,kBAAkB;IAazF,WAAW,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAepC,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI;IAkCvC,UAAU,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IAMnC,OAAO,CAAC,eAAe;IAKvB,SAAS,CAAE,IAAI,EAAE,UAAU,CAAC,IAAI,EAAE,OAAO,EAAE,OAAO,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU;IAyClF,SAAS,CAAC,IAAI,EAAE,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,OAAO,EAAE,UAAU,CAAC,UAAU;IAarE;;OAEG;IACG,aAAa,CAAE,GAAG,EAAE,OAAO,EAAE,OAAO,EAAE;QAAE,IAAI,EAAE,MAAM,CAAA;KAAE;IAc5D;;;OAGG;IACH,cAAc,CAAE,KAAK,EAAE,UAAU,CAAC,KAAK;IASjC,UAAU,CAAE,IAAI,EAAE,UAAU,CAAC,UAAU;IAS7C;;;;;;;OAOG;IACH,aAAa,CAAC,KAAK,EAAE,UAAU,CAAC,KAAK,EAAE,MAAM,EAAE,UAAU,CAAC,YAAY;IAOtE;;OAEG;IACG,KAAK,CAAE,MAAM,EAAE,MAAM;IAmD3B;;;;OAIG;YACW,WAAW;IAezB,QAAQ,CAAE,YAAY,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM;IAmB9C,SAAS,CAAE,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,UAAQ,EAAE,WAAW,CAAC,EAAE,MAAM;IAMlG;;OAEG;IACH,OAAO,CAAE,QAAQ,EAAE,MAAM,EAAE,cAAc,UAAQ,EAAE,WAAW,CAAC,EAAE,MAAM;IAgDvE;;OAEG;IACG,aAAa,CAAE,UAAU,EAAE,MAAM;YAezB,WAAW;IAgBzB,OAAO,CAAC,oBAAoB;IAa5B,OAAO,CAAC,UAAU;IAUlB,OAAO,CAAC,eAAe;IAiCvB,OAAO,CAAC,sBAAsB;CAOjC"}

package/build/service.js

@@ -1,9 +1,10 @@
 import fs from 'node:fs/promises';
 import path from 'node:path';
-import { default as SauceLabs } from 'saucelabs';
+import { default as SauceLabs, } from 'saucelabs';
 import logger from '@wdio/logger';
 import { isRDC, ansiRegex } from './utils.js';
 import { DEFAULT_OPTIONS } from './constants.js';
+import { CI } from './ci.js';
 const jobDataProperties = ['name', 'tags', 'public', 'build', 'custom-data'];
 const log = logger('@wdio/sauce-service');
 export default class SauceService {
@@ -14,18 +15,22 @@ export default class SauceService {
     _failures = 0; // counts failures between reloads
     _isServiceEnabled = true;
     _isJobNameSet = false;
+    _testStartTime;
     _options;
     _api;
     _browser;
     _isRDC;
     _suiteTitle;
     _cid = '';
+    _testRuns;
     constructor(options, _capabilities, _config) {
         this._capabilities = _capabilities;
         this._config = _config;
         this._options = { ...DEFAULT_OPTIONS, ...options };
         this._api = new SauceLabs.default(this._config);
         this._maxErrorStackLength = this._options.maxErrorStackLength || this._maxErrorStackLength;
+        this._testStartTime = new Date();
+        this._testRuns = [];
     }
     /**
      * gather information about runner
@@ -74,6 +79,7 @@ export default class SauceService {
         if (!this._isServiceEnabled || !this._browser) {
             return;
         }
+        this._testStartTime = new Date();
         /**
          * in jasmine we get Jasmine__TopLevel__Suite as title since service using test
          * framework hooks in order to execute async functions.
@@ -107,6 +113,7 @@ export default class SauceService {
         lines.forEach((line) => this.setAnnotation(`sauce:context=${line.replace(ansiRegex(), '')}`));
     }
     afterTest(test, context, results) {
+        this._collectTestRun(test, results);
         /**
          * If the test failed push the stack to Sauce Labs in separate lines
          */
@@ -211,6 +218,13 @@ export default class SauceService {
         const status = 'status: ' + (failures > 0 ? 'failing' : 'passing');
         if (!this._browser.isMultiremote) {
             await this._uploadLogs(this._browser.sessionId);
+            this._updateJobIdInTestRuns(this._browser.sessionId);
+            try {
+                await this._api.createTestRunsV1({ test_runs: this._testRuns });
+            }
+            catch (e) {
+                log.debug('Submitting test run failed: ', e);
+            }
             log.info(`Update job with sessionId ${this._browser.sessionId}, ${status}`);
             return this._isRDC ?
                 this.setAnnotation(`sauce:job-result=${failures === 0}`) :
@@ -221,6 +235,13 @@ export default class SauceService {
             const isMultiRemoteRDC = isRDC(multiRemoteBrowser.capabilities);
             log.info(`Update multiRemote job for browser "${browserName}" and sessionId ${multiRemoteBrowser.sessionId}, ${status}`);
             await this._uploadLogs(multiRemoteBrowser.sessionId);
+            this._updateJobIdInTestRuns(multiRemoteBrowser.sessionId);
+            try {
+                await this._api.createTestRunsV1({ test_runs: this._testRuns });
+            }
+            catch (e) {
+                log.debug('Submitting test run failed: ', e);
+            }
             // Sauce Unified Platform (RDC) can not be updated with an API.
             if (isMultiRemoteRDC) {
                 return this.setAnnotation(`sauce:job-result=${failures === 0}`);
@@ -323,4 +344,63 @@ export default class SauceService {
         await this.setAnnotation(`sauce:job-name=${jobName}`);
         this._isJobNameSet = true;
     }
+    _getStatusForTestRun(result) {
+        if (['passed', 'failed', 'skipped'].includes(result.status)) {
+            return result.status;
+        }
+        if (result.error) {
+            return 'failed';
+        }
+        if (result.passed) {
+            return 'passed';
+        }
+        return 'skipped';
+    }
+    _getOsName(osName) {
+        if (!osName) {
+            return 'unknown';
+        }
+        if ('darwin' === osName) {
+            return 'Mac';
+        }
+        return osName;
+    }
+    _collectTestRun(test, results) {
+        const caps = this._capabilities;
+        const sauceCaps = this._capabilities;
+        const testRun = {
+            name: `${test.parent} - ${test.title}`,
+            start_time: this._testStartTime?.toISOString(),
+            end_time: (new Date()).toISOString(),
+            duration: results.duration || 0,
+            browser: caps?.browserName || 'chrome',
+            build_name: sauceCaps?.build?.toString() || '',
+            tags: sauceCaps?.tags,
+            framework: 'webdriverio',
+            platform: 'other',
+            os: this._getOsName(process.platform),
+            status: this._getStatusForTestRun(results),
+            type: 'web',
+            ci: {
+                ref_name: CI.refName,
+                commit_sha: CI.sha,
+                repository: CI.repo,
+                branch: CI.refName,
+            }
+        };
+        if (results.error) {
+            testRun.errors = [{
+                    message: results.error?.message?.toString(),
+                    path: test.file,
+                }];
+        }
+        this._testRuns?.push(testRun);
+    }
+    _updateJobIdInTestRuns(id) {
+        this._testRuns?.forEach(testRun => {
+            testRun.sauce_job = {
+                id,
+            };
+        });
+    }
 }

package/build/types.d.ts

@@ -43,4 +43,14 @@ export interface SauceServiceConfig {
      */
     setJobName?: (config: Options.Testrunner, capabilities: Capabilities.RemoteCapability, suiteTitle: string) => string;
 }
+export interface Provider {
+    matcher(): boolean;
+    ci: CI;
+}
+export interface CI {
+    repo: string;
+    refName: string;
+    sha: string;
+    user: string;
+}
 //# sourceMappingURL=types.d.ts.map

package/build/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAExD,MAAM,WAAW,kBAAkB;IAC/B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,mBAAmB,CAAA;IAEtC;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,CACT,MAAM,EAAE,OAAO,CAAC,UAAU,EAC1B,YAAY,EAAE,YAAY,CAAC,gBAAgB,EAC3C,UAAU,EAAE,MAAM,KACjB,MAAM,CAAA;CACd"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,WAAW,CAAA;AACpD,OAAO,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,aAAa,CAAA;AAExD,MAAM,WAAW,kBAAkB;IAC/B;;;OAGG;IACH,mBAAmB,CAAC,EAAE,MAAM,CAAA;IAE5B;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,mBAAmB,CAAA;IAEtC;;;OAGG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IAEpB;;;OAGG;IACH,OAAO,CAAC,EAAE,OAAO,CAAA;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,CACT,MAAM,EAAE,OAAO,CAAC,UAAU,EAC1B,YAAY,EAAE,YAAY,CAAC,gBAAgB,EAC3C,UAAU,EAAE,MAAM,KACjB,MAAM,CAAA;CACd;AAED,MAAM,WAAW,QAAQ;IACrB,OAAO,IAAI,OAAO,CAAC;IACnB,EAAE,EAAE,EAAE,CAAC;CACV;AAED,MAAM,WAAW,EAAE;IACf,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,GAAG,EAAE,MAAM,CAAC;IACZ,IAAI,EAAE,MAAM,CAAC;CAChB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wdio/sauce-service",
-  "version": "8.27.0",
+  "version": "8.28.0",
   "description": "WebdriverIO service that provides a better integration into Sauce Labs",
   "author": "Christian Bromann <mail@bromann.dev>",
   "homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-sauce-service",
@@ -30,19 +30,19 @@
   },
   "typeScriptVersion": "3.8.3",
   "dependencies": {
-    "@wdio/logger": "8.24.12",
-    "@wdio/types": "8.27.0",
-    "@wdio/utils": "8.27.0",
+    "@wdio/logger": "8.28.0",
+    "@wdio/types": "8.28.0",
+    "@wdio/utils": "8.28.0",
     "ip": "^1.1.8",
-    "saucelabs": "7.4.0",
-    "webdriverio": "8.27.0"
+    "saucelabs": "7.5.0",
+    "webdriverio": "8.28.0"
   },
   "devDependencies": {
     "@types/ip": "^1.1.0",
-    "@wdio/globals": "8.27.0"
+    "@wdio/globals": "8.28.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "be6dce3344ac864509f676b561cb0eed821b36f6"
+  "gitHead": "15f6ac509df48b23477cd4c793206a4f707e3df0"
 }