Files
cacti/tests/Unit/Security/SqlInjection/InClausePlaceholderTest.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

70 lines
3.3 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 |
+-------------------------------------------------------------------------+
*/
// Proves the IN-clause placeholder rewrite used to parameterise purge_old_graphs()
// targets the same rows as the previous implode(',', $ids) form.
require_once dirname(__DIR__, 3) . '/Helpers/UnitStubs.php';
// The exact placeholder builder used at the call sites.
$in_placeholders = static fn (array $ids): string => trim(str_repeat('?, ', cacti_sizeof($ids)), ', ');
test('placeholder count matches the id count', function () use ($in_placeholders) {
expect($in_placeholders(array(5, 12, 88)))->toBe('?, ?, ?');
expect($in_placeholders(array(7)))->toBe('?');
});
test('bound values reproduce the old inline IN list', function () use ($in_placeholders) {
// array_rekey(..., col, col) yields an associative [id => id] map.
$rekeyed = array(5 => 5, 12 => 12, 88 => 88);
$old_inline = 'IN (' . implode(',', $rekeyed) . ')';
$params = array_values($rekeyed);
$new_clause = 'IN (' . $in_placeholders($rekeyed) . ')';
// Same number of slots, and the params are exactly the ids the old form inlined.
expect(substr_count($new_clause, '?'))->toBe(count($params));
expect($params)->toBe(array(5, 12, 88));
// Substituting the params back into the placeholders rebuilds the old clause
// (whitespace between list items is not significant to SQL).
$rebuilt = $new_clause;
foreach ($params as $v) {
$rebuilt = preg_replace('/\?/', (string) $v, $rebuilt, 1);
}
$strip = fn ($s) => str_replace(' ', '', $s);
expect($strip($rebuilt))->toBe($strip($old_inline));
});
test('array_values drops the associative keys PDO would misbind', function () {
$rekeyed = array(5 => 5, 12 => 12);
expect(array_values($rekeyed))->toBe(array(5, 12));
});
// Text search filter must not go through gfrv() (FILTER_VALIDATE_INT default).
// Sort URLs with an active non-numeric filter would die_html_input_error().
test('aggregate graph list sort URL keeps text filter via grv not gfrv', function () {
$src = file_get_contents(dirname(__DIR__, 4) . '/aggregate_graphs.php');
expect($src)->not->toBeFalse('Failed to read aggregate_graphs.php');
// Whitespace-tolerant so reformatting the call site doesn't break the test;
// still pins that the sort URL passes the filter through grv(), not gfrv()
// (which applies FILTER_VALIDATE_INT and would die_html_input_error() on a
// non-numeric filter).
expect(preg_match("/rawurlencode\(\s*grv\(\s*'filter'\s*\)\s*\)/", $src))->toBe(1,
"the sort URL must build its filter param via grv('filter')");
expect(preg_match("/rawurlencode\(\s*gfrv\(\s*'filter'\s*\)\s*\)/", $src))->toBe(0,
"the sort URL must not switch to gfrv('filter')");
});