Using DocBlock Annotations
DocBlock annotations help to declare context in your code. In addition to built-in PHPUnit annotations , the Integration testing framework provides custom annotations described in this topic.
Quick overview
The following annotations are available in integration tests:
| Name | Annotation | Format | Description |
|---|---|---|---|
| Admin Configuration Fixture | @magentoAdminConfigFixture |
@magentoAdminConfigFixture <config_path> <config_value> |
Configures an admin setting for the test run. For example, to enable Captcha, you would use @magentoAdminConfigFixture admin/captcha/enable 1. |
| Application Isolation | @magentoAppIsolation |
@magentoAppIsolation enabled|disabled |
Enables or disables application isolation when you run tests. When enabled, an application state after a test run will be the same as before the test run. For example, you should enable it, when you want to create sessions in a test, but you don’t want them to affect other tests. |
| Configuration Fixture | @magentoConfigFixture |
@magentoConfigFixture [<store_code>_store] <config_path> <config_value> |
Sets up configuration settings for a particular test. The list of settings is stored in the core_config_data database table. After the test execution, the settings revert to their original state. |
| Database Isolation | @magentoDbIsolation |
@magentoDbIsolation enabled|disabled |
Enables or disables database isolation. Disabled by default, unless you are using @magentoDataFixture, in which case it is enabled by default. All data, required for a test, live during transaction only. Any test results won’t be written in a database. |
| Data Fixture | @magentoDataFixture |
@magentoDataFixture <script_filename>|<method_name>|<fully_qualified_class_name> [as:alias | with:{}] |
Points to a class or a method which creates testing entities (fixtures) for test execution. These are applied during the transaction. |
| Data Fixture Before Transaction | @magentoDataFixtureBeforeTransaction |
@magentoDataFixtureBeforeTransaction <script_filename>|<method_name> |
Points to a class or a method which creates testing entities (fixtures) for test execution before the transaction has begun. You will need to implement a rollback file for changes made here. (e.g. Fixture file my_fixture.php would also require a my_fixture_rollback.php that reverts the original fixture’s changed.) |
| Data Fixture Data Provider | @magentoDataFixtureDataProvider |
@magentoDataFixtureDataProvider <callable>|{} |
Points to a Data Provider callable method or contains an inline JSON string for Parameterized Data Fixtures. |
| Application Area | @magentoAppArea |
@magentoAppArea adminhtml|frontend|global |
Configures test environment in the context of specified application area. |
| Enable/Disable Cache | @magentoCache |
@magentoCache <type>|all enabled|disabled |
Enables or disables certain cache segment or all of them to prevent isolation problems. |
| Indexer Dimension Mode | @magentoIndexerDimensionMode |
@magentoIndexerDimensionMode <indexer> <mode> |
Sets the indexer dimension mode for the test run. More information can be found in the DevBlog. |
| Register Components | @magentoComponentsDir |
@magentoComponentsDir <dir_path> |
Registers fixture components from specified directory (recursively). Unregisters the components after the test is finished. |
Applying annotations
The Magento-specific annotations for integration tests are applied in the following order:
@magentoAppIsolation@magentoDbIsolation@magentoDataFixtureBeforeTransaction@magentoDataFixtureDataProvider@magentoDataFixture@magentoIndexerDimensionMode@magentoComponentsDir@magentoAppArea@magentoCache@magentoAdminConfigFixture@magentoConfigFixture
This order is necessary to meet the requirement of setting up the store-scoped configuration values for fixture stores (stores that are created by data fixtures).