Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
.idea
.editorconfig
.cursor
.claude/

# npm
node_modules
Expand Down
1 change: 1 addition & 0 deletions src/pages/adp-site-metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{"total":3,"offset":0,"limit":3,"data":[{"key":"contributors","value":"src/pages/contributors.json"},{"key":"get-credentials","value":null},{"key":"site-wide-banner","value":null}],":type":"sheet"}
1 change: 1 addition & 0 deletions src/pages/contributors.json

Large diffs are not rendered by default.

48 changes: 24 additions & 24 deletions src/pages/functional-testing-framework/data.md
Original file line number Diff line number Diff line change
Expand Up @@ -246,22 +246,22 @@ You can also call data from the XML definition of a `data` tag directly:

`<entity>` is an element that contains `<data>` elements.

Attributes|Type|Use|Description
---|---|---|---
`name`|string|optional|Name of the `<entity>`. Use camel case for entity names.
`type`|string|optional|Node containing the exact name of `<entity>` type. Used later to find specific Persistence Layer Model class. `type` in `<data>` can be whatever the user wants; There are no constraints. It is important when persisting data, depending on the `type` given, as it will try to match a metadata definition with the operation being done. Example: A `myCustomer` entity with `type="customer"`, calling `<createData entity="myCustomer"/>`, will try to find a metadata entry with the following attributes: `<operation dataType="customer" type="create">`.
`deprecated`|string|optional|Used to warn about the future deprecation of the data entity. String will appear in Allure reports and console output at runtime.
| Attributes|Type|Use|Description |
| ---|---|---|--- |
| `name`|string|optional|Name of the `<entity>`. Use camel case for entity names. |
| `type`|string|optional|Node containing the exact name of `<entity>` type. Used later to find specific Persistence Layer Model class. `type` in `<data>` can be whatever the user wants; There are no constraints. It is important when persisting data, depending on the `type` given, as it will try to match a metadata definition with the operation being done. Example: A `myCustomer` entity with `type="customer"`, calling `<createData entity="myCustomer"/>`, will try to find a metadata entry with the following attributes: `<operation dataType="customer" type="create">`. |
| `deprecated`|string|optional|Used to warn about the future deprecation of the data entity. String will appear in Allure reports and console output at runtime. |

`<entity>` may contain one or more [`<data>`][], [`<var>`][], [`<required-entities>`][], or [`<array>`][] elements in any sequence.

### data

`<data>` is an element containing a data/value pair.

Attributes|Type|Use|Description
---|---|---|---
`key`|string|optional|Key attribute of data/value pair.
`unique`|enum: `"prefix"`, `"suffix"`|optional|Add suite or test wide unique sequence as "prefix" or "suffix" to the data value if specified.
| Attributes|Type|Use|Description |
| ---|---|---|--- |
| `key`|string|optional|Key attribute of data/value pair. |
| `unique`|enum: `"prefix"`, `"suffix"`|optional|Add suite or test wide unique sequence as "prefix" or "suffix" to the data value if specified. |

Example:

Expand All @@ -273,12 +273,12 @@ Example:

`<var>` is an element that can be used to grab a key-value from another entity. For example, when creating a customer with the `<createData>` action, the server responds with the auto-incremented ID of that customer. Use `<var>` to access that ID and use it in another data entity.

Attributes|Type|Use|Description
---|---|---|---
`key`|string|optional|Key attribute of this entity to assign a value to.
`entityType`|string|optional|Type attribute of referenced entity.
`entityKey`|string|optional|Key attribute of the referenced entity from which to get a value.
`unique`|--|--|_This attribute hasn't been implemented yet._
| Attributes|Type|Use|Description |
| ---|---|---|--- |
| `key`|string|optional|Key attribute of this entity to assign a value to. |
| `entityType`|string|optional|Type attribute of referenced entity. |
| `entityKey`|string|optional|Key attribute of the referenced entity from which to get a value. |
| `unique`|--|--|_This attribute hasn't been implemented yet._ |

Example:

Expand All @@ -300,9 +300,9 @@ Example: You have customer address info. To specify that relationship:
</entity>
```

Attributes|Type|Use|Description
---|---|---|---
`type`|string|optional|Type attribute of `<requiredEntity>`.
| Attributes|Type|Use|Description |
| ---|---|---|--- |
| `type`|string|optional|Type attribute of `<requiredEntity>`. |

### array

Expand All @@ -321,19 +321,19 @@ Example:
</entity>
```

Attributes|Type|Use|Description
---|---|---|---
`key`|string|required|Key attribute of this entity in which to assign a value.
| Attributes|Type|Use|Description |
| ---|---|---|--- |
| `key`|string|required|Key attribute of this entity in which to assign a value. |

`<array>` may contain [`<item>`][] elements.

### item

`<item>` is an individual piece of data to be passed in as part of the parent `<array>` type.

Attributes|Type|Use|Description
---|---|---|---
`name`|string|optional|Key attribute of `<item/>` entity in which to assign a value. By default numeric key will be generated.
| Attributes|Type|Use|Description |
| ---|---|---|--- |
| `name`|string|optional|Key attribute of `<item/>` entity in which to assign a value. By default numeric key will be generated. |

[`<array>`]: #array
[`<data>`]: #data
Expand Down
2 changes: 1 addition & 1 deletion src/pages/functional-testing-framework/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -366,5 +366,5 @@ allure serve dev/tests/acceptance/tests/_output/allure-results/
[Set up a standalone MFTF]: #set-up-a-standalone-mftf
[Find your version]: index.md#find-your-framework-version
[Installation Guide docroot]: https://experienceleague.adobe.com/en/docs/commerce-operations/installation-guide/tutorials/docroot
[two-factor authentication (2FA) extension]: https://developer.adobe.com/commerce/testing/functional-testing-framework/two-factor-authentication/
[two-factor authentication (2FA) extension]: two-factor-authentication.md
[Credentials Page]: credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -86,4 +86,4 @@ If you are a contributing developer with an understanding of Git and Composer co
[Composer based Installation]: https://experienceleague.adobe.com/en/docs/commerce-operations/installation-guide/composer
[GitHub Installation]: https://developer.adobe.com/commerce/contributor/guides/install/clone-repository
[Standalone]: getting-started.md#set-up-a-standalone-mftf
[composer package]: https://developer.adobe.com/commerce/php/development/package/component/
[composer package]: https://developer.adobe.com/commerce/php/development/package/component
26 changes: 13 additions & 13 deletions src/pages/functional-testing-framework/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -141,15 +141,15 @@ It contains only one `<page>` element.

`<page>` contains a sequence of UI sections in a page.

Attributes|Type|Use|Description
---|---|---|---
`name`|string|required|Unique page name identifier.
`url`|string|required|URL path (excluding the base URL) for the page. Use parameterized notation (`{{var1}}`) for replaceable parameters, such as the edit page for a persisted entity that is based on an ID or a name.
`module`|string|required|Name of the module to which the page belongs. The name must be prefixed with a vendor name. It corresponds to the parent directory where the module with tests is stored. Example: `"Magento_Catalog"`.
`area`|string|required|The area where this page lives. Three possible values: `admin` prepends `BACKEND_NAME` to `url`, `storefront` does not prepend anything to `url`, `external` flags the page for use with `amOnUrl`. The `url` provided must be a full URL, such as `http://myFullUrl.com/`, instead of the URL for a page.
`parameterized`|boolean |optional|Include and set to `"true"` if the `url` for this page has parameters that need to be replaced for proper use.
`remove`|boolean|optional|The default value is `"false"`. Set to `"true"` to remove this element during parsing.
`deprecated`|string|optional|Used to warn about the future deprecation of the data entity. String will appear in Allure reports and console output at runtime.
| Attributes|Type|Use|Description |
| ---|---|---|--- |
| `name`|string|required|Unique page name identifier. |
| `url`|string|required|URL path (excluding the base URL) for the page. Use parameterized notation (`{{var1}}`) for replaceable parameters, such as the edit page for a persisted entity that is based on an ID or a name. |
| `module`|string|required|Name of the module to which the page belongs. The name must be prefixed with a vendor name. It corresponds to the parent directory where the module with tests is stored. Example: `"Magento_Catalog"`. |
| `area`|string|required|The area where this page lives. Three possible values: `admin` prepends `BACKEND_NAME` to `url`, `storefront` does not prepend anything to `url`, `external` flags the page for use with `amOnUrl`. The `url` provided must be a full URL, such as `http://myFullUrl.com/`, instead of the URL for a page. |
| `parameterized`|boolean |optional|Include and set to `"true"` if the `url` for this page has parameters that need to be replaced for proper use. |
| `remove`|boolean|optional|The default value is `"false"`. Set to `"true"` to remove this element during parsing. |
| `deprecated`|string|optional|Used to warn about the future deprecation of the data entity. String will appear in Allure reports and console output at runtime. |

`<page>` may contain several [`<section>`](#section) elements.

Expand All @@ -158,10 +158,10 @@ Attributes|Type|Use|Description
`<section>` contains the sequence of UI elements.
A section is a reusable piece or part of a page.

Attributes|Type|Use|Description
---|---|---|---
`name`|string|required|Unique section name identifier.
`remove`|boolean|optional|The default value is `"false"`. Set to `"true"` to remove this element during parsing.
| Attributes|Type|Use|Description |
| ---|---|---|--- |
| `name`|string|required|Unique section name identifier. |
| `remove`|boolean|optional|The default value is `"false"`. Set to `"true"` to remove this element during parsing. |

[`<createData>`]: test/actions.md#createdata
[`<test>`]: test/index.md
Expand Down
30 changes: 15 additions & 15 deletions src/pages/functional-testing-framework/section/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,26 +91,26 @@ The following is an example of a call in test:

`<section>` contains the sequence of UI elements in a section of a [page][].

Attributes|Type|Use|Description
---|---|---|---
`name`|string|required|Unique section name identifier.
`deprecated`|string|optional|Used to warn about the future deprecation of the section. String will appear in Allure reports and console output at runtime.
`remove`|boolean|optional|The default is `false`. Set to `true` to remove this element during parsing.
| Attributes|Type|Use|Description |
| ---|---|---|--- |
| `name`|string|required|Unique section name identifier. |
| `deprecated`|string|optional|Used to warn about the future deprecation of the section. String will appear in Allure reports and console output at runtime. |
| `remove`|boolean|optional|The default is `false`. Set to `true` to remove this element during parsing. |

### element

`<element>`is a UI element used in an [action][].

Attributes|Type|Use|Description
---|---|---|---
`name`|string|required|The element name; Must be alphanumeric.
`type`|string|required|The type of the element. Possible values: `text`, `textarea`, `input`, `button`, `checkbox`, `radio`, `checkboxset`, `radioset`, `date`, `file`, `select`, `multiselect`, `wysiwyg`, `iframe`, `block`.
`selector`|string|optional|[XPath][] or [CSS][] selector of the element.
`locatorFunction`|string|optional|[Locator function][] declaration to be used in lieu of a selector.
`timeout`|string|optional|The timeout after interaction with the element (in seconds). The default is _none_.
`parameterized`|boolean|optional|Include and set to `true` if the `selector` for this element has parameters that need to be replaced for proper use. Learn more in [Parameterized selectors][].
`deprecated`|string|optional|Used to warn about the future deprecation of the element. String will appear in Allure reports and console output at runtime.
`remove`|boolean|optional|The default is `false`. Set to `true` to remove this element during parsing.
| Attributes|Type|Use|Description |
| ---|---|---|--- |
| `name`|string|required|The element name; Must be alphanumeric. |
| `type`|string|required|The type of the element. Possible values: `text`, `textarea`, `input`, `button`, `checkbox`, `radio`, `checkboxset`, `radioset`, `date`, `file`, `select`, `multiselect`, `wysiwyg`, `iframe`, `block`. |
| `selector`|string|optional|[XPath][] or [CSS][] selector of the element. |
| `locatorFunction`|string|optional|[Locator function][] declaration to be used in lieu of a selector. |
| `timeout`|string|optional|The timeout after interaction with the element (in seconds). The default is _none_. |
| `parameterized`|boolean|optional|Include and set to `true` if the `selector` for this element has parameters that need to be replaced for proper use. Learn more in [Parameterized selectors][]. |
| `deprecated`|string|optional|Used to warn about the future deprecation of the element. String will appear in Allure reports and console output at runtime. |
| `remove`|boolean|optional|The default is `false`. Set to `true` to remove this element during parsing. |

#### `timeout` attribute

Expand Down
34 changes: 17 additions & 17 deletions src/pages/functional-testing-framework/suite.md
Original file line number Diff line number Diff line change
Expand Up @@ -208,10 +208,10 @@ The root element for suites.

A set of "before" and "after" preconditions, and test filters to include and exclude tests in the scope of suite.

Attributes|Type|Use|Description
---|---|---|---
`name`|string|required|Unique suite name identifier.
`remove`|boolean|optional|Removing the suite during merging.
| Attributes|Type|Use|Description |
| ---|---|---|--- |
| `name`|string|required|Unique suite name identifier. |
| `remove`|boolean|optional|Removing the suite during merging. |

It can contain `<before>`, `<after>`, `<include>`, and `<exclude>`.

Expand Down Expand Up @@ -266,22 +266,22 @@ The element may contain [`<test>`](#test), [`<group>`](#group), and [`<module>`]

### test

Attributes|Type|Use|Description
---|---|---|---
`name`|string|required|Filtering a test by its name.
`remove`|boolean|optional|Removing the filter during merging.
| Attributes|Type|Use|Description |
| ---|---|---|--- |
| `name`|string|required|Filtering a test by its name. |
| `remove`|boolean|optional|Removing the filter during merging. |

### group

Attributes|Type|Use|Description
---|---|---|---
`name`|string|required|Filtering tests by the `<group>` annotation.
`remove`|boolean|optional|Removing the filter during merging.
| Attributes|Type|Use|Description |
| ---|---|---|--- |
| `name`|string|required|Filtering tests by the `<group>` annotation. |
| `remove`|boolean|optional|Removing the filter during merging. |

### module

Attributes|Type|Use|Description
---|---|---|---
`name`|string|required|Filtering tests by their location in the corresponding module.
`file`|string|optional|Filtering a specific test file in the module.
`remove`|boolean|optional|Removing the filter during merging.
| Attributes|Type|Use|Description |
| ---|---|---|--- |
| `name`|string|required|Filtering tests by their location in the corresponding module. |
| `file`|string|optional|Filtering a specific test file in the module. |
| `remove`|boolean|optional|Removing the filter during merging. |
Loading
Loading