mirror of
https://github.com/Cacti/cacti.git
synced 2026-10-25 20:48:28 +09:00
Sean Mancini
96033267cb
* refactor(tests): reorganize unit tests into domain category folders - Consolidate per-advisory GHSA regression tests into Security/ subfolders by vuln class - Group all 186 test files into domain folders: DataCollection/, Ui/, Core/, Database/, Installer/, Scripts/, Security/, Plugin/ - Strip GitHub issue/GHSA numbers from filenames; keep IDs in test descriptions - Fix all __DIR__ relative paths to match new folder nesting depth - Update CI workflow path triggers and phpunit XML configs for new file locations - Update .github/copilot-instructions.md with unit test organization guidelines - Add tests/vendor/ to .gitignore * add gaurds * fix up guard for unit tests * fix redeclaration of cacti_log in tests * fix updates to unit tests * fix test patjhs * fix: update test __DIR__ paths for reorganized test structure * fix: conditionally define read_user_setting to prevent redeclaration in tests * fix: conditionally define functions to prevent redeclaration in tests - Wrap clean_up_lines, raise_message, cacti_debug_backtrace, and get_debug_prefix with function_exists() checks to prevent conflicts when test stubs are loaded before lib/functions.php in the same PHP process * fix: add unit test bootstrap to prevent function redeclaration errors - Create tests/bootstrap-unit.php to load core libraries before tests - Ensures lib/functions.php loads before test stubs define stub functions - Test stubs use function_exists() checks, so they detect pre-loaded functions - Update phpunit.xml to use bootstrap-unit.php for Unit testsuite - Fixes 'Cannot redeclare read_user_setting()' errors when tests run in same process * fix: load test stubs before global.php in unit test bootstrap - Reorder bootstrap to load CactiStubs.php and UnitStubs.php first - Ensures stub functions like __() are available when global.php loads - global.php calls get_cacti_version_text() which needs __() for translations - Fixes 'Call to undefined function __()' error during bootstrap * fix: remove function conflicts from test stubs - Remove stub definitions for functions already in lib/functions.php: cacti_sizeof, cacti_log, cacti_strtolower, read_config_option, read_user_setting, cacti_count - Keep translation function stubs (__(), __esc()) needed by global.php - Update bootstrap to load lib/functions.php after stubs - This prevents function redeclaration errors while maintaining test isolation * fix: prevent constant and variable redeclaration in bootstrap - Remove explicit PHP_TESTING and CACTI_TEST_BOOTSTRAP defines from bootstrap (CactiStubs.php now handles this with guards) - Add guards to CactiStubs.php to prevent redefinition of PHP_TESTING - Only set CACTI_TEST_BOOTSTRAP env vars if not already set - Fixes PHP warnings about 'Constant X already defined' * fix: remove redundant lib/functions.php load from bootstrap include/global.php already loads lib/functions.php at lines 287-288. The bootstrap was trying to load it again after global.php, but global.php needs format_cacti_version() to be available on lines 293-294 to define CACTI_VERSION and CACTI_VERSION_FULL constants. Solution: Let global.php handle loading lib/functions.php itself, and don't load it separately in the bootstrap. * fix: remove more conflicting function stubs from test helpers - Remove stubs for functions also defined in lib/functions.php: raise_message, clean_up_lines, cacti_debug_backtrace, get_debug_prefix - Remove POLLER_ID constant stub (defined unconditionally by global.php) - Keep only translation functions and test-specific helpers - This prevents function/constant redeclaration errors * fix: minimize test stubs to only translation functions Remove ALL helper functions and constants from UnitStubs.php that are: - Defined in lib/functions.php (raise_message, clean_up_lines, etc.) - Defined in lib/html_utility.php (srv, set_request_var) - Defined in global_constants.php (POLLER_VERBOSITY_*, MESSAGE_LEVEL_*) - Defined in global.php (POLLER_ID) Keep ONLY translation functions (__(), __esc()) that are: - Called by global.php during initialization - Not defined elsewhere - Required for proper bootstrap sequence This eliminates all constant and function redeclaration errors. * fix: remove __esc stub - already defined in global_languages.php Keep only __() translation function stub, which is needed by global.php and not defined elsewhere in Cacti core. * fix: handle no-arg case in __() translation stub The __() function may be called with just a string and no format arguments. Previously, vsprintf() would fail with 'arguments array must contain 2 items'. Now, if no args are provided, return the text as-is.
60 lines
3.0 KiB
PHP
60 lines
3.0 KiB
PHP
<?php
|
|
/*
|
|
+-------------------------------------------------------------------------+
|
|
| Copyright (C) 2004-2026 The Cacti Group |
|
|
+-------------------------------------------------------------------------+
|
|
*/
|
|
|
|
/*
|
|
* Contract tests for poller.php's query-optimization fixes:
|
|
*
|
|
* #7529 -- three unscoped global aggregate scans (total_snmp_ports and the
|
|
* mutually-exclusive active_profiles pair) ran on every poller, including
|
|
* remote pollers, redundantly recomputing the same central-DB-wide answer.
|
|
* They must now be gated behind poller_id == 1, with remote pollers reading
|
|
* back the config option the central poller already stored.
|
|
*
|
|
* #7530 -- the process-leveling $sql_where used a non-sargable predicate
|
|
* (`rrd_next_step - $poller_interval <= 0`), preventing use of the
|
|
* poller_id_rrd_next_step index. The fix rewrites it as the algebraically
|
|
* equivalent, sargable `rrd_next_step <= $poller_interval`.
|
|
*/
|
|
|
|
$source = file_get_contents(dirname(__DIR__, 4) . '/poller.php');
|
|
|
|
test('the total_snmp_ports scan only runs on the central poller', function () use ($source) {
|
|
$pos = strpos($source, "COUNT(DISTINCT snmp_port)");
|
|
expect($pos)->not->toBeFalse();
|
|
|
|
// walk backwards to the nearest enclosing "if ($poller_id == 1) {"
|
|
$before = substr($source, 0, $pos);
|
|
$ifPos = strrpos($before, 'if ($poller_id == 1) {');
|
|
|
|
expect($ifPos)->not->toBeFalse('total_snmp_ports scan must be inside an if ($poller_id == 1) block');
|
|
|
|
// and there must be no closing brace of that if-block between it and the scan
|
|
$between = substr($source, $ifPos, $pos - $ifPos);
|
|
expect(substr_count($between, "\n}"))->toBe(0);
|
|
});
|
|
|
|
test('the active_profiles determination only runs on the central poller, with a remote fallback to read_config_option', function () use ($source) {
|
|
$pos = strpos($source, 'COUNT(DISTINCT data_source_profile_id)');
|
|
expect($pos)->not->toBeFalse();
|
|
|
|
$before = substr($source, 0, $pos);
|
|
$ifPos = strrpos($before, 'if ($poller_id == 1) {');
|
|
expect($ifPos)->not->toBeFalse('active_profiles determination must be inside an if ($poller_id == 1) block');
|
|
|
|
$block = substr($source, $ifPos, strpos($source, "set_config_option('active_profiles'", $pos) - $ifPos + 40);
|
|
expect($block)->toContain("db_fetch_cell('SELECT COUNT(DISTINCT rrd_next_step) FROM poller_item')");
|
|
|
|
// the else branch (remote pollers) must read the value back, not recompute it
|
|
$elsePos = strpos($source, "} else {\n\t// remote pollers read the value the central poller already computed and stored\n\t\$active_profiles = read_config_option('active_profiles');");
|
|
expect($elsePos)->not->toBeFalse('remote pollers must fall back to read_config_option(\'active_profiles\') instead of recomputing it');
|
|
});
|
|
|
|
test('the process-leveling predicate is sargable (no arithmetic on the indexed column)', function () use ($source) {
|
|
expect($source)->toContain("WHERE rrd_next_step <= \$poller_interval AND h.disabled = '' AND pi.poller_id = \$poller_id")
|
|
->and($source)->not->toContain('rrd_next_step - $poller_interval <= 0');
|
|
});
|