Skip to content

annual-docs to master #769

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.

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 39 commits into from
Jul 28, 2020
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
39 commits
Select commit Hold shift + click to select a range
8b39c15
Data entity document improvement
ajithkumar-maragathavel Apr 29, 2020
c0423df
Minor changes in the document
ajithkumar-maragathavel May 12, 2020
657aabb
Grammar and formatting
dobooth May 19, 2020
6bf46e5
Remove refs to Test Migration repo
Jul 8, 2020
a37ebc4
Remove refs to Test Migration repo
Jul 8, 2020
713ffdd
Merge branch 'db_remove_banner' of github.com:magento/magento2-functi…
Jul 8, 2020
b195677
MQE-2214: Part 1 Docs Annual Review
tomreece Jul 13, 2020
50185d1
Merge branch 'master' into db_remove_banner
dobooth Jul 15, 2020
20498b7
MQE-2214: Part 1 Docs Annual Review
tomreece Jul 16, 2020
6917199
MQE-2214: Part 1 Docs Annual Review
tomreece Jul 16, 2020
c275806
Merge pull request #756 from magento/MQE-2214
tomreece Jul 17, 2020
8e42fda
Mqe 2215: Docs Annual Review Part 2 (#760)
jilu1 Jul 20, 2020
ddf5564
MQE-2216: Annual Docs Review Part 3 (#761)
soumyau Jul 21, 2020
ee10e68
Add raw tag to prevent build errors.
dobooth Jul 22, 2020
7b57266
MQE-2218: Part 5 Docs Annual Review (#764)
soumyau Jul 22, 2020
a9b6bbe
MQE-1776: CICD System Documentation
KevinBKozan Oct 11, 2019
4e94af4
Editorial pass
dobooth Oct 29, 2019
66ff24d
Fixed links
dobooth Oct 29, 2019
87f246a
MQE-2223: Part 7 Docs Review "MFTF Ease Of Use" PR #483
soumyau Jul 23, 2020
cf297c4
Grammar and formatting
dobooth Jul 23, 2020
eda8252
ME-2217: Part 4 Docs Annual Review (#763)
soumyau Jul 24, 2020
7a21f39
MQE-2219: Part 6 Docs Annual Review (#767)
soumyau Jul 24, 2020
0f64e29
Merge pull request #693 from ajithkumar-maragathavel/data-entity-impr…
dobooth Jul 24, 2020
a1d1598
Merge branch 'annual-docs' into db_remove_banner
dobooth Jul 24, 2020
5f5eddf
Merge pull request #751 from magento/db_remove_banner
dobooth Jul 24, 2020
f16e06c
Merge pull request #766 from magento/dobooth-patch-1
dobooth Jul 24, 2020
bd46a50
Remove accidental v2 directory
tomreece Jul 24, 2020
8e69653
Merge pull request #768 from magento/MQE-2223
tomreece Jul 24, 2020
995a88c
Replace broken devhub.io/zh paths with github.com paths
sta1r Jul 8, 2020
977b1ef
Make intro text clearer and more accurate
sta1r Jul 8, 2020
8263ade
Fix order (Blocker is the most severe)
sta1r Jul 8, 2020
b871ae5
Add usage guidelines table outlining the difference between levels
sta1r Jul 8, 2020
50249bc
Trim text
sta1r Jul 8, 2020
27dd329
command added to modifiy the web server rewrites config
ajithkumar-maragathavel Apr 19, 2020
a1e8179
Grammar
dobooth Apr 24, 2020
ebd9a94
Link fix
Jul 24, 2020
f7e3426
Remove accidental v2 folder
tomreece Jul 24, 2020
332da12
Remove stray file.
Jul 24, 2020
04e128b
Merge branch 'annual-docs' of github.com:magento/magento2-functional-…
Jul 24, 2020
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
Prev Previous commit
Next Next commit
MQE-2214: Part 1 Docs Annual Review
  • Loading branch information
tomreece committed Jul 16, 2020
commit 20498b78f406ecd06ab18f9293f945008080064d
4 changes: 2 additions & 2 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -221,13 +221,13 @@ The path to where the MFTF modules mirror Magento modules.
Example:

```conf
TESTS_MODULE_PATH=~/magento2/dev/tests/acceptance/tests/functional/Magento/FunctionalTest
TESTS_MODULE_PATH=~/magento2/dev/tests/acceptance/tests/functional/Magento
```

### MODULE_ALLOWLIST

Use for a new module.
When adding a new directory at `Magento/FunctionalTest`, add the directory name to `MODULE_ALLOWLIST` to enable MFTF to process it.
When adding a new directory at `tests/functional/Magento`, add the directory name to `MODULE_ALLOWLIST` to enable MFTF to process it.

Example:

Expand Down
22 changes: 11 additions & 11 deletions docs/extending.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,14 +177,14 @@ Extend an [action group] to add or update [actions] in your module.

### Update an action

__Use case__: The `CountProductA` test counts the particular product.
__Use case__: The `AssertAdminCountProductActionGroup` action group counts the particular product.
Modify the action group to use another product.

> Action groups with "extends":

```xml
<actionGroups>
<actionGroup name="CountProductA">
<actionGroup name="AssertAdminCountProductActionGroup">
<arguments>
<argument name="count" type="string"/>
</arguments>
Expand All @@ -195,7 +195,7 @@ Modify the action group to use another product.
</assertCount>
</actionGroup>

<actionGroup name="CountProductB" extends="CountProductA">
<actionGroup name="AssertAdminOtherCountProductActionGroup" extends="AssertAdminCountProductActionGroup">
<grabMultiple selector="selectorForProductB" stepKey="grabProducts"/>
</actionGroup>
</actionGroups>
Expand All @@ -205,7 +205,7 @@ Modify the action group to use another product.

```xml
<actionGroups>
<actionGroup name="CountProductA">
<actionGroup name="AssertAdminCountProductActionGroup">
<arguments>
<argument name="count" type="string"/>
</arguments>
Expand All @@ -216,7 +216,7 @@ Modify the action group to use another product.
</assertCount>
</actionGroup>

<actionGroup name="CountProductB">
<actionGroup name="AssertAdminOtherCountProductActionGroup">
<arguments>
<argument name="count" type="string"/>
</arguments>
Expand All @@ -231,21 +231,21 @@ Modify the action group to use another product.

### Add an action

__Use case__: The `GetProductCount` action group returns the count of products.
Add a new test `VerifyProductCount` that asserts the count of products:
__Use case__: The `AdminGetProductCountActionGroup` action group returns the count of products.
Add a new test `AssertAdminVerifyProductCountActionGroup` that asserts the count of products:

> Action groups with "extends":

```xml
<actionGroups>
<actionGroup name="GetProductCount">
<actionGroup name="AdminGetProductCountActionGroup">
<arguments>
<argument name="productSelector" type="string"/>
</arguments>
<grabMultiple selector="{{productSelector}}" stepKey="grabProducts"/>
</actionGroup>

<actionGroup name="VerifyProductCount" extends="GetProductCount">
<actionGroup name="AssertAdminVerifyProductCountActionGroup" extends="AdminGetProductCountActionGroup">
<arguments>
<argument name="count" type="string"/>
</arguments>
Expand All @@ -261,14 +261,14 @@ Add a new test `VerifyProductCount` that asserts the count of products:

```xml
<actionGroups>
<actionGroup name="GetProductCount">
<actionGroup name="AdminGetProductCountActionGroup">
<arguments>
<argument name="productSelector" type="string"/>
</arguments>
<grabMultiple selector="{{productSelector}}" stepKey="grabProducts"/>
</actionGroup>

<actionGroup name="VerifyProductCount">
<actionGroup name="AssertAdminVerifyProductCountActionGroup">
<arguments>
<argument name="count" type="string"/>
<argument name="productSelector" type="string"/>
Expand Down
8 changes: 4 additions & 4 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ cd magento2/
```

```bash
git checkout 2.3-develop
git checkout 2.4-develop
```

Install the Magento application.
Expand Down Expand Up @@ -241,10 +241,10 @@ See more commands in [`codecept`][].

#### Run a simple test {#run-test}

To clean up the previously generated tests, and then generate and run a single test `AdminLoginTest`, run:
To clean up the previously generated tests, and then generate and run a single test `AdminLoginSuccessfulTest`, run:

```bash
vendor/bin/mftf run:test AdminLoginTest --remove
vendor/bin/mftf run:test AdminLoginSuccessfulTest --remove
```

See more commands in [`mftf`][].
Expand Down Expand Up @@ -315,7 +315,7 @@ composer remove magento/magento2-functional-testing-framework --dev -d <path to
Generate and run a single test that will check your logging to the Magento Admin functionality:

```bash
bin/mftf run:test AdminLoginTest
bin/mftf run:test AdminLoginSuccessfulTest
```

You can find the generated test at `dev/tests/functional/tests/MFTF/_generated/default/`.
Expand Down