Skip to content

Fixing links and other changes per review. #321

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 7 commits into from
Mar 28, 2019
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
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ Each Magento source file included in this distribution is licensed under AGPL 3.
See the license [here][] or contact [license@magentocommerce.com][] for a copy.

<!-- Link Definitions -->
[Getting Started]: https://devdocs.magento.com/mftf/getting-started.html
[Getting Started]: docs/getting-started.md
[Contribution Guidelines]: .github/CONTRIBUTING.html
[DevDocs Contributing]: https://github.com/magento/devdocs/blob/master/.github/CONTRIBUTING.md
[security@magento.com]: mailto:security@magento.com
Expand Down
12 changes: 6 additions & 6 deletions docs/commands/codeception.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,27 +12,27 @@ To run the Codeception testing framework commands directly, change your director
Run all the generated tests:

```bash
../../../vendor/bin/codecept run functional -c dev/tests/acceptance/codeception.yml
vendor/bin/codecept run functional -c dev/tests/acceptance/codeception.yml
```

Run all tests without the `<group value="skip"/>` [annotation][]:

```bash
../../../vendor/bin/codecept run functional --skip-group skip -c dev/tests/acceptance/codeception.yml
vendor/bin/codecept run functional --skip-group skip -c dev/tests/acceptance/codeception.yml
```

Run all tests with the `<group value="example"/>` [annotation][] but with no `<group value="skpip"/>`:

```bash
../../../vendor/bin/codecept run functional --group example --skip-group skip -c dev/tests/acceptance/codeception.yml
vendor/bin/codecept run functional --group example --skip-group skip -c dev/tests/acceptance/codeception.yml
```

## `codecept run`

`codecept run` runs the test suites:

```bash
../../../vendor/bin/codecept run
vendor/bin/codecept run
```

<div class="bs-callout bs-callout-info">
Expand Down Expand Up @@ -81,5 +81,5 @@ Options:

<!-- Link definitions -->

[mftf tool]: mftf.html
[annotation]: ../test/annotations.html
[mftf tool]: mftf.md
[annotation]: ../test/annotations.md
4 changes: 2 additions & 2 deletions docs/commands/mftf.md
Original file line number Diff line number Diff line change
Expand Up @@ -384,11 +384,11 @@ vendor/bin/mftf upgrade:tests /Users/user/magento2/app/code/Magento/Catalog/Test

<!-- LINK DEFINITIONS -->

[configuration]: ../configuration.html
[configuration]: ../configuration.md
[Reference]: #reference
[build]: #buildproject
[setup]: #setupenv
[Reporting]: ../reporting.html
[Reporting]: ../reporting.md

<!-- Abbreviations -->

Expand Down
6 changes: 3 additions & 3 deletions docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ Example:
MAGENTO_RESTAPI_SERVER_PORT=5000
```

### *_BP
### \*_BP

Settings to override base paths for the framework.
You can use it when the MFTF is applied as a separate tool.
Expand Down Expand Up @@ -254,6 +254,6 @@ BROWSER=firefox
<!-- Link definitions -->

[`MAGENTO_CLI_COMMAND_PATH`]: #magento_cli_command_path
[generateDate]: test/actions.html#generatedate
[mftf]: commands/mftf.html
[generateDate]: test/actions.md#generatedate
[mftf]: commands/mftf.md
[timezones]: http://php.net/manual/en/timezones.php
8 changes: 4 additions & 4 deletions docs/credentials.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ The decrypted values are only available in the `.credentials` file.
The MFTF tests delivered with Magento application do not use credentials and do not cover external services, because of sensitivity of the data.</div>

<!-- Link definitions -->
[`fillField`]: test/actions.html#fillfield
[data]: data.html
[initial setup]: getting-started.html
[test reports]: reporting.html
[`fillField`]: test/actions.md#fillfield
[data]: data.md
[initial setup]: getting-started.md
[test reports]: reporting.md
4 changes: 2 additions & 2 deletions docs/data.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ This emphasizes the practice for the `stepKey` of `createData` to be descriptive

## Use data returned by test actions

A test can also reference data that was returned as a result of [test actions](./test/actions.html#actions-returning-a-variable), like the action `<grabValueFrom selector="someSelector" stepKey="grabStepKey>`.
A test can also reference data that was returned as a result of [test actions](./test/actions.md#actions-returning-a-variable), like the action `<grabValueFrom selector="someSelector" stepKey="grabStepKey>`.

Further in the test, the data grabbed by the `someSelector` selector can be referenced using the `stepKey` value. In this case, it is `grabStepKey`.

Expand All @@ -89,7 +89,7 @@ The following example shows the usage of `grabValueFrom` in testing, where the r

The data to operate against can be included as literals in a test. Hard-coded data input can be useful in assertions.

See also [Actions](./test/actions.html).
See also [Actions](./test/actions.md).

```xml
userInput="We'll email you an order confirmation with details and tracking info."
Expand Down
8 changes: 4 additions & 4 deletions docs/extending.md
Original file line number Diff line number Diff line change
Expand Up @@ -363,7 +363,7 @@ __Use case__: Create an entity named `DivPanelGreen`, which is similar to the `D
```

<!-- Link definitions -->
[test]: ./test.html
[data]: ./data.html
[action group]: ./test/action-groups.html
[actions]: ./test/actions.html
[test]: ./test.md
[data]: ./data.md
[action group]: ./test/action-groups.md
[actions]: ./test/actions.md
2 changes: 1 addition & 1 deletion docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -183,7 +183,7 @@ cd dev/tests/acceptance
```

```bash
../../../vendor/bin/codecept run functional
vendor/bin/codecept run functional -c dev/tests/acceptance/codeception.yml
```

See more commands in [`codecept`][].
Expand Down
3 changes: 0 additions & 3 deletions docs/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,6 @@

[Find your MFTF version][] of the MFTF.

The latest Magento 2.3 release supports MFTF 2.3.13.
The latest Magento 2.2 release supports MFTF 2.3.8.

The Magento Functional Testing Framework (MFTF) aims to replace the [Functional Testing Framework] in future releases.
MFTF improves:

Expand Down
6 changes: 5 additions & 1 deletion docs/merge_points/extend-action-groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ In this example we add a `<click>` command to check the checkbox that our extens

## Starting action group

<!-- {% raw %} -->

```xml
<actionGroup name="FillAdminSimpleProductForm">
<arguments>
Expand Down Expand Up @@ -95,4 +97,6 @@ Note that there are now two action groups below.
<click selector="{{AdminProductSEOSection.sectionHeader}}" stepKey="openSeoSectionAssert"/>
<seeInField userInput="{{simpleProduct.urlKey}}" selector="{{AdminProductSEOSection.urlKeyInput}}" stepKey="assertFieldUrlKey"/>
</actionGroup>
```
```

<!-- {% endraw %} -->
18 changes: 9 additions & 9 deletions docs/merge_points/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ Consult [when to use Extends][] to use extends when deciding whether to merge or
- [Extend Tests][]

<!-- Link definitions -->
[when to use Extends]: https://devdocs.magento.com/mftf/docs/best-practices.html#when-to-use-extends
[Merge Action Groups]: https://devdocs.magento.com/mftf/docs/merge_points/merge-action-groups.html
[Merge Data]: https://devdocs.magento.com/mftf/docs/merge_points/merge-data.html
[Merge Pages]: https://devdocs.magento.com/mftf/docs/merge_points/merge-pages.html
[Merge Sections]: https://devdocs.magento.com/mftf/docs/merge_points/merge-sections.html
[Merge Tests]: https://devdocs.magento.com/mftf/docs/merge_points/merge-tests.html
[Extend Action Groups]: https://devdocs.magento.com/mftf/docs/merge_points/extend-action-groups.html
[Extend Data]: https://devdocs.magento.com/mftf/docs/merge_points/extend-data.html
[Extend Tests]: https://devdocs.magento.com/mftf/docs/merge_points/extend-tests.html
[when to use Extends]: ../best-practices.md#when-to-use-extends
[Merge Action Groups]: merge-action-groups.md
[Merge Data]: merge-data.md
[Merge Pages]: merge-pages.md
[Merge Sections]: merge-sections.md
[Merge Tests]: merge-tests.md
[Extend Action Groups]: extend-action-groups.md
[Extend Data]: extend-data.md
[Extend Tests]: extend-tests.md
6 changes: 5 additions & 1 deletion docs/merge_points/merge-action-groups.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ In this example we add a `<click>` command to check the checkbox that our extens

## Starting test

<!-- {% raw %} -->

```xml
<actionGroup name="FillAdminSimpleProductForm">
<arguments>
Expand Down Expand Up @@ -71,4 +73,6 @@ In this example we add a `<click>` command to check the checkbox that our extens
<click selector="{{AdminProductSEOSection.sectionHeader}}" stepKey="openSeoSectionAssert"/>
<seeInField userInput="{{simpleProduct.urlKey}}" selector="{{AdminProductSEOSection.urlKeyInput}}" stepKey="assertFieldUrlKey"/>
</actionGroup>
```
```

<!-- {% endraw %} -->
6 changes: 5 additions & 1 deletion docs/merge_points/merge-sections.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ In this example we add another selector to the section on the products page sect

## Starting section

<!-- {% raw %} -->

```xml
<section name="ProductsPageSection">
<element name="addProductButton" type="button" selector="//button[@id='add_new_product-button']"/>
Expand Down Expand Up @@ -40,4 +42,6 @@ In this example we add another selector to the section on the products page sect
<element name="myExtensionElement" type="button" selector="input.myExtension"/>
</section>
</page>
```
```

<!-- {% endraw %} -->
14 changes: 7 additions & 7 deletions docs/merging.md
Original file line number Diff line number Diff line change
Expand Up @@ -562,10 +562,10 @@ The `_defaultSample` results corresponds to:

<!-- Link definitions -->

[`codecept`]: ./commands/codeception.html
[`mftf`]: ./commands/mftf.html
[`<data>`]: ./data.html
[elements]: ./section.html#element-tag
[`<pages>`]: ./page.html
[`<sections>`]: ./section.html
[`<tests>`]: ./test.html
[`codecept`]: ./commands/codeception.md
[`mftf`]: ./commands/mftf.md
[`<data>`]: ./data.md
[elements]: ./section.md#element-tag
[`<pages>`]: ./page.md
[`<sections>`]: ./section.md
[`<tests>`]: ./test.md
16 changes: 8 additions & 8 deletions docs/metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -554,30 +554,30 @@ Example:

<!-- LINK DEFINITIONS -->

[actions]: test/actions.html
[actions]: test/actions.md
[api reference]: https://devdocs.magento.com/guides/v2.3/get-started/bk-get-started-api.html
[application/x-www-form-urlencoded]: https://www.w3.org/TR/html401/interact/forms.html#h-17.13.4.1
{:target="_blank"}
[catalogCategoryRepositoryV1 image]: img/catalogCategoryRepository-operations.png
[catalogCategoryRepositoryV1SavePostBody]: #catalogCategoryRepositoryV1SavePostBody
[contentType]: #contentType-tag
[Create a new category]: #create-object-as-adminOauth
[createData]: test/actions.html#createdata
[createData]: test/actions.md#createdata
[delete a category by its ID]: #delete-object-as-adminOauth
[deleteData]: test/actions.html#deletedata
[entity]: data.html#entity-tag
[deleteData]: test/actions.md#deletedata
[entity]: data.md#entity-tag
[get information about a category by its ID]: #get-object-as-adminOauth
[getData]: test/actions.html#getdata
[getData]: test/actions.md#getdata
[HTML forms]: https://www.w3.org/TR/html401/interact/forms.html
{:target="_blank"}
{:target="\_blank"}
[oauth]: https://devdocs.magento.com/guides/v2.3/get-started/authentication/gs-authentication-oauth.html
{:target="_blank"}
{:target="\_blank"}
[operation]: #operation-tag
[reference]: #reference
[rest request]: #handling-with-api
[html form]: #using-html-forms
[update category data by its ID]: #update-object-as-adminOauth
[updateData]: test/actions.html#updatedata
[updateData]: test/actions.md#updatedata
[rest response]: #rest-response

*[CRUD]: Create Read Update Delete
Expand Down
8 changes: 4 additions & 4 deletions docs/page.md
Original file line number Diff line number Diff line change
Expand Up @@ -161,12 +161,12 @@ Attributes|Type|Use|Description
`remove`|boolean|optional|The default value is `"false"`. Set to `"true"` to remove this element during parsing.

<!-- Link definitions -->
[`<createData>`]: test/actions.html#createdata
[`<createData>`]: test/actions.md#createdata
[`<page>`]: #page-tag
[`<section>`]: #section-tag
[`<test>`]: test.html
[actions]: test/actions.html
[`<test>`]: test.md
[actions]: test/actions.md
[explicit page]: #explicit-page
[PageObjects]: https://github.com/SeleniumHQ/selenium/wiki/PageObjects
[parameterized page]: #parameterized-page
[section]: section.html
[section]: section.md
10 changes: 5 additions & 5 deletions docs/reporting.md
Original file line number Diff line number Diff line change
Expand Up @@ -344,13 +344,13 @@ Refer to the [Reporting section][] for more Allure CLI details.

<!-- Link definitions -->

[`after`]: test.html#after-tag
[`run:group`]: commands/mftf.html#rungroup
[`run:test`]: commands/mftf.html#runtest
[`after`]: test.md#after-tag
[`run:group`]: commands/mftf.md#rungroup
[`run:test`]: commands/mftf.md#runtest
[Allure Framework]: https://docs.qameta.io/allure/
[Allure Test Report]: http://allure.qatools.ru/
[codecept]: commands/codeception.html
[codecept]: commands/codeception.md
[codeception]: https://codeception.com/docs/reference/Commands
[mftf]: commands/mftf.html
[mftf]: commands/mftf.md
[report an issue]: https://github.com/magento/magento2-functional-testing-framework/blob/master/.github/CONTRIBUTING.md#report-an-issue
[Reporting section]: https://docs.qameta.io/allure/#_reporting
4 changes: 2 additions & 2 deletions docs/section/locator-functions.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,5 +42,5 @@ Given the above element definitions, you call the elements in a test just like a

<!-- Link Definitions -->
[Locator functions]: http://codeception.com/docs/reference/Locator
[section]: ../section.html
[parameterized selectors]: ./parameterized-selectors.html
[section]: ../section.md
[parameterized selectors]: ./parameterized-selectors.md
2 changes: 1 addition & 1 deletion docs/section/parameterized-selectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,4 +152,4 @@ Any data can be used in parameterized elements, as well as entered in test actio
* `{$variable}` is a reference to data returned by a test action, like `<grabValueFrom>`.

<!-- Link Definitions -->
[test]: ../test.html
[test]: ../test.md
12 changes: 6 additions & 6 deletions docs/suite.md
Original file line number Diff line number Diff line change
Expand Up @@ -94,7 +94,7 @@ There are several ways to generate and execute your new test in the context of a

### Enabling/disabling WYSIWYG in suite conditions

<!-- {{raw}} -->
<!-- {% raw %} -->

```xml
<suites xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../dev/tests/acceptance/vendor/magento/magento2-functional-testing-framework/src/Magento/FunctionalTestingFramework/Suite/etc/suiteSchema.xsd">
Expand Down Expand Up @@ -122,7 +122,7 @@ There are several ways to generate and execute your new test in the context of a
</suites>
```

<!-- {{endraw}} -->
<!-- {% endraw %} -->
This example declares a suite with the name `WYSIWYG`.
The suite enables WYSIWYG *before* running tests.
It performs the following steps:
Expand Down Expand Up @@ -282,12 +282,12 @@ Attributes|Type|Use|Description
`remove`|boolean|optional|Removing the filter during merging.

<!-- Link definitions -->
[actions]: test/actions.html
[action groups]: test/action-groups.html
[actions]: test/actions.md
[action groups]: test/action-groups.md
[`<after>`]: #after-tag
[`<before>`]: #before-tag
[`generate:tests`]: commands/mftf.html#generatetests
[test]: test.html
[`generate:tests`]: commands/mftf.md#generatetests
[test]: test.md
[`<test>`]: #test-tag
[`<group>`]: #group-tag
[`<module>`]: #module-tag
Expand Down
14 changes: 7 additions & 7 deletions docs/test.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,12 +136,12 @@ See [Action groups][action group] for more information.
[`<before>`]: #before-tag
[`<test>`]: #test-tag
[`<tests>`]: #tests-tag
[action group]: ./test/action-groups.html
[actions]: ./test/actions.html
[action group]: ./test/action-groups.md
[actions]: ./test/actions.md
[Allure]: https://github.com/allure-framework/
[Annotations]: ./test/annotations.html
[assertion]: ./test/assertions.html
[Annotations]: ./test/annotations.md
[assertion]: ./test/assertions.md
[Codeception]: https://codeception.com/docs/07-AdvancedUsage
[extend]: extending.html
[merging]: ./merging.html#insert-after
[suites]: ./suite.html
[extend]: extending.md
[merging]: ./merging.md#insert-after
[suites]: ./suite.md
Loading