mirror of
https://github.com/Cacti/plugin_thold.git
synced 2026-10-25 12:36:53 +09:00
TheWitnessandCopilot
9b217e0e3a
* INFO: set compat to 1.2.32 * docs: update Copilot instructions Cacti baseline to 1.2.32 (matches INFO compat) * INFO: back off compat to 1.2.29 * Add manifest.json + upgrade-time file pruning * Prune phpunit.xml on upgrade and ignore markdown-lint configs phpunit.xml ships in the repo for CI but is a dev-only test artifact, so it is removed from manifest.json 'expected', pruned from installs on upgrade (like tests/), and excluded from the manifest drift check. The retired markdown-lint configs (.mdlrc, .md_style.rb) are deleted, and .md* is now ignored like .git*: protected from pruning and excluded from drift if it reappears. * Move thold_functions.php and thold_webapi.php into includes/; flatten css The main threshold library becomes includes/functions.php and the web API helper becomes includes/webapi.php; every caller (setup.php, includes/*, the CLI/poller/notify entry points and the test suite) loads them from includes/. Each per-theme stylesheet css/<theme>/main.css becomes css/<theme>.css so users can drop their own css/<theme>.css into the css base, and the page_head hook looks there. Old paths are tombstoned so existing installs drop the stale copies on upgrade. * Regenerate cacti.pot for the includes/ file relocations Moving the plugin's library files into includes/ changed the source-reference lines in the translation template; regenerate it so the 'Verify translation template' CI check passes. * Harden the hook-include test and make RPN integer ops explicit The HookFunctionsIncludeTest invokes real hooks with placeholder input purely to execute their relocated include_once lines; it now swallows engine notices/warnings/deprecations during those calls (and restores the error handler and config afterward) so it cannot trip the suite's failOnDeprecation or leak state into other tests. The RPN % and ^ operators now cast their operands to int explicitly, matching their long-standing integer-truncation behaviour while silencing the implicit float-to-int conversion deprecation. * Harden prune against tampered-manifest path traversal The upgrade-time prune now rejects any tombstone containing '.'/'..' segments (which could escape the plugin directory or resolve to its root) and treats ancestors of whitelist entries as protected, so a tombstone on a parent directory can no longer delete a whitelisted file beneath it. * docs: update and align the Project Structure block Point the structure tree at the relocated files (libraries now under includes/, data files under docs/, stylesheets under css/) and align the trailing '# ...' comments to a single column so they no longer drift right. * docs/tests: standardize test header and correct manifest-contract notes - Use the full license header (from the plugin's own setup.php) in tests/Unit/PruneFilesTest.php instead of the abbreviated copyright banner. - Document that the manifest drift check and the upgrade-time prune also handle phpunit.xml and .md* files, matching the implemented behavior. * refactor: rename prune helpers to the plugin-slug function prefix The repository naming contract reserves the plugin_<name>_ prefix for plugin lifecycle / hook-registration functions; all other functions use the plain <name>_ prefix. Rename the internal upgrade helpers accordingly: plugin_<name>_prune_files() -> <name>_prune_files() plugin_<name>_rmtree() -> <name>_rmtree() The call site, unit tests, and the copilot-instructions.md references are updated to match. No behavioral change. * chore: set the Cacti compatibility floor to 1.2.29 Align the compat metadata (and the contributor-guide references) with the team decision to standardize the minimum supported Cacti version at 1.2.29; the previously proposed 1.2.32 floor was not adopted. --------- Co-authored-by: Copilot <copilot@users.noreply.github.com>
64 lines
2.2 KiB
PHP
64 lines
2.2 KiB
PHP
<?php
|
|
/*
|
|
+-------------------------------------------------------------------------+
|
|
| Copyright (C) 2004-2026 The Cacti Group |
|
|
+-------------------------------------------------------------------------+
|
|
*/
|
|
|
|
/*
|
|
* Several hooks lazy-load the threshold library on demand. After its move to
|
|
* includes/functions.php, invoke each one so the relocated include_once path
|
|
* is exercised; a bad relocation would surface here. The hooks run against the
|
|
* bootstrap's Cacti stubs and any downstream error is irrelevant to the goal.
|
|
*/
|
|
|
|
beforeAll(function () {
|
|
require_once __DIR__ . '/../../setup.php';
|
|
require_once __DIR__ . '/../../includes/polling.php';
|
|
});
|
|
|
|
it('resolves includes/functions.php from every hook that lazy-loads it', function () {
|
|
$restoreBase = $GLOBALS['config']['base_path'] ?? null;
|
|
$restoreOpts = CactiStubs::$configOptions;
|
|
$GLOBALS['config']['base_path'] = dirname(__DIR__, 4);
|
|
CactiStubs::$configOptions['alert_deadnotify'] = 'on';
|
|
|
|
$hooks = [
|
|
static fn () => thold_rrd_graph_graph_options([]),
|
|
static fn () => thold_device_action_execute('thold'),
|
|
static fn () => thold_api_device_new([]),
|
|
static fn () => thold_api_device_save([]),
|
|
static fn () => thold_data_source_action_execute(''),
|
|
static fn () => thold_graphs_action_execute(''),
|
|
static fn () => thold_create_graph_thold([]),
|
|
static fn () => thold_data_source_remove([]),
|
|
static fn () => thold_clog_regex_threshold([]),
|
|
static fn () => thold_update_host_status(),
|
|
];
|
|
|
|
// This suite runs failOnDeprecation/Warning/Notice; feeding the hooks
|
|
// placeholder input legitimately trips those, so swallow engine messages
|
|
// while the include_once lines execute, then return control to PHPUnit.
|
|
set_error_handler(static fn (): bool => true);
|
|
|
|
try {
|
|
foreach ($hooks as $hook) {
|
|
ob_start();
|
|
|
|
try {
|
|
$hook();
|
|
} catch (\Throwable $e) {
|
|
// Reaching the include_once at the top of each hook is the point.
|
|
} finally {
|
|
ob_end_clean();
|
|
}
|
|
}
|
|
} finally {
|
|
restore_error_handler();
|
|
CactiStubs::$configOptions = $restoreOpts;
|
|
$GLOBALS['config']['base_path'] = $restoreBase;
|
|
}
|
|
|
|
expect(function_exists('plugin_thold_csp_nonce'))->toBeTrue();
|
|
});
|