Files
cacti/tests/Unit/Core/RemoteAgent/RemoteAgentTransportTest.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.4 KiB
PHP

<?php
declare(strict_types = 1);
/*
+-------------------------------------------------------------------------+
| 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 |
+-------------------------------------------------------------------------+
| Cacti: The Complete RRDtool-based Graphing Solution |
+-------------------------------------------------------------------------+
*/
require_once dirname(__DIR__, 4) . '/lib/remote_agent_transport.php';
test('remote-agent HTTP status parser returns the final valid status', function () {
expect(remote_agent_http_status([
'HTTP/1.1 301 Moved Permanently',
'Location: /other',
'HTTP/2 204',
]))->toBe(204)
->and(remote_agent_http_status(['Content-Type: text/plain']))->toBeNull()
->and(remote_agent_http_status(['HTTP/1.1 invalid']))->toBeNull();
});
test('HTTPS remote-agent context verifies peers and disables redirects by default', function () {
$options = remote_agent_context_options('https', 10, true, '/tmp/test-ca.pem', 'collector.example.test');
expect($options['ssl']['verify_peer'])->toBeTrue()
->and($options['ssl']['verify_peer_name'])->toBeTrue()
->and($options['ssl']['allow_self_signed'])->toBeFalse()
->and($options['ssl']['peer_name'])->toBe('collector.example.test')
->and($options['ssl']['cafile'])->toBe('/tmp/test-ca.pem')
->and($options['http']['timeout'])->toBe(10)
->and($options['http']['follow_location'])->toBe(0)
->and($options['http']['max_redirects'])->toBe(0)
->and($options)->not->toHaveKey('https');
});
test('remote-agent TLS verification requires an explicit opt out', function () {
$options = remote_agent_context_options('https', 5, false, '', '127.0.0.1');
expect($options['ssl']['verify_peer'])->toBeFalse()
->and($options['ssl']['verify_peer_name'])->toBeFalse()
->and($options['ssl']['allow_self_signed'])->toBeTrue()
->and($options['http']['timeout'])->toBe(5)
->and($options['ssl'])->not->toHaveKey('cafile');
});
test('HTTP remote-agent context applies timeout without TLS options', function () {
$options = remote_agent_context_options('http', 5, true);
expect($options)->toHaveKey('http')
->and($options)->not->toHaveKey('ssl');
});
test('remote collector handoff enforces path status and response-size contracts', function () {
$source = file_get_contents(dirname(__DIR__, 4) . '/lib/functions.php');
expect($source)->toContain('strpbrk($url, "\\0\\r\\n")')
->and($source)->toContain('REMOTE_AGENT_MAX_RESPONSE_BYTES + 1')
->and($source)->toContain('$http_response_header = [];')
->and($source)->toContain('remote_agent_http_status($http_response_header)')
->and($source)->toContain('$status < 200 || $status >= 300');
});
test('remote graph JSON accepts only strict supported image envelopes', function (string $image) {
$envelope = ['image' => base64_encode($image), 'graph_start' => 1];
expect(remote_graph_json_envelope(json_encode($envelope, JSON_THROW_ON_ERROR)))->toBe($envelope);
})->with([
'png' => "\x89PNG\r\n\x1a\ndata",
'gif' => 'GIF89adata',
'svg' => '<svg xmlns="http://www.w3.org/2000/svg"></svg>',
'svg with declaration' => '<?xml version="1.0" encoding="UTF-8"?>' . PHP_EOL . '<svg xmlns="http://www.w3.org/2000/svg"></svg>'
]);
test('remote graph JSON rejects malformed missing and unsupported images', function (string $response) {
expect(remote_graph_json_envelope($response))->toBeFalse();
})->with([
'malformed JSON' => '{',
'non-object JSON' => '[]',
'missing image' => '{"graph_start":1}',
'non-string image' => '{"image":7}',
'invalid base64' => '{"image":"%%%"}',
'empty image' => '{"image":""}',
'unsupported data' => '{"image":"' . base64_encode('plain text') . '"}',
'non-SVG XML' => '{"image":"' . base64_encode('<?xml version="1.0"?><html></html>') . '"}'
]);
test('remote graph endpoints preserve local request identity over remote metadata', function () {
$source = file_get_contents(dirname(__DIR__, 4) . '/graph_json.php');
expect($source)->toContain("unset(\$decoded['type'], \$decoded['local_graph_id'], \$decoded['rra_id'])")
->and($source)->toContain('array_merge($decoded, $oarray)');
});