mirror of
https://github.com/Cacti/cacti.git
synced 2026-10-25 04:27:56 +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.
77 lines
3.0 KiB
PHP
77 lines
3.0 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 |
|
|
+-------------------------------------------------------------------------+
|
|
*/
|
|
|
|
/*
|
|
* Tests for the unresolved substitution variable warning (#3744).
|
|
*
|
|
* get_full_script_path() and get_full_test_script_path() null out
|
|
* <field> tokens that no data input field resolved. That keeps the
|
|
* script runnable but silently shifts positional arguments. The fix
|
|
* logs a warning naming the unresolved tokens before stripping them.
|
|
*
|
|
* SYNC WARNING: detect_unresolved_tokens() mirrors the guard in
|
|
* lib/functions.php. Production functions require DB state, so the
|
|
* logic is replicated here for behavioral coverage.
|
|
*/
|
|
|
|
function detect_unresolved_tokens(string $full_path): array {
|
|
preg_match_all('/<[A-Za-z0-9_]+>/', $full_path, $matches);
|
|
|
|
return array_values(array_unique($matches[0]));
|
|
}
|
|
|
|
function strip_unresolved_tokens(string $full_path): string {
|
|
return preg_replace('/(<[A-Za-z0-9_]+>)+/', '', $full_path) ?? '';
|
|
}
|
|
|
|
test('fully substituted command produces no tokens and no warning', function () {
|
|
$cmd = "/usr/bin/php -q script.php '10.0.0.1' 'public'";
|
|
|
|
expect(detect_unresolved_tokens($cmd))->toBe([])
|
|
->and(strip_unresolved_tokens($cmd))->toBe($cmd);
|
|
});
|
|
|
|
test('unresolved field token is detected and named', function () {
|
|
$cmd = "/usr/bin/php -q script.php <hostname> 'public'";
|
|
|
|
expect(detect_unresolved_tokens($cmd))->toBe(['<hostname>']);
|
|
});
|
|
|
|
test('duplicate unresolved tokens are reported once', function () {
|
|
$cmd = 'script.sh <hostname> <hostname> <index>';
|
|
|
|
expect(detect_unresolved_tokens($cmd))->toBe(['<hostname>', '<index>']);
|
|
});
|
|
|
|
test('stripping preserves the argument-offset behaviour being warned about', function () {
|
|
$cmd = 'script.sh <hostname> arg2 arg3';
|
|
|
|
// after the strip, arg2 shifts into the hostname position: the reason the warning exists
|
|
expect(strip_unresolved_tokens($cmd))->toBe('script.sh arg2 arg3');
|
|
});
|
|
|
|
test('path placeholders and shell redirects are not treated as tokens', function () {
|
|
// '2>' and '<file' are not <word> tokens; resolved values are quoted strings
|
|
$cmd = "script.sh 'a' 2>/dev/null";
|
|
|
|
expect(detect_unresolved_tokens($cmd))->toBe([]);
|
|
});
|
|
|
|
test('consecutive tokens strip as one group, matching legacy behaviour', function () {
|
|
$cmd = 'script.sh <a><b> tail';
|
|
|
|
expect(detect_unresolved_tokens($cmd))->toBe(['<a>', '<b>'])
|
|
->and(strip_unresolved_tokens($cmd))->toBe('script.sh tail');
|
|
});
|