2.2.4 : Magento 2 integration tests enables all modules

[kanduvisla]

By default, I disable a lot of modules in my Magento setup, simply because I don't need them and I wish to spare my resources for the modules that I do need.

But I am currently in the situation where my integration test suite always runs with all modules enabled, whereas I want the suite to run again the same configuration is my store (so with a bunch of modules disabled).

A simple example: I don't use the Vertex_Tax-module so I have disabled it, but now my integration test suite is failing because some interceptors of this module expect some data to be populated:

Error: Call to undefined method Magento\Customer\Api\Data\CustomerExtension::setVertexCustomerCode()

Preconditions

1. Install Magento 2.2.4

Steps to reproduce

1. Disable some modules
2. Run the integration test suite (or run your own)

Expected result

The integration test suite should respect the enabled / disabled module status.

Actual result

The integration test suite enables all modules.

[kanduvisla]

As a (hopefully temporary) workaround for this I came up with a solution where I created a wrapper around the bootstrap (call it a "bootwrap" if you may).

So in my phpunit.xml, I set my boostrap to:

bootstrap="./etc/bootstrap.php"

And etc/bootstrap.php looks like this:

// Bootstrap wrapper, used to disable certain modules for integration tests.
$ds = DIRECTORY_SEPARATOR;

// Default bootstrap, as provided by Magento:
include_once __DIR__ . $ds . implode($ds, ['..', 'framework', 'bootstrap.php']);

// Copy the original config.php, that has all the disabled modules:
$tmpDir = \Magento\TestFramework\Helper\Bootstrap::getInstance()->getAppTempDir();
$dir = __DIR__ . $ds . implode($ds, ['..', '..', '..', '..', 'app', 'etc']);
copy(
    $dir . $ds . 'config.php',
    $tmpDir . $ds . implode($ds, ['etc', 'config.php'])
);

Basically, the only thing it does, is copy your app/etc/config.php to your dev/tests/integration/tmp/xxxxxx/etc-folder; effectively disabling the proper modules.

[jissereitsma]

This issue actually leads to a bigger issue. Within the phpunit.xml.dist configuration, there is the suggestion for using TESTS_GLOBAL_CONFIG_FILE which allows you to add new configuration options to your testing environment. However, the default options in the supplied config-global.php.dist file are never merged into the sandbox environment. Either, the whole mentioning of TESTS_GLOBAL_CONFIG_FILE needs to be removed, or it needs to be fixed. I'll have a PR for this in an hour or so.

Once this fix is included in Magento, you can create a new file dev/tests/integration/etc/config-global.php where you can include the exact contents of your global app/etc/config.php. Or you can use a custom bootstrap like the following to actually merge the global app/etc/config.php and the config-global.php.dist supplied by Magento. Thanks @kanduvisla for pointing the option for a custom bootstrap. My approach is a bit different, because it assumes the fix (PR coming) and therefore only generates a fresh config-global.php which should be considered as optional.

My bootstrap etc/custom-bootstrap.php is referenced in PHPUnit as such:

bootstrap="./etc/custom-bootstrap.php"

The bootstrap file itself looks like this:

<?php
$defaultConfig = include __DIR__ . '/config-global.php.dist';
$actualConfig = include __DIR__ . '/../../../../app/etc/config.php';
$newConfig = array_merge($defaultConfig, $actualConfig);

$code = var_export($newConfig, true);
$code = "<?php\n return " . preg_replace('/stdClass::__set_state/', '(object)', $code) . ';';
file_put_contents(__DIR__ . '/config-global.php', $code);

include_once __DIR__ . '/../framework/bootstrap.php';

[jissereitsma]

PR created: #16361

[kanduvisla]

It turns out my little trick no longer works (perhaps the 2.2.5 update caused it to stop working).

Isn't there any way to disable certain modules for running integration tests on a local development setup? Anyone? Already spent way too much time on this one.

@magento-engcom-team : perhaps add an extra flag to phpunit.xml to opt-in for automatically enable all the modules for your integration tests? I just want my integration tests to have the same modules enabled as my production site (which makes sense)

edit: I checked my Git log and indeed: my little trick stopped working since the 2.2.5 update

[kanduvisla]

So I seem to have "fixed" it once again with yet another dirty hack. Instead of having to copy/paste the original config.php before my tests, I had to dig deeper into the bootstrapping-context.

So I copied the original framework/bootstrap.php to my etc.php and edited as follows:

• I changed the require_once __DIR__ ... -statements to require_once __DIR__ . '/../framework' so all required files got loaded properly.
• I replaced the $application-instantiating as follows:

Original:

$application = new \Magento\TestFramework\Application(
    $shell,
    $installDir,
    $installConfigFile,
    $globalConfigFile,
    $settings->get('TESTS_GLOBAL_CONFIG_DIR'),
    $settings->get('TESTS_MAGENTO_MODE'),
    AutoloaderRegistry::getAutoloader(),
    true
);

My version:

// Manipulate existing application class to inject the projects' config.php:
$application = new class(
    $shell,
    $installDir,
    $installConfigFile,
    $globalConfigFile,
    $settings->get('TESTS_GLOBAL_CONFIG_DIR'),
    $settings->get('TESTS_MAGENTO_MODE'),
    AutoloaderRegistry::getAutoloader(),
    true
) extends \Magento\TestFramework\Application
{
    /**
     * @inheritDoc
     */
    public function install($cleanup)
    {
        $this->_ensureDirExists($this->installDir);
        $this->_ensureDirExists($this->_configDir);

        $file = $this->_globalConfigDir . '/config.php';
        $targetFile = $this->_configDir . str_replace($this->_globalConfigDir, '', $file);

        $this->_ensureDirExists(dirname($targetFile));
        if ($file !== $targetFile) {
            copy($file, $targetFile);
        }

        parent::install($cleanup);
    }

    /**
     * @inheritDoc
     */
    public function isInstalled()
    {
        // Always return false, otherwise DB credentials will be empty
        return false;
    }
};

I had to use an anonymous class because the new instantiation of the Application prevented me from using proper dependency injection. What it basically does, is it copies the config.php-file before the original install()-method is called. So when a native installation starts, it uses the config.php of my project to determine which modules should be installed.

Also, I had to override the isInstalled()-method to always return false, because otherwise the database function would have the wrong credentials (isInstalled() would always return true if a config.php is found).

So this way the integration tests on our CI server will run on an installation that reflects our production setup.

[sidolov]

Hi @kanduvisla. Thank you for your report.
The issue has been fixed in #16361 by @jissereitsma in 2.2-develop branch
Related commit(s):

• 23f1c0a4e1615c8f1d57376044646bfb6761cdf2
• 43df1045e13d96b2957c9974e8bb2d643a2e4963
• 244d480cb875a9e45f9fef0965d164b5c3c02e6a
• bb5b50e37e5be4677da4c092dfcb966e111eb8c9
• a77bdfc7e165ecdeda9d6cf8999d2f717fdd1cb2

The fix will be available with the upcoming 2.2.8 release.