magento / magento/magento-coding-standard

`@magentoAppArea` annotation REQUIRED for Controllers Integration Tests

Open
#175 3 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

proposal
Dominant language
PHP
Stars
375
Forks
165
PR merge metrics
No merged PRs in 30d

Description

### Rule
Integration Test class should contain
```php
/**
* @magentoAppArea adminhtml
*/
```

### Reason
This is required annotation to specify the area code for Controllers.
Integration Tests fail when it's missing.

### Implementation

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the repository's existing PHP coding-standard rules and how they inspect integration-test classes. Determine where controller integration tests are identified and how annotations are validated. Done means the standard reliably reports controller integration tests missing @magentoAppArea, with coverage for the adminhtml example described here.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.