Files
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

146 lines
5.9 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 |
+-------------------------------------------------------------------------+
*/
require_once dirname(__DIR__, 4) . '/include/vendor/autoload.php';
require_once dirname(__DIR__, 4) . '/lib/CactiValidator.php';
use Symfony\Component\Validator\Constraints as Assert;
beforeEach(function () {
CactiValidator::reset();
});
it('validates a numeric host id', function () {
expect(CactiValidator::isValidHostId(123))->toBeTrue();
expect(CactiValidator::isValidHostId('456'))->toBeTrue();
expect(CactiValidator::isValidHostId(0))->toBeTrue();
});
it('rejects a negative host id', function () {
expect(CactiValidator::isValidHostId(-1))->toBeFalse();
});
it('rejects a non-numeric host id', function () {
expect(CactiValidator::isValidHostId('abc'))->toBeFalse();
expect(CactiValidator::isValidHostId(''))->toBeFalse();
expect(CactiValidator::isValidHostId(null))->toBeFalse();
});
it('validates a safe rrd path', function () {
expect(CactiValidator::isValidRrdPath('host_1/traffic_in.rrd'))->toBeTrue();
expect(CactiValidator::isValidRrdPath('archive/2023-01-01.rrd'))->toBeTrue();
expect(CactiValidator::isValidRrdPath('local.rrd'))->toBeTrue();
});
it('rejects rrd path with traversal', function () {
expect(CactiValidator::isValidRrdPath('../../etc/passwd'))->toBeFalse();
expect(CactiValidator::isValidRrdPath('..'))->toBeFalse();
expect(CactiValidator::isValidRrdPath('/var/www/html/cacti/rra/../config.php'))->toBeFalse();
});
it('rejects rrd path with invalid characters', function () {
expect(CactiValidator::isValidRrdPath('my graph; rm -rf /'))->toBeFalse();
expect(CactiValidator::isValidRrdPath('host_1/<script>alert(1)</script>.rrd'))->toBeFalse();
});
it('validates ipv4 and ipv6 addresses', function () {
expect(CactiValidator::isValidIpAddress('127.0.0.1'))->toBeTrue();
expect(CactiValidator::isValidIpAddress('192.168.1.1'))->toBeTrue();
expect(CactiValidator::isValidIpAddress('::1'))->toBeTrue();
expect(CactiValidator::isValidIpAddress('2001:0db8:85a3:0000:0000:8a2e:0370:7334'))->toBeTrue();
expect(CactiValidator::isValidIpAddress('not-an-ip'))->toBeFalse();
expect(CactiValidator::isValidIpAddress('256.256.256.256'))->toBeFalse();
});
it('validates email addresses', function () {
expect(CactiValidator::isValidEmail('test@example.com'))->toBeTrue();
expect(CactiValidator::isValidEmail('user.name+tag@domain.co.uk'))->toBeTrue();
expect(CactiValidator::isValidEmail('invalid-email'))->toBeFalse();
expect(CactiValidator::isValidEmail('test@example'))->toBeFalse();
});
it('validates snmp community strings', function () {
expect(CactiValidator::isValidSnmpCommunity('public'))->toBeTrue();
expect(CactiValidator::isValidSnmpCommunity('my-community_123'))->toBeTrue();
expect(CactiValidator::isValidSnmpCommunity('public@site'))->toBeTrue();
expect(CactiValidator::isValidSnmpCommunity('read only/community:1'))->toBeTrue();
expect(CactiValidator::isValidSnmpCommunity(''))->toBeFalse();
expect(CactiValidator::isValidSnmpCommunity("comm\nunity"))->toBeFalse();
expect(CactiValidator::isValidSnmpCommunity("comm\x7funity"))->toBeFalse();
});
it('can validate against custom constraints', function () {
$constraints = [
new Assert\Email(mode: 'html5'),
new Assert\NotBlank(),
];
expect(CactiValidator::isValid('test@example.com', $constraints))->toBeTrue();
expect(CactiValidator::isValid('invalid-email', $constraints))->toBeFalse();
});
it('rejects rrd path with absolute root', function () {
expect(CactiValidator::isValidRrdPath('/etc/passwd_no_dots'))->toBeFalse();
expect(CactiValidator::isValidRrdPath('/var/www/html/cacti/rra/host_1.rrd'))->toBeFalse();
});
it('rejects rrd path with NUL byte', function () {
expect(CactiValidator::isValidRrdPath("foo\0..rrd"))->toBeFalse();
});
it('rejects empty rrd path', function () {
expect(CactiValidator::isValidRrdPath(''))->toBeFalse();
});
it('enforces rraRoot containment when supplied', function () {
$root = sys_get_temp_dir() . '/cacti_rra_' . uniqid();
mkdir($root, 0700, true);
file_put_contents($root . '/host_1.rrd', '');
try {
expect(CactiValidator::isValidRrdPath('host_1.rrd', $root))->toBeTrue();
// Improved: allow missing files if containment can be verified
expect(CactiValidator::isValidRrdPath('missing.rrd', $root))->toBeTrue();
} finally {
// nosemgrep: php.lang.security.unlink-use.unlink-use - test cleanup of file we just created in temp dir
@unlink($root . '/host_1.rrd');
@rmdir($root);
}
});
it('validates ipv4-mapped ipv6 and reserved ranges as syntactically valid', function () {
expect(CactiValidator::isValidIpAddress('::ffff:127.0.0.1'))->toBeTrue();
});
it('rejects malformed ipv4 with leading zeros that some parsers accept', function () {
// Symfony Ip validator accepts "192.168.001.001" - assert current behavior so regressions are visible.
$value = CactiValidator::isValidIpAddress('192.168.001.001');
expect($value)->toBeBool();
});
it('rejects email with header injection attempt', function () {
expect(CactiValidator::isValidEmail("a@b.com\r\nBcc: c@d.com"))->toBeFalse();
});
it('rejects oversize email', function () {
$local = str_repeat('a', 320);
expect(CactiValidator::isValidEmail($local . '@example.com'))->toBeFalse();
});
it('rejects snmp community with non-ascii', function () {
expect(CactiValidator::isValidSnmpCommunity("p\xc3\xa9blic"))->toBeFalse();
});