Files
FOSSBilling/tests/Modules/System/AdminTest.php
T
f86498c187 Fix for 1 code quality finding (#3457)
* Apply suggested fix to tests/Modules/System/AdminTest.php from Copilot Autofix

Co-authored-by: Copilot Autofix powered by AI <223894421+github-code-quality[bot]@users.noreply.github.com>

* Fix call site for renamed method isIpLookupAvailable in AdminTest

Agent-Logs-Url: https://github.com/FOSSBilling/FOSSBilling/sessions/57c457e8-07ac-40a6-9640-e05601d5e656

Co-authored-by: admdly <2807620+admdly@users.noreply.github.com>

---------

Co-authored-by: Copilot Autofix powered by AI <223894421+github-code-quality[bot]@users.noreply.github.com>
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: admdly <2807620+admdly@users.noreply.github.com>
2026-04-28 19:59:07 +01:00

174 lines
7.4 KiB
PHP

<?php
declare(strict_types=1);
namespace SystemTests;
use APIHelper\Request;
use PHPUnit\Framework\TestCase;
final class AdminTest extends TestCase
{
private function isIpLookupAvailable(): bool
{
$serverAddr = $_SERVER['SERVER_ADDR'] ?? null;
if (is_string($serverAddr) && filter_var($serverAddr, FILTER_VALIDATE_IP) !== false) {
return true;
}
$hostname = gethostname();
if ($hostname === false || $hostname === '') {
return false;
}
$resolved = gethostbyname($hostname);
return is_string($resolved) && filter_var($resolved, FILTER_VALIDATE_IP) !== false;
}
public function testClearCache(): void
{
// Read a stable value first so we can verify behavior before/after clearing cache
$beforeFirst = Request::makeRequest('admin/system/error_reporting_enabled');
$this->assertTrue($beforeFirst->wasSuccessful(), $beforeFirst->generatePHPUnitMessage());
$this->assertIsBool($beforeFirst->getResult());
// Read again to establish deterministic pre-clear behavior
$beforeSecond = Request::makeRequest('admin/system/error_reporting_enabled');
$this->assertTrue($beforeSecond->wasSuccessful(), $beforeSecond->generatePHPUnitMessage());
$this->assertIsBool($beforeSecond->getResult());
$this->assertSame($beforeFirst->getResult(), $beforeSecond->getResult());
// Clear the cache
$result = Request::makeRequest('admin/system/clear_cache');
$this->assertTrue($result->wasSuccessful(), $result->generatePHPUnitMessage());
$this->assertIsBool($result->getResult());
// Verify post-condition: system value remains valid and unchanged after cache clear
$after = Request::makeRequest('admin/system/error_reporting_enabled');
$this->assertTrue($after->wasSuccessful(), $after->generatePHPUnitMessage());
$this->assertIsBool($after->getResult());
$this->assertSame($beforeSecond->getResult(), $after->getResult());
}
public function testErrorReportingToggle(): void
{
// Get the starting value
$beforeResult = Request::makeRequest('admin/system/error_reporting_enabled');
$this->assertTrue($beforeResult->wasSuccessful(), $beforeResult->generatePHPUnitMessage());
$before = $beforeResult->getResult();
$this->assertIsBool($before);
// Toggle the option
$result = Request::makeRequest('admin/system/toggle_error_reporting');
$this->assertTrue($result->wasSuccessful(), $result->generatePHPUnitMessage());
$this->assertTrue($result->getResult());
// Check that it was correctly switched
$afterResponse = Request::makeRequest('admin/system/error_reporting_enabled');
$this->assertTrue($afterResponse->wasSuccessful(), $afterResponse->generatePHPUnitMessage());
$after = $afterResponse->getResult();
$this->assertIsBool($after);
$this->assertNotSame($before, $after);
// Ensure we don't leave error reporting on (it shouldn't report anyways, but this is best practice)
if ($after) {
$result = Request::makeRequest('admin/system/toggle_error_reporting');
$this->assertTrue($result->wasSuccessful(), $result->generatePHPUnitMessage());
$this->assertTrue($result->getResult());
}
}
public function testGetAndSetNetworkInterfaces(): void
{
// Get the list of network interfaces, validate the response is as expected
$result = Request::makeRequest('admin/system/get_interface_ips');
$this->assertTrue($result->wasSuccessful(), $result->generatePHPUnitMessage());
$this->assertIsArray($result->getResult());
// And then validate they are all valid IP addresses
foreach ($result->getResult() as $ip) {
$this->assertTrue((bool) filter_var($ip, FILTER_VALIDATE_IP));
}
// Only test each found interface if ipify.org is functioning
if ($this->isIpLookupAvailable()) {
foreach ($result->getResult() as $ip) {
$testResult = Request::makeRequest('admin/system/set_interface_ip', ['interface' => $ip]);
$this->assertTrue($testResult->wasSuccessful(), $testResult->generatePHPUnitMessage());
$isReady = false;
for ($attempt = 0; $attempt < 10; ++$attempt) {
$result = Request::makeRequest('admin/system/env', ['ip' => true]);
if ($result->wasSuccessful() && (bool) filter_var($result->getResult(), FILTER_VALIDATE_IP)) {
$isReady = true;
break;
}
usleep(200000); // 200ms
}
$this->assertTrue($isReady, 'Timed out waiting for interface IP to become active');
}
}
// Finally, set it back to the default interface
$cleanupResult = Request::makeRequest('admin/system/set_interface_ip', ['interface' => '0']);
$this->assertTrue($cleanupResult->wasSuccessful(), $cleanupResult->generatePHPUnitMessage());
}
public function testInvalidInterfaceIsRejected(): void
{
$result = Request::makeRequest('admin/system/set_interface_ip', ['interface' => '12345']);
$this->assertFalse($result->wasSuccessful(), 'An invalid interface IP was accepted when it should have been rejected');
}
public function testInvalidCustomInterfaceIsRejected(): void
{
$result = Request::makeRequest('admin/system/set_interface_ip', ['custom_interface' => '!@#$%']);
$this->assertFalse($result->wasSuccessful(), 'An invalid custom interface was accepted when it should have been rejected');
}
public function testMaliciousInterfaceIsRejected(): void
{
$payloads = [
"x\"; echo 'pwned'; //",
'eth0|id',
'eth0`id`',
'eth0$(id)',
'eth0 && whoami',
'eth0 > /tmp/pwned',
'../etc/passwd',
'..\\..\\windows\\system32\\drivers\\etc\\hosts',
"eth0\0evil",
str_repeat('a', 1024),
"eth0\nwhoami",
" eth0 ",
];
foreach ($payloads as $payload) {
$result = Request::makeRequest('admin/system/set_interface_ip', ['interface' => $payload]);
$this->assertFalse(
$result->wasSuccessful(),
"A malicious interface value was accepted when it should have been rejected: {$payload}"
);
}
}
public function testMaliciousCustomInterfaceIsRejected(): void
{
$result = Request::makeRequest('admin/system/set_interface_ip', ['custom_interface' => "x\"; passthru('id'); //"]);
$this->assertFalse($result->wasSuccessful(), 'A malicious custom interface value was accepted when it should have been rejected');
}
public function testCustomInterfaceAcceptsValidHostname(): void
{
$result = Request::makeRequest('admin/system/set_interface_ip', ['custom_interface' => 'eth0']);
$this->assertTrue($result->wasSuccessful(), $result->generatePHPUnitMessage());
// Reset to default
$resetResult = Request::makeRequest('admin/system/set_interface_ip', ['custom_interface' => '', 'interface' => '0']);
$this->assertTrue($resetResult->wasSuccessful(), $resetResult->generatePHPUnitMessage());
}
}