Intercepted classes don't work correctly when using ReflectionClass - Integration Tests

[domeglic]

Summary (*)

Creating a store inside integration tests doesn't work if there is a plugin defined for Magento\Framework\App\Config.

I have a test that requires a new store and it is not possible to save it. There is an exception "Property data does not exist".
When saving a store, method \Magento\TestFramework\Store\StoreManager::reinitStores is called, the reflection class will only have properties from the Interceptor class and not \Magento\TestFramework\App\Config.

PHP: 7.0
Magento: 2.2.6

Examples (*)

Create a plugin for Config, doesn't matter what it does:

<type name="Magento\Framework\App\Config">
        <plugin name="some_plugin" type="Some\Vendor\Plugin\FrameworkAppConfig" />
</type>

Have an integration test that creates a new store:

$store = \Magento\TestFramework\Helper\Bootstrap::getObjectManager(\Magento\Store\Model\Store::class)->create();  
$store->setCode('new_store)->setWebsiteId(1)->setGroupId(1)->setName('New store')->setIsActive(true);  
\Magento\TestFramework\Helper\Bootstrap::getObjectManager(\Magento\Store\Model\ResourceModel\Store::class)->save($store);

Proposed solution

[magento-engcom-team]

Hi @domeglic. Thank you for your report.
To help us process this issue please make sure that you provided the following information:

• Summary of the issue
• Information on your environment
• Steps to reproduce
• Expected and actual results

Please make sure that the issue is reproducible on the vanilla Magento instance following Steps to reproduce. To deploy vanilla Magento instance on our environment, please, add a comment to the issue:

@magento-engcom-team give me $VERSION instance

where $VERSION is version tags (starting from 2.2.0+) or develop branches (for example: 2.3-develop).
For more details, please, review the Magento Contributor Assistant documentation.

@domeglic do you confirm that you was able to reproduce the issue on vanilla Magento instance following steps to reproduce?

• yes
• no

[orlangur]

\Magento\Framework\App\Config\ScopeConfigInterface::class => \Magento\TestFramework\App\Config::class

@domeglic what if you define plugin on interface?

[domeglic]

It didn't make a difference, in the end the class is still the Interceptor. But I have found one way to fix it:
This is the method causing the problem

public function reinitStores()
    {
        //In order to restore configFixture values
        $testAppConfig = ObjectManager::getInstance()->get(Config::class);
        $reflection = new \ReflectionClass($testAppConfig);
        $dataProperty = $reflection->getProperty('data');
        $dataProperty->setAccessible(true);
        $savedConfig = $dataProperty->getValue($testAppConfig);
        $this->decoratedStoreManager->reinitStores();
        $dataProperty->setValue($testAppConfig, $savedConfig);
        $this->dispatchInitCurrentStoreAfterEvent();
    }

There is no property data because it is private and $reflection is of type Interceptor. But it seems the solution is simple by just checking if there is a parent class:

if ($reflection->getParentClass()) {
    $dataProperty = $reflection->getParentClass()->getProperty('data');
} else {
    $dataProperty = $reflection->getProperty('data');
}

Then it would work in case a plugin or proxy is set.

[magento-engcom-team]

Hi @engcom-backlog-nazar. Thank you for working on this issue.
In order to make sure that issue has enough information and ready for development, please read and check the following instruction: 👇

• 1. Verify that issue has all the required information. (Preconditions, Steps to reproduce, Expected result, Actual result).

  Details

  If the issue has a valid description, the label Issue: Format is valid will be added to the issue automatically. Please, edit issue description if needed, until label Issue: Format is valid appears.

• 2. Verify that issue has a meaningful description and provides enough information to reproduce the issue. If the report is valid, add Issue: Clear Description label to the issue by yourself.

• 3. Add Component: XXXXX label(s) to the ticket, indicating the components it may be related to.

• 4. Verify that the issue is reproducible on 2.3-develop branch

  Details

  - Add the comment @magento-engcom-team give me 2.3-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.3-develop branch, please, add the label Reproduced on 2.3.x.
  - If the issue is not reproducible, add your comment that issue is not reproducible and close the issue and stop verification process here!

• 5. Verify that the issue is reproducible on 2.2-develop branch.

  Details

  - Add the comment @magento-engcom-team give me 2.2-develop instance to deploy test instance on Magento infrastructure.
  - If the issue is reproducible on 2.2-develop branch, please add the label Reproduced on 2.2.x

• 6. Add label Issue: Confirmed once verification is complete.

• 7. Make sure that automatic system confirms that report has been added to the backlog.

[ghost]

Hi @domeglic thank you for you report, please try to use inserface instand of appConfig class -> Magento\Framework\App\ConfigScopeConfigInterface

[domeglic]

As I said that didn't make any difference.

[ghost]

@domeglic ok, wait one second, i'm will recheck.

[ghost]

@magento-engcom-team give me 2.3-develop instance

[magento-engcom-team]

Hi @engcom-backlog-nazar. Thank you for your request. I'm working on Magento 2.3-develop instance for you

[magento-engcom-team]

Hi @engcom-backlog-nazar, here is your Magento instance.
Admin access: https://i-18668-2-3-develop.instances.magento-community.engineering/admin
Login: admin Password: 123123q
Instance will be terminated in up to 3 hours.

[magento-engcom-team]

@engcom-backlog-nazar Thank you for verifying the issue. Based on the provided information internal tickets MAGETWO-96700, MAGETWO-96701 were created

[domeglic]

@magento-engcom-team give me 2.4-develop instance

[magento-engcom-team]

Hi @domeglic. Thank you for your request. I'm working on Magento 2.4-develop instance for you

[magento-engcom-team]

Hi @domeglic, here is your Magento instance.
Admin access: https://i-18668-2-4-develop.instances.magento-community.engineering/admin
Login: admin Password: 123123q
Instance will be terminated in up to 3 hours.