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
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
|
<?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;
use OCA\Settings\SetupChecks\WellKnownUrls;
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 WellKnownUrlsTest extends TestCase {
private IL10N|MockObject $l10n;
private IConfig|MockObject $config;
private IURLGenerator|MockObject $urlGenerator;
private IClientService|MockObject $clientService;
private LoggerInterface|MockObject $logger;
private WellKnownUrls|MockObject $setupcheck;
protected function setUp(): void {
parent::setUp();
/** @var IL10N|MockObject */
$this->l10n = $this->getMockBuilder(IL10N::class)
->disableOriginalConstructor()->getMock();
$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(WellKnownUrls::class)
->onlyMethods(['runRequest'])
->setConstructorArgs([
$this->l10n,
$this->config,
$this->urlGenerator,
$this->clientService,
$this->logger,
])
->getMock();
}
/**
* Test that the SetupCheck is skipped if the system config is set
*/
public function testDisabled(): void {
$this->config
->expects($this->once())
->method('getSystemValueBool')
->with('check_for_working_wellknown_setup')
->willReturn(false);
$this->setupcheck
->expects($this->never())
->method('runRequest');
$result = $this->setupcheck->run();
$this->assertEquals(SetupResult::INFO, $result->getSeverity());
$this->assertMatchesRegularExpression('/check was skipped/', $result->getDescription());
}
/**
* Test what happens if the local server could not be reached (no response from the requests)
*/
public function testNoResponse(): void {
$this->config
->expects($this->once())
->method('getSystemValueBool')
->with('check_for_working_wellknown_setup')
->willReturn(true);
$this->setupcheck
->expects($this->once())
->method('runRequest')
->will($this->generate([]));
$result = $this->setupcheck->run();
$this->assertEquals(SetupResult::INFO, $result->getSeverity());
$this->assertMatchesRegularExpression('/^Could not check/', $result->getDescription());
}
/**
* Test responses
* @dataProvider dataTestResponses
*/
public function testResponses($responses, string $expectedSeverity): void {
$this->config
->expects($this->once())
->method('getSystemValueBool')
->with('check_for_working_wellknown_setup')
->willReturn(true);
$this->setupcheck
->expects($this->atLeastOnce())
->method('runRequest')
->willReturnOnConsecutiveCalls(...$responses);
$result = $this->setupcheck->run();
$this->assertEquals($expectedSeverity, $result->getSeverity());
}
public function dataTestResponses(): array {
$createResponse = function (int $statuscode, array $header = []): IResponse|MockObject {
$response = $this->createMock(IResponse::class);
$response->expects($this->any())
->method('getStatusCode')
->willReturn($statuscode);
$response->expects($this->any())
->method('getHeader')
->willReturnCallback(fn ($name) => $header[$name] ?? '');
return $response;
};
$wellKnownHeader = ['X-NEXTCLOUD-WELL-KNOWN' => 'yes'];
return [
'expected codes' => [
[
$this->generate([$createResponse(200, $wellKnownHeader)]),
$this->generate([$createResponse(200, $wellKnownHeader)]),
$this->generate([$createResponse(207)]),
$this->generate([$createResponse(207)]),
],
SetupResult::SUCCESS,
],
'late response with expected codes' => [
[
$this->generate([$createResponse(404), $createResponse(200, $wellKnownHeader)]),
$this->generate([$createResponse(404), $createResponse(200, $wellKnownHeader)]),
$this->generate([$createResponse(404), $createResponse(207)]),
$this->generate([$createResponse(404), $createResponse(207)]),
],
SetupResult::SUCCESS,
],
'working but disabled webfinger' => [
[
$this->generate([$createResponse(404, $wellKnownHeader)]),
$this->generate([$createResponse(404, $wellKnownHeader)]),
$this->generate([$createResponse(207)]),
$this->generate([$createResponse(207)]),
],
SetupResult::SUCCESS,
],
'unauthorized webdav but with correct configured redirect' => [
[
$this->generate([$createResponse(404, $wellKnownHeader)]),
$this->generate([$createResponse(404, $wellKnownHeader)]),
$this->generate([$createResponse(401, ['X-Guzzle-Redirect-History' => 'https://example.com,https://example.com/remote.php/dav/'])]),
$this->generate([$createResponse(401, ['X-Guzzle-Redirect-History' => 'https://example.com/remote.php/dav/'])]),
],
SetupResult::SUCCESS,
],
'not configured path' => [
[
$this->generate([$createResponse(404)]),
$this->generate([$createResponse(404)]),
$this->generate([$createResponse(404)]),
$this->generate([$createResponse(404)]),
],
SetupResult::WARNING,
],
'Invalid webfinger' => [
[
$this->generate([$createResponse(404)]),
$this->generate([$createResponse(404, $wellKnownHeader)]),
$this->generate([$createResponse(207)]),
$this->generate([$createResponse(207)]),
],
SetupResult::WARNING,
],
'Invalid nodeinfo' => [
[
$this->generate([$createResponse(404, $wellKnownHeader)]),
$this->generate([$createResponse(404)]),
$this->generate([$createResponse(207)]),
$this->generate([$createResponse(207)]),
],
SetupResult::WARNING,
],
'Invalid caldav' => [
[
$this->generate([$createResponse(404, $wellKnownHeader)]),
$this->generate([$createResponse(404, $wellKnownHeader)]),
$this->generate([$createResponse(404)]),
$this->generate([$createResponse(207)]),
],
SetupResult::WARNING,
],
];
}
/**
* 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;
});
}
}
|
