aboutsummaryrefslogtreecommitdiffstats
path: root/apps/settings/tests/SetupChecks/OcxProvicersTest.php
blob: 8e5a2c1b88b2e4968aa1a8a37e91313a9a2e154e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
<?php

declare(strict_types=1);

/**
 * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors
 * SPDX-License-Identifier: AGPL-3.0-or-later
 */
namespace OCA\Settings\Tests\SetupChecks;

use OCA\Settings\SetupChecks\OcxProviders;
use OCP\Http\Client\IClientService;
use OCP\Http\Client\IResponse;
use OCP\IConfig;
use OCP\IL10N;
use OCP\IURLGenerator;
use OCP\SetupCheck\SetupResult;
use PHPUnit\Framework\MockObject\MockObject;
use Psr\Log\LoggerInterface;
use Test\TestCase;

class OcxProvicersTest extends TestCase {
	private IL10N|MockObject $l10n;
	private IConfig|MockObject $config;
	private IURLGenerator|MockObject $urlGenerator;
	private IClientService|MockObject $clientService;
	private LoggerInterface|MockObject $logger;
	private OcxProviders|MockObject $setupcheck;

	protected function setUp(): void {
		parent::setUp();

		$this->l10n = $this->createMock(IL10N::class);
		$this->l10n->expects($this->any())
			->method('t')
			->willReturnCallback(function ($message, array $replace) {
				return vsprintf($message, $replace);
			});

		$this->config = $this->createMock(IConfig::class);
		$this->urlGenerator = $this->createMock(IURLGenerator::class);
		$this->clientService = $this->createMock(IClientService::class);
		$this->logger = $this->createMock(LoggerInterface::class);

		$this->setupcheck = $this->getMockBuilder(OcxProviders::class)
			->onlyMethods(['runRequest'])
			->setConstructorArgs([
				$this->l10n,
				$this->config,
				$this->urlGenerator,
				$this->clientService,
				$this->logger,
			])
			->getMock();
	}

	public function testSuccess(): void {
		$response = $this->createMock(IResponse::class);
		$response->expects($this->any())->method('getStatusCode')->willReturn(200);

		$this->setupcheck
			->expects($this->exactly(2))
			->method('runRequest')
			->willReturnOnConsecutiveCalls($this->generate([$response]), $this->generate([$response]));

		$result = $this->setupcheck->run();
		$this->assertEquals(SetupResult::SUCCESS, $result->getSeverity());
	}

	public function testLateSuccess(): void {
		$response1 = $this->createMock(IResponse::class);
		$response1->expects($this->exactly(3))->method('getStatusCode')->willReturnOnConsecutiveCalls(404, 500, 200);
		$response2 = $this->createMock(IResponse::class);
		$response2->expects($this->any())->method('getStatusCode')->willReturnOnConsecutiveCalls(200);

		$this->setupcheck
			->expects($this->exactly(2))
			->method('runRequest')
			->willReturnOnConsecutiveCalls($this->generate([$response1, $response1, $response1]), $this->generate([$response2])); // only one response out of two

		$result = $this->setupcheck->run();
		$this->assertEquals(SetupResult::SUCCESS, $result->getSeverity());
	}

	public function testNoResponse(): void {
		$response = $this->createMock(IResponse::class);
		$response->expects($this->any())->method('getStatusCode')->willReturn(200);

		$this->setupcheck
			->expects($this->exactly(2))
			->method('runRequest')
			->willReturnOnConsecutiveCalls($this->generate([]), $this->generate([])); // No responses

		$result = $this->setupcheck->run();
		$this->assertEquals(SetupResult::WARNING, $result->getSeverity());
		$this->assertMatchesRegularExpression('/^Could not check/', $result->getDescription());
	}

	public function testPartialResponse(): void {
		$response = $this->createMock(IResponse::class);
		$response->expects($this->any())->method('getStatusCode')->willReturn(200);

		$this->setupcheck
			->expects($this->exactly(2))
			->method('runRequest')
			->willReturnOnConsecutiveCalls($this->generate([$response]), $this->generate([])); // only one response out of two

		$result = $this->setupcheck->run();
		$this->assertEquals(SetupResult::WARNING, $result->getSeverity());
		$this->assertMatchesRegularExpression('/^Could not check/', $result->getDescription());
	}

	public function testInvalidResponse(): void {
		$response = $this->createMock(IResponse::class);
		$response->expects($this->any())->method('getStatusCode')->willReturn(404);

		$this->setupcheck
			->expects($this->exactly(2))
			->method('runRequest')
			->willReturnOnConsecutiveCalls($this->generate([$response]), $this->generate([$response])); // only one response out of two

		$result = $this->setupcheck->run();
		$this->assertEquals(SetupResult::WARNING, $result->getSeverity());
		$this->assertMatchesRegularExpression('/^Your web server is not properly set up/', $result->getDescription());
	}

	public function testPartialInvalidResponse(): void {
		$response1 = $this->createMock(IResponse::class);
		$response1->expects($this->any())->method('getStatusCode')->willReturnOnConsecutiveCalls(200);
		$response2 = $this->createMock(IResponse::class);
		$response2->expects($this->any())->method('getStatusCode')->willReturnOnConsecutiveCalls(404);

		$this->setupcheck
			->expects($this->exactly(2))
			->method('runRequest')
			->willReturnOnConsecutiveCalls($this->generate([$response1]), $this->generate([$response2]));

		$result = $this->setupcheck->run();
		$this->assertEquals(SetupResult::WARNING, $result->getSeverity());
		$this->assertMatchesRegularExpression('/^Your web server is not properly set up/', $result->getDescription());
	}

	/**
	 * Helper function creates a nicer interface for mocking Generator behavior
	 */
	protected function generate(array $yield_values) {
		return $this->returnCallback(function () use ($yield_values) {
			yield from $yield_values;
		});
	}
}