mirror of
https://github.com/Cacti/cacti.git
synced 2026-10-30 16:47:14 +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.
79 lines
3.0 KiB
PHP
79 lines
3.0 KiB
PHP
<?php
|
|
declare(strict_types = 1);
|
|
/*
|
|
+-------------------------------------------------------------------------+
|
|
| Copyright (C) 2004-2026 The Cacti Group |
|
|
+-------------------------------------------------------------------------+
|
|
| Cacti: The Complete RRDtool-based Graphing Solution |
|
|
+-------------------------------------------------------------------------+
|
|
*/
|
|
|
|
/**
|
|
* Regression test for VDEF emission in rrdtool_function_graph() (lib/rrd.php).
|
|
*
|
|
* The #6540 refactor moved the $vdef_cache reset into the per-item loop and
|
|
* dropped the '!' from the isset() guard. The condition was then always
|
|
* false: no VDEF: line was ever emitted, the cache entry was never written,
|
|
* and the later 'vdef' . generate_graph_def_name($vdef_cache[$key]) passed
|
|
* null to generate_graph_def_name(int), fataling any graph item with a VDEF.
|
|
*
|
|
* The fix restores !isset(), keeps the cache at function scope, guards the
|
|
* dereference, and excludes VDEF-backed items from XPORT (rrdtool xport only
|
|
* accepts DEF/CDEF references).
|
|
*
|
|
* @group regression
|
|
*/
|
|
|
|
function rrd_source(): string {
|
|
$src = file_get_contents(__DIR__ . '/../../../../lib/rrd.php');
|
|
expect($src)->not->toBeFalse('Failed to read lib/rrd.php');
|
|
|
|
return $src;
|
|
}
|
|
|
|
function vdef_block(string $src): string {
|
|
$start = strpos($src, 'GRAPH ITEMS: VDEFs START');
|
|
$end = strpos($src, 'GRAPH ITEMS: VDEFs END');
|
|
expect($start)->not->toBeFalse()
|
|
->and($end)->toBeGreaterThan($start);
|
|
|
|
return substr($src, $start, $end - $start);
|
|
}
|
|
|
|
test('the VDEF block builds only uncached VDEFs (!isset)', function () {
|
|
$block = vdef_block(rrd_source());
|
|
|
|
expect($block)->toContain('!isset($vdef_cache[$vdef_cache_key])')
|
|
->and($block)->toContain('$vdef_cache[$vdef_cache_key] = $i');
|
|
});
|
|
|
|
test('the VDEF cache is not reset inside the item loop', function () {
|
|
$src = rrd_source();
|
|
|
|
// no reset between the loop-local markers (the per-item VDEF block)
|
|
expect(preg_match('/\$vdef_cache\s*=\s*\[\]/', vdef_block($src)))->toBe(0);
|
|
|
|
// exactly one initialization, and it precedes the item loop's CDEF/VDEF blocks
|
|
expect(preg_match_all('/\$vdef_cache\s*=\s*\[\]/', $src, $m, PREG_OFFSET_CAPTURE))->toBe(1)
|
|
->and($m[0][0][1])->toBeLessThan(strpos($src, 'GRAPH ITEMS: CDEF START'));
|
|
});
|
|
|
|
test('the vdef data source name is only used when cached', function () {
|
|
$src = rrd_source();
|
|
|
|
expect(preg_match(
|
|
'/if \(\$graph_item\[\'vdef_id\'\] > 0 && isset\(\$vdef_cache\[\$vdef_cache_key\]\)\) \{\s*' .
|
|
'\$data_source_name = \'vdef\' \. generate_graph_def_name\(\$vdef_cache\[\$vdef_cache_key\]\);/',
|
|
$src
|
|
))->toBe(1);
|
|
});
|
|
|
|
test('XPORT emission excludes VDEF-backed items', function () {
|
|
$src = rrd_source();
|
|
|
|
// the AREA/STACK/LINE selector for xport must gate on vdef_id == 0 so a
|
|
// drawn VDEF item does not emit XPORT:vdefNN and fail the whole export
|
|
expect(preg_match('/^.*preg_match\(\'\/\^\(AREA\|AREA:STACK\|LINE\[123\]\|STACK\)\$\/\'.*$/m', $src, $m))->toBe(1)
|
|
->and($m[0])->toContain("\$graph_item['vdef_id'] == 0 &&");
|
|
});
|