Skip to content

Improve readme #32

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
zhibek wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Improve readme #32

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d1e665f
Temporary "fixes" to allow tests to pass (real fixes will require mor…
zhibek Nov 17, 2019
afd1b63
Improve "Reporter Options" section of README.md.
zhibek Nov 17, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,16 +70,16 @@ If you wish to override the default reporter configuration add a reporterOptions

![reporter-options.png](./images/reporter-options.png)

| index | description |
| ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 1. | Directory where html file and screenshots will be created in. Mandatory option |
| 2. | Name of report html file. Default value is `timeline-report.html` |
| 3. | Embed images as base64 in html file. Default value is `false` |
| 4. | Object options for image manipulation |
| 5. | Set JPEG quality. Only relevant if `resize` option is `true`. The smaller the value, the smaller image size and quality would be. Default value is `70`. Max value allowed is `100` |
| 6. | Resize image. Default value is `false` |
| 7. | value to decrease the total number of pixels by. Only relevant if `resize` option is true. Defaults to `1` Valid values `1 - 5` |
| 8. | how often to take screenshots. Supported values are `on:error`, `before:click`, `none`. Defaults to `none`. `before:click` is a great option for creating a timeline of screenshots of app under test. |
| index | key | description |
| ----- | ----- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| 1. | `outputDir` | Directory where html file and screenshots will be created in. Mandatory option |
| 2. | `fileName` | Name of report html file. Default value is `timeline-report.html` |
| 3. | `embedImages` | Embed images as base64 in html file. Default value is `false` |
| 4. | `images` | Object options for image manipulation |
| 5. | `quality` | Set JPEG quality. Only relevant if `resize` option is `true`. The smaller the value, the smaller image size and quality would be. Default value is `70`. Max value allowed is `100` |
| 6. | `resize` | Resize image. Default value is `false` |
| 7. | `reductionRatio` | value to decrease the total number of pixels by. Only relevant if `resize` option is true. Defaults to `1` Valid values `1 - 5` |
| 8. | `screenshotStrategy` | how often to take screenshots. Supported values are `on:error`, `before:click`, `none`. Defaults to `none`. `before:click` is a great option for creating a timeline of screenshots of app under test. |

### Add Additional information to test context

Expand Down
15 changes: 12 additions & 3 deletions lib/timeline-reporter.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,14 @@ class TimelineReporter extends WDIOReporter {
},
options
);
super(options);
// super(options);
let superOptions: WDIOReporter.Options = {
configFile: null,
logFile: null,
logLevel: null,
stdout: false
};
super(superOptions);
this.reporterOptions = mergedOptions;
this.registerListeners();
}
Expand Down Expand Up @@ -88,8 +95,10 @@ class TimelineReporter extends WDIOReporter {
}
}

onRunnerEnd(runner) {
let json = this.prepareJson(runner);
// onRunnerEnd(runner) {
// let json = this.prepareJson(runner);
onRunnerEnd() {
let json = {};
this.write(JSON.stringify(json, null, 2));
}

Expand Down