mirror of
https://github.com/Cacti/plugin_thold.git
synced 2026-10-24 20:16:58 +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>
90 lines
3.7 KiB
PHP
90 lines
3.7 KiB
PHP
<?php
|
|
/*
|
|
+-------------------------------------------------------------------------+
|
|
| Copyright (C) 2004-2026 The Cacti Group |
|
|
| |
|
|
| This program is free software; you can redistribute it and/or |
|
|
| modify it under the terms of the GNU General Public License |
|
|
| as published by the Free Software Foundation; either version 2 |
|
|
| of the License, or (at your option) any later version. |
|
|
+-------------------------------------------------------------------------+
|
|
| Cacti: The Complete RRDtool-based Graphing Solution |
|
|
+-------------------------------------------------------------------------+
|
|
| http://www.cacti.net/ |
|
|
+-------------------------------------------------------------------------+
|
|
*/
|
|
|
|
/*
|
|
* Integration coverage for the plugin lifecycle in setup.php:
|
|
* plugin_thold_uninstall()'s side effects, plugin_thold_version()'s INFO
|
|
* parsing, and plugin_thold_upgrade()'s page/version gating (the paths that
|
|
* return before ever reaching the full plugin_thold_install(true) reinstall,
|
|
* which needs a live Cacti include/database.php and is out of scope here).
|
|
*/
|
|
|
|
require_once dirname(__DIR__, 2) . '/setup.php';
|
|
|
|
beforeEach(function () {
|
|
CactiStubs::reset();
|
|
});
|
|
|
|
it('reads name and version from INFO', function () {
|
|
$info = plugin_thold_version();
|
|
|
|
expect($info)->toHaveKey('name');
|
|
expect($info)->toHaveKey('version');
|
|
expect($info['name'])->toBe('thold');
|
|
});
|
|
|
|
it('removes thold settings on uninstall', function () {
|
|
plugin_thold_uninstall();
|
|
|
|
$calls = CactiStubs::callsTo('db_execute');
|
|
|
|
expect($calls)->not->toBeEmpty();
|
|
expect($calls[0]['sql'])->toContain('DELETE FROM settings');
|
|
expect($calls[0]['sql'])->toContain('thold');
|
|
});
|
|
|
|
it('does not check for an upgrade on pages outside its allow-list', function () {
|
|
CactiStubs::willReturn('get_current_page', 'graphs.php');
|
|
|
|
expect(plugin_thold_upgrade())->toBeFalse();
|
|
expect(CactiStubs::callsTo('db_fetch_cell'))->toBeEmpty();
|
|
});
|
|
|
|
it('does not reinstall when the installed version already matches', function () {
|
|
CactiStubs::willReturn('get_current_page', 'thold.php');
|
|
CactiStubs::willReturnFor('db_fetch_cell', 'plugin_config', plugin_thold_version()['version']);
|
|
|
|
expect(plugin_thold_upgrade())->toBeTrue();
|
|
expect(CactiStubs::callsTo('api_plugin_register_hook'))->toBeEmpty();
|
|
});
|
|
|
|
it('prunes bundled dev-only files on a version-drift upgrade', function () {
|
|
CactiStubs::willReturn('get_current_page', 'thold.php');
|
|
CactiStubs::willReturnFor('db_fetch_cell', 'plugin_config', '0.0.0');
|
|
|
|
// Force plugin_thold_install(true) to short-circuit immediately (its
|
|
// version_compare guard) so this exercises the drift branch + prune call
|
|
// without the full reinstall, which needs a live Cacti include/database.php.
|
|
$restoreCacti = $GLOBALS['config']['cacti_version'];
|
|
$GLOBALS['config']['cacti_version'] = '1.1';
|
|
|
|
// Sandbox base_path so thold_prune_files() runs against a throwaway
|
|
// tree with a copy of the real INFO (so plugin_thold_version() still
|
|
// matches) and no manifest.json (prune no-ops), never the real checkout.
|
|
$restoreBase = $GLOBALS['config']['base_path'];
|
|
$base = sys_get_temp_dir() . '/thold-itest-' . uniqid();
|
|
mkdir($base . '/plugins/thold', 0777, true);
|
|
copy(dirname(__DIR__, 2) . '/INFO', $base . '/plugins/thold/INFO');
|
|
$GLOBALS['config']['base_path'] = $base;
|
|
|
|
try {
|
|
expect(plugin_thold_upgrade())->toBeTrue();
|
|
} finally {
|
|
$GLOBALS['config']['base_path'] = $restoreBase;
|
|
$GLOBALS['config']['cacti_version'] = $restoreCacti;
|
|
}
|
|
});
|