-Both the `open` and `waitForPageLoading` methods return the instance calling them. -This is meant to provide a [fluent API](https://en.wikipedia.org/wiki/Fluent_interface){:target="_blank"}, so that you can rely on method chaining. -You should write your service methods with this in mind. -Check [FilesIT]({{ site.repository_url }}/it-testbook/src/test/java/io/github/giulong/spectrum/it_testbook/tests/FilesIT.java){:target="_blank"} for an example: - -{% include copyCode.html %} - -```java -uploadPage - .open() - .upload(uploadPage.getFileUpload(),FILE_TO_UPLOAD) - .getSubmit() - .click(); -``` +> 💡 **Tip**
+> Both the `open` and `waitForPageLoading` methods return the instance calling them. +> This is meant to provide a [fluent API](https://en.wikipedia.org/wiki/Fluent_interface){:target="_blank"}, so that you can rely on method chaining. +> You should write your service methods with this in mind. +> Check [FilesIT]({{ site.repository_url }}/it-testbook/src/test/java/io/github/giulong/spectrum/it_testbook/tests/FilesIT.java){:target="_blank"} for an example: +> ```java +> uploadPage +> .open() +> .upload(uploadPage.getFileUpload(), FILE_TO_UPLOAD) +> .getSubmit() +> .click(); +> ``` * `isLoaded()`: This is a method to check if the caller page is loaded. It returns a boolean which is true if the current url is equal to the AUT's base url combined with the page's endpoint. -{% include copyCode.html %} - ```java public class HelloWorldIT extends SpectrumTest
-> When running on *nix, the [configuration.default.unix.yaml]({{ site.repository_url }}/spectrum/src/main/resources/yaml/configuration.default.unix.yaml){:target="_blank"} -> will be merged onto the base -> one -> to set filesystem-specific values such as path separators. +> When running on *nix, the +> [configuration.default.unix.yaml]({{ site.repository_url }}/spectrum/src/main/resources/yaml/configuration.default.unix.yaml){:target="_blank"} +> will be merged onto the base one to set filesystem-specific values such as path separators. To provide your own configuration and customise these values, you can create the `src/test/resources/configuration.yaml` file in your project. @@ -578,23 +541,20 @@ which is a comma separated list of profile names you want to activate. > ⚠️ **Merging Lists**
> Watch out that list-type nodes will not be overridden. Their values will be merged by appending elements! Let's clarify with an example: - -{% include copyCode.html %} - -```yaml -# configuration.yaml -anyList: - - baseValue - -# configuration-test.yaml -anyList: - - valueForTest - -# merged configurations -anyList: - - baseValue - - valueForTest -``` +> ```yaml +> # configuration.yaml +> anyList: +> - baseValue +> +> # configuration-test.yaml +> anyList: +> - valueForTest +> +> # merged configurations +> anyList: +> - baseValue +> - valueForTest +> ``` > 💡 **Tip**
> Working in a team where devs need different local configurations? You can *gitignore* a file like `configuration-personal.yaml`, @@ -610,13 +570,10 @@ anyList: > > The very first node of the base `configuration.yaml` linked above sets the active profiles, instructing Spectrum to load the other two configurations, > and overriding the `application.baseUrl` accordingly: - -{% include copyCode.html %} - -```yaml -runtime: - profiles: local,second -``` +> ```yaml +> runtime: +> profiles: local,second +> ``` --- @@ -638,8 +595,6 @@ There are a few ways to interpolate configuration keys: Each interpolator can be configured in the base `configuration.yaml` under the `config` node. Here you can see the internal [configuration.default.yaml]({{ site.repository_url }}/spectrum/src/main/resources/yaml/configuration.default.yaml){:target="_blank"}: -{% include copyCode.html %} - ```yaml # Generic configuration. This node is read only from the base configuration.yaml config: @@ -683,8 +638,6 @@ depending on the type needed as result. Let's suppose we have the variable `key Let's clarify this with an example where you run behind a proxy. You could store the proxy port as a common variable, and then interpolate it in each driver's preferences with the proper type: -{% include copyCode.html %} - ```yaml vars: proxyHost: my-proxy.com @@ -706,8 +659,6 @@ drivers: This is the full syntax for values interpolation, where '`:-`' is the separator between the name of the key to search for and the default value to use in case that key is not found: -{% include copyCode.html %} - ```yaml # String example object: @@ -728,7 +679,6 @@ Spectrum will interpolate the dollar-string with the first value found in this l 1. [vars node](#vars-node): - {% include copyCode.html %} ```yaml vars: key: value @@ -767,34 +717,23 @@ Both key name and default value might contain dots like in `${some.key:-default. > This trick is used in the internal [configuration.default.yaml]({{ site.repository_url }}/spectrum/src/main/resources/yaml/configuration.default.yaml){:target="_blank"} > to allow for variables to be read from outside. > For example, profiles are set like this: - -{% include copyCode.html %} - -```yaml -# internal configuration.default.yaml -runtime: - profiles: ${spectrum.profiles:-local} -``` - +> ```yaml +> # internal configuration.default.yaml +> runtime: +> profiles: ${spectrum.profiles:-local} +> ``` > This allows you to just run with `-Dspectrum.profiles=...` while having a default, but you can still explicitly set them in your `configuration.yaml`: - -{% include copyCode.html %} - -```yaml -# your configuration.yaml -runtime: - profiles: my-profile,another-one -``` - +> ```yaml +> # your configuration.yaml +> runtime: +> profiles: my-profile,another-one +> ``` > You can also choose to provide your own variable, which could be useful to create and leverage your own naming convention for env variables. - -{% include copyCode.html %} - -```yaml -# your configuration.yaml -runtime: - profiles: ${active-profiles:-local} -``` +> ```yaml +> # your configuration.yaml +> runtime: +> profiles: ${active-profiles:-local} +> ``` These variables are already available in the [configuration.default.yaml]({{ site.repository_url }}/spectrum/src/main/resources/yaml/configuration.default.yaml){: target="_blank"}. @@ -811,8 +750,6 @@ You can add your own and even override the default ones in your `configuration*. The in-place interpolator is enabled by default with the highest priority. You can disable it or change its priority with this configuration snippet: -{% include copyCode.html %} - ```yaml config: interpolators: @@ -826,8 +763,6 @@ config: You can **avoid specifying keys directly in the yaml files** and interpolate values taken from environment variables by providing this configuration snippet: -{% include copyCode.html %} - ```yaml config: interpolators: @@ -836,8 +771,6 @@ config: Providing an empty object as above, you'll leverage on the internal defaults, which are the following: -{% include copyCode.html %} - ```yaml config: interpolators: @@ -854,8 +787,6 @@ For instance, you can inject the `application.baseUrl` setting an env variable n To give you another example, you can use this config to inject env vars like `APPLICATION_BASEURL`: -{% include copyCode.html %} - ```yaml config: interpolators: @@ -884,8 +815,6 @@ Allowed values for the `transformCase` property are: You can **avoid specifying keys directly in the yaml files** and interpolate values taken from system properties by providing this configuration snippet: -{% include copyCode.html %} - ```yaml config: interpolators: @@ -894,8 +823,6 @@ config: Providing an empty object as above, you'll leverage on the internal defaults, which are the following: -{% include copyCode.html %} - ```yaml config: interpolators: @@ -912,8 +839,6 @@ For instance, you can inject the `application.baseUrl` setting the system proper To give you another example, you can use this config to inject system properties like `-DAPPLICATION_BASEURL`: -{% include copyCode.html %} - ```yaml config: interpolators: @@ -960,8 +885,6 @@ See [https://www.selenium.dev/documentation/webdriver/browsers/chrome/](https:// | capabilities | Map\
> The weights shown in the snippet above are the default, meaning **passed** tests are shown before **skipped** ones, > which in turn are shown before those that **failed**. If this order is fine for you, there's no need to explicitly provide those weights. You can just write: - -{% include copyCode.html %} - -```yaml -extent: - sort: - status: { } -``` +> ```yaml +> extent: +> sort: +> status: { } +> ``` ### Custom locators @@ -2063,8 +1895,6 @@ You can leverage the `extent.locatorRegex` property to extract the important bit out of it, **using the capturing group** (the one wrapped by parentheses). For example, for a field annotated like this: -{% include copyCode.html %} - ```java @FindBys({ @@ -2080,8 +1910,6 @@ this would be the full `toString()`: The regex in the [configuration.default.yaml]({{ site.repository_url }}/spectrum/src/main/resources/yaml/configuration.default.yaml){:target="_blank"} is: -{% include copyCode.html %} - ```yaml locatorRegex: \s->\s([\w:\s\-.#]+) ``` @@ -2092,8 +1920,6 @@ which extracts just this (mind the capturing group above): For example, if you want to shrink it even more, you could add this as `extent.locatorRegex` in your `configuration.yaml`: -{% include copyCode.html %} - ```yaml locatorRegex: \s->[\w\s]+:\s([()^\w\s\-.#]+) ``` @@ -2134,16 +1960,13 @@ You can specify which screenshots to be used as frames providing one or more of > Screenshots are taken automatically (with `autoBefore` and `autoAfter`) according to the current log level > and the `drivers.events` settings. For example, if running with the default `INFO` log level and the configuration below, > no screenshot will be taken before clicking any element. It will when raising the log level at `DEBUG` or higher. - -{% include copyCode.html %} - -```yaml -drivers: - events: - beforeClick: - level: DEBUG # Screenshots for this event are taken only when running at `DEBUG` level or higher - message: Clicking on %1$s -``` +> ```yaml +> drivers: +> events: +> beforeClick: +> level: DEBUG # Screenshots for this event are taken only when running at `DEBUG` level or higher +> message: Clicking on %1$s +> ``` > 💡 **Tip**
> Setting both `autoBefore` and `autoAfter` is likely to be useless. In this flow, screenshots at bullets 3 and 4 will be equal: @@ -2169,19 +1992,16 @@ folder and attached to the Extent Report as well, where: > 💡 **Video Configuration Example**
> Here's a quick example snippet. Remember you just need to provide fields with a value different from the corresponding one in the > internal [configuration.default.yaml]({{ site.repository_url }}/spectrum/src/main/resources/yaml/configuration.default.yaml){:target="_blank"}: - -{% include copyCode.html %} - -```yaml -video: - frames: - - autoAfter - - manual - skipDuplicateFrames: false - extentTest: - width: 640 # we want a bigger video tag in the report - height: 480 -``` +> ```yaml +> video: +> frames: +> - autoAfter +> - manual +> skipDuplicateFrames: false +> extentTest: +> width: 640 # we want a bigger video tag in the report +> height: 480 +> ``` > ⚠️ **Video Frame Rate**
> Since the execution video is made up of screenshots, for performance reason it has a fixed rate of 1 frame per second. @@ -2216,8 +2036,6 @@ So, when configured, a `successful` number of report(s), if present, are retaine This is meant to have an evidence of the last successful run(s), even if there's a long recent history of failed ones. This snippet shows how to configure the example we just saw: -{% include copyCode.html %} - ```yaml retention: total: 10 @@ -2227,8 +2045,6 @@ retention: Additionally, you can configure a number of `days` after which reports will be deleted. A `successful` number of reports, if present, will still be kept, regardless of their age. Let's make another example. Say we configured this: -{% include copyCode.html %} - ```yaml retention: total: 5 @@ -2254,8 +2070,6 @@ As you can see, by default no report will be deleted, regardless of the executio this is how you can configure it for the extent report and testbook. Mind how you can have just the retention parameters you need, it's not mandatory to use them all: -{% include copyCode.html %} - ```yaml extent: retention: @@ -2301,8 +2115,6 @@ You can add files to be uploaded in the folder specified in the `runtime.filesFo This is the default you can see in the internal [configuration.default.yaml]({{ site.repository_url }}/spectrum/src/main/resources/yaml/configuration.default.yaml){:target="_blank"}: -{% include copyCode.html %} - ```yaml runtime: filesFolder: src/test/resources/files @@ -2310,8 +2122,6 @@ runtime: If you have these files in the configured folder: -{% include copyCode.html %} - ```text root └─ src @@ -2324,8 +2134,6 @@ root and in the web page there's an input field with `type="file"`, you can leverage the `upload` method directly in any of your tests/pages like this: -{% include copyCode.html %} - ```java public class HelloWorldIT extends SpectrumTest
> Check the `eventsConsumers` in the [configuration.default.yaml]({{ site.repository_url }}/spectrum/src/main/resources/yaml/configuration.default.yaml){:target="_blank"}. -> Internal consumers need to take actions after each test is done, meaning they listen to events tagged with "test": - -{% include copyCode.html %} - -```yaml -eventsConsumers: - - extentTest: # We need to add an entry to the Extent Report once each test is done - events: - - reason: after - tags: [ test ] -``` +> Internal consumers need to take actions after each test is done, meaning they listen to events tagged with `test`: +> ```yaml +> eventsConsumers: +> - extentTestEnd: # We need to add an entry to the Html Report once each test is done +> events: +> - reason: after +> tags: [ test ] +> ``` ## Reason @@ -2690,8 +2471,6 @@ in custom templates to access objects stored in it. For example, the default [slack.json template]({{ site.repository_url }}/spectrum/src/main/resources/templates/slack.json){:target="_blank"} uses it to print class and test names: -{% include copyCode.html %} - ```json "text": "*Name*\n*Class*: `${event.context.parent.get().displayName}`\n*Test*: `${event.context.displayName}`" ``` @@ -2715,25 +2494,20 @@ The other columns are the event's keys, with blank values being nulls. > 💡 **Tip**
> If you're not sure about a particular event, when it's fired and what are the actual values of its keys, > you can always run with `-Dspectrum.log.level=TRACE` and look into logs. You'll find something like "Dispatching event ...": - -{% include copyCode.html %} - -```text -18:00:05.076 D EventsDispatcher | Dispatching event Event(primaryId=null, secondaryId=null, tags=[suite], reason=before, result=null) -18:00:05.081 T EventsConsumer | ExtentTestConsumer matchers for Event(primaryId=null, secondaryId=null, tags=[suite], reason=before, result=null) -18:00:05.081 T EventsConsumer | reasonMatches: false -18:00:05.081 T EventsConsumer | resultMatches: false -18:00:05.081 T EventsConsumer | TestBookConsumer matchers for Event(primaryId=null, secondaryId=null, tags=[suite], reason=before, result=null) -18:00:05.081 T EventsConsumer | reasonMatches: false -18:00:05.081 T EventsConsumer | resultMatches: false -``` +> ```text +> 18:00:05.076 D EventsDispatcher | Dispatching event Event(primaryId=null, secondaryId=null, tags=[suite], reason=before, result=null) +> 18:00:05.081 T EventsConsumer | ExtentTestConsumer matchers for Event(primaryId=null, secondaryId=null, tags=[suite], reason=before, result=null) +> 18:00:05.081 T EventsConsumer | reasonMatches: false +> 18:00:05.081 T EventsConsumer | resultMatches: false +> 18:00:05.081 T EventsConsumer | TestBookConsumer matchers for Event(primaryId=null, secondaryId=null, tags=[suite], reason=before, result=null) +> 18:00:05.081 T EventsConsumer | reasonMatches: false +> 18:00:05.081 T EventsConsumer | resultMatches: false +> ``` ## Custom Events Since `eventsDispatcher` is injected in every `SpectrumTest` and `SpectrumPage`, you can programmatically send custom events and listen to them: -{% include copyCode.html %} - ```java @DisplayName("Class display name") @@ -2800,50 +2574,41 @@ Let's now see how to configure few consumers: > 💡 **Example: reason and primaryId and secondaryId**
> We want to send a Slack notification before and after a specific test, and an email just after: - -{% include copyCode.html %} - -```yaml -eventsConsumers: - - slack: - events: - - primaryId: Class Name - secondaryId: test name - reason: before - - primaryId: Class Name - secondaryId: test name - reason: after - - mail: - events: - - primaryId: Class Name - secondaryId: test name - reason: after -``` +> ```yaml +> eventsConsumers: +> - slack: +> events: +> - primaryId: Class Name +> secondaryId: test name +> reason: before +> - primaryId: Class Name +> secondaryId: test name +> reason: after +> - mail: +> events: +> - primaryId: Class Name +> secondaryId: test name +> reason: after +> ``` > 💡 **Example: result and tags**
> We want to send a mail notification if the whole suite fails: - -{% include copyCode.html %} - -```yaml -eventsConsumers: - - mail: - events: - - result: FAILED - tags: [ suite ] -``` +> ```yaml +> eventsConsumers: +> - mail: +> events: +> - result: FAILED +> tags: [ suite ] +> ``` > 💡 **Example: custom event by primaryId and reason**
- -{% include copyCode.html %} - -```yaml -eventsConsumers: - - slack: - events: - - primaryId: primary.* # every event which primaryId is starting with "primary" - reason: custom-event -``` +> ```yaml +> eventsConsumers: +> - slack: +> events: +> - primaryId: primary.* # every event which primaryId is starting with "primary" +> reason: custom-event +> ``` > 💡 **Tip**
> Consumers send notification using templates that leverage [FreeMarker](https://freemarker.apache.org/){:target="_blank"}. @@ -2863,8 +2628,6 @@ the [docs](https://www.simplejavamail.org/configuration.html#section-config-prop For example, to send an email via GMail, you can use these properties by replacing placeholders with actual values: -{% include copyCode.html %} - ```properties simplejavamail.transportstrategy=SMTP_TLS simplejavamail.smtp.host=smtp.gmail.com @@ -2887,20 +2650,17 @@ Check Simple java Mail's docs to see all the [available properties](https://www. > The default [mail.html template]({{ site.repository_url }}/spectrum/src/main/resources/templates/mail.html){:target="_blank"} > can either be used to notify about single tests or the whole suite result, > as per the snippet below. You can use both or just the one you prefer. - -{% include copyCode.html %} - -```yaml -eventsConsumers: - - mail: - events: - - reason: after - tags: [ test ] - - mail: - events: - - reason: after - tags: [ suite ] -``` +> ```yaml +> eventsConsumers: +> - mail: +> events: +> - reason: after +> tags: [ test ] +> - mail: +> events: +> - reason: after +> tags: [ suite ] +> ``` The default template is pretty basic, as you can see. The first is the test example, while the second is the suite result notification: @@ -2912,8 +2672,6 @@ If you want to provide a custom template there are two ways: * provide a template with a custom name under `src/test/resources/templates`: -{% include copyCode.html %} - ```yaml eventsConsumers: - mail: @@ -2936,8 +2694,6 @@ You can also specify a list of attachments, by providing: For example, it's useful to send the html report and/or testbook when the suite is complete: -{% include copyCode.html %} - ```yaml eventsConsumers: - mail: @@ -2955,26 +2711,23 @@ eventsConsumers: > Mind that, like in the snippet above, attachments are specified at consumer level. > This means for all the events of a specific consumer, all the attachments will be sent. > If you need to send different sets of attachments, provide different consumers: - -{% include copyCode.html %} - -```yaml -eventsConsumers: - - mail: - events: - - reason: after - tags: [ suite ] - attachments: - - name: report - file: target/spectrum/reports/report.html - - mail: - events: - - reason: after - tags: [ class ] - attachments: - - name: attachment - file: path/to/attachment -``` +> ```yaml +> eventsConsumers: +> - mail: +> events: +> - reason: after +> tags: [ suite ] +> attachments: +> - name: report +> file: target/spectrum/reports/report.html +> - mail: +> events: +> - reason: after +> tags: [ class ] +> attachments: +> - name: attachment +> file: path/to/attachment +> ``` ### Slack Consumer @@ -2986,7 +2739,6 @@ A few steps are needed to configure your Slack Workspace to receive notification 2. choose to create it **from an app manifest**
 3. Select your workspace, delete the default yaml manifest and copy this one:
- {% include copyCode.html %} ```yaml display_information: name: Spectrum @@ -3023,7 +2775,6 @@ A few steps are needed to configure your Slack Workspace to receive notification 3. copy the **Channel ID** from the details overlay:
 5. Configure the Slack consumer(s) in your `configuration*.yaml` by providing the **token** and the **Channel ID** from the previous steps: - {% include copyCode.html %} ```yaml eventsConsumers: - slack: @@ -3040,31 +2791,25 @@ A few steps are needed to configure your Slack Workspace to receive notification > The default [slack.json template]({{ site.repository_url }}/spectrum/src/main/resources/templates/slack.json){:target="_blank"} is meant to be used to notify about each > test result, > as per the snippet below. It might not be correctly interpolated if used on other events. - -{% include copyCode.html %} - -```yaml -eventsConsumers: - - slack: - events: - - reason: after - tags: [ test ] -``` - +> ```yaml +> eventsConsumers: +> - slack: +> events: +> - reason: after +> tags: [ test ] +> ``` +> > If you want to provide a custom template there are two ways: > * provide a template with a custom name under `src/test/resources/templates`: - -{% include copyCode.html %} - -```yaml -eventsConsumers: - - slack: - template: my-template.txt # The extension doesn't really matter. - events: - - reason: after - tags: [ test ] -``` - +> +> ```yaml +> eventsConsumers: +> - slack: +> template: my-template.txt # The extension doesn't really matter. +> events: +> - reason: after +> tags: [ test ] +> ``` > * simply create the file `src/test/resources/templates/slack.json`. This will override the internal default, so there's no need to explicitly provide the path. > 💡 **Tip**
@@ -3075,8 +2820,6 @@ eventsConsumers: You can leverage this consumer to have a minimalistic report with the list of web driver's events, along with the time at which they were fired and the time delta between each. To have one generated for each test, you need to declare this: -{% include copyCode.html %} - ```yaml eventsConsumers: - testSteps: @@ -3089,19 +2832,17 @@ eventsConsumers: > By default, the [test-steps.txt template]({{ site.repository_url }}/spectrum/src/main/resources/templates/test-steps.txt){:target="_blank"} is used. > If you want to provide a custom template there are two ways: > * provide a template with a custom name under `src/test/resources/templates`: - -{% include copyCode.html %} - -```yaml -eventsConsumers: - - testSteps: - template: my-template.html # The report produced will match the template's extension. - output: target/spectrum/tests-steps # This is the default output path, no need to set it unless you want to change it. - events: - - reason: after - tags: [ test, dynamicTest ] -``` - +> +> ```yaml +> eventsConsumers: +> - testSteps: +> template: my-template.html # The report produced will match the template's extension. +> output: target/spectrum/tests-steps # This is the default output path, no need to set it unless you want to change it. +> events: +> - reason: after +> tags: [ test, dynamicTest ] +> ``` +> > * simply create the file `src/test/resources/templates/test-steps.txt`. This will override the internal default, so there's no need to explicitly provide the path. > > The template is interpolated with [FreeMarker](https://freemarker.apache.org/){:target="_blank"}. All the steps recorded are exposed in the `steps` variable and each is mapped @@ -3109,8 +2850,6 @@ eventsConsumers: By default, a report like this will be produced: -{% include copyCode.html %} - ```text Time | Time taken | Message ---------------------------------------------------------------------------------------------------- @@ -3133,8 +2872,6 @@ Time | Time taken | Message You can leverage this consumer to log a message. For instance, to hook it on a custom event, you can declare this: -{% include copyCode.html %} - ```yaml eventsConsumers: - log: @@ -3147,26 +2884,22 @@ eventsConsumers: > By default, the [log.txt template]({{ site.repository_url }}/spectrum/src/main/resources/templates/log.txt){:target="_blank"} is used. > If you want to provide a custom template there are two ways: > * provide a template with a custom name under `src/test/resources/templates`: - -{% include copyCode.html %} - -```yaml -eventsConsumers: - - log: - template: my-template.txt - events: - - primaryId: primary.* - reason: custom-event -``` - +> +> ```yaml +> eventsConsumers: +> - log: +> template: my-template.txt +> events: +> - primaryId: primary.* +> reason: custom-event +> ``` +> > * simply create the file `src/test/resources/templates/log.txt`. This will override the internal default, so there's no need to explicitly provide the path. > > The template is interpolated with [FreeMarker](https://freemarker.apache.org/){:target="_blank"}. The event is exposed in the `event` variable. By default, a message like this is logged: -{% include copyCode.html %} - ```text Class Name: Checkbox Page Test Name : testWithNoDisplayName() @@ -3183,8 +2916,6 @@ You can optionally have Spectrum generate an execution summary by providing one This is the default summary in the internal [configuration.default.yaml]({{ site.repository_url }}/spectrum/src/main/resources/yaml/configuration.default.yaml){:target="_blank"}. -{% include copyCode.html %} - ```yaml summary: reporters: [ ] # List of reporters that will produce the summary in specific formats @@ -3204,18 +2935,13 @@ meaning you can write complex conditions using the variables briefly explained b > 💡 **Tip**
> Since the testBook's quality gate status is added to the vars used when evaluating the summary's condition, > you can indirectly bind those two by having this: - -{% include copyCode.html %} - -```yaml -summary: - condition: ${qgStatus} -``` +> ```yaml +> summary: +> condition: ${qgStatus} +> ``` As an example, this is how you can have a html summary: -{% include copyCode.html %} - ```yaml summary: reporters: @@ -3230,8 +2956,6 @@ summary: All the reporters below have default values for their parameters, which means you can just configure them as empty objects like: -{% include copyCode.html %} - ```yaml reporters: - log: { } @@ -3261,8 +2985,6 @@ For each reporter: This is the internal [logReporter.yaml]({{ site.repository_url }}/spectrum/src/main/resources/yaml/dynamic/summary/logReporter.yaml){:target="_blank"}: -{% include copyCode.html %} - ```yaml log: template: summary.txt @@ -3270,8 +2992,6 @@ log: Here is the output produced by the default internal template, for tests of the `it-testbook` module: -{% include copyCode.html %} - ```text ############################################################################################################# EXECUTION SUMMARY @@ -3304,8 +3024,6 @@ Here is the output produced by the default internal template, for tests of the ` This is the internal [txtReporter.yaml]({{ site.repository_url }}/spectrum/src/main/resources/yaml/dynamic/summary/txtReporter.yaml){:target="_blank"}: -{% include copyCode.html %} - ```yaml txt: template: summary.txt @@ -3323,8 +3041,6 @@ Or you can provide different templates to log a shorter report and send the full This is the internal [htmlReporter.yaml]({{ site.repository_url }}/spectrum/src/main/resources/yaml/dynamic/summary/htmlReporter.yaml){:target="_blank"}: -{% include copyCode.html %} - ```yaml html: template: summary.html @@ -3342,8 +3058,6 @@ Beside the default template, these are already available, you just need to pick * [summary-pies.html](assets/miscellanea/summary-pies.html){:target="_blank"} that leverages [Google Charts](https://developers.google.com/chart){:target="_blank"} -{% include copyCode.html %} - ```yaml html: template: summary-pies.html @@ -3392,8 +3106,6 @@ These are the testbook parameters you need to configure: The QG node has only one property, which is the boolean condition to be evaluated: -{% include copyCode.html %} - ```yaml qualityGate: condition: ${weightedSuccessful.percentage} > 60 @@ -3477,8 +3189,6 @@ You can provide a txt file where each line is in this format: For example: -{% include copyCode.html %} - ```text test class::my test another class::another test @@ -3495,8 +3205,6 @@ You can provide a csv file where each line is in this format: For example: -{% include copyCode.html %} - ```text test class,my test another class,another test @@ -3514,8 +3222,6 @@ You can provide a yaml file where you have class names as keys in the root of th For example: -{% include copyCode.html %} - ```yaml test class: - name: my test @@ -3533,8 +3239,6 @@ another class: All the reporters below have default values for their parameters, which means you can just configure them as empty objects like: -{% include copyCode.html %} - ```yaml reporters: - log: { } @@ -3579,8 +3283,6 @@ For each reporter: This is the internal [logReporter.yaml]({{ site.repository_url }}/spectrum/src/main/resources/yaml/dynamic/testbook/logReporter.yaml){:target="_blank"}: -{% include copyCode.html %} - ```yaml log: template: testbook.txt @@ -3588,8 +3290,6 @@ log: Here is the output produced by the default internal template, for tests of the `it-testbook` module: -{% include copyCode.html %} - ```text ########################################################################################################## @@ -3699,8 +3399,6 @@ UNMAPPED TESTS: This is the internal [txtReporter.yaml]({{ site.repository_url }}/spectrum/src/main/resources/yaml/dynamic/testbook/txtReporter.yaml){:target="_blank"}: -{% include copyCode.html %} - ```yaml txt: template: testbook.txt @@ -3718,8 +3416,6 @@ Or you can provide different templates to log a shorter report and send the full This is the internal [htmlReporter.yaml]({{ site.repository_url }}/spectrum/src/main/resources/yaml/dynamic/testbook/htmlReporter.yaml){:target="_blank"}: -{% include copyCode.html %} - ```yaml html: template: testbook.html @@ -3737,8 +3433,6 @@ Beside the default template, these are already available, you just need to pick * [testbook-pies.html](assets/miscellanea/testbook-pies.html){:target="_blank"} that leverages [Google Charts](https://developers.google.com/chart){:target="_blank"} -{% include copyCode.html %} - ```yaml html: template: testbook-pies.html @@ -3752,8 +3446,6 @@ The one below is the testBook in the internal [configuration.default.yaml]({{ site.repository_url }}/spectrum/src/main/resources/yaml/configuration.default.yaml){:target="_blank"}. As you can see, it has a quality gate already set, as well as a yaml parser but no reporters. -{% include copyCode.html %} - ```yaml # internal configuration.default.yaml testBook: @@ -3767,8 +3459,6 @@ testBook: In your `configuration.yaml` you need to provide the reporters you want: -{% include copyCode.html %} - ```yaml testBook: reporters: @@ -3779,8 +3469,6 @@ testBook: ## Full TestBook Examples -{% include copyCode.html %} - ```yaml testBook: qualityGate: @@ -3796,8 +3484,6 @@ testBook: output: ${testBookReportOutput}/testbook.html # a html report will be produced at this path ``` -{% include copyCode.html %} - ```yaml testBook: qualityGate: @@ -3813,8 +3499,6 @@ testBook: output: some/path/testbook.html # a html report will be produced at this path ``` -{% include copyCode.html %} - ```yaml testBook: qualityGate: @@ -3828,10 +3512,212 @@ testBook: --- + +# Visual Regression Testing + +Spectrum supports **Visual Regression Testing**, comparing visual snapshots of the AUT to identify regressions. This is done in a two-steps process: + +1. During the first run, Spectrum takes screenshots that act as snapshot references. +2. During the subsequent runs, Spectrum takes screenshots in the same moments, and compare them to the snapshots. + +If one or more screenshots don't match with their snapshot counterpart, a `VisualRegressionException` is thrown. + +> 💡 **Tip**
+> Visual regression works with both full-page and single webElements screenshots. + +This capability is disabled by default. This is the minimum piece of configuration you need to add to activate it: + +```yaml +visualRegression: + frames: + - manual +``` + +With the snippet above, you're saying you want to compare just the screenshots you take manually. +The available frames are the same used in the [Automatic Execution Video Generation](#automatic-execution-video-generation) +(check both this and the [WebDriver Events Listener section](#webdriver-events-listener) for more info): + +| Frame | Description | +|------------|------------------------------------------------------------------------------------------------------------------------------------| +| autoBefore | Screenshots taken **before** an event happening in the WebDriver | +| autoAfter | Screenshots taken **after** an event happening in the WebDriver | +| manual | Screenshots programmatically taken by you by invoking one of the [SpectrumEntity Service Methods](#spectrumentity-service-methods) | + +Let's now review all the other options available to configure this capability. This is the internal +[configuration.default.yaml]({{ site.repository_url }}/spectrum/src/main/resources/yaml/configuration.default.yaml){:target="_blank"}: + +```yaml +# Visual Regression Testing configuration +visualRegression: + failFast: false # Whether to fail immediately when the first visual regression is found, rather than running the entire test + snapshots: # Snapshots screenshots references configuration + folder: src/test/resources/visual-regression # Where to save the screenshot references + override: false # Whether to override the snapshots references already generated + frames: [ ] # Kind of frames to be considered. Empty by default + checks: # Checks configuration + count: 0 # Number of checks to perform before considering a snapshot valid + interval: .5 # Interval between checks in seconds + maxRetries: 3 # Max retries before throwing an exception + diff: # Screenshots diff configuration + noOp: { } # No diff is shown by default. Just the snapshot reference and the regression side by side +``` + +## Fail Fast + +By default, even if a visual regression is found, the test will be completed. A `VisualRegressionException` with the total number of regressions +is thrown at the end, and the test will be flagged as failed. + +Setting `failFast` to true, the `VisualRegressionException` will be thrown at the very first regression, and the test is immediately terminated. + +## Snapshots + +The `snapshots` node lets you specify where to save the screenshot references. By default, they're saved in the resources folder +for them to be versioned. If you want to refresh the snapshots, you can manually delete the folder where they're stored, or leverage +the `override` parameter. + +> 💡 **Tip**
+> If you run your suite with multiple drivers and in multiple environments, it's likely they have different viewport sizes, meaning +> screenshots may not be cross-compatible. You can leverage [Values Interpolation](#values-interpolation) +> to save them in segregated folders: +> +> ```yaml +> visualRegression: +> snapshots: +> folder: src/test/resources/visual-regression/${ENVIRONMENT}/${spectrum.driver:-chrome} +> override: false +> ``` +> +> The same suggestion is valid for the `override` parameter: instead of changing the value directly in the configuration, you should +> interpolate it. You can also have different configurations dedicated to specific drivers/environments. + +## Checks + +The `checks` node lets you run additional checks when taking screenshots. By default, each screenshot is immediately considered +valid, as soon as it's taken. There might be situations where elements in the page are still loading, and comparing such a screenshot +with its snapshot could lead to flaky tests. + +To avoid such a situation, you can raise the `count` parameter. This way, Spectrum will take a corresponding number of screenshots +and check if they are all equal. If they are, it means the page is not changing, and the screenshot is valid. You can use the `interval` +and `maxRetries` parameters to tweak the checks behaviour. + +With the snippet below, upon taking a screenshot, Spectrum will take 2 more with 1 second interval between each, for a maximum of +5 times. As soon as the check is satisfied, the execution will continue. + +```yaml +visualRegression: + checks: + count: 2 + interval: 1 + maxRetries: 5 +``` + +> ⚠️ **Performance**
+> Running additional checks slows the test, since the execution will pause while Spectrum takes additional +> screenshots and sleeps according to the `interval` parameter. + +## Diff + +The `diff` node lets you specify how visual regressions are shown in the html report. Images are compared by their bytes hash, +first of all. If they match it means the images are the same, and no additional calculation is performed. +This means that **if a screenshot check is successful, no diff is calculated**. + +For instance, let's say these are the snapshot reference and the corresponding visual regression, where the +first checkbox was expected to be checked: + +
+ 
+
+> ⚠️ **Performance**+> Calculating the diff affects performance. The bigger the images to compare, the worse the performance. +> Generally speaking, this shouldn't be an issue, though. + +### NoOp Diff + +By default, just the snapshot reference and the regression are shown side by side. You can click on them +in the generated report to magnify them. + + + +With the other diffs kind, the diff will be shown as well: + + + +If the two images have different sizes, they can't be compared, and a corresponding message is shown: + + + +### Highlight Diff + +The `highlight` diff will highlight pixels that are different between the two images, with the provided RGB color. +For instance, with this snippet you'll get the diff shown below. + +```yaml +visualRegression: + diff: + highlight: + color: '#ff0000' # RGB color used to highlight changed pixels. Must be prefixed by a # +``` + + + +### Outline Diff + +The `outline` diff will show the outline of pixels that are different between the two images, with the provided RGB color. +For instance, with this snippet you'll get the diff shown below. + +```yaml +visualRegression: + diff: + outline: + color: '#ff0000' # RGB color used to highlight changed pixels. Must be prefixed by a # +``` + + + +## Full Visual Regression Testing Examples + +Example 1: +* saving snapshots in the `target` folder +* recording just manual frames +* performing 2 additional checks (0.5s `interval` and 3 `maxRetries` by default) +* highlighting diffs in red + +```yaml +visualRegression: + snapshots: + folder: target/visual-regression + frames: + - manual + checks: + count: 2 + diff: + highlight: + color: '#ff0000' +``` + +Example 2: +* saving snapshots in the default `src/test/resources/visual-regression` folder +* recording both `autoBefore` and `manual` frames +* performing 2 additional checks (0.5s `interval` and 3 `maxRetries` by default) +* no diffs shown +* failing fast + +```yaml +visualRegression: + frames: + - autoBefore + - manual + checks: + count: 2 + failFast: true +``` + +--- + # Parallel Execution Spectrum tests can be run in parallel by leveraging -[JUnit Parallel Execution](https://docs.junit.org/snapshot/user-guide/#writing-tests-parallel-execution){:target="_blank"} +[JUnit Parallel Execution](https://docs.junit.org/snapshot/writing-tests/parallel-execution.html){:target="_blank"} --- @@ -3875,8 +3761,6 @@ Let's see how your project will look like. Few assumptions for this example: * you configured both a html and a txt testbook reporters, which will produce `testbook.html` and `testbook.txt` reports * you configured the extent report to have a fixed name with: `extent.fileName: report.html` -{% include copyCode.html %} - ```text root └─ src diff --git a/docs/_includes/copyCode.html b/docs/_includes/copyCode.html deleted file mode 100644 index 2f7fc831b..000000000 --- a/docs/_includes/copyCode.html +++ /dev/null @@ -1,6 +0,0 @@ - - - diff --git a/docs/assets/css/style.scss b/docs/assets/css/style.scss index 36069b120..6d501931d 100644 --- a/docs/assets/css/style.scss +++ b/docs/assets/css/style.scss @@ -254,15 +254,29 @@ tbody tr:nth-child(odd) { blockquote { font-style: normal; - margin: 25px -20px -10px; - padding: 1px 20px 1px 40px; + margin: 10px -20px -10px; + padding: 1px 40px; +} + +div.highlighter-rouge { + position: relative; + top: -20px; +} + +blockquote pre.highlight { + margin: 0 0 20px; +} + +blockquote div.highlighter-rouge { + margin-top: -20px; } span.copy-header { display: block; - padding: 28px 16px 4px; - margin: 0 -20px -64px; text-align: right; + position: relative; + top: 42px; + right: 8px; } span.schema-copy-header { @@ -270,8 +284,8 @@ span.schema-copy-header { text-align: center; } -blockquote + p > span.copy-header { - padding: 6px 16px 4px; +blockquote span.copy-header { + padding: 6px 16px 2px; } button.copy-button, button.schema-copy-button { diff --git a/docs/assets/images/color-diff.png b/docs/assets/images/color-diff.png new file mode 100644 index 000000000..9c35c08bc Binary files /dev/null and b/docs/assets/images/color-diff.png differ diff --git a/docs/assets/images/diff.png b/docs/assets/images/diff.png new file mode 100644 index 000000000..f6efa78d1 Binary files /dev/null and b/docs/assets/images/diff.png differ diff --git a/docs/assets/images/different-size-diff.png b/docs/assets/images/different-size-diff.png new file mode 100644 index 000000000..390692581 Binary files /dev/null and b/docs/assets/images/different-size-diff.png differ diff --git a/docs/assets/images/no-diff.png b/docs/assets/images/no-diff.png new file mode 100644 index 000000000..823284c71 Binary files /dev/null and b/docs/assets/images/no-diff.png differ diff --git a/docs/assets/images/outline.png b/docs/assets/images/outline.png new file mode 100644 index 000000000..af0447dd4 Binary files /dev/null and b/docs/assets/images/outline.png differ diff --git a/docs/assets/images/reference.png b/docs/assets/images/reference.png new file mode 100644 index 000000000..920d420b1 Binary files /dev/null and b/docs/assets/images/reference.png differ diff --git a/docs/assets/images/regression.png b/docs/assets/images/regression.png new file mode 100644 index 000000000..88845ad47 Binary files /dev/null and b/docs/assets/images/regression.png differ diff --git a/docs/assets/scripts/copyCode.js b/docs/assets/scripts/copyCode.js index 7f272a1a0..136359da1 100644 --- a/docs/assets/scripts/copyCode.js +++ b/docs/assets/scripts/copyCode.js @@ -1,10 +1,24 @@ -const copyHeaders = document.querySelectorAll('.copy-header'); -const copyButtons = document.querySelectorAll('.copy-button'); +const codeSnippets = document.querySelectorAll('div.highlighter-rouge') +const buttonSnippet = ` + + `; (async () => { const response = await fetch('https://api.github.com/repos/giulong/spectrum/contents/docs/json-schemas'); const json = await response.json(); + codeSnippets.forEach(codeSnippet => { + const wrapper = document.createElement('span'); + wrapper.innerHTML = buttonSnippet; + codeSnippet.prepend(wrapper); + }); + + const copyHeaders = document.querySelectorAll('.copy-header'); + const copyButtons = document.querySelectorAll('.copy-button'); + copyButtons.forEach((copyButton, index) => { try { const code = copyHeaders[index].parentElement.nextElementSibling.innerText; diff --git a/it-appium/src/test/resources/logback-test.xml b/it-appium/src/test/resources/logback-test.xml deleted file mode 100644 index f42375332..000000000 --- a/it-appium/src/test/resources/logback-test.xml +++ /dev/null @@ -1,25 +0,0 @@ - -
\\s*
", DOTALL);
private static final Base64.Encoder ENCODER = Base64.getEncoder();
private static final String SRC = "src";
+ private static final String ID = "id";
private final FreeMarkerWrapper freeMarkerWrapper = FreeMarkerWrapper.getInstance();
private final ContextManager contextManager = ContextManager.getInstance();
@@ -34,14 +34,16 @@ public class HtmlUtils implements SessionHook {
private String videoTemplate;
private String divTemplate;
private String frameTemplate;
- private String inlineImageTemplate;
+ private String imageTemplate;
+ private String visualRegressionTemplate;
@Override
public void sessionOpened() {
this.videoTemplate = fileUtils.readTemplate("video.html");
this.divTemplate = fileUtils.readTemplate("div-template.html");
- this.inlineImageTemplate = fileUtils.readTemplate("div-image-template.html");
- this.frameTemplate = fileUtils.readTemplate("div-frame-template.html");
+ this.imageTemplate = fileUtils.readTemplate("image-template.html");
+ this.frameTemplate = fileUtils.readTemplate("frame-template.html");
+ this.visualRegressionTemplate = fileUtils.readTemplate("visual-regression-template.html");
}
public static HtmlUtils getInstance() {
@@ -57,36 +59,59 @@ public String buildFrameTagFor(final int number, final String content, final Tes
}
public String buildFrameTagFor(final int number, final String content, final TestData testData, final String classes) {
- return freeMarkerWrapper.interpolate(this.frameTemplate, Map.of("classes", classes, "id", testData.getTestId(), "number", number, "content", content));
+ return freeMarkerWrapper.interpolate(this.frameTemplate, Map.of("classes", classes, ID, testData.getTestId(), "number", number, "content", content));
+ }
+
+ public String buildVisualRegressionTagFor(final int number, final TestData testData, final byte[] referenceBytes, final byte[] regressionBytes) {
+ return buildVisualRegressionTagFor(number, testData, referenceBytes, regressionBytes, Result.builder().shown(false).build());
+ }
+
+ public String buildVisualRegressionTagFor(final int number, final TestData testData, final byte[] referenceBytes, final byte[] regressionBytes, final Result result) {
+ final Map\\s*[^\"]*)\".*?
\\s*
+
diff --git a/spectrum/src/main/resources/yaml/configuration.default.yaml b/spectrum/src/main/resources/yaml/configuration.default.yaml
index 0b5bb465b..9782e8589 100644
--- a/spectrum/src/main/resources/yaml/configuration.default.yaml
+++ b/spectrum/src/main/resources/yaml/configuration.default.yaml
@@ -33,9 +33,24 @@ runtime:
# Application under test
application:
baseUrl: http://localhost:8080 # Application's under test base url
+ screenshotsFolder: null # Path where to save screenshots. If not provided, screenshots are saved in the target folder.
highlight: # Highlight the web elements the test interacts with. Useful to visually debug the execution
js: js/highlight.js # Path to the js used to highlight. Relative to the resources folder
+# Visual Regression Testing configuration
+visualRegression:
+ failFast: false # Whether to fail immediately when the first visual regression is found, rather than running the entire test
+ snapshots: # Snapshots screenshots references configuration
+ folder: src/test/resources/visual-regression # Where to save the screenshot references
+ override: false # Whether to override the snapshots references already generated
+ frames: [ ] # Kind of frames to be considered. Empty by default
+ checks: # Checks configuration
+ count: 0 # Number of checks to perform before considering a snapshot valid
+ interval: .5 # Interval between checks in seconds
+ maxRetries: 3 # Max retries before throwing an exception
+ diff: # Screenshots diff configuration
+ noOp: { } # No diff is shown by default. Just the snapshot reference and the regression side by side
+
# TestBook (coverage)
testBook:
qualityGate:
@@ -354,6 +369,12 @@ drivers:
afterGetCssValue:
level: INFO
message: Css property
+
+
+
+ REFERENCE
+
+
+ REGRESSION
+
+ <#if shown>
+
+ DIFF
+
+
+ 
+ 
+ 
+ %2$s of element %1$s is %3$s
+ beforeGetScreenshotAs:
+ level: INFO
+ message: Getting screenshot as %2$s
+ afterGetScreenshotAs:
+ level: ERROR
+ message: Screenshot as %2$s resulted is %3$s
beforeAnyNavigationCall:
message: Calling navigation method %2$s with args %3$s
afterAnyNavigationCall:
@@ -533,15 +554,33 @@ eventsConsumers:
events:
- reason: beforeExecution
tags: [ dynamicTest ]
+ - genericScreenshot: # common operations on screenshots
+ events:
+ - primaryId: .*
+ reason: screenshot
+ - extentScreenshot: # add the screenshot to the Extent Report
+ events:
+ - primaryId: (manual)
+ reason: screenshot
- video: # add the screenshot to the video
events:
- - primaryId: screenshot
+ - primaryId: (manual|autoBefore|autoAfter)
reason: screenshot
- videoDynamic: # add the screenshot to the dynamic video
events:
- - primaryId: screenshot
+ - primaryId: (manual|autoBefore|autoAfter)
+ reason: screenshot
+ - visualRegressionCheck: # check the previously generated screenshot reference for visual regression
+ failOnError: true # to enable fail fast effectively break the test immediately
+ events:
+ - primaryId: (manual|autoBefore|autoAfter)
+ reason: screenshot
+ - visualRegressionReferenceCreator: # create the screenshot reference for visual regression
+ failOnError: true # to enable failed checks break the test immediately
+ events:
+ - primaryId: (manual|autoBefore|autoAfter)
reason: screenshot
- - extentTest: # add an entry to the Extent Report once each test is done
+ - extentTestEnd: # add an entry to the Extent Report once each test is done
events:
- reason: after
tags: [ test ]
diff --git a/spectrum/src/test/java/io/github/giulong/spectrum/MockFinal.java b/spectrum/src/test/java/io/github/giulong/spectrum/MockFinal.java
new file mode 100644
index 000000000..7ee829162
--- /dev/null
+++ b/spectrum/src/test/java/io/github/giulong/spectrum/MockFinal.java
@@ -0,0 +1,12 @@
+package io.github.giulong.spectrum;
+
+import static java.lang.annotation.ElementType.FIELD;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+@Target(FIELD)
+@Retention(RUNTIME)
+public @interface MockFinal {
+}
diff --git a/spectrum/src/test/java/io/github/giulong/spectrum/SpectrumEntityTest.java b/spectrum/src/test/java/io/github/giulong/spectrum/SpectrumEntityTest.java
index 09363ab7d..bb9822080 100644
--- a/spectrum/src/test/java/io/github/giulong/spectrum/SpectrumEntityTest.java
+++ b/spectrum/src/test/java/io/github/giulong/spectrum/SpectrumEntityTest.java
@@ -1,41 +1,39 @@
package io.github.giulong.spectrum;
-import static com.aventstack.extentreports.Status.*;
-import static io.github.giulong.spectrum.SpectrumEntity.HASH_ALGORITHM;
+import static com.aventstack.extentreports.Status.FAIL;
+import static com.aventstack.extentreports.Status.INFO;
+import static com.aventstack.extentreports.Status.WARNING;
import static io.github.giulong.spectrum.enums.Frame.MANUAL;
-import static io.github.giulong.spectrum.extensions.resolvers.DriverResolver.DRIVER;
+import static io.github.giulong.spectrum.extensions.resolvers.DriverResolver.ORIGINAL_DRIVER;
import static io.github.giulong.spectrum.extensions.resolvers.TestContextResolver.EXTENSION_CONTEXT;
-import static io.github.giulong.spectrum.utils.web_driver_events.ScreenshotConsumer.SCREENSHOT;
-import static org.junit.jupiter.api.Assertions.*;
+import static io.github.giulong.spectrum.utils.web_driver_events.VideoAutoScreenshotProducer.SCREENSHOT;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertFalse;
+import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.extension.ExtensionContext.Namespace.GLOBAL;
import static org.junit.jupiter.params.provider.Arguments.arguments;
import static org.mockito.Mockito.*;
import static org.openqa.selenium.OutputType.BYTES;
import java.io.File;
-import java.io.IOException;
import java.lang.reflect.Field;
import java.nio.file.Files;
import java.nio.file.Path;
import java.security.MessageDigest;
-import java.security.NoSuchAlgorithmException;
import java.util.List;
-import java.util.Map;
import java.util.function.Function;
import java.util.stream.Stream;
-import com.aventstack.extentreports.ExtentTest;
import com.aventstack.extentreports.MediaEntityBuilder;
import com.aventstack.extentreports.Status;
-import com.aventstack.extentreports.model.Media;
import io.github.giulong.spectrum.interfaces.Shared;
-import io.github.giulong.spectrum.types.TestData;
-import io.github.giulong.spectrum.utils.*;
+import io.github.giulong.spectrum.pojos.events.Event.Payload;
+import io.github.giulong.spectrum.utils.Configuration;
+import io.github.giulong.spectrum.utils.FileUtils;
+import io.github.giulong.spectrum.utils.Reflections;
+import io.github.giulong.spectrum.utils.TestContext;
import io.github.giulong.spectrum.utils.events.EventsDispatcher;
-import io.github.giulong.spectrum.utils.video.Video;
-
-import lombok.SneakyThrows;
import org.junit.jupiter.api.AfterEach;
import org.junit.jupiter.api.BeforeEach;
@@ -47,7 +45,10 @@
import org.junit.jupiter.params.provider.MethodSource;
import org.junit.jupiter.params.provider.ValueSource;
import org.mockito.*;
-import org.openqa.selenium.*;
+import org.openqa.selenium.By;
+import org.openqa.selenium.TakesScreenshot;
+import org.openqa.selenium.WebDriver;
+import org.openqa.selenium.WebElement;
import org.openqa.selenium.interactions.Actions;
import org.openqa.selenium.support.ui.WebDriverWait;
@@ -58,32 +59,19 @@ class SpectrumEntityTest {
private MockedStatic