AssertArtifactTask

MMO\admin\tasks · 1 symbol · generated 5 Oct 2026

class

AssertArtifactTask

Read the finished artifact back and refuse to ship it if it contains anything that must never leave a developer's machine.

class MMO\admin\tasks\AssertArtifactTask extends MMO\admin\classes\aDeployTask

Namespace: MMO\admin\tasks
Extends: aDeployTask

Three independent mechanisms keep dev-only files out of a release, and this is the last of them: 1. `export-ignore` in the project's `.gitattributes` -- honoured by `git archive` itself, on every branch and every machine, with no hook installed and no per-branch `.gitignore` to swap. This is the mechanism. 2. [`BuildTask::$exclude`](https://mcp.mmoframework.fr/documentation/mmo.admin/php/tasks/BuildTask.md#buildtask-exclude) -- a deny-list applied to the exported tree, for paths git does not track. 3. **This task** -- which trusts neither of the above and simply looks inside the tarball. The third one exists because the first two are configuration, and configuration is what gets forgotten when a new file is added. A deployment that leaks `deploy.json` or a private key is not a deployment that can be rolled back: the secret is on the server, in an artifact, in a backup, and quite possibly served over HTTP. So the check is not "warn and continue" -- it fails the release before anything is uploaded. Patterns are matched against release-relative paths, `*` matching within one segment and `**` across them.

Index

	FORBIDDEN	paths that must never be inside a release.
	allowed
	forbidden
	apply($context)	Inspecting an archive changes nothing, so this runs during a dry run too -- a plan that cannot tell you the release would be refused is not worth printing.
	getDescription()
	getPatterns()
	isChange()	It only ever reads: a release where this was the only thing that ran deployed nothing.
	isNeeded($context)	Nothing to check until something has been built.
	matches($path, $pattern)	Glob matching where `` stays inside one path segment and `*` crosses them -- the same rule `.gitignore` and `.gitattributes` use, so a pattern that works there works here.
	matchesAny($path, $patterns)
	plan($context)
	scan($context, $artifact)
	__construct($forbidden, $allowed)

Constants1

FORBIDDEN

paths that must never be inside a release.

const FORBIDDEN = […23 items]

Properties2

allowed

protected array $allowed

Type: array

forbidden

protected array $forbidden

Type: array

Methods10

apply($context)

AssertArtifactTask.php:80

Inspecting an archive changes nothing, so this runs during a dry run too -- a plan that cannot tell you the release would be refused is not worth printing.

function apply(MMO\admin\helpers\Context $context): void

$context	Context
returns	void
throws		when the artifact carries something it must not.

getDescription()

AssertArtifactTask.php:61

function getDescription(): string

returns

string

getPatterns()

AssertArtifactTask.php:130

function getPatterns(): array

returns

array

every pattern this task refuses.

isChange()

AssertArtifactTask.php:67

It only ever reads: a release where this was the only thing that ran deployed nothing.

function isChange(): bool

returns

bool

isNeeded($context)

AssertArtifactTask.php:64

Nothing to check until something has been built.

function isNeeded(MMO\admin\helpers\Context $context): bool

$context	Context
returns	bool

matches($path, $pattern)

AssertArtifactTask.php:148

Glob matching where * stays inside one path segment and ** crosses them -- the same rule .gitignore and .gitattributes use, so a pattern that works there works here.

protected function matches(string $path, string $pattern): bool

$path	string
$pattern	string
returns	bool

matchesAny($path, $patterns)

AssertArtifactTask.php:134

protected function matchesAny(string $path, array $patterns): bool

$path	string
$patterns	array
returns	bool

plan($context)

AssertArtifactTask.php:69

function plan(MMO\admin\helpers\Context $context): array

$context	Context
returns	array

scan($context, $artifact)

AssertArtifactTask.php:105

protected function scan(MMO\admin\helpers\Context $context, string $artifact): array

$context	Context
$artifact	string
returns	array	the release-relative paths that must not be there.

__construct($forbidden, $allowed)

AssertArtifactTask.php:54

function __construct(array $forbidden = [], array $allowed = [])

$forbidden = []	array
$allowed = []	array

Inherited members (38)

Constants	Declared by	Description
`ALERT`	iLogLevel	Alert: Action must be taken immediately.
`ALL`	iLogLevel	Mask for all
`ALL_PLUS`	iLogLevel	debug everything
`BACKTRACE`	iLogLevel
`CRITICAL`	iLogLevel	Critical: Critical conditions.
`DEBUG`	iLogLevel	Debug: Detailed debug information.
`DEEP`	iLogLevel	debug everything with arguments
`EMERGENCY`	iLogLevel	Emergency: System is unusable.
`ERROR`	iLogLevel	Error: Runtime errors that do not require immediate action but should typically be logged and monitored.
`ERROR_PLUS`	iLogLevel	Mask for all error
`FATAL`	iLogLevel	Mask for all fatal error
`INFO`	iLogLevel	Info: Interesting events.
`INFO_PLUS`	iLogLevel	Mask for all errors/warning/notices/info
`MEMORY`	iLogLevel	include backtrace object
`NOTICE`	iLogLevel	Notice: Normal but significant events.
`NOTICE_PLUS`	iLogLevel	Mask for all errors/warning/notices/info
`TRACE`	iLogLevel	include backtrace as origins
`WARNING`	iLogLevel	Warning: Exceptional occurrences that are not errors.
`WARNING_PLUS`	iLogLevel	Mask for all errors and warnings

	Properties	Declared by	Description
	`verbosity`	aDeployTask

Methods	Declared by	Description
`alert($message, $context)`	aDeployTask	Action must be taken immediately.
`backtraces($message, $context)`	aDeployTask	Force-log a message at INFO level together with a full stack trace/memory snapshot (`iLogLevel::BACKTRACE`), bypassing the verbosity mask entirely (any non-zero verbosity is enough to trigger it).
`critical($message, $context)`	aDeployTask	Critical conditions. No-op if CRITICAL is currently filtered out by the verbosity mask.
`debug($message, $context)`	aDeployTask	Detailed debug information.
`debugName()`	aDeployTask
`emergency($message, $context)`	aDeployTask	System is unusable. No-op if EMERGENCY is currently filtered out by the verbosity mask.
`error($message, $context)`	aDeployTask	Runtime errors that do not require immediate action but should typically be logged and monitored.
`getName()`	aDeployTask
`getVerbosity()`	aDeployTask
`info($message, $context)`	aDeployTask	Interesting events. No-op if INFO is currently filtered out by the verbosity mask.
`isRollbackCritical()`	aDeployTask
`log($level, $message, $context)`	aDeployTask	Logs with an arbitrary level.
`notice($message, $context)`	aDeployTask	Normal but significant events.
`rollback($context)`	aDeployTask	Undo this task. Called by the runner, in reverse order, for every task already applied when a later one failed.
`setVerbosity($verb)`	aDeployTask	Set the current verbosity mask, replacing whatever it was before.
`testVerbosity($level)`	aDeployTask	Test whether a given level (or set of levels) is currently enabled by this instance's verbosity mask.
`verify($context)`	aDeployTask	Check, by looking at the target, that the task really took effect.
`warning($message, $context)`	aDeployTask	Exceptional occurrences that are not errors.