Magento 2 integration test in admin context

Question

I'm writing an integration test for Magento 2 where I have to emulate the admin area.

To do so, I use the @magentoAppArea annotation:

/**
 * @magentoAppArea adminhtml
 */

However, some things did not work as expected and I found out that the current store id is set to "1" (default store) instead of "0" (admin store)

Here's a failing test as minimum example:

/**
 * @magentoAppArea adminhtml
 */
public function testAdminarea()
{
    $storeManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()
        ->get(\Magento\Store\Model\StoreManagerInterface::class);
    $this->assertEquals(0, $storeManager->getStore()->getId());
}

How do I set up this test correctly?

---

What I found during debugging:

1. Magento\TestFramework\Application::loadArea('adminhtml') is triggered correctly.

2. The store id is first initialized in Magento\Store\Model\StoreResolver::getStoresData():

   $cacheKey = 'resolved_stores_' . md5($this->runMode . $this->scopeCode);
   $cacheData = $this->cache->load($cacheKey);
   

   Where $this->runMode is "website" and $this->scopeCode is "null".

Answer 1

I think the assumption that the admin store is always active in the adminhtml scope might no longer be true in Magento 2.
I have not found any constant with an admin store ID of zero anywhere. Probably that should also no longer be assumed to be the case.

The app state and the scope are both set to adminhtml by the annotation test listener, which probably is enough to trigger complete backend behavior.
I'm not sure though. What do you want to actually test?

/**
 * @magentoAppArea adminhtml
 */
public function testBackendScopeIsSet()
{
    /** @var ObjectManager $objectManager */
    $objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();

    /** @var \Magento\TestFramework\App\State $state */
    $state = $objectManager->get(\Magento\TestFramework\App\State::class);
    $this->assertSame(Area::AREA_ADMINHTML, $state->getAreaCode());

    /** @var \Magento\Framework\Config\Scope $scope */
    $scope = $objectManager->get(\Magento\Framework\Config\Scope::class);
    $this->assertSame(Area::AREA_ADMINHTML, $scope->getCurrentScope());
}

Should your test require the admin store to be active you will also need to set that up manually in the arrange section of the test:

    /** @var StoreManagerInterface $storeManager */
    $storeManager = $objectManager->get(StoreManagerInterface::class);
    $storeManager->setCurrentStore(Store::ADMIN_CODE);

    $this->assertEquals(0, $storeManager->getStore()->getId());

Answer 2

I'm pretty sure it should work without anything else.

Basically the @magentoAppArea annotation is defined under /dev/tests/integration/framework/Magento/TestFramework/Annotation/AppArea.php so if I'm not sure if the annotation would work if the test class is sitting under app/code/Vendor/Module/TestFolder

What that class does is to reinitialize then load the area you specified:

public function startTest(\PHPUnit_Framework_TestCase $test)
{
    $area = $this->_getTestAppArea($test->getAnnotations());
    if ($this->_application->getArea() !== $area) {
        $this->_application->reinitialize();

        if ($this->_application->getArea() !== $area) {
            $this->_application->loadArea($area);
        }
    }
}

The loadArea method is defined under /dev/tests/integration/framework/Magento/TestFramework/Application.php and does the following:

• change the scope
• reconfigure the OM based on the area config

• load the area

  public function loadArea($areaCode)
  {
      $this->_appArea = $areaCode;
      $scope = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->get('Magento\Framework\Config\Scope');
      $scope->setCurrentScope($areaCode);
      \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->configure(
          \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->get(
              'Magento\Framework\App\ObjectManager\ConfigLoader'
          )->load(
              $areaCode
          )
      );
      $app = \Magento\TestFramework\Helper\Bootstrap::getObjectManager()->get('Magento\Framework\App\AreaList');
      if ($areaCode == \Magento\TestFramework\Application::DEFAULT_APP_AREA) {
          $app->getArea($areaCode)->load(\Magento\Framework\App\Area::PART_CONFIG);
      } else {
          \Magento\TestFramework\Helper\Bootstrap::getInstance()->loadArea($areaCode);
      }
  }
  

Maybe this is where you should start debugging.