[Question] Getting the live (non-test) module activation state during integration tests

[Vinai]

This is a question for help while studying the Magento 2 testing frameworks.

In a test I want to check for module activation state in an integration test.
I managed to get to it (see below), but I wonder if there is a more elegant way, as it seems like an awful lot of setup for such a small thing.

Here is the code I used:

<?php

namespace Namespace\Module;

use Magento\TestFramework\Helper\Bootstrap;
use Magento\Framework\Module\ModuleList;
use Magento\Framework\App\DeploymentConfig;
use Magento\Framework\App\DeploymentConfig\Reader as ConfigReader;
use Magento\Framework\App\Filesystem\DirectoryList;

class ModuleTest extends \PHPUnit_Framework_TestCase
{
    /**
     * @var string
     */
    private $moduleName = 'Namespace_Module';

    /**
     * @test
     * @return void
     */
    public function itShouldBeKnownToMagento()
    {
        $this->assertTrue(
           $this->getNonIntegrationTestModuleList()->has($this->moduleName),
            sprintf('The module "%s" is not known', $this->moduleName)
        );
    }

    /**
     * @return ModuleList
     */
    private function getNonIntegrationTestModuleList()
    {
        return Bootstrap::getObjectManager()->create(
            ModuleList::class,
            ['config' => $this->getNonIntegrationTestDeploymentConfig()]
        );
    }

    /**
     * @return DeploymentConfig
     */
    private function getNonIntegrationTestDeploymentConfig()
    {
        return Bootstrap::getObjectManager()->create(
            DeploymentConfig::class,
            ['reader' => $this->getNonIntegrationTestConfigReader()]
        );
    }

    /**
     * @return ConfigReader
     */
    private function getNonIntegrationTestConfigReader()
    {
        return Bootstrap::getObjectManager()->create(
            ConfigReader::class,
            ['dirList' => $this->getNonIntegrationTestDirectoryList()]
        );
    }

    /**
     * @return DirectoryList
     */
    private function getNonIntegrationTestDirectoryList()
    {
        return Bootstrap::getObjectManager()->create(
            DirectoryList::class,
            ['root' => $this->getBaseDirectoryPath()]
        );
    }

    /**
     * @return string
     */
    private function getBaseDirectoryPath()
    {
        return Bootstrap::getObjectManager()
            ->get(\Magento\Framework\Filesystem::class)
            ->getDirectoryRead(DirectoryList::ROOT)
            ->getAbsolutePath();
    }
}

PS: 🔔 @maksek :)

[maksek]

Hi @Vinai, very good question. Basically we are creating integration test with assumption - "system up and running", and all modules enabled. If some modules is disabled, we just add to ignore list the tests. So, answering your questions - there is no "official" way to check for modules status, but if you want - feel free to implement and create PR.
Another point - if you have extensions which relied on another one, and you need alter behavior in the case (reason to have the validation in tests), maybe you need to choose another way for implementation with less coupling.

[Vinai]

I agree with the current state that it makes sense to enable modules during integration tests.
Otherwise it would not be possible to run tests against disabled modules during development, which probably is a common scenario.

I just was wondering if there is a way to set options for specific integration tests to configure the environment. If not, no prob. Thanks for the answer!