mirror of
https://github.com/nextcloud/server.git
synced 2026-04-08 02:26:12 -04:00
1c33307a59
Add validation in the Metric constructor that rejects invalid OpenMetrics label names with InvalidArgumentException. Sanitize app IDs at the source in AppsInfo by replacing hyphens with underscores before creating the Metric. Fixes nextcloud/server#59247 Signed-off-by: moktamd <moktamd@users.noreply.github.com>
110 lines
4 KiB
PHP
110 lines
4 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/**
|
|
* SPDX-FileCopyrightText: 2025 Nextcloud GmbH and Nextcloud contributors
|
|
* SPDX-License-Identifier: AGPL-3.0-or-later
|
|
*/
|
|
|
|
namespace Tests\Core\Controller;
|
|
|
|
use Generator;
|
|
use OC\Core\Controller\OpenMetricsController;
|
|
use OC\OpenMetrics\ExporterManager;
|
|
use OCP\AppFramework\Http\IOutput;
|
|
use OCP\AppFramework\Http\Response;
|
|
use OCP\AppFramework\Http\StreamTraversableResponse;
|
|
use OCP\IConfig;
|
|
use OCP\IRequest;
|
|
use OCP\OpenMetrics\IMetricFamily;
|
|
use OCP\OpenMetrics\Metric;
|
|
use OCP\OpenMetrics\MetricType;
|
|
use PHPUnit\Framework\MockObject\MockObject;
|
|
use Psr\Log\LoggerInterface;
|
|
use Test\TestCase;
|
|
|
|
class OpenMetricsControllerTest extends TestCase {
|
|
private IRequest&MockObject $request;
|
|
private IConfig&MockObject $config;
|
|
private ExporterManager&MockObject $exporterManager;
|
|
private LoggerInterface&MockObject $logger;
|
|
private OpenMetricsController $controller;
|
|
|
|
protected function setUp(): void {
|
|
parent::setUp();
|
|
$this->request = $this->createMock(IRequest::class);
|
|
$this->request->method('getRemoteAddress')
|
|
->willReturn('192.168.1.1');
|
|
$this->config = $this->createMock(IConfig::class);
|
|
$this->exporterManager = $this->createMock(ExporterManager::class);
|
|
$this->exporterManager->method('export')->willReturnCallback([$this, 'getFakeMetrics']);
|
|
$this->logger = $this->createMock(LoggerInterface::class);
|
|
$this->controller = new OpenMetricsController('core', $this->request, $this->config, $this->exporterManager, $this->logger);
|
|
}
|
|
|
|
public function getFakeMetrics(): Generator {
|
|
$metric = $this->createMock(IMetricFamily::class);
|
|
$metric->method('type')->willReturn(MetricType::gauge);
|
|
$metric->method('unit')->willReturn('fake');
|
|
$metric->method('name')->willReturn('fake_count');
|
|
$metric->method('help')->willReturn('A fake count used for tests');
|
|
$metric->method('metrics')->willReturnCallback(function () {
|
|
yield new Metric(42, ['type' => 'used']);
|
|
yield new Metric(24, ['type' => 'unused']);
|
|
});
|
|
yield $metric;
|
|
}
|
|
public function testGetMetrics(): void {
|
|
$output = $this->createMock(IOutput::class);
|
|
$fullOutput = '';
|
|
$output->method('setOutput')
|
|
->willReturnCallback(function ($output) use (&$fullOutput): void {
|
|
$fullOutput .= $output;
|
|
});
|
|
$this->config->expects($this->once())
|
|
->method('getSystemValue')
|
|
->with('openmetrics_allowed_clients')
|
|
->willReturn(['192.168.0.0/16']);
|
|
$response = $this->controller->export();
|
|
$this->assertInstanceOf(StreamTraversableResponse::class, $response);
|
|
$this->assertEquals('200', $response->getStatus());
|
|
$this->assertEquals('application/openmetrics-text; version=1.0.0; charset=utf-8', $response->getHeaders()['Content-Type']);
|
|
$expected = <<<EXPECTED
|
|
# TYPE nextcloud_fake_count gauge
|
|
# UNIT nextcloud_fake_count fake
|
|
# HELP nextcloud_fake_count A fake count used for tests
|
|
nextcloud_fake_count{type="used"} 42
|
|
nextcloud_fake_count{type="unused"} 24
|
|
# TYPE nextcloud_exporter_run_seconds gauge
|
|
# UNIT nextcloud_exporter_run_seconds seconds
|
|
# HELP nextcloud_exporter_run_seconds Exporter run time
|
|
nextcloud_exporter_run_seconds %f
|
|
# EOF
|
|
|
|
EXPECTED;
|
|
$response->callback($output);
|
|
$this->assertStringMatchesFormat($expected, $fullOutput);
|
|
}
|
|
|
|
public function testMetricRejectsInvalidLabelNames(): void {
|
|
$this->expectException(\InvalidArgumentException::class);
|
|
new Metric(1, ['hide-photos' => '1.0.0']);
|
|
}
|
|
|
|
public function testMetricAcceptsValidLabelNames(): void {
|
|
$metric = new Metric(1, ['hide_photos' => '1.0.0', 'normal_app' => '2.0.0']);
|
|
$this->assertEquals('1.0.0', $metric->label('hide_photos'));
|
|
$this->assertEquals('2.0.0', $metric->label('normal_app'));
|
|
}
|
|
|
|
public function testGetMetricsFromForbiddenIp(): void {
|
|
$this->config->expects($this->once())
|
|
->method('getSystemValue')
|
|
->with('openmetrics_allowed_clients')
|
|
->willReturn(['1.2.3.4']);
|
|
$response = $this->controller->export();
|
|
$this->assertInstanceOf(Response::class, $response);
|
|
$this->assertEquals('403', $response->getStatus());
|
|
}
|
|
}
|