mirror of
https://github.com/Cacti/cacti.git
synced 2026-10-23 03:27:02 +09:00
* feat(validator): add settings constraint validation pilot Routes saved settings through Symfony Validator so include/global_settings.php can declare per-setting constraints inline. The save handler runs one validator pass and surfaces violations via the existing raise_message() pattern, replacing scattered ad-hoc checks. Pilot covers 12 high-value settings; the rest stay on the existing implicit form-render checks. Signed-off-by: Thomas Vincent <thomasvincent@gmail.com> * ci(infection): allow infection/extension-installer composer plugin Signed-off-by: Thomas Vincent <thomasvincent@gmail.com> * docs(validator): document must-be-posted-to-validate contract Signed-off-by: Thomas Vincent <thomasvincent@gmail.com> * fix(bootstrap): guard Symfony autoload in global_settings before use declarations Signed-off-by: Thomas Vincent <thomasvincent@gmail.com> * fix(test): remove redundant autoload require in CactiSettingsTest Signed-off-by: Thomas Vincent <thomasvincent@gmail.com> * fix(test): restore require_once for CactiSettings (not in Composer autoload) Signed-off-by: Thomas Vincent <thomasvincent@gmail.com> * feat(validator): fold helper into settings pilot * fix(validator): translate default Symfony constraint messages Default Symfony NotBlank/Length/Range/Choice/Positive messages render in English regardless of Cacti locale because the validator runs without a Symfony Translator. Pass explicit __()-wrapped message, minMessage, maxMessage, and notInRangeMessage options on each bare constraint in include/global_settings.php so violations participate in Cacti's gettext pipeline. Documents the no-Translator decision in CactiValidator so future contributors know to translate at the call site. Addresses Copilot PR #7077 review feedback. Signed-off-by: Thomas Vincent <thomasvincent@gmail.com> * fix(graph): improve remote agent parsing and RRD path validation * feat(validator): migrate automation_graph_rules.php to symfony validator * refactor(validator): move automation validator helper to shared library and enhance tests * feat(validator): migrate automation_networks.php to symfony validator * feat(validator): migrate automation_snmp.php to symfony validator * feat(validator): migrate automation_templates.php to symfony validator * feat(validator): migrate automation_tree_rules.php to symfony validator * refactor(automation): move api_networks_save to shared library for testability * feat(validator): add validateInput helper and migrate color_templates.php * feat(validator): migrate host_templates.php to symfony validator * feat(validator): migrate graph_templates.php to symfony validator * feat(validator): migrate data_templates.php to symfony validator * feat(validator): migrate data_input.php to symfony validator * feat(validator): migrate data_queries.php to symfony validator * feat(validator): migrate graphs_new.php to symfony validator * feat(validator): migrate graphs.php to symfony validator * feat(validator): migrate data_sources.php to symfony validator * feat(validator): migrate user_group_admin.php to symfony validator * feat(validator): migrate managers.php to symfony validator * feat(validator): migrate package_repos.php to symfony validator * Refactor pollers.php to use CactiValidator * fix(security): close validator migration regressions * test(snmp): add spine docker harness * fix(review): address validator migration feedback * fix(deps): include validator runtime packages * chore(deps): normalize composer.json require-block indentation The validator migration introduced tab-indented entries in an otherwise space-indented require block. Re-indent the stevenmaguire/* and symfony/* lines to 8 spaces so the block is consistent. Co-Authored-By: Oz <oz-agent@warp.dev> * fix(graphs): repair graph json response branch * fix(validation): apply php cs fixer * ci(codeql): skip autobuild for interpreted scans * fix(link): satisfy phpstan path guard * chore(pr): remove branch pollution * ci(codeql): align autobuild pin with init and analyze Signed-off-by: Thomas Vincent <thomasvincent@gmail.com> * refactor(automation): use CactiValidator::validateInput, drop wrapper automation_validate_input() in lib/api_automation.php was a byte-for-byte duplicate of CactiValidator::validateInput() (identical session handling and raise_message() semantics, and it already delegated to CactiValidator::validate internally). Per review feedback, use the shared class directly everywhere instead of a parallel automation-only wrapper. - Remove automation_validate_input() from lib/api_automation.php - Replace all call sites with CactiValidator::validateInput() (automation_templates/graph_rules/tree_rules/snmp and api_networks_save) - Update the automation validator unit tests to match - Add @param/@return PHPDoc to CactiValidator specific-validator methods Co-Authored-By: Oz <oz-agent@warp.dev> --------- Signed-off-by: Thomas Vincent <thomasvincent@gmail.com> Co-authored-by: Thomas Vincent <thomas@vincent.dev> Co-authored-by: Oz <oz-agent@warp.dev> Co-authored-by: TheWitness <thewitness@cacti.net>
69 lines
3.2 KiB
PHP
69 lines
3.2 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__, 2) . '/include/vendor/autoload.php';
|
|
require_once dirname(__DIR__, 2) . '/lib/CactiValidator.php';
|
|
require_once dirname(__DIR__, 2) . '/lib/api_automation.php';
|
|
|
|
use Symfony\Component\Validator\Constraints as Assert;
|
|
|
|
beforeEach(function () {
|
|
CactiValidator::reset();
|
|
});
|
|
|
|
it('validates host_template (NotBlank + Regex)', function () {
|
|
$constraints = [new Assert\NotBlank(), new Assert\Regex('/^[0-9]+$/')];
|
|
expect(CactiValidator::isValid('1', $constraints))->toBeTrue();
|
|
expect(CactiValidator::isValid('0', $constraints))->toBeTrue();
|
|
expect(CactiValidator::isValid('', $constraints))->toBeFalse();
|
|
expect(CactiValidator::isValid(null, $constraints))->toBeFalse();
|
|
expect(CactiValidator::isValid('abc', $constraints))->toBeFalse();
|
|
});
|
|
|
|
it('validates availability_method (NotBlank + Regex)', function () {
|
|
$constraints = [new Assert\NotBlank(), new Assert\Regex('/^[0-9]+$/')];
|
|
expect(CactiValidator::isValid('1', $constraints))->toBeTrue();
|
|
expect(CactiValidator::isValid('0', $constraints))->toBeTrue();
|
|
expect(CactiValidator::isValid('', $constraints))->toBeFalse();
|
|
expect(CactiValidator::isValid(null, $constraints))->toBeFalse();
|
|
expect(CactiValidator::isValid('abc', $constraints))->toBeFalse();
|
|
});
|
|
|
|
it('verifies CactiValidator::validateInput populates session and raises message on failure', function () {
|
|
// Define constants if not present
|
|
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
|
|
if (!function_exists('raise_message')) {
|
|
function raise_message($id) { $GLOBALS['raised_message'] = $id; }
|
|
}
|
|
|
|
$_SESSION = [];
|
|
$constraints = [new Assert\NotBlank(), new Assert\Regex('/^[0-9]+$/')];
|
|
|
|
// Test valid input
|
|
CactiValidator::validateInput('123', 'host_template', $constraints);
|
|
expect($_SESSION[SESS_FIELD_VALUES]['host_template'])->toBe('123');
|
|
expect(isset($_SESSION[SESS_ERROR_FIELDS]['host_template']))->toBeFalse();
|
|
|
|
// Test invalid input
|
|
$_SESSION = [];
|
|
$GLOBALS['raised_message'] = null;
|
|
CactiValidator::validateInput('', 'host_template', $constraints, 3);
|
|
expect($_SESSION[SESS_FIELD_VALUES]['host_template'])->toBe('');
|
|
expect($_SESSION[SESS_ERROR_FIELDS]['host_template'])->toBe(3);
|
|
expect($GLOBALS['raised_message'])->toBe(3);
|
|
});
|