Added the ability to use entity properties in metadata

[rocketweb]

Description

Added the ability to use entity properties inside metadata entities for when you make API requests to create something that has to contain an array of properties from other entities, e.g. the request for creating a new tax rule has to contain an array of the ids of the tax rates that will be associated to it.

Now you can have a meta file that represents a tax rate, which would look something like this:

<?xml version="1.0" encoding="UTF-8"?>
<operations xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:noNamespaceSchemaLocation="../../../../../../vendor/magento/magento2-functional-testing-framework/src/Magento/FunctionalTestingFramework/DataGenerator/etc/dataOperation.xsd">
    <operation name="CreateTaxRate" dataType="tax_rate" type="create" auth="adminOauth" url="/V1/taxRates" method="POST">
        <contentType>application/json</contentType>
        <object dataType="tax_rate" key="taxRate">
            <field key="code">string</field>
            <field key="tax_country_id">string</field>
            <field key="tax_region_id">integer</field>
            <field key="tax_postcode">string</field>
            <field key="rate">integer</field>
        </object>
    </operation>
</operations>

And a meta file that represents a tax rule, which would look something like this:

<?xml version="1.0" encoding="UTF-8"?>
<operations xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
            xsi:noNamespaceSchemaLocation="../../../../../../vendor/magento/magento2-functional-testing-framework/src/Magento/FunctionalTestingFramework/DataGenerator/etc/dataOperation.xsd">
    <operation name="CreateTaxRule" dataType="tax_rule" type="create" auth="adminOauth" url="/V1/taxRules" method="POST">
        <contentType>application/json</contentType>
        <object dataType="tax_rule" key="rule">
            <field key="code">string</field>
            <field key="priority">integer</field>
            <field key="position">integer</field>
            <array key="customer_tax_class_ids">
                <value>integer</value>
            </array>
            <array key="product_tax_class_ids">
                <value>integer</value>
            </array>
            <array key="tax_rate_ids">
                <value>tax_rate.id</value>
            </array>
        </object>
    </operation>
</operations>

Notice the <value>tax_rate.id</value> inside the tax_rule entity. Now a tax rule can be created successfully.

Contribution checklist

• Pull request has a meaningful description of its purpose
• All commits are accompanied by meaningful commit messages
• All new or changed code is covered with unit/verification tests (if applicable)
• All automated tests passed successfully (all builds on Travis CI are green)
• Changes to Framework doesn't have backward incompatible changes for tests or have related Pull Request with fixes to tests

[coveralls]

Coverage decreased (-0.07%) to 52.37% when pulling 73c4371 on rocketweb:use-entity-properties-in-metadata into bf24553 on magento:develop.

[okolesnyk]

Hi again.
For this ticket I also created internal ticket MQE-911.
And I will update you as soon as possible on progress of this ticket here.

[okolesnyk]

Hello, @rocketweb
Please sign licence/cla, because otherwise I can not process this Pull Request.

[KevinBKozan]

@rocketweb,
Following up with you about the license/CLA. If you could please sign the license/cla we can process this Pull Request.

[okolesnyk]

@rocketweb Thank you very much, we will include it into 2.3.1 upcoming release.

[jilu1]

@rocketweb Thanks for your contribution! I have pulled your PR into our current develop branch, setup tax rate and tax rule meta data as described in PR, I tried a few ways to setup data and test for tax rule, but could not persist tax rule data correctly. Could you please send us your data, meta data, and test for us to review?

Issue resolved.