Skip to content

MQE-1639: [DEVDOCS] Best Practices for including HTML Source in Tests #390

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

Merged
merged 7 commits into from
Jul 24, 2019
Merged

MQE-1639: [DEVDOCS] Best Practices for including HTML Source in Tests #390

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b8b4d25
MQE-1639: [DEVDOCS] Best Practices for including HTML Source in Tests
tomreece Jul 23, 2019
7925287
Small edits.
dobooth Jul 23, 2019
da75a64
MQE-1639: [DEVDOCS] Best Practices for including HTML Source in Tests
tomreece Jul 24, 2019
3b9c9b5
Merge branch 'develop' into MQE-1639
ivy00johns Jul 24, 2019
0c6bd9a
MQE-1639: [DEVDOCS] Best Practices for including HTML Source in Tests…
tomreece Jul 24, 2019
8dbe359
Merge branch 'MQE-1639' of https://github.com/magento/magento2-functi…
tomreece Jul 24, 2019
afeef28
Merge branch 'develop' into MQE-1639
tomreece Jul 24, 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
42 changes: 30 additions & 12 deletions docs/test/actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,18 @@ The following test actions handle data entities using [metadata](../metadata.md)

Learn more in [Handling a REST API response](../metadata.md#rest-response).

## Actions specifying HTML values

To use HTML in actions you must encode the HTML string. We recommend using [CyberChef](https://gchq.github.io/CyberChef/#recipe=To_HTML_Entity(false,'Numeric%20entities')). Using CyberChef or a similar tool is straightforward: enter in your HTML string, copy the encoded result, and paste that value into your MFTF test.

For example, we want to ensure that this value is presented as a string and not rendered as a H1 tag: `<h1 class="login-header">`

After passing `<h1 class="login-header">` through CyberChef we get `&#60;h1 class&#61;&#34;login-header&#34;&#62;` which can be used in a test like:

```xml
<dontSeeInSource html="&#60;h1 class&#61;&#34;login-header&#34;&#62;" stepKey="dontSeeInSource"/>
```

## Reference

The following list contains reference documentation about all action elements available in the MFTF.
Expand Down Expand Up @@ -849,7 +861,7 @@ See [dontSeeInPageSource docs on codeception.com](http://codeception.com/docs/mo

Attribute|Type|Use|Description
---|---|---|---
`userInput`|string|optional| Value for the form field.
`html`|string|required| HTML code to be searched for within the page source. The value must be entity-encoded. See example.
`stepKey`|string|required| A unique identifier of the action.
`skipReadiness`|boolean|optional| A flag to skip the readiness check.
`before`|string|optional| `stepKey` of action that must be executed next.
Expand All @@ -858,8 +870,8 @@ Attribute|Type|Use|Description
#### Example

```xml
<!-- Verify that the page source does not contain the string "Sample text". -->
<dontSeeInPageSource userInput="Sample text" stepKey="dontSeeInPageSource"/>
<!-- Verify that the page source does not contain the raw source code `<h1 class="login-header">`. -->
<dontSeeInPageSource userInput="&#60;h1 class&#61;&#34;login-header&#34;&#62;" stepKey="dontSeeInPageSource"/>
```

### dontSeeInSource
Expand All @@ -868,17 +880,19 @@ See [dontSeeInSource docs on codeception.com](http://codeception.com/docs/module

Attribute|Type|Use|Description
---|---|---|---
`html`|string|optional| HTML code to search for within the source code.
`html`|string|required| HTML code to be searched for within the page source. The value must be entity-encoded. See example.
`stepKey`|string|required| A unique identifier of the action.
`skipReadiness`|boolean|optional| A flag to skip the readiness check.
`before`|string|optional| `stepKey` of action that must be executed next.
`after`|string|optional| `stepKey` of preceding action.

#### Example

You must encode the `html` using a tool such as [CyberChef](https://gchq.github.io/CyberChef/#recipe=To_HTML_Entity(false,'Numeric%20entities')).

```xml
<!-- Verify that the page does not contain the raw source code `<h1>Sample text</h1>`. -->
<dontSeeInSource userInput="<h1>Sample text</h1>" stepKey="dontSeeInSource"/>
<!-- Verify that the page source does not contain the raw source code `<h1 class="login-header">`. -->
<dontSeeInSource html="&#60;h1 class&#61;&#34;login-header&#34;&#62;" stepKey="dontSeeInSource"/>
```

### dontSeeInTitle
Expand Down Expand Up @@ -1922,17 +1936,19 @@ See [seeInPageSource docs on codeception.com](http://codeception.com/docs/module

Attribute|Type|Use|Description
---|---|---|---
`html`|string|optional| HTML code to be searched for within the document.
`html`|string|required| HTML code to be searched for within the page source. The value must be entity-encoded. See example.
`stepKey`|string|required| A unique identifier of the action.
`skipReadiness`|boolean|optional| A flag to skip the readiness check.
`before`|string|optional| `stepKey` of action that must be executed next.
`after`|string|optional| `stepKey` of preceding action.

#### Example

You must encode the `html` using a tool such as [CyberChef](https://gchq.github.io/CyberChef/#recipe=To_HTML_Entity(false,'Numeric%20entities')).

```xml
<!-- Verify that the page source contains the string "Sample text". -->
<seeInPageSource userInput="Sample text" stepKey="seeInPageSource"/>
<!-- Verify that the page source contains the raw source code `<h1 class="login-header">`. -->
<seeInPageSource html="&#60;h1 class&#61;&#34;login-header&#34;&#62;" stepKey="seeInPageSource"/>
```

### seeInPopup
Expand Down Expand Up @@ -1960,17 +1976,19 @@ See [seeInSource docs on codeception.com](http://codeception.com/docs/modules/We

Attribute|Type|Use|Description
---|---|---|---
`html`|string|optional| HTML code to be searched for within the page source.
`html`|string|required| HTML code to be searched for within the page source. The value must be entity-encoded. See example.
`stepKey`|string|required| A unique identifier of the action.
`skipReadiness`|boolean|optional| A flag to skip the readiness check.
`before`|string|optional| `stepKey` of action that must be executed next.
`after`|string|optional| `stepKey` of preceding action.

#### Example

You must encode the `html` using a tool such as [CyberChef](https://gchq.github.io/CyberChef/#recipe=To_HTML_Entity(false,'Numeric%20entities')).

```xml
<!-- Verify that the page does contains the raw source code `<h1>Sample text</h1>`. -->
<seeInSource userInput="<h1>Sample text</h1>" stepKey="seeInSource"/>
<!-- Verify that the page source contains the raw source code `<h1 class="login-header">`. -->
<seeInSource html="&#60;h1 class&#61;&#34;login-header&#34;&#62;" stepKey="seeInSource"/>
```

### seeInTitle
Expand Down