Files
cacti/tests/Unit/Core/Automation/AutomationSnmpValidatorTest.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

98 lines
4.6 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';
require_once dirname(__DIR__, 4) . '/lib/api_automation.php';
use Symfony\Component\Validator\Constraints as Assert;
beforeEach(function () {
CactiValidator::reset();
});
it('validates automation name (NotBlank)', function () {
$constraints = [new Assert\NotBlank()];
expect(CactiValidator::isValid('Default SNMP', $constraints))->toBeTrue();
expect(CactiValidator::isValid('', $constraints))->toBeFalse();
});
it('validates SNMP community (NotBlank + Regex)', function () {
$constraints = [new Assert\NotBlank(), new Assert\Regex('/^[a-zA-Z0-9_\-\.]+$/')];
expect(CactiValidator::isValid('public', $constraints))->toBeTrue();
expect(CactiValidator::isValid('v2-community.string_123', $constraints))->toBeTrue();
expect(CactiValidator::isValid('comm unity', $constraints))->toBeFalse();
expect(CactiValidator::isValid('comm!unity', $constraints))->toBeFalse();
expect(CactiValidator::isValid('', $constraints))->toBeFalse();
});
it('validates SNMP version (Choice)', function () {
$constraints = [new Assert\NotBlank(), new Assert\Choice(['1', '2', '3'])];
expect(CactiValidator::isValid('1', $constraints))->toBeTrue();
expect(CactiValidator::isValid('2', $constraints))->toBeTrue();
expect(CactiValidator::isValid('3', $constraints))->toBeTrue();
expect(CactiValidator::isValid('0', $constraints))->toBeFalse();
expect(CactiValidator::isValid('4', $constraints))->toBeFalse();
expect(CactiValidator::isValid('', $constraints))->toBeFalse();
});
it('validates SNMP port (Range)', function () {
$constraints = [new Assert\NotBlank(), new Assert\Range(min: 1, max: 65535)];
expect(CactiValidator::isValid('161', $constraints))->toBeTrue();
expect(CactiValidator::isValid('1', $constraints))->toBeTrue();
expect(CactiValidator::isValid('65535', $constraints))->toBeTrue();
expect(CactiValidator::isValid('0', $constraints))->toBeFalse();
expect(CactiValidator::isValid('65536', $constraints))->toBeFalse();
expect(CactiValidator::isValid('-1', $constraints))->toBeFalse();
});
it('validates numeric fields (NotBlank + GreaterThanOrEqual)', function () {
$constraints = [new Assert\NotBlank(), new Assert\Type('numeric'), new Assert\GreaterThanOrEqual(0)];
expect(CactiValidator::isValid('0', $constraints))->toBeTrue();
expect(CactiValidator::isValid('100', $constraints))->toBeTrue();
expect(CactiValidator::isValid('-1', $constraints))->toBeFalse();
expect(CactiValidator::isValid('abc', $constraints))->toBeFalse();
});
it('validates bulk_walk_size (NotBlank + numeric)', function () {
$constraints = [new Assert\NotBlank(), new Assert\Type('numeric')];
expect(CactiValidator::isValid('20', $constraints))->toBeTrue();
expect(CactiValidator::isValid('-1', $constraints))->toBeTrue();
expect(CactiValidator::isValid('0', $constraints))->toBeTrue();
expect(CactiValidator::isValid('abc', $constraints))->toBeFalse();
});
it('verifies CactiValidator::validateInput behavior for SNMP', function () {
if (!defined('SESS_FIELD_VALUES')) define('SESS_FIELD_VALUES', 'sess_field_values');
if (!defined('SESS_ERROR_FIELDS')) define('SESS_ERROR_FIELDS', 'sess_error_fields');
// Mock raise_message if it doesn't exist (a full-suite run may have already
// loaded the real one from lib/functions.php; either is safe to call here).
if (!function_exists('raise_message')) {
function raise_message($id) {}
}
$_SESSION = [];
$constraints = [new Assert\NotBlank()];
CactiValidator::validateInput('snmp_opt', 'name', $constraints);
expect($_SESSION[SESS_FIELD_VALUES]['name'])->toBe('snmp_opt');
expect(isset($_SESSION[SESS_ERROR_FIELDS]['name']))->toBeFalse();
$_SESSION = [];
CactiValidator::validateInput('', 'name', $constraints, 3);
expect($_SESSION[SESS_FIELD_VALUES]['name'])->toBe('');
expect($_SESSION[SESS_ERROR_FIELDS]['name'])->toBe(3);
});