Skip to content

MQE-1964: MFTF Helper - Implementation #644

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 11 commits into from
Mar 17, 2020
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
5 changes: 5 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,16 @@ language: php
php:
- 7.2
- 7.3
services:
- docker
before_install:
- docker run -d -p 4444:4444 -v /dev/shm:/dev/shm selenium/standalone-chrome:3.141.59-zirconium
install: composer install --no-interaction --prefer-source
env:
matrix:
- VERIFICATION_TOOL=phpunit-checks
- VERIFICATION_TOOL=static-checks
- VERIFICATION_TOOL=functional
script:
- bin/$VERIFICATION_TOOL
after_success:
Expand Down
10 changes: 10 additions & 0 deletions bin/functional
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Copyright © Magento, Inc. All rights reserved.
# See COPYING.txt for license details.

set -e

echo "==============================="
echo " EXECUTE DevDocsTest "
echo "==============================="
bin/mftf build:project
bin/mftf run:test DevDocsTest -f
2 changes: 1 addition & 1 deletion composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@
"files": ["src/Magento/FunctionalTestingFramework/_bootstrap.php"],
"psr-4": {
"Magento\\FunctionalTestingFramework\\": "src/Magento/FunctionalTestingFramework",
"MFTF\\": "dev/tests/functional/MFTF"
"MFTF\\": "dev/tests/functional/tests/MFTF"
}
},
"autoload-dev": {
Expand Down
5 changes: 3 additions & 2 deletions composer.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
-->
<actionGroups xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="urn:magento:mftf:Test/etc/actionGroupSchema.xsd">
<actionGroup name="HelperActionGroup">
<arguments>
<argument name="test" type="string" />
</arguments>
<comment userInput="Action group to demonstrate helper functionality available from action groups." stepKey="comment" />
<helper class="\MFTF\DevDocs\Helper\CustomHelper" method="goTo" stepKey="customHelper">
<argument name="test">{{contentSection.parametrizedSelector(test)}}</argument>
<argument name="module">['{{test}}', 'Bla']</argument>
<argument name="url">{{test}}</argument>
<argument name="bool">true</argument>
<argument name="float">4.400000000234234</argument>
<argument name="int">42</argument>
</helper>
</actionGroup>
</actionGroups>
14 changes: 14 additions & 0 deletions dev/tests/functional/tests/MFTF/DevDocs/Data/HelperData.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
-->

<entities xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="urn:magento:mftf:DataGenerator/etc/dataProfileSchema.xsd">
<entity name="HelperData">
<data key="entityField">Some kind of data for testing purposes</data>
</entity>
</entities>
49 changes: 49 additions & 0 deletions dev/tests/functional/tests/MFTF/DevDocs/Helper/CustomHelper.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/

namespace MFTF\DevDocs\Helper;

use Magento\FunctionalTestingFramework\Helper\Helper;

class CustomHelper extends Helper
{
/**
* Custom helper.
*
* @param string $url
* @param mixed $test
* @param bool $bool
* @param int $int
* @param float $float
* @param array $module
* @param null $superBla
* @param mixed $bla
* @param array $arraysomething
* @return void
*/
public function goTo(
string $url,
$test,
bool $bool,
int $int,
float $float,
array $module = [],
$superBla = null,
$bla = 'blaValue',
array $arraysomething = ['key' => 'value', 'test']
) {
print('Hello, this is custom helper which provides an ability to write custom solutions.' . PHP_EOL);
print('string $url = ' . $url . PHP_EOL);
print('$test = ' . $test . PHP_EOL);
print('$bool = ' . $bool . PHP_EOL);
print('$int = ' . $int . PHP_EOL);
print('$float = ' . $float . PHP_EOL);
print('array $module = [' . implode(', ', $module) . ']' . PHP_EOL);
print('$superBla = ' . $superBla . PHP_EOL);
print('$bla = ' . $bla . PHP_EOL);
print('array $arraysomething = [' . implode(', ', $arraysomething) . ']' . PHP_EOL);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
xsi:noNamespaceSchemaLocation="urn:magento:mftf:Page/etc/SectionObject.xsd">
<section name="contentSection">
<element name="pageIntro" type="text" selector=".page-intro"/>
<element name="parametrizedSelector" type="text" selector=".page-intro > {{justToProofItWorks}}" parameterized="true"/>
<element name="deprecatedPageIntro" type="text" selector=".page-intro-old" deprecated="New element was introduced. Please use 'contentSection.pageIntro'"/>
</section>
</sections>
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,6 @@
<!-- Open MFTF DevDocs Page -->
<amOnPage stepKey="openMFTFDevDocPage" url="{{DeprecatedMFTFDocPage.url}}" />
<see stepKey="verifyPageIntroText" selector="{{DeprecatedContentSection.pageIntro}}" userInput="{{DeprecatedMessageData.message}}" />
<actionGroup ref="DeprecatedCommentActionGroup" stepKey="commentActionGroup" />
<actionGroup ref="DeprecatedCommentActionGroup" stepKey="commentActionGroup"/>
</test>
</tests>
23 changes: 23 additions & 0 deletions dev/tests/functional/tests/MFTF/DevDocs/Test/DevDocsTest.xml
Original file line number Diff line number Diff line change
Expand Up @@ -22,5 +22,28 @@
<!-- Open MFTF DevDocs Page -->
<amOnPage stepKey="openMFTFDevDocPage" url="{{MFTFDocPage.url}}" />
<see stepKey="verifyPageIntroText" selector="{{contentSection.pageIntro}}" userInput="{{MessageData.message}}" />
<helper class="\MFTF\DevDocs\Helper\CustomHelper" method="goTo" stepKey="customHelper">
<argument name="test">{{contentSection.pageIntro}}</argument>
<argument name="module">['Test', 'Bla']</argument>
<argument name="url">{{MFTFDocPage.url}}</argument>
<argument name="bool">true</argument>
<argument name="float">1.2</argument>
<argument name="int">123</argument>
</helper>

<helper class="\MFTF\DevDocs\Helper\CustomHelper" method="goTo" stepKey="customHelperWithArrayParametrized">
<argument name="test">{{contentSection.pageIntro}}</argument>
<argument name="module">[]</argument>
<argument name="url">{{DeprecatedMFTFDocPage.url}}</argument>
<argument name="superBla">1.2</argument>
<argument name="bla" />
<argument name="bool">false</argument>
<argument name="float">4.223</argument>
<argument name="int">987</argument>
</helper>

<actionGroup ref="HelperActionGroup" stepKey="actionGroupWithCustomHelper">
<argument name="test" value="{{HelperData.entityField}}" />
</actionGroup>
</test>
</tests>
2 changes: 0 additions & 2 deletions etc/config/functional.suite.dist.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@ namespace: Magento\FunctionalTestingFramework
modules:
enabled:
- \Magento\FunctionalTestingFramework\Module\MagentoWebDriver
- \Magento\FunctionalTestingFramework\Helper\Acceptance
- \Magento\FunctionalTestingFramework\Helper\MagentoFakerData
- \Magento\FunctionalTestingFramework\Module\MagentoSequence
- \Magento\FunctionalTestingFramework\Module\MagentoAssert
- \Magento\FunctionalTestingFramework\Module\MagentoActionProxies
Expand Down
8 changes: 7 additions & 1 deletion etc/di.xml
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@

<!-- Entity value gets replaced in Dom.php before reading $xml -->
<!DOCTYPE config [
<!ENTITY commonTestActions "acceptPopup|actionGroup|amOnPage|amOnUrl|amOnSubdomain|appendField|assertArrayIsSorted|assertArraySubset|assertElementContainsAttribute|attachFile|cancelPopup|checkOption|clearField|click|clickWithLeftButton|clickWithRightButton|closeAdminNotification|closeTab|comment|conditionalClick|createData|deleteData|updateData|getData|dontSee|dontSeeJsError|dontSeeCheckboxIsChecked|dontSeeCookie|dontSeeCurrentUrlEquals|dontSeeCurrentUrlMatches|dontSeeElement|dontSeeElementInDOM|dontSeeInCurrentUrl|dontSeeInField|dontSeeInFormFields|dontSeeInPageSource|dontSeeInSource|dontSeeInTitle|dontSeeLink|dontSeeOptionIsSelected|doubleClick|dragAndDrop|entity|executeJS|fillField|formatMoney|generateDate|grabAttributeFrom|grabCookie|grabFromCurrentUrl|grabMultiple|grabPageSource|grabTextFrom|grabValueFrom|loadSessionSnapshot|loginAsAdmin|magentoCLI|magentoCron|makeScreenshot|maximizeWindow|moveBack|moveForward|moveMouseOver|mSetLocale|mResetLocale|openNewTab|pauseExecution|parseFloat|pressKey|reloadPage|resetCookie|submitForm|resizeWindow|saveSessionSnapshot|scrollTo|scrollToTopOfPage|searchAndMultiSelectOption|see|seeCheckboxIsChecked|seeCookie|seeCurrentUrlEquals|seeCurrentUrlMatches|seeElement|seeElementInDOM|seeInCurrentUrl|seeInField|seeInFormFields|seeInPageSource|seeInPopup|seeInSource|seeInTitle|seeLink|seeNumberOfElements|seeOptionIsSelected|selectOption|setCookie|submitForm|switchToIFrame|switchToNextTab|switchToPreviousTab|switchToWindow|typeInPopup|uncheckOption|unselectOption|wait|waitForAjaxLoad|waitForElement|waitForElementChange|waitForElementNotVisible|waitForElementVisible|waitForPwaElementNotVisible|waitForPwaElementVisible|waitForJS|waitForLoadingMaskToDisappear|waitForPageLoad|waitForText|assertArrayHasKey|assertArrayNotHasKey|assertArraySubset|assertContains|assertCount|assertEmpty|assertEquals|assertFalse|assertFileExists|assertFileNotExists|assertGreaterOrEquals|assertGreaterThan|assertGreaterThanOrEqual|assertInstanceOf|assertInternalType|assertIsEmpty|assertLessOrEquals|assertLessThan|assertLessThanOrEqual|assertNotContains|assertNotEmpty|assertNotEquals|assertNotInstanceOf|assertNotNull|assertNotRegExp|assertNotSame|assertNull|assertRegExp|assertSame|assertStringStartsNotWith|assertStringStartsWith|assertTrue|expectException|fail|dontSeeFullUrlEquals|dontSee|dontSeeFullUrlMatches|dontSeeInFullUrl|seeFullUrlEquals|seeFullUrlMatches|seeInFullUrl|grabFromFullUrl">
<!ENTITY commonTestActions "acceptPopup|actionGroup|amOnPage|amOnUrl|amOnSubdomain|appendField|assertArrayIsSorted|assertArraySubset|assertElementContainsAttribute|attachFile|cancelPopup|checkOption|clearField|click|clickWithLeftButton|clickWithRightButton|closeAdminNotification|closeTab|comment|conditionalClick|createData|deleteData|updateData|getData|dontSee|dontSeeJsError|dontSeeCheckboxIsChecked|dontSeeCookie|dontSeeCurrentUrlEquals|dontSeeCurrentUrlMatches|dontSeeElement|dontSeeElementInDOM|dontSeeInCurrentUrl|dontSeeInField|dontSeeInFormFields|dontSeeInPageSource|dontSeeInSource|dontSeeInTitle|dontSeeLink|dontSeeOptionIsSelected|doubleClick|dragAndDrop|entity|executeJS|fillField|formatMoney|generateDate|grabAttributeFrom|grabCookie|grabFromCurrentUrl|grabMultiple|grabPageSource|grabTextFrom|grabValueFrom|loadSessionSnapshot|loginAsAdmin|magentoCLI|magentoCron|makeScreenshot|maximizeWindow|moveBack|moveForward|moveMouseOver|mSetLocale|mResetLocale|openNewTab|pauseExecution|parseFloat|pressKey|reloadPage|resetCookie|submitForm|resizeWindow|saveSessionSnapshot|scrollTo|scrollToTopOfPage|searchAndMultiSelectOption|see|seeCheckboxIsChecked|seeCookie|seeCurrentUrlEquals|seeCurrentUrlMatches|seeElement|seeElementInDOM|seeInCurrentUrl|seeInField|seeInFormFields|seeInPageSource|seeInPopup|seeInSource|seeInTitle|seeLink|seeNumberOfElements|seeOptionIsSelected|selectOption|setCookie|submitForm|switchToIFrame|switchToNextTab|switchToPreviousTab|switchToWindow|typeInPopup|uncheckOption|unselectOption|wait|waitForAjaxLoad|waitForElement|waitForElementChange|waitForElementNotVisible|waitForElementVisible|waitForPwaElementNotVisible|waitForPwaElementVisible|waitForJS|waitForLoadingMaskToDisappear|waitForPageLoad|waitForText|assertArrayHasKey|assertArrayNotHasKey|assertArraySubset|assertContains|assertCount|assertEmpty|assertEquals|assertFalse|assertFileExists|assertFileNotExists|assertGreaterOrEquals|assertGreaterThan|assertGreaterThanOrEqual|assertInstanceOf|assertInternalType|assertIsEmpty|assertLessOrEquals|assertLessThan|assertLessThanOrEqual|assertNotContains|assertNotEmpty|assertNotEquals|assertNotInstanceOf|assertNotNull|assertNotRegExp|assertNotSame|assertNull|assertRegExp|assertSame|assertStringStartsNotWith|assertStringStartsWith|assertTrue|expectException|fail|dontSeeFullUrlEquals|dontSee|dontSeeFullUrlMatches|dontSeeInFullUrl|seeFullUrlEquals|seeFullUrlMatches|seeInFullUrl|grabFromFullUrl|helper">
]>

<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../src/Magento/FunctionalTestingFramework/ObjectManager/etc/config.xsd">
Expand Down Expand Up @@ -222,6 +222,8 @@
<item name="/tests/test/(createData|updateData|getData)/requiredEntity" xsi:type="string">createDataKey</item>
<item name="/tests/test/(createData|updateData|getData)/field" xsi:type="string">key</item>
<item name="/tests/test/(actionGroup|&commonTestActions;)" xsi:type="string">stepKey</item>
<item name="/tests/test/helper/argument" xsi:type="string">name</item>
<item name="/tests/test/(before|after)/helper/argument" xsi:type="string">name</item>
<item name="/tests/test/(before|after)/(actionGroup|&commonTestActions;)" xsi:type="string">stepKey</item>
<item name="/tests/test/remove" xsi:type="string">keyForRemoval</item>
<item name="/tests/test/(before|after)/remove" xsi:type="string">keyForRemoval</item>
Expand All @@ -239,6 +241,8 @@
<argument name="assocArrayAttributes" xsi:type="array">
<item name="/tests/test/(actionGroup|&commonTestActions;)" xsi:type="string">stepKey</item>
<item name="/tests/test/(before|after)/(actionGroup|&commonTestActions;)" xsi:type="string">stepKey</item>
<item name="/tests/test/helper/argument" xsi:type="string">name</item>
<item name="/tests/test/(before|after)/helper/argument" xsi:type="string">name</item>
<item name="/tests/test/remove" xsi:type="string">keyForRemoval</item>
<item name="/tests/test/(before|after)/remove" xsi:type="string">keyForRemoval</item>
<item name="/tests/test" xsi:type="string">name</item>
Expand Down Expand Up @@ -299,6 +303,7 @@
<argument name="idAttributes" xsi:type="array">
<item name="/actionGroups/actionGroup" xsi:type="string">name</item>
<item name="/actionGroups/actionGroup/arguments/argument" xsi:type="string">name</item>
<item name="/actionGroups/actionGroup/helper/argument" xsi:type="string">name</item>
<item name="/actionGroups/actionGroup/(&commonTestActions;)" xsi:type="string">stepKey</item>
<item name="/actionGroups/actionGroup/(createData|updateData|getData)/requiredEntity" xsi:type="string">createDataKey</item>
<item name="/actionGroups/actionGroup/(createData|updateData|getData)/field" xsi:type="string">key</item>
Expand All @@ -316,6 +321,7 @@
<item name="/actionGroups/actionGroup/remove" xsi:type="string">keyForRemoval</item>
<item name="/actionGroups/actionGroup" xsi:type="string">name</item>
<item name="/actionGroups/actionGroup/arguments/argument" xsi:type="string">name</item>
<item name="/actionGroups/actionGroup/helper/argument" xsi:type="string">name</item>
<item name="/actionGroups/actionGroup/(createData|updateData|getData)/requiredEntity" xsi:type="string">createDataKey</item>
<item name="/actionGroups/actionGroup/(createData|updateData|getData)/field" xsi:type="string">key</item>
</argument>
Expand Down
42 changes: 0 additions & 42 deletions src/Magento/FunctionalTestingFramework/Helper/Acceptance.php

This file was deleted.

Loading