Added ability to add console log to allure and spec reporters (fix for #7001) #7134

praveendvd · 2021-07-13T18:30:44Z

Proposed changes

This commit allows to add cosnole logs to spec and allure reporters , all webdriverio logs containing mwebdriver will be ignored to avoid overloading the console log being logged (fix for #7001)

Types of changes

Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Documentation update

Checklist

I have read the CONTRIBUTING doc
I have added tests that prove my fix is effective or that my feature works
I have added necessary documentation (if appropriate)
I have added proper type definitions for new commands (if appropriate)

Further comments

Reviewers: @webdriverio/project-committers

@christian-bromann

praveendvd · 2021-07-13T18:33:08Z

@christian-bromann i am not able to understand how to write unit test for spec reporter , could you have a look at : https://github.com/webdriverio/webdriverio/pull/7134/files#diff-cfe87f6281a8a4048d929804c6a8caf9eae3031fe3af66296e2f58d0a46cbde5

Its not live report , it seems like the result are being mocked so i am not sure how to mock presence of console.log

praveendvd

tmpReporter.onSuiteStart(suiteEnd()) was corrected to tmpReporter.onSuiteEnd()

packages/wdio-allure-reporter/src/index.ts

packages/wdio-allure-reporter/src/types.ts

packages/wdio-allure-reporter/src/utils.ts

packages/wdio-spec-reporter/src/index.ts

christian-bromann · 2021-07-14T07:42:19Z

packages/wdio-spec-reporter/src/index.ts

@@ -45,6 +50,11 @@ export default class SpecReporter extends WDIOReporter {
        this._sauceLabsSharableLinks = 'sauceLabsSharableLinks' in options
            ? options.sauceLabsSharableLinks as boolean
            : this._sauceLabsSharableLinks
+        let processObj: any = process


Suggested change

let processObj: any = process

let processObj = process

if i remove any , i get

packages/wdio-spec-reporter/src/index.ts

packages/wdio-spec-reporter/tests/index.test.ts

christian-bromann · 2021-07-14T12:46:45Z

Why closing the PR?

praveendvd · 2021-07-14T12:48:22Z

@christian-bromann making changes didn't wanted each push to trigger the work flow and spam your inbox , thanks for the detailed review

christian-bromann · 2021-07-14T12:56:52Z

Don't worry about that 😉

…console-log

praveendvd · 2021-07-14T16:21:21Z

@christian-bromann , i done all i could i am not able to increase statement coverage Jest: "global" coverage threshold for statements (98%) not met: 97.98% 😢

christian-bromann

Couple more comments, feel free to drop the coverage by 1% 😉

christian-bromann · 2021-07-15T06:16:21Z

packages/wdio-spec-reporter/src/index.ts

@@ -45,6 +50,16 @@ export default class SpecReporter extends WDIOReporter {
        this._sauceLabsSharableLinks = 'sauceLabsSharableLinks' in options
            ? options.sauceLabsSharableLinks as boolean
            : this._sauceLabsSharableLinks
+        let processObj:any = process


Suggested change

let processObj:any = process

let processObj = process

if i remove any , i get

@christian-bromann could you have a look at this , what type should i give

@christian-bromann If no changes needs to be done for this comment then could you retrigger the workflow it looks like an intermittent failure. sleep(100) was 99 something, Thank you so much for your time and detailed reviews learned a lot

packages/wdio-spec-reporter/src/index.ts

packages/wdio-spec-reporter/tests/index.test.ts

praveendvd · 2021-07-15T08:48:28Z

@christian-bromann i saw light at the end of the tunnel 😆 all green uff thank you Christian

christian-bromann · 2021-07-15T10:20:40Z

Good job @praveendvd

starbuck251 · 2021-11-10T16:36:47Z

@praveendvd we're using this in our runs, but the console logs are not added to the failing step. Our dev was able to fix it but unable to jump through the submission hooks. I wonder if you could look into fixing it? if you haven't already

praveendvd · 2021-11-10T16:38:11Z

@praveendvd we're using this in our runs, but the console logs are not added to the failing step. Our dev was able to fix it but unable to jump through the submission hooks. I wonder if you could look into fixing it? if you haven't already

Could you add an reproducible example

starbuck251 · 2021-11-10T16:41:32Z

Hi @praveendvd not without completely deconstructing our repo, I'd need to build one from scratch. I have asked my dev if he'd be able to comment on here as to how he fixed it - would that be of help? It will take me a couple of days before I will have time to build a small example, but will do so as the failing step is where we really need the logs :) - great work btw - its really useful!

praveendvd · 2021-11-10T16:54:11Z

@starbuck251 Glad it's helpful , could you add one example code where Yoh explicitly add some console log and explicitly make the code fail but the log not getting added to the report

starbuck251 · 2021-11-10T16:59:12Z

sure thing @praveendvd , will work on that over next couple of days and send a link to it :)

praveendvd · 2021-11-10T17:48:03Z

@starbuck251 is the issue with cucumber ?

starbuck251 · 2021-11-10T17:50:50Z

yes, we use the cucumber framework for our project

praveendvd · 2021-11-10T17:58:02Z

@starbuck251

attachConsoleLogs(this._consoleOutput, this._allure)

moving this to top of onTestFail fixes the issue, was that the fix the dev team suggested ?

starbuck251 · 2021-11-10T18:01:41Z

I believe it might be something like that, I'll slack him to confirm :)

starbuck251 · 2021-11-11T10:04:55Z

Hi @praveendvd I got confirmation today - that your suggestion there is the same which will fix the issue of logs not attaching on failed steps :) which we tested here I believe
Will this be sufficient do you think or shall I work on an example repo also?

praveendvd · 2021-11-11T10:13:46Z

Hi @praveendvd I got confirmation today - that your suggestion there is the same which will fix the issue of logs not attaching on failed steps :) which we tested here I believe
Will this be sufficient do you think or shall I work on an example repo also?

Just raise a issue will create a pull request today thank you

starbuck251 · 2021-11-11T10:32:48Z

Thanks, that's amazingly helpful and kind of you :)

praveendvd added 2 commits July 13, 2021 19:24

Added ability to print console log for spec and allure reports

a29fd8e

Removed package-lock

7152f48

praveendvd commented Jul 13, 2021

View reviewed changes

christian-bromann reviewed Jul 14, 2021

View reviewed changes

packages/wdio-spec-reporter/tests/index.test.ts Outdated Show resolved Hide resolved

Merge branch 'webdriverio:main' into console-log

407c69c

praveendvd closed this Jul 14, 2021

Made the changes as per review

845e722

praveendvd reopened this Jul 14, 2021

praveendvd closed this Jul 14, 2021

Merge branch 'webdriverio:main' into console-log

4e50b15

praveendvd and others added 4 commits July 14, 2021 15:09

Added unit tests

dc2461f

Merge branch 'webdriverio:main' into console-log

5c014bd

Merge branch 'console-log' of github.com:praveendvd/webdriverio into …

e6f4d0d

…console-log

Added types to process.write

856407a

praveendvd reopened this Jul 14, 2021

praveendvd added 2 commits July 14, 2021 16:40

Added unit test coverage

5952210

Increase statement coverage

104b16c

christian-bromann reviewed Jul 15, 2021

View reviewed changes

Changed statement coverage to 97

468166c

christian-bromann added the PR: Polish 💅 PRs that contain improvements on existing features label Jul 15, 2021

christian-bromann merged commit 0a7887d into webdriverio:main Jul 15, 2021

praveendvd deleted the console-log branch July 15, 2021 10:36

starbuck251 mentioned this pull request Nov 11, 2021

[🐛 Bug]: Console.Logs not attaching to AllureReport on a failed cucumber step #7686

Closed

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Added ability to add console log to allure and spec reporters (fix for #7001) #7134

Added ability to add console log to allure and spec reporters (fix for #7001) #7134

praveendvd commented Jul 13, 2021 •

edited

praveendvd commented Jul 13, 2021 •

edited

praveendvd left a comment

christian-bromann Jul 14, 2021

praveendvd Jul 14, 2021

christian-bromann commented Jul 14, 2021

praveendvd commented Jul 14, 2021

christian-bromann commented Jul 14, 2021

praveendvd commented Jul 14, 2021

christian-bromann left a comment

christian-bromann Jul 15, 2021

praveendvd Jul 15, 2021

praveendvd Jul 15, 2021

praveendvd Jul 15, 2021

praveendvd commented Jul 15, 2021

christian-bromann commented Jul 15, 2021

starbuck251 commented Nov 10, 2021

praveendvd commented Nov 10, 2021

starbuck251 commented Nov 10, 2021

praveendvd commented Nov 10, 2021

starbuck251 commented Nov 10, 2021

praveendvd commented Nov 10, 2021

starbuck251 commented Nov 10, 2021

praveendvd commented Nov 10, 2021

starbuck251 commented Nov 10, 2021

starbuck251 commented Nov 11, 2021

praveendvd commented Nov 11, 2021

starbuck251 commented Nov 11, 2021

Added ability to add console log to allure and spec reporters (fix for #7001) #7134

Added ability to add console log to allure and spec reporters (fix for #7001) #7134

Conversation

praveendvd commented Jul 13, 2021 • edited

Proposed changes

Types of changes

Checklist

Further comments

Reviewers: @webdriverio/project-committers

praveendvd commented Jul 13, 2021 • edited

praveendvd left a comment

Choose a reason for hiding this comment

christian-bromann Jul 14, 2021

Choose a reason for hiding this comment

praveendvd Jul 14, 2021

Choose a reason for hiding this comment

christian-bromann commented Jul 14, 2021

praveendvd commented Jul 14, 2021

christian-bromann commented Jul 14, 2021

praveendvd commented Jul 14, 2021

christian-bromann left a comment

Choose a reason for hiding this comment

christian-bromann Jul 15, 2021

Choose a reason for hiding this comment

praveendvd Jul 15, 2021

Choose a reason for hiding this comment

praveendvd Jul 15, 2021

Choose a reason for hiding this comment

praveendvd Jul 15, 2021

Choose a reason for hiding this comment

praveendvd commented Jul 15, 2021

christian-bromann commented Jul 15, 2021

starbuck251 commented Nov 10, 2021

praveendvd commented Nov 10, 2021

starbuck251 commented Nov 10, 2021

praveendvd commented Nov 10, 2021

starbuck251 commented Nov 10, 2021

praveendvd commented Nov 10, 2021

starbuck251 commented Nov 10, 2021

praveendvd commented Nov 10, 2021

starbuck251 commented Nov 10, 2021

starbuck251 commented Nov 11, 2021

praveendvd commented Nov 11, 2021

starbuck251 commented Nov 11, 2021

praveendvd commented Jul 13, 2021 •

edited

praveendvd commented Jul 13, 2021 •

edited