Skip to content

Latest commit

 

History

History
52 lines (39 loc) · 2.43 KB

cucumber-logging.md

File metadata and controls

52 lines (39 loc) · 2.43 KB
Raw

Cucumber Logging

Tools like BrowserStack, Sauce Labs and others have these great tools, like recording and logging. However, they are horrible to sync up with your Cucumber Scenarios, which makes troubleshooting with these services painful. To shorten your troubleshooting time, set up your Cucumber Logging.

Cucumber has the attach capability, which can append almost anything to the output JSON file. This file can be converted into a HTML report. The report shows the status of each scenario steps, the before and after hooks. Attach place text or images relative to the context it was executed within. This means a test error stack trace can be shown within the failing scenario step. In addition, embedding a web-client screenshot of the failing scenario step alongside the stack trace is very powerful. Even more can be logged.

Besides logging the stack trace from the test code and the screenshot of the failing web-client, browser logs can be embedded into the HTML report.
In our implementation, they are obtained at the end of scenario. In addition, we only obtain error messages to keep the noise down.

Viewing the Cucumber HTML Report

After running the e2e test suite, it generates a HTML report.
The e2e test suite creates a Cucumber HTML report in <root-folder>/first-bank-of-change/.tmp/report. Opening index.html in a browser will allow you see the failing and passing items.

Logging Stack Trace and Screenshots

Logging of errors are provided by Cucumber and WebDriverIO, so there is no implementation required from us. However, screenshots requires a few lines of code in the afterStep function in the first-bank-of-change\wdio.conf.js around line 305.

Logging Browser Log Entries

Logging web-client browser logs take a bit more effort. The implementation here attempts to remove noise and returns just the error message. It uses a modified version of protractor tool to retrieve browser logs and filter them by logging level.

All the code is in wdio.conf.js, most of it is at top of the file with a couple of hooks making related calls. The code starts first-bank-of-change\wdio.conf.js around line 7. The primary piece is the logConsoleOutput function, which retrieves the logs and filters them.

Logging in the Test Suite

With Cucumber you can log within scenario steps. An example of the code is first-bank-of-change\wdio.conf.js around line 10.