Skip to content

Commit 8e42fda

Browse files
authored
Mqe 2215: Docs Annual Review Part 2 (magento#760)
* MQE-2215: Docs Annual Review * MQE-2215: Docs Annual Review
1 parent c275806 commit 8e42fda

File tree

6 files changed

+24
-25
lines changed

6 files changed

+24
-25
lines changed

docs/merge_points/extend-action-groups.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ In this example we add a `<click>` command to check the checkbox that our extens
99
<!-- {% raw %} -->
1010

1111
```xml
12-
<actionGroup name="FillAdminSimpleProductForm">
12+
<actionGroup name="AdminFillSimpleProductFormActionGroup">
1313
<arguments>
1414
<argument name="category"/>
1515
<argument name="simpleProduct"/>
@@ -34,10 +34,10 @@ In this example we add a `<click>` command to check the checkbox that our extens
3434
</actionGroup>
3535
```
3636

37-
## File to merge
37+
## Extend file
3838

3939
```xml
40-
<actionGroup name="FillAdminSimpleProductFormWithMyExtension" extends="FillAdminSimpleProductForm">
40+
<actionGroup name="AdminFillSimpleProductFormWithMyExtensionActionGroup" extends="AdminFillSimpleProductFormActionGroup">
4141
<!-- This will be added after the step "fillQuantity" on line 12 in the above test. -->
4242
<click selector="{{MyExtensionSection.myCheckbox}}" stepKey="clickMyCheckbox" after="fillQuantity"/>
4343
</actionGroup>
@@ -48,7 +48,7 @@ In this example we add a `<click>` command to check the checkbox that our extens
4848
Note that there are now two action groups below.
4949

5050
```xml
51-
<actionGroup name="FillAdminSimpleProductForm">
51+
<actionGroup name="AdminFillSimpleProductFormActionGroup">
5252
<arguments>
5353
<argument name="category"/>
5454
<argument name="simpleProduct"/>
@@ -71,7 +71,7 @@ Note that there are now two action groups below.
7171
<click selector="{{AdminProductSEOSection.sectionHeader}}" stepKey="openSeoSectionAssert"/>
7272
<seeInField userInput="{{simpleProduct.urlKey}}" selector="{{AdminProductSEOSection.urlKeyInput}}" stepKey="assertFieldUrlKey"/>
7373
</actionGroup>
74-
<actionGroup name="FillAdminSimpleProductFormWithMyExtension">
74+
<actionGroup name="AdminFillSimpleProductFormWithMyExtensionActionGroup">
7575
<arguments>
7676
<argument name="category"/>
7777
<argument name="simpleProduct"/>

docs/merge_points/extend-data.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ In this example we update the quantity to 1001 and add a new piece of data relev
2323
</entity>
2424
```
2525

26-
## File to merge
26+
## Extend file
2727

2828
```xml
2929
<entity name="ExtensionProduct" type="product" extends="SimpleProduct">

docs/merge_points/extend-tests.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ In this example, we add an action group to a new copy of the original test for o
2525
<deleteData createDataKey="createPreReqCategory" stepKey="deletePreReqCategory"/>
2626
</after>
2727

28-
<actionGroup ref="LoginAsAdmin" stepKey="loginAsAdmin1"/>
29-
<actionGroup ref="FillAdminSimpleProductForm" stepKey="fillProductFieldsInAdmin">
28+
<actionGroup ref="AdminLoginActionGroup" stepKey="AdminLoginActionGroup1"/>
29+
<actionGroup ref="AdminFillSimpleProductFormActionGroup" stepKey="fillProductFieldsInAdmin">
3030
<argument name="category" value="$$createPreReqCategory$$"/>
3131
<argument name="simpleProduct" value="_defaultProduct"/>
3232
</actionGroup>
@@ -40,7 +40,7 @@ In this example, we add an action group to a new copy of the original test for o
4040
</test>
4141
```
4242

43-
## File to merge
43+
## Extend file
4444

4545
```xml
4646
<test name="AdminCreateSimpleProductExtensionTest" extends="AdminCreateSimpleProductTest">
@@ -89,8 +89,8 @@ Note that there are now two tests below.
8989
<deleteData createDataKey="createPreReqCategory" stepKey="deletePreReqCategory"/>
9090
</after>
9191

92-
<actionGroup ref="LoginAsAdmin" stepKey="loginAsAdmin1"/>
93-
<actionGroup ref="FillAdminSimpleProductForm" stepKey="fillProductFieldsInAdmin">
92+
<actionGroup ref="AdminLoginActionGroup" stepKey="AdminLoginActionGroup1"/>
93+
<actionGroup ref="AdminFillSimpleProductFormActionGroup" stepKey="fillProductFieldsInAdmin">
9494
<argument name="category" value="$$createPreReqCategory$$"/>
9595
<argument name="simpleProduct" value="_defaultProduct"/>
9696
</actionGroup>
@@ -120,8 +120,8 @@ Note that there are now two tests below.
120120
<deleteData createDataKey="createPreReqCategory" stepKey="deletePreReqCategory"/>
121121
</after>
122122

123-
<actionGroup ref="LoginAsAdmin" stepKey="loginAsAdmin1"/>
124-
<actionGroup ref="FillAdminSimpleProductForm" stepKey="fillProductFieldsInAdmin">
123+
<actionGroup ref="AdminLoginActionGroup" stepKey="AdminLoginActionGroup1"/>
124+
<actionGroup ref="AdminFillSimpleProductFormActionGroup" stepKey="fillProductFieldsInAdmin">
125125
<argument name="category" value="$$createPreReqCategory$$"/>
126126
<argument name="simpleProduct" value="_defaultProduct"/>
127127
</actionGroup>

docs/merge_points/merge-action-groups.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Merge action groups
22

33
An action group is a set of individual actions working together as a group.
4-
These action groups can be shared between tests and they also be modified to your needs.
4+
These action groups can be shared between tests and they also can be modified to your needs.
55

66
In this example we add a `<click>` command to check the checkbox that our extension adds to the simple product creation form.
77

@@ -10,7 +10,7 @@ In this example we add a `<click>` command to check the checkbox that our extens
1010
<!-- {% raw %} -->
1111

1212
```xml
13-
<actionGroup name="FillAdminSimpleProductForm">
13+
<actionGroup name="AdminFillSimpleProductFormActionGroup">
1414
<arguments>
1515
<argument name="category"/>
1616
<argument name="simpleProduct"/>
@@ -38,7 +38,7 @@ In this example we add a `<click>` command to check the checkbox that our extens
3838
## File to merge
3939

4040
```xml
41-
<actionGroup name="FillAdminSimpleProductForm">
41+
<actionGroup name="AdminFillSimpleProductFormActionGroup">
4242
<!-- This will be added after the step "fillQuantity" in the above test. -->
4343
<click selector="{{MyExtensionSection.myCheckbox}}" stepKey="clickMyCheckbox" after="fillQuantity"/>
4444
</actionGroup>
@@ -47,7 +47,7 @@ In this example we add a `<click>` command to check the checkbox that our extens
4747
## Resultant test
4848

4949
```xml
50-
<actionGroup name="FillAdminSimpleProductForm">
50+
<actionGroup name="AdminFillSimpleProductFormActionGroup">
5151
<arguments>
5252
<argument name="category"/>
5353
<argument name="simpleProduct"/>

docs/merge_points/merge-sections.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ In this example we add another selector to the section on the products page sect
99
<!-- {% raw %} -->
1010

1111
```xml
12-
<section name="ProductsPageSection">
12+
<section name="AdminProductsPageSection">
1313
<element name="addProductButton" type="button" selector="//button[@id='add_new_product-button']"/>
1414
<element name="checkboxForProduct" type="button" selector="//*[contains(text(),'{{args}}')]/parent::td/preceding-sibling::td/label[@class='data-grid-checkbox-cell-inner']" parameterized="true"/>
1515
<element name="actions" type="button" selector="//div[@class='col-xs-2']/div[@class='action-select-wrap']/button[@class='action-select']"/>
@@ -22,7 +22,7 @@ In this example we add another selector to the section on the products page sect
2222
## File to merge
2323

2424
```xml
25-
<section name="ProductsPageSection">
25+
<section name="AdminProductsPageSection">
2626
<!-- myExtensionElement will simply be added to the page -->
2727
<element name="myExtensionElement" type="button" selector="input.myExtension"/>
2828
</section>
@@ -31,7 +31,7 @@ In this example we add another selector to the section on the products page sect
3131
## Resultant section
3232

3333
```xml
34-
<section name="ProductsPageSection">
34+
<section name="AdminProductsPageSection">
3535
<element name="addProductButton" type="button" selector="//button[@id='add_new_product-button']"/>
3636
<element name="checkboxForProduct" type="button" selector="//*[contains(text(),'{{args}}')]/parent::td/preceding-sibling::td/label[@class='data-grid-checkbox-cell-inner']" parameterized="true"/>
3737
<element name="actions" type="button" selector="//div[@class='col-xs-2']/div[@class='action-select-wrap']/button[@class='action-select']"/>
@@ -41,7 +41,6 @@ In this example we add another selector to the section on the products page sect
4141
<!-- New element merged -->
4242
<element name="myExtensionElement" type="button" selector="input.myExtension"/>
4343
</section>
44-
</page>
4544
```
4645

4746
<!-- {% endraw %} -->

docs/merge_points/merge-tests.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -25,8 +25,8 @@ In this example we add an action group that modifies the original test to intera
2525
<deleteData createDataKey="createPreReqCategory" stepKey="deletePreReqCategory"/>
2626
</after>
2727

28-
<actionGroup ref="LoginAsAdmin" stepKey="loginAsAdmin1"/>
29-
<actionGroup ref="FillAdminSimpleProductForm" stepKey="fillProductFieldsInAdmin">
28+
<actionGroup ref="AdminLoginActionGroup" stepKey="adminLoginActionGroup1"/>
29+
<actionGroup ref="AdminFillSimpleProductFormActionGroup" stepKey="fillProductFieldsInAdmin">
3030
<argument name="category" value="$$createPreReqCategory$$"/>
3131
<argument name="simpleProduct" value="_defaultProduct"/>
3232
</actionGroup>
@@ -77,8 +77,8 @@ In this example we add an action group that modifies the original test to intera
7777
<deleteData createDataKey="createPreReqCategory" stepKey="deletePreReqCategory"/>
7878
</after>
7979

80-
<actionGroup ref="LoginAsAdmin" stepKey="loginAsAdmin1"/>
81-
<actionGroup ref="FillAdminSimpleProductForm" stepKey="fillProductFieldsInAdmin">
80+
<actionGroup ref="AdminLoginActionGroup" stepKey="AdminLoginActionGroup1"/>
81+
<actionGroup ref="AdminFillSimpleProductFormActionGroup" stepKey="fillProductFieldsInAdmin">
8282
<argument name="category" value="$$createPreReqCategory$$"/>
8383
<argument name="simpleProduct" value="_defaultProduct"/>
8484
</actionGroup>

0 commit comments

Comments
 (0)