Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

Commit 57fef8b

Browse files
authored
Merge pull request #4869 from tomreece/MQE-1609
MQE-1609: Add more MFTF technical guidelines to devdocs
2 parents 46b6c68 + 2f8fb3f commit 57fef8b

File tree

1 file changed

+25
-1
lines changed

1 file changed

+25
-1
lines changed

guides/v2.2/coding-standards/technical-guidelines.md

Lines changed: 25 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -745,9 +745,33 @@ You need to read configuration from different sources (like database or filesyst
745745

746746
11.3.2.3. There MUST be only one `<section>` entity per file.
747747

748+
#### 11.3.3. Elements
749+
750+
11.3.3.1. All element selectors MUST follow these [best practices](https://devdocs.magento.com/mftf/docs/best-practices.html).
751+
752+
11.3.3.2. The element `name` MUST be unique within the `<section>`.
753+
754+
11.3.3.3. The element `name` SHOULD be written in [camelCase](http://wiki.c2.com/?CamelCase).
755+
756+
11.3.3.4. Parameterized selectors MUST use descriptive names for their parameters.
757+
758+
11.3.3.5. Elements SHOULD use the `timeout` attribute to wait after interactions.
759+
760+
#### 11.3.4. Data Entities
761+
762+
11.3.4.1. Data entity file names MUST follow this pattern:
763+
764+
* {Type}Data.xml, where {Type} describes the type of entities.
765+
* Use [PascalCase](http://wiki.c2.com/?PascalCase).
766+
* Examples: ProductData.xml or CustomerData.xml
767+
768+
11.3.4.2. Data entities SHOULD make use of `unique="suffix"` or `unique="prefix"` to ensure that tests using the entity can be repeatedly ran against the same environment.
769+
770+
11.3.4.3. Changes to existing data entities MUST be compatible with existing tests.
771+
748772
## 12. Web API
749773

750-
12.1. Both REST and SOAP API's MUST be exposed.
774+
12.1. Both REST and SOAP APIs MUST be exposed.
751775

752776
12.2. All [Web API](https://glossary.magento.com/web-api) GET endpoints MUST return lists of entities.
753777

0 commit comments

Comments
 (0)