Files
cacti/tests/Unit/DataCollection/Cmd/CmdPhpAllhostCronIntervalTest.php
Sean Mancini 96033267cb refactor(tests): reorganize unit tests into domain category folders (#7733)
* 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.
2026-08-16 19:23:31 -07:00

79 lines
3.3 KiB
PHP

<?php
/*
+-------------------------------------------------------------------------+
| Copyright (C) 2004-2026 The Cacti Group |
+-------------------------------------------------------------------------+
*/
/*
* Regression test for issue #7525 (cmd.php --allhost invocation ignored
* cron_interval when resetting rrd_next_step).
*
* The ranged (--first/--last) branch already changed the reset baseline
* (3rd UPDATE param) from 0 to $poller_interval when cron_interval !=
* poller_interval. The $allhost branch hardcoded 0 unconditionally. The fix
* applies the same cron_interval-aware conditional to $allhost's $params3.
*
* The $allhost branch is pulled directly out of cmd.php and wrapped in a
* throwaway function so the test exercises the shipped code rather than a
* re-typed copy of it, matching the extract-and-eval pattern used in
* SsNimbleAlletraVolumesWordAssemblyTest.php and
* Issue7070PercentileContractTest.php.
*/
$cmdPhpSource = file_get_contents(dirname(__DIR__, 4) . '/cmd.php');
preg_match('/^if \(\$allhost\) \{.*?^\}\n/ms', $cmdPhpSource, $allhostBlock);
test('the $allhost branch is present in cmd.php', function () use ($allhostBlock) {
expect($allhostBlock)->not->toBeEmpty();
});
// eval() here only wraps PHP regex-extracted from this repo's own cmd.php
// (not external/user input) into a throwaway function. Test-only. Guarded
// by function_exists() so re-running this file within the same process is safe.
if (!function_exists('cmd_php_allhost_params3')) {
eval('function cmd_php_allhost_params3(int $poller_interval, int $cron_interval, int $poller_id) {
$allhost = true;
' . $allhostBlock[0] . '
return $params3;
}');
}
test('cron_interval == poller_interval resets rrd_next_step to 0', function () {
$params3 = cmd_php_allhost_params3(300, 300, 1);
expect($params3)->toBe([300, 300, 0, 300, 1]);
});
test('cron_interval != poller_interval resets rrd_next_step to poller_interval, matching the ranged branch', function () {
$params3 = cmd_php_allhost_params3(60, 300, 1);
// before the fix this was hardcoded to 0 regardless of cron_interval
expect($params3)->toBe([60, 60, 60, 60, 1])
->and($params3[2])->not->toBe(0);
});
// the extracted block above is the full if ($allhost) {...} else {...}
// structure (the non-greedy match only stops at the bare top-level "}" that
// closes the whole statement, since the if-branch's own closing brace is
// immediately followed by " else {" on the same line, not a newline) -- so
// the same extraction can drive the ranged branch too, just by flipping the
// runtime $allhost flag the extracted code branches on.
if (!function_exists('cmd_php_ranged_params3')) {
eval('function cmd_php_ranged_params3(int $poller_interval, int $cron_interval, int $poller_id, $first, $last) {
$allhost = false;
' . $allhostBlock[0] . '
return $params3;
}');
}
test('the $allhost and ranged branches compute the same $params3 for a given cron_interval/poller_interval pair', function () {
$allhostParams = cmd_php_allhost_params3(60, 300, 1);
$rangedParams = cmd_php_ranged_params3(60, 300, 1, 5, 10);
// ranged appends $first/$last; the first 5 elements (the ones this fix
// touches) must stay in parity between both branches
expect(array_slice($rangedParams, 0, 5))->toBe($allhostParams);
});