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.
75 lines
3.8 KiB
PHP
75 lines
3.8 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 |
|
|
+-------------------------------------------------------------------------+
|
|
*/
|
|
|
|
/**
|
|
* Test for issue #6788: include_once replaced with require_once for core
|
|
* library files and plugin setup loaders so missing files produce immediate
|
|
* fatal errors rather than silent undefined-function failures downstream.
|
|
*/
|
|
|
|
test('include/global.php uses require_once for all core library includes', function () {
|
|
$source = file_get_contents(__DIR__ . '/../../../include/global.php');
|
|
|
|
expect($source)->not->toContain('include_once(');
|
|
expect($source)->toContain("require_once(CACTI_PATH_LIBRARY . '/database.php')");
|
|
});
|
|
|
|
test('lib/plugins.php uses require_once for plugin setup.php in install path', function () {
|
|
$source = file_get_contents(__DIR__ . '/../../../lib/plugins.php');
|
|
|
|
/* The install path now has an explicit file_exists guard followed by
|
|
* require_once — verify no bare include_once remains for setup.php. */
|
|
expect(preg_match('/include_once\s*\(\s*CACTI_PATH_PLUGINS/', $source))->toBe(0);
|
|
expect(preg_match('/require_once\s*\(\s*CACTI_PATH_PLUGINS/', $source))->toBe(1);
|
|
});
|
|
|
|
test('lib/plugins.php install path hard-fails with sanitized log when setup.php missing', function () {
|
|
$source = file_get_contents(__DIR__ . '/../../../lib/plugins.php');
|
|
|
|
/* Verify the file_exists guard exists before require_once in the install path. */
|
|
expect($source)->toContain("file_exists(CACTI_PATH_PLUGINS . \"/\$plugin/setup.php\")");
|
|
|
|
/* The log message must use preg_replace to strip non-safe chars from $plugin
|
|
* before interpolation, preventing pipe/newline injection into structured logs. */
|
|
expect($source)->toContain("preg_replace('/[^a-zA-Z0-9_\\-]/', '', \$plugin)");
|
|
|
|
/* raise_message must accompany the log call so the UI reflects the failure. */
|
|
expect($source)->toContain("raise_message('plugin_missing'");
|
|
});
|
|
|
|
test('lib/plugins.php uninstall and check_config silently skip missing setup.php (by design)', function () {
|
|
$source = file_get_contents(__DIR__ . '/../../../lib/plugins.php');
|
|
|
|
/* Install hard-fails (file_exists guard + exit) while uninstall/check_config
|
|
* use a silent-skip pattern (require_once only inside if (file_exists(...))).
|
|
* This asymmetry is intentional: install must be explicit; cleanup is best-effort. */
|
|
$uninstallGuards = preg_match_all('/file_exists\(CACTI_PATH_PLUGINS.*setup\.php.*\)/', $source);
|
|
expect($uninstallGuards)->toBeGreaterThanOrEqual(3);
|
|
});
|
|
|
|
test('cli/audit_database.php uses require_once inside file_exists guard', function () {
|
|
$source = file_get_contents(__DIR__ . '/../../../cli/audit_database.php');
|
|
|
|
expect($source)->not->toContain('include_once(');
|
|
expect($source)->toContain("require_once(\$plugin . '/setup.php')");
|
|
});
|
|
|
|
test('cli/audit_database.php inner includes/database.php load is guarded by file_exists', function () {
|
|
$source = file_get_contents(__DIR__ . '/../../../cli/audit_database.php');
|
|
|
|
/* Confirm includes/database.php is loaded with require_once and only when present. */
|
|
expect($source)->toContain("require_once(\$plugin . '/includes/database.php')");
|
|
expect($source)->toContain("file_exists(\$plugin . '/includes/database.php')");
|
|
});
|