Index

TestsController

MMO\client\controllers · 1 symbol · generated 30 Sep 2026

class

TestsController

TestsController.php:38

The http face of the javascript test suite: lists what can be run, and runs it.

class MMO\client\controllers\TestsController extends MMO\core\classes\aController
Namespace
MMO\client\controllers
Extends
aController
Two routes, both of which are what `<mmo-js-tests>` calls: - `GET tests/js.json` the namespaces the suite holds, and whether it can run here; - `POST tests/js/run.json` runs one namespace, or all of them, and answers the report. Both shell out to the package's own node runner (`tests/js-node/run.js`, `its` README) in its `--json` mode. The runner stays the single source of truth: this controller starts a process and hands back what it printed, it does not reimplement any part of running a test. ### Who may call it Running this spawns a process on the server. That is a development tool, not a feature, so the controller answers 403 outside of development unless an application explicitly says otherwise ([`$devOnly`](https://mmoframework.fr/documentation/mmo.client/php/controllers/TestsController.md#testscontroller-devonly)) -- and it is moot in a release anyway, since `tests/` is excluded from one (`scripts/admin.php`). ### What reaches the shell One argument does: the namespace filter. It is checked against [`NAMESPACE_REGEX`](https://mmoframework.fr/documentation/mmo.client/php/controllers/TestsController.md#testscontroller-namespace-regex) and then escaped with `escapeshellarg()` rather than handed to `\MMO\core\shell\serialize()`, whose positional arguments are concatenated unescaped. Nothing else in the command comes from the request. ```json // POST tests/js/run.json {"filter": "core.Map"} ```

Index

NAMESPACE_REGEX
devOnly
node
timeout
check($route)
decode($route, $stdout, $stderr)
DefaultConfig() static
getRunner()
routeList($route)The namespaces the suite holds.
routeRun($route)Run the suite, or the part of it a filter names.
run($args)Run the node runner and give back what it printed.

Constants1

NAMESPACE_REGEX

const NAMESPACE_REGEX = '/^[A-Za-z0-9._]{0,120}$/'

Properties3

devOnly

protected bool $devOnly = true
Type
bool

node

protected string $node = 'node'
Type
string

timeout

protected int $timeout = 120
Type
int

Methods7

check($route)

TestsController.php:78
protected function check(MMO\core\server\Route $route): void
$routeRoute
returnsvoid
throwswhen the suite may not be run over http here, or is not installed

decode($route, $stdout, $stderr)

TestsController.php:114
protected function decode(MMO\core\server\Route $route, string $stdout, string $stderr): array
$routeRoute
$stdoutstringwhat the runner printed
$stderrstringwhat it printed on the error stream, shown when stdout is not json
returnsarraythe report
throwswhen the runner did not answer json -- a missing node, a crash, a missing jsdom

getRunner()

TestsController.php:69
protected function getRunner(): string
returnsstringthe runner's folder, which is also the working directory a run needs: the runner resolves the sources and the fixtures relative to itself.

routeList($route)

TestsController.php:135

The namespaces the suite holds. Answers before anything is run, so a page can draw its picker.

#[MMO\core\attributes\APIRoute('GET|tests/js.json', […2 items], mediaTypes: ['json'])] function routeList(MMO\core\server\Route $route): array
$routeRoute
returnsarray{namespaces: string[]}

routeRun($route)

TestsController.php:154

Run the suite, or the part of it a filter names.

#[MMO\core\attributes\APIRoute('POST|tests/js/run.json', […2 items], mediaTypes: ['json'])] function routeRun(MMO\core\server\Route $route): arrayA failing test is not a failing request: the report says so, with the assertion message and the console output of every test, and the route answers 200. Only the runner itself failing is a 500.
$routeRoute
returnsarraythe runner's report
throwswhen the filter is not a test namespace

run($args)

TestsController.php:94

Run the node runner and give back what it printed.

protected function run(array $args): array
$argsarraythe runner's arguments, already safe to pass to a shell
returnsarrayint, 1: string, 2: string} exit code, stdout, stderr
Inherited members (55)
ConstantsDeclared byDescription
ALERTiLogLevelAlert: Action must be taken immediately.
ALLiLogLevelMask for all
ALL_PLUSiLogLeveldebug everything
BACKTRACEiLogLevel
CRITICALiLogLevelCritical: Critical conditions.
DEBUGiLogLevelDebug: Detailed debug information.
DEEPiLogLeveldebug everything with arguments
EMERGENCYiLogLevelEmergency: System is unusable.
ERRORiLogLevelError: Runtime errors that do not require immediate action but should typically be logged and monitored.
ERROR_PLUSiLogLevelMask for all error
FATALiLogLevelMask for all fatal error
INFOiLogLevelInfo: Interesting events.
INFO_PLUSiLogLevelMask for all errors/warning/notices/info
MEMORYiLogLevelinclude backtrace object
NOTICEiLogLevelNotice: Normal but significant events.
NOTICE_PLUSiLogLevelMask for all errors/warning/notices/info
TRACEiLogLevelinclude backtrace as origins
WARNINGiLogLevelWarning: Exceptional occurrences that are not errors.
WARNING_PLUSiLogLevelMask for all errors and warnings
PropertiesDeclared byDescription
verbosityaModule
MethodsDeclared byDescription
alert($message, $context)aModuleAction must be taken immediately.
backtraces($message, $context)aModuleForce-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).
Configure($config)aModuleMerge $config into this module's configuration in the shared Configuration.
critical($message, $context)aModuleCritical conditions. No-op if CRITICAL is currently filtered out by the verbosity mask.
debug($message, $context)aModuleDetailed debug information.
debugName()aModuleHuman-readable identifier used as the default {origin} in this instance's log messages.
emergency($message, $context)aModuleSystem is unusable. No-op if EMERGENCY is currently filtered out by the verbosity mask.
error($message, $context)aModuleRuntime errors that do not require immediate action but should typically be logged and monitored.
ExtractRoutes($config)aControllerExtract all the APIRoute from this class, regardless of the fact they are registered in the application
getVerbosity()aModule
HasRoutes()aControllerTells if any APIRoute are registered in the application
info($message, $context)aModuleInteresting events. No-op if INFO is currently filtered out by the verbosity mask.
Instantiate($config)aModule(Re)create the shared instance immediately, configured with $config merged into the class's existing config.
IsShared()aModule
Link($method, $data)aControllerBuild a Link (URL + label/icon/description/title, taken from the route's APIRoute metadata) for a registered route.
log($level, $message, $context)aModuleLogs with an arbitrary level.
notice($message, $context)aModuleNormal but significant events.
offsetExists($key)aModule\ArrayAccess::offsetExists -- tells whether $key is a declared property at all, regardless of whether it is currently readable/writable through array access.
offsetGet($key)aModule\ArrayAccess::offsetGet -- reads a property directly, unless it has a #[Serialize(serialize: 'methodName')] attribute, in which case that zero-argument method is called instead (e.g.
offsetSet($key, $value)aModule\ArrayAccess::offsetSet -- sets a property directly, unless it has a #[Serialize(unserialize: 'methodName')] attribute, in which case that method is called with $value instead (e.g.
offsetUnset($key)aModule\ArrayAccess::offsetUnset -- equivalent to $module[$key] = null.
onRoute($route)aControllerThis function is called before any api route declared.
Route($method)aControllerGet a registered APIRoute WARNING: if this class was not registered in the application, it will return null.
Routes()aControllerGet a list of registered APIRoutes (from this class) in the application WARNING: if this class was not registered in the application, it will return an empty array.
serialize($path, $serializer)aModule\MMO\core\interfaces\iSerializable::serialize -- exports every property (via
setVerbosity($verb)aModuleSet the current verbosity mask, replacing whatever it was before.
Shared()aModuleGet the shared instance, creating (and configuring) it on first call.
testVerbosity($level)aModuleTest whether a given level (or set of levels) is currently enabled by this instance's verbosity mask.
traitUnshare($serialize)aModuleRemove the shared instance, so the next Shared() call creates a fresh one.
unserialize($data, $path, $instances)aModule\MMO\core\interfaces\iSerializable::unserialize -- merges $data onto DefaultConfig, runs it through the (possibly overridden) constructor, then applies each resulting value to its property (via
Unshare($serialize)aModuleLike tSingleton::Unshare, but also disconnects this module's instance from every event it was listening to (via Event::DisconnectListeners) before dropping it.
Url($method, $data)aControllerBuild the URL for a registered route, filling in any {placeholder} from $data.
warning($message, $context)aModuleExceptional occurrences that are not errors.
__construct($config)aModuleprotected constructor, so it is not possible to do new Module(...) called by the serialization process just before being injected with data.
__wakeup()aControllerCalled automatically right after the controller's shared instance is built (aModule::unserialize): registers onRoute as a Route listener with a low priority (-10), so it…