Download the PHP package dashworthy/pest-plugin-arch-coverage without Composer

pest-plugin-arch-coverage

One architecture expectation for Pest: every class under a mapped source directory must have a test file at the mirrored position.

The motivating case is generated code. An agent told by a failing test that its action needs a test writes one; an agent told so by a document does not. So the failure names the paths that would satisfy it rather than restating the rule.

Installation

The expectation registers itself through Composer's autoload.files. There is nothing to publish and no service provider.

Usage

The verb takes a whole layer — every class beneath a source root — and requires each to have a test at the mirrored position. It does not single out a kind of class: an action, a model, and a data object under the root are all subject to it equally. There is no "Actions directory" to point at; you map the root, and every class below it is covered.

Point it at a namespace, and the map mirrors each matched class into a test root at the same relative path. A class at App\Domains\Platform\Billing\Actions\PublishPlanVersion requires a test at tests/Unit/Domains/Platform/Billing/Actions/PublishPlanVersionTest.php, and the failure names that exact path until it exists:

Sending one layer to a different suite

The map is an argument, not a config file, and the longest matching source root wins. That lets one layer inside the tree mirror somewhere else without restating its parent — here, controllers run through the framework, so they belong in the feature suite while everything else stays in the unit suite:

A controller matches both roots; the longer one wins, so its test is required under tests/Feature/Domains/... and not in the unit suite. A single global config listing roots could not express "this subtree, but not its parent".

Signature

Directories rather than namespaces, because a Pest test file declares no class: class_exists() is false for every test in a Pest suite, so whether a test exists is a question about a file.

Failures

One violation is reported per run. Pest\Arch\Blueprint::targeted() throws inside its own loop, so a convention failing across forty classes reports the first and you rerun for the next. Recovering aggregation would mean replacing Blueprint, which is a cost this package deliberately does not pay.

Deliberately not included

• The reverse direction — "this test file covers a class that no longer exists". Its subject is a Pest test file, and a Pest test file declares no class, so it never becomes an object arch can reason about at all.
• Symlink detection beneath a test root. It existed to protect a walk of the test tree, and there is no such walk in the forward direction. Roots reached through a symlink are still resolved, so a package symlinked into vendor/ compares equal to the same directory named literally.
• A config file. Every parameter is an argument at the call site.

Suppression

pest-plugin-arch honours @pest-arch-ignore-line and @pest-arch-ignore-next-line unconditionally, and that cannot be disabled from outside Blueprint. If suppression matters to you, police it with an ordinary arch test:

Licence

MIT.