Set the job name before a suite is run (#7672)

Co-authored-by: Christian Bromann <github@christian-bromann.com>
webdriverio · Nov 15, 2021 · a1d33f7 · a1d33f7
1 parent f8d20cc
commit a1d33f7
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 7 deletions.
diff --git a/packages/wdio-sauce-service/src/service.ts b/packages/wdio-sauce-service/src/service.ts
@@ -76,6 +76,14 @@ export default class SauceService implements Services.ServiceInstance {
 
     beforeSuite (suite: Frameworks.Suite) {
         this._suiteTitle = suite.title
+
+        /**
+         * Make sure we account for the cases where there is a long running `before` function for a
+         * suite or one that can fail so we set the default job name at the suite level
+         **/
+        if (this._browser && !this._isUP && !this._isJobNameSet) {
+            this._browser.execute('sauce:job-name=' + this._suiteTitle)
+        }
     }
 
     beforeTest (test: Frameworks.Test) {
@@ -94,16 +102,15 @@ export default class SauceService implements Services.ServiceInstance {
         }
 
         if (this._browser && !this._isJobNameSet) {
-            let jobName = this._suiteTitle
             if (this._options.setJobName) {
-                jobName = this._options.setJobName(
+                let jobName = this._options.setJobName(
                     this._config,
                     this._capabilities,
                     this._suiteTitle!
                 )
+                this._browser.execute(`sauce:job-name=${jobName}`)
             }
 
-            this._browser.execute(`sauce:job-name=${jobName}`)
             this._isJobNameSet = true
         }
 

diff --git a/packages/wdio-sauce-service/tests/service.test.ts b/packages/wdio-sauce-service/tests/service.test.ts
@@ -74,7 +74,31 @@ test('beforeSession should set to unknown creds if no sauce user and key are fou
     expect(config.key).toBe('unknown_key')
 })
 
-test('beforeTest should set job-name', () => {
+test('beforeSuite should send request to set the job name as suite name', () => {
+    const service = new SauceService({}, {}, {} as any)
+    service['_browser'] = browser
+    expect(service['_suiteTitle']).toBeUndefined()
+    service.beforeSuite({ title: 'foobar' } as any)
+    expect(service['_suiteTitle']).toBe('foobar')
+    expect(browser.execute).toBeCalledWith('sauce:job-name=foobar')
+})
+
+test('beforeTest should send the job-name as suite name by default', () => {
+    const service = new SauceService({}, {}, { user: 'foobar', key: '123', capabilities: {} })
+    service['_browser'] = browser
+    service['_suiteTitle'] = 'Suite Title'
+    expect(service['_isJobNameSet']).toBe(false)
+    service.beforeSuite({ title: 'foobar suite' } as any)
+    service.beforeTest({
+        fullName: 'my test can do something',
+        description: 'foobar'
+    } as any)
+    expect(browser.execute).toBeCalledTimes(2)
+    expect(browser.execute).toBeCalledWith('sauce:job-name=foobar suite')
+    expect(browser.execute).toBeCalledWith('sauce:context=my test can do something')
+})
+
+test('beforeTest should mark job-name as set', () => {
     const service = new SauceService({}, {}, { user: 'foobar', key: '123', capabilities: {} })
     service['_browser'] = browser
     service['_suiteTitle'] = 'Suite Title'
@@ -84,7 +108,6 @@ test('beforeTest should set job-name', () => {
         description: 'foobar'
     } as any)
     expect(service['_isJobNameSet']).toBe(true)
-    expect(browser.execute).toBeCalledWith('sauce:job-name=Suite Title')
 })
 
 test('beforeTest should set job-name via custom setJobName method', () => {
@@ -165,8 +188,7 @@ test('beforeTest should not set context for UP test', () => {
     upService.beforeTest({
         title: 'update up job name'
     } as any)
-    expect(browser.execute).toBeCalledTimes(1)
-    expect(browser.execute).not.toBeCalledWith('sauce:job-name==update up job name')
+    expect(browser.execute).toBeCalledTimes(0)
 })
 
 test('beforeTest should not set context if user does not use sauce', () => {