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
|
<?php
namespace Shaarli\Api\Controllers;
use malkusch\lock\mutex\NoMutex;
use Shaarli\Api\Exceptions\ApiBadParametersException;
use Shaarli\Bookmark\BookmarkFileService;
use Shaarli\Bookmark\LinkDB;
use Shaarli\Config\ConfigManager;
use Shaarli\History;
use Slim\Container;
use Slim\Http\Environment;
use Slim\Http\Request;
use Slim\Http\Response;
class PutTagTest extends \Shaarli\TestCase
{
/**
* @var string datastore to test write operations
*/
protected static $testDatastore = 'sandbox/datastore.php';
/**
* @var string datastore to test write operations
*/
protected static $testHistory = 'sandbox/history.php';
/**
* @var ConfigManager instance
*/
protected $conf;
/**
* @var \ReferenceLinkDB instance.
*/
protected $refDB = null;
/**
* @var HistoryController instance.
*/
protected $history;
/**
* @var Container instance.
*/
protected $container;
/**
* @var BookmarkFileService instance.
*/
protected $bookmarkService;
/**
* @var Tags controller instance.
*/
protected $controller;
/**
* Number of JSON field per link.
*/
const NB_FIELDS_TAG = 2;
/**
* Before every test, instantiate a new Api with its config, plugins and bookmarks.
*/
protected function setUp(): void
{
$mutex = new NoMutex();
$this->conf = new ConfigManager('tests/utils/config/configJson');
$this->conf->set('resource.datastore', self::$testDatastore);
$this->refDB = new \ReferenceLinkDB();
$this->refDB->write(self::$testDatastore);
$refHistory = new \ReferenceHistory();
$refHistory->write(self::$testHistory);
$this->history = new History(self::$testHistory);
$this->bookmarkService = new BookmarkFileService($this->conf, $this->history, $mutex, true);
$this->container = new Container();
$this->container['conf'] = $this->conf;
$this->container['db'] = $this->bookmarkService;
$this->container['history'] = $this->history;
$this->controller = new Tags($this->container);
}
/**
* After every test, remove the test datastore.
*/
protected function tearDown(): void
{
@unlink(self::$testDatastore);
@unlink(self::$testHistory);
}
/**
* Test tags update
*/
public function testPutLinkValid()
{
$env = Environment::mock([
'REQUEST_METHOD' => 'PUT',
]);
$tagName = 'gnu';
$update = ['name' => $newName = 'newtag'];
$request = Request::createFromEnvironment($env);
$request = $request->withParsedBody($update);
$response = $this->controller->putTag($request, new Response(), ['tagName' => $tagName]);
$this->assertEquals(200, $response->getStatusCode());
$data = json_decode((string) $response->getBody(), true);
$this->assertEquals(self::NB_FIELDS_TAG, count($data));
$this->assertEquals($newName, $data['name']);
$this->assertEquals(2, $data['occurrences']);
$tags = $this->bookmarkService->bookmarksCountPerTag();
$this->assertNotTrue(isset($tags[$tagName]));
$this->assertEquals(2, $tags[$newName]);
$historyEntry = $this->history->getHistory()[0];
$this->assertEquals(History::UPDATED, $historyEntry['event']);
$this->assertTrue(
(new \DateTime())->add(\DateInterval::createFromDateString('-5 seconds')) < $historyEntry['datetime']
);
$historyEntry = $this->history->getHistory()[1];
$this->assertEquals(History::UPDATED, $historyEntry['event']);
$this->assertTrue(
(new \DateTime())->add(\DateInterval::createFromDateString('-5 seconds')) < $historyEntry['datetime']
);
}
/**
* Test tag update with an existing tag: they should be merged
*/
public function testPutTagMerge()
{
$tagName = 'gnu';
$newName = 'w3c';
$tags = $this->bookmarkService->bookmarksCountPerTag();
$this->assertEquals(1, $tags[$newName]);
$this->assertEquals(2, $tags[$tagName]);
$env = Environment::mock([
'REQUEST_METHOD' => 'PUT',
]);
$update = ['name' => $newName];
$request = Request::createFromEnvironment($env);
$request = $request->withParsedBody($update);
$response = $this->controller->putTag($request, new Response(), ['tagName' => $tagName]);
$this->assertEquals(200, $response->getStatusCode());
$data = json_decode((string) $response->getBody(), true);
$this->assertEquals(self::NB_FIELDS_TAG, count($data));
$this->assertEquals($newName, $data['name']);
$this->assertEquals(3, $data['occurrences']);
$tags = $this->bookmarkService->bookmarksCountPerTag();
$this->assertNotTrue(isset($tags[$tagName]));
$this->assertEquals(3, $tags[$newName]);
}
/**
* Test tag update with an empty new tag name => ApiBadParametersException
*/
public function testPutTagEmpty()
{
$this->expectException(\Shaarli\Api\Exceptions\ApiBadParametersException::class);
$this->expectExceptionMessage('New tag name is required in the request body');
$tagName = 'gnu';
$newName = '';
$tags = $this->bookmarkService->bookmarksCountPerTag();
$this->assertEquals(2, $tags[$tagName]);
$env = Environment::mock([
'REQUEST_METHOD' => 'PUT',
]);
$request = Request::createFromEnvironment($env);
$env = Environment::mock([
'REQUEST_METHOD' => 'PUT',
]);
$update = ['name' => $newName];
$request = Request::createFromEnvironment($env);
$request = $request->withParsedBody($update);
try {
$this->controller->putTag($request, new Response(), ['tagName' => $tagName]);
} catch (ApiBadParametersException $e) {
$tags = $this->bookmarkService->bookmarksCountPerTag();
$this->assertEquals(2, $tags[$tagName]);
throw $e;
}
}
/**
* Test tag update on non existent tag => ApiTagNotFoundException.
*/
public function testPutTag404()
{
$this->expectException(\Shaarli\Api\Exceptions\ApiTagNotFoundException::class);
$this->expectExceptionMessage('Tag not found');
$env = Environment::mock([
'REQUEST_METHOD' => 'PUT',
]);
$request = Request::createFromEnvironment($env);
$this->controller->putTag($request, new Response(), ['tagName' => 'nopenope']);
}
}
|
