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
|
<?php
/**
* @copyright Copyright (c) 2023 Daniel Calviño Sánchez <danxuliu@gmail.com>
*
* @license GNU AGPL version 3 or any later version
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*
*/
use Behat\Gherkin\Node\TableNode;
use GuzzleHttp\Client;
use PHPUnit\Framework\Assert;
// The following attributes and methods are expected to be available in the
// class that uses this trait:
// - baseUrl
// - assertStatusCode()
// - sendRequest()
// - sendRequestFullUrl()
// - setAppConfig()
trait RecordingTrait {
/** @var string */
private $recordingServerPid = '';
/** @var string */
private $recordingServerAddress = 'localhost:9000';
/**
* @Given /^recording server is started$/
*/
public function recordingServerIsStarted() {
if ($this->recordingServerPid !== '') {
return;
}
// "the secret" is hardcoded in the fake recording server.
$this->setAppConfig('spreed', new TableNode([['recording_servers', json_encode(['servers' => [['server' => 'http://' . $this->recordingServerAddress]], 'secret' => 'the secret'])]]));
$this->recordingServerPid = exec('php -S ' . $this->recordingServerAddress . ' features/bootstrap/FakeRecordingServer.php >/dev/null & echo $!');
}
/**
* @AfterScenario
*
* @When /^recording server is stopped$/
*/
public function recordingServerIsStopped() {
if ($this->recordingServerPid === '') {
return;
}
// Get received requests to clear them.
$this->getRecordingServerReceivedRequests();
exec('kill ' . $this->recordingServerPid);
$this->recordingServerPid = '';
}
/**
* @When /^recording server sent started request for "(audio|video)" recording in room "([^"]*)" as "([^"]*)" with (\d+)(?: \((v1)\))?$/
*/
public function recordingServerSentStartedRequestForRecordingInRoomAsWith(string $recordingType, string $identifier, string $user, int $statusCode, string $apiVersion = 'v1') {
$recordingTypes = [
'video' => 1,
'audio' => 2,
];
$data = [
'type' => 'started',
'started' => [
'token' => FeatureContext::getTokenForIdentifier($identifier),
'status' => $recordingTypes[$recordingType],
'actor' => [
'type' => 'users',
'id' => $user,
],
],
];
$this->sendBackendRequestFromRecordingServer($data, $statusCode, $apiVersion);
}
/**
* @When /^recording server sent stopped request for recording in room "([^"]*)" with (\d+)(?: \((v1)\))?$/
*/
public function recordingServerSentStoppedRequestForRecordingInRoomWith(string $identifier, int $statusCode, string $apiVersion = 'v1') {
$this->recordingServerSentStoppedRequestForRecordingInRoomAsWith($identifier, null, $statusCode, $apiVersion);
}
/**
* @When /^recording server sent stopped request for recording in room "([^"]*)" as "([^"]*)" with (\d+)(?: \((v1)\))?$/
*/
public function recordingServerSentStoppedRequestForRecordingInRoomAsWith(string $identifier, ?string $user, int $statusCode, string $apiVersion = 'v1') {
$data = [
'type' => 'stopped',
'stopped' => [
'token' => FeatureContext::getTokenForIdentifier($identifier),
],
];
if ($user !== null) {
$data['stopped']['actor'] = [
'type' => 'users',
'id' => $user,
];
}
$this->sendBackendRequestFromRecordingServer($data, $statusCode, $apiVersion);
}
/**
* @When /^recording server sent failed request for recording in room "([^"]*)" with (\d+)(?: \((v1)\))?$/
*/
public function recordingServerSentFailedRequestForRecordingInRoomWith(string $identifier, int $statusCode, string $apiVersion = 'v1') {
$data = [
'type' => 'failed',
'failed' => [
'token' => FeatureContext::getTokenForIdentifier($identifier),
],
];
$this->sendBackendRequestFromRecordingServer($data, $statusCode, $apiVersion);
}
private function sendBackendRequestFromRecordingServer(array $data, int $statusCode, string $apiVersion = 'v1') {
$body = json_encode($data);
$random = md5((string) rand());
$checksum = hash_hmac('sha256', $random . $body, "the secret");
$headers = [
'Backend-Url' => $this->baseUrl . 'ocs/v2.php/apps/spreed/api/' . $apiVersion . '/recording/backend',
'Talk-Recording-Random' => $random,
'Talk-Recording-Checksum' => $checksum,
];
$this->sendRequestFullUrl('POST', 'http://' . $this->recordingServerAddress . '/fake/send-backend-request', $body, $headers);
$this->assertStatusCode($this->response, $statusCode);
}
/**
* @Then /^recording server received the following requests$/
*/
public function recordingServerReceivedTheFollowingRequests(TableNode $formData = null) {
$requests = $this->getRecordingServerReceivedRequests();
if ($formData === null) {
Assert::assertEmpty($requests);
return;
}
if ($requests === null) {
Assert::fail('No received requests');
return;
}
$expected = array_map(static function (array $request) {
$request['token'] = FeatureContext::getTokenForIdentifier($request['token']);
return $request;
}, $formData->getHash());
$count = count($expected);
Assert::assertCount($count, $requests, 'Request count does not match');
Assert::assertEquals($expected, $requests);
}
private function getRecordingServerReceivedRequests() {
$url = 'http://' . $this->recordingServerAddress . '/fake/requests';
$client = new Client();
$response = $client->get($url);
return json_decode($response->getBody()->getContents(), true);
}
}
|
