mirror of
https://github.com/Vateron-Media/XC_VM.git
synced 2026-11-07 19:03:36 +01:00
Plan section 9, R1 `settings`: API nodes log unknown-key reads to
`audit.settings_misses`. Once a node's replica owns its settings, a key
outside lb_settings_keys.php is absent there, and the CI scan behind the
allowlist cannot see a key built at run time. The count names such reads
before they fail.
On the node (Core/Cluster/SettingsAudit): in mode 1 or 2, as the agent's
flows.json says (NodeFlows::declared, no database and no servers read),
each read through SettingsManager's getters (get, getBool, getInt,
getString, getArray, has) of a key outside the allowlist's `keys` and
`withheld` is counted. A process keeps its counts in memory and merges
them at exit, and every minute while it runs, into a per-day file under
its lock (STORAGE_PATH/cluster/settings_misses/YYYYMMDD.json). It then
writes config/cluster/audit.json, `{"settings_misses": {key: count}}`
over the last seven UTC days, which the agent is to send as the
heartbeat's `audit`. Everything is bounded: 64 names, the rest and any
key that is not a settings name under "*". cron:cleanup prunes the day
files after eight days and rewrites audit.json every hour, so old days
drop out; in mode 0 the file is removed. MAIN and legacy nodes have no
flows.json and count nothing; a read costs one lookup.
On MAIN (Domain/Cluster/NodeAudit): a heartbeat's `audit` is normalised
(names and positive integer counts only, at most 16 KiB, the least
missed past 64 names folded into "*") and kept in the new
cluster_nodes.audit (migration 045, mirrored in database.sql; 044 is taken
by work on another branch). It is written only when it differs from what
the row holds, which every request reads already, so an unchanged report
costs no query, on the cluster bus or not. A heartbeat without `audit`,
today's agent's, changes nothing. The Cluster Nodes page shows each mode 1
or 2 node's misses.
SettingsAuditTest covers the counting per getter, withheld keys not
counted, mode 0 and MAIN counting nothing, the merge across processes,
the caps, the seven-day window, the pruning, the empty report and the
minute's merge of a long-running process. ClusterApiTest covers the
heartbeat storing a report once, an unchanged, missing or malformed one
writing nothing, an empty one clearing the page, and the cap; and
ReplicaBootTest a child process's miss reaching audit.json at its exit,
while booting from the replica reads only allowlisted settings.
122 lines
4.0 KiB
PHP
122 lines
4.0 KiB
PHP
<?php
|
|
|
|
$projectRoot = dirname(__DIR__);
|
|
$srcRoot = $projectRoot . '/src';
|
|
$flatRoot = $projectRoot;
|
|
|
|
if (file_exists($srcRoot . '/vendor/autoload.php')) {
|
|
$appRoot = $srcRoot;
|
|
} elseif (file_exists($flatRoot . '/vendor/autoload.php')) {
|
|
$appRoot = $flatRoot;
|
|
} else {
|
|
throw new RuntimeException('Unable to locate vendor/autoload.php in expected project paths.');
|
|
}
|
|
|
|
// Silence error_log() diagnostics emitted by exercised code paths (ModuleLoader
|
|
// dependency skips, GitHubReleases version warnings, …) so the test run stays clean.
|
|
// No test asserts on this output; production behaviour is unchanged.
|
|
ini_set('error_log', '/dev/null');
|
|
|
|
$tmpRoot = __DIR__ . '/.tmp';
|
|
$binRoot = $tmpRoot . '/bin';
|
|
|
|
if (!is_dir($tmpRoot)) {
|
|
mkdir($tmpRoot, 0775, true);
|
|
}
|
|
if (!is_dir($binRoot)) {
|
|
mkdir($binRoot, 0775, true);
|
|
}
|
|
|
|
$fakeBinary = $binRoot . '/fake_bin.sh';
|
|
if (!file_exists($fakeBinary)) {
|
|
file_put_contents($fakeBinary, "#!/bin/sh\nexit 0\n");
|
|
chmod($fakeBinary, 0755);
|
|
}
|
|
|
|
if (!defined('MAIN_HOME')) {
|
|
define('MAIN_HOME', $appRoot . '/');
|
|
}
|
|
|
|
if (!defined('PHP_BIN')) {
|
|
define('PHP_BIN', PHP_BINARY);
|
|
}
|
|
// Extra OpenSSL entropy/seed used by Encryption (real value in AppConfig.php).
|
|
// Any stable value works for tests that round-trip encrypt/decrypt.
|
|
if (!defined('OPENSSL_EXTRA')) {
|
|
define('OPENSSL_EXTRA', 'test-openssl-extra');
|
|
}
|
|
// FfmpegPaths::binary() builds paths under BIN_PATH . 'ffmpeg_bin/<ver>/'. No such
|
|
// fixtures exist here, so lookups miss and the code falls back to FFMPEG_BIN_40.
|
|
if (!defined('BIN_PATH')) {
|
|
define('BIN_PATH', $binRoot . '/');
|
|
}
|
|
if (!defined('VOD_PATH')) {
|
|
define('VOD_PATH', $tmpRoot . '/vod/');
|
|
}
|
|
if (!is_dir(VOD_PATH)) {
|
|
mkdir(VOD_PATH, 0775, true);
|
|
}
|
|
|
|
foreach (array('40', '71', '80') as $version) {
|
|
$ffmpegConst = 'FFMPEG_BIN_' . $version;
|
|
$ffprobeConst = 'FFPROBE_BIN_' . $version;
|
|
if (!defined($ffmpegConst)) {
|
|
define($ffmpegConst, $fakeBinary);
|
|
}
|
|
if (!defined($ffprobeConst)) {
|
|
define($ffprobeConst, $fakeBinary);
|
|
}
|
|
}
|
|
|
|
if (!isset($_FILES)) {
|
|
$_FILES = array();
|
|
}
|
|
|
|
if (!function_exists('igbinary_serialize')) {
|
|
function igbinary_serialize($value) {
|
|
return serialize($value);
|
|
}
|
|
}
|
|
if (!function_exists('igbinary_unserialize')) {
|
|
function igbinary_unserialize($value) {
|
|
return unserialize($value);
|
|
}
|
|
}
|
|
|
|
require_once MAIN_HOME . 'vendor/autoload.php';
|
|
require_once __DIR__ . '/Unit/M3uParser/ExtCustomTag.php';
|
|
|
|
// Test support: in-memory SQLite harness for DB-touching repositories/services.
|
|
require_once __DIR__ . '/Support/TestDb.php';
|
|
require_once __DIR__ . '/Support/ClusterReference.php';
|
|
require_once __DIR__ . '/Support/FakeClusterCrypto.php';
|
|
require_once __DIR__ . '/Support/FakeSshFleet.php';
|
|
require_once __DIR__ . '/Support/BusServer.php';
|
|
require_once __DIR__ . '/Support/QueryLogDb.php';
|
|
require_once __DIR__ . '/Support/InstallSchema.php';
|
|
require_once __DIR__ . '/Support/ReplicaFixture.php';
|
|
|
|
// EventIngest's lane locks are real flock files. Without this they would land
|
|
// in the shared TMP_PATH or system temp dir, where suite runs from other
|
|
// checkouts contend on the same files: give each test process its own
|
|
// directory under tests/.tmp, removed when the process ends.
|
|
$ingestLockDir = $tmpRoot . '/cluster_ingest/' . getmypid() . '/';
|
|
\XcVm\Domain\Cluster\EventIngest::useLockDir($ingestLockDir);
|
|
register_shutdown_function(static function () use ($ingestLockDir): void {
|
|
foreach (glob($ingestLockDir . '*') ?: array() as $lockFile) {
|
|
@unlink($lockFile);
|
|
}
|
|
@rmdir($ingestLockDir);
|
|
});
|
|
|
|
// The node replica's ETag cache (ReplicaEtagCache) lives in TMP_PATH, which
|
|
// some tests define as a shared path, and many tests fix the cluster clock at
|
|
// the same instant, so a cached section would outlive the test that built it:
|
|
// off for the suite; a test that checks the caching gives it a directory.
|
|
\XcVm\Core\Cluster\ReplicaEtagCache::useDir(false);
|
|
|
|
// The settings-miss audit (SettingsAudit) counts reads on nodes in mode 1 or
|
|
// 2, and many tests point NodeFlows at such a file: off for the suite; a
|
|
// test that checks it gives it its own directories.
|
|
\XcVm\Core\Cluster\SettingsAudit::useDir(false);
|