Files
cacti/tests/Unit/Core/Rrd/RrdGprintCaseConsolidationTest.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

133 lines
4.7 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. |
| |
| This program is distributed in the hope that it will be useful, |
| but WITHOUT ANY WARRANTY; without even the implied warranty of |
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| GNU General Public License for more details. |
+-------------------------------------------------------------------------+
| Cacti: The Complete RRDtool-based Graphing Solution |
+-------------------------------------------------------------------------+
| This code is designed, written, and maintained by the Cacti Group. See |
| about.php and/or the AUTHORS file for specific developer information. |
+-------------------------------------------------------------------------+
| http://www.cacti.net/ |
+-------------------------------------------------------------------------+
*/
/**
* Test for GPRINT case consolidation refactoring
* Verifies that all four GPRINT_* types behave identically
*/
// Load Cacti constants for GRAPH_ITEM_TYPE_* definitions
require_once __DIR__ . '/../../../../include/global_constants.php';
// Mock the graph item behavior that the switch statement processes
function mockGraphItem(int $graphType, int $consolidationFunctionId): array
{
return [
'graph_type_id' => $graphType,
'consolidation_function_id' => $consolidationFunctionId,
'local_data_id' => 1,
];
}
// Extract the consolidation logic from the switch statement
function processGraphItemType(array $graphItem): ?int
{
switch ($graphItem['graph_type_id']) {
case GRAPH_ITEM_TYPE_GPRINT_AVERAGE:
case GRAPH_ITEM_TYPE_GPRINT_LAST:
case GRAPH_ITEM_TYPE_GPRINT_MAX:
case GRAPH_ITEM_TYPE_GPRINT_MIN:
// This is the consolidated logic
return $graphItem['consolidation_function_id'];
default:
return null;
}
}
test('GPRINT_AVERAGE uses consolidation_function_id directly', function () {
$cfId = 2; // Example CF ID
$item = mockGraphItem(GRAPH_ITEM_TYPE_GPRINT_AVERAGE, $cfId);
$result = processGraphItemType($item);
expect($result)->toBe($cfId);
});
test('GPRINT_LAST uses consolidation_function_id directly', function () {
$cfId = 3;
$item = mockGraphItem(GRAPH_ITEM_TYPE_GPRINT_LAST, $cfId);
$result = processGraphItemType($item);
expect($result)->toBe($cfId);
});
test('GPRINT_MAX uses consolidation_function_id directly', function () {
$cfId = 4;
$item = mockGraphItem(GRAPH_ITEM_TYPE_GPRINT_MAX, $cfId);
$result = processGraphItemType($item);
expect($result)->toBe($cfId);
});
test('GPRINT_MIN uses consolidation_function_id directly', function () {
$cfId = 5;
$item = mockGraphItem(GRAPH_ITEM_TYPE_GPRINT_MIN, $cfId);
$result = processGraphItemType($item);
expect($result)->toBe($cfId);
});
test('all four GPRINT types produce identical results for same CF ID', function () {
$cfId = 2;
$avgResult = processGraphItemType(mockGraphItem(GRAPH_ITEM_TYPE_GPRINT_AVERAGE, $cfId));
$lastResult = processGraphItemType(mockGraphItem(GRAPH_ITEM_TYPE_GPRINT_LAST, $cfId));
$maxResult = processGraphItemType(mockGraphItem(GRAPH_ITEM_TYPE_GPRINT_MAX, $cfId));
$minResult = processGraphItemType(mockGraphItem(GRAPH_ITEM_TYPE_GPRINT_MIN, $cfId));
expect($avgResult)
->toBe($lastResult)
->toBe($maxResult)
->toBe($minResult)
->toBe($cfId, 'All four GPRINT types should return the same CF ID');
});
test('GPRINT consolidation preserves individual CF ID values', function () {
$cfIds = [1, 2, 3, 4, 5];
$types = [
GRAPH_ITEM_TYPE_GPRINT_AVERAGE,
GRAPH_ITEM_TYPE_GPRINT_LAST,
GRAPH_ITEM_TYPE_GPRINT_MAX,
GRAPH_ITEM_TYPE_GPRINT_MIN
];
foreach ($cfIds as $cfId) {
foreach ($types as $type) {
$result = processGraphItemType(mockGraphItem($type, $cfId));
expect($result)
->toBe($cfId, "Type $type should preserve CF ID $cfId");
}
}
});
test('non-GPRINT types return null from consolidated case', function () {
// Test that other graph types don't match the consolidated GPRINT cases
$result = processGraphItemType(mockGraphItem(GRAPH_ITEM_TYPE_LINE1, 2));
expect($result)->toBeNull('Non-GPRINT types should not match consolidated cases');
});