diff options
author | ArthurHoaro <arthur@hoa.ro> | 2018-05-19 15:04:04 +0200 |
---|---|---|
committer | ArthurHoaro <arthur@hoa.ro> | 2018-06-04 18:51:22 +0200 |
commit | d3f42ca487287447efb81061609644108044a038 (patch) | |
tree | 6e9d5a33290f857c8f7a04dbdf8cf0ca749db149 /tests/api/controllers/PutLinkTest.php | |
parent | 17e45b2e9c33c736751e059276fadb480f98e621 (diff) | |
download | Shaarli-d3f42ca487287447efb81061609644108044a038.tar.gz Shaarli-d3f42ca487287447efb81061609644108044a038.tar.zst Shaarli-d3f42ca487287447efb81061609644108044a038.zip |
Implements Tags endpoints for Shaarli's REST API
Endpoints:
* List All Tags [GET]
* Get a tag [GET]
* Update a tag [PUT]
* Delete a tag [DELETE]
Fixes #904
References shaarli/api-documentation#34
Diffstat (limited to 'tests/api/controllers/PutLinkTest.php')
-rw-r--r-- | tests/api/controllers/PutLinkTest.php | 222 |
1 files changed, 0 insertions, 222 deletions
diff --git a/tests/api/controllers/PutLinkTest.php b/tests/api/controllers/PutLinkTest.php deleted file mode 100644 index 8a562571..00000000 --- a/tests/api/controllers/PutLinkTest.php +++ /dev/null | |||
@@ -1,222 +0,0 @@ | |||
1 | <?php | ||
2 | |||
3 | |||
4 | namespace Shaarli\Api\Controllers; | ||
5 | |||
6 | |||
7 | use Shaarli\Config\ConfigManager; | ||
8 | use Slim\Container; | ||
9 | use Slim\Http\Environment; | ||
10 | use Slim\Http\Request; | ||
11 | use Slim\Http\Response; | ||
12 | |||
13 | class PutLinkTest extends \PHPUnit_Framework_TestCase | ||
14 | { | ||
15 | /** | ||
16 | * @var string datastore to test write operations | ||
17 | */ | ||
18 | protected static $testDatastore = 'sandbox/datastore.php'; | ||
19 | |||
20 | /** | ||
21 | * @var string datastore to test write operations | ||
22 | */ | ||
23 | protected static $testHistory = 'sandbox/history.php'; | ||
24 | |||
25 | /** | ||
26 | * @var ConfigManager instance | ||
27 | */ | ||
28 | protected $conf; | ||
29 | |||
30 | /** | ||
31 | * @var \ReferenceLinkDB instance. | ||
32 | */ | ||
33 | protected $refDB = null; | ||
34 | |||
35 | /** | ||
36 | * @var \History instance. | ||
37 | */ | ||
38 | protected $history; | ||
39 | |||
40 | /** | ||
41 | * @var Container instance. | ||
42 | */ | ||
43 | protected $container; | ||
44 | |||
45 | /** | ||
46 | * @var Links controller instance. | ||
47 | */ | ||
48 | protected $controller; | ||
49 | |||
50 | /** | ||
51 | * Number of JSON field per link. | ||
52 | */ | ||
53 | const NB_FIELDS_LINK = 9; | ||
54 | |||
55 | /** | ||
56 | * Before every test, instantiate a new Api with its config, plugins and links. | ||
57 | */ | ||
58 | public function setUp() | ||
59 | { | ||
60 | $this->conf = new ConfigManager('tests/utils/config/configJson.json.php'); | ||
61 | $this->refDB = new \ReferenceLinkDB(); | ||
62 | $this->refDB->write(self::$testDatastore); | ||
63 | |||
64 | $refHistory = new \ReferenceHistory(); | ||
65 | $refHistory->write(self::$testHistory); | ||
66 | $this->history = new \History(self::$testHistory); | ||
67 | |||
68 | $this->container = new Container(); | ||
69 | $this->container['conf'] = $this->conf; | ||
70 | $this->container['db'] = new \LinkDB(self::$testDatastore, true, false); | ||
71 | $this->container['history'] = new \History(self::$testHistory); | ||
72 | |||
73 | $this->controller = new Links($this->container); | ||
74 | |||
75 | // Used by index_url(). | ||
76 | $this->controller->getCi()['environment'] = [ | ||
77 | 'SERVER_NAME' => 'domain.tld', | ||
78 | 'SERVER_PORT' => 80, | ||
79 | 'SCRIPT_NAME' => '/', | ||
80 | ]; | ||
81 | } | ||
82 | |||
83 | /** | ||
84 | * After every test, remove the test datastore. | ||
85 | */ | ||
86 | public function tearDown() | ||
87 | { | ||
88 | @unlink(self::$testDatastore); | ||
89 | @unlink(self::$testHistory); | ||
90 | } | ||
91 | |||
92 | /** | ||
93 | * Test link update without value: reset the link to default values | ||
94 | */ | ||
95 | public function testPutLinkMinimal() | ||
96 | { | ||
97 | $env = Environment::mock([ | ||
98 | 'REQUEST_METHOD' => 'PUT', | ||
99 | ]); | ||
100 | $id = '41'; | ||
101 | $request = Request::createFromEnvironment($env); | ||
102 | |||
103 | $response = $this->controller->putLink($request, new Response(), ['id' => $id]); | ||
104 | $this->assertEquals(200, $response->getStatusCode()); | ||
105 | $data = json_decode((string) $response->getBody(), true); | ||
106 | $this->assertEquals(self::NB_FIELDS_LINK, count($data)); | ||
107 | $this->assertEquals($id, $data['id']); | ||
108 | $this->assertEquals('WDWyig', $data['shorturl']); | ||
109 | $this->assertEquals('http://domain.tld/?WDWyig', $data['url']); | ||
110 | $this->assertEquals('?WDWyig', $data['title']); | ||
111 | $this->assertEquals('', $data['description']); | ||
112 | $this->assertEquals([], $data['tags']); | ||
113 | $this->assertEquals(false, $data['private']); | ||
114 | $this->assertEquals( | ||
115 | \DateTime::createFromFormat('Ymd_His', '20150310_114651'), | ||
116 | \DateTime::createFromFormat(\DateTime::ATOM, $data['created']) | ||
117 | ); | ||
118 | $this->assertTrue(new \DateTime('5 seconds ago') < \DateTime::createFromFormat(\DateTime::ATOM, $data['updated'])); | ||
119 | |||
120 | $historyEntry = $this->history->getHistory()[0]; | ||
121 | $this->assertEquals(\History::UPDATED, $historyEntry['event']); | ||
122 | $this->assertTrue( | ||
123 | (new \DateTime())->add(\DateInterval::createFromDateString('-5 seconds')) < $historyEntry['datetime'] | ||
124 | ); | ||
125 | $this->assertEquals($id, $historyEntry['id']); | ||
126 | } | ||
127 | |||
128 | /** | ||
129 | * Test link update with new values | ||
130 | */ | ||
131 | public function testPutLinkWithValues() | ||
132 | { | ||
133 | $env = Environment::mock([ | ||
134 | 'REQUEST_METHOD' => 'PUT', | ||
135 | 'CONTENT_TYPE' => 'application/json' | ||
136 | ]); | ||
137 | $id = 41; | ||
138 | $update = [ | ||
139 | 'url' => 'http://somewhere.else', | ||
140 | 'title' => 'Le Cid', | ||
141 | 'description' => 'Percé jusques au fond du cœur [...]', | ||
142 | 'tags' => ['corneille', 'rodrigue'], | ||
143 | 'private' => true, | ||
144 | ]; | ||
145 | $request = Request::createFromEnvironment($env); | ||
146 | $request = $request->withParsedBody($update); | ||
147 | |||
148 | $response = $this->controller->putLink($request, new Response(), ['id' => $id]); | ||
149 | $this->assertEquals(200, $response->getStatusCode()); | ||
150 | $data = json_decode((string) $response->getBody(), true); | ||
151 | $this->assertEquals(self::NB_FIELDS_LINK, count($data)); | ||
152 | $this->assertEquals($id, $data['id']); | ||
153 | $this->assertEquals('WDWyig', $data['shorturl']); | ||
154 | $this->assertEquals('http://somewhere.else', $data['url']); | ||
155 | $this->assertEquals('Le Cid', $data['title']); | ||
156 | $this->assertEquals('Percé jusques au fond du cœur [...]', $data['description']); | ||
157 | $this->assertEquals(['corneille', 'rodrigue'], $data['tags']); | ||
158 | $this->assertEquals(true, $data['private']); | ||
159 | $this->assertEquals( | ||
160 | \DateTime::createFromFormat('Ymd_His', '20150310_114651'), | ||
161 | \DateTime::createFromFormat(\DateTime::ATOM, $data['created']) | ||
162 | ); | ||
163 | $this->assertTrue(new \DateTime('5 seconds ago') < \DateTime::createFromFormat(\DateTime::ATOM, $data['updated'])); | ||
164 | } | ||
165 | |||
166 | /** | ||
167 | * Test link update with an existing URL: 409 Conflict with the existing link as body | ||
168 | */ | ||
169 | public function testPutLinkDuplicate() | ||
170 | { | ||
171 | $link = [ | ||
172 | 'url' => 'mediagoblin.org/', | ||
173 | 'title' => 'new entry', | ||
174 | 'description' => 'shaare description', | ||
175 | 'tags' => ['one', 'two'], | ||
176 | 'private' => true, | ||
177 | ]; | ||
178 | $env = Environment::mock([ | ||
179 | 'REQUEST_METHOD' => 'PUT', | ||
180 | 'CONTENT_TYPE' => 'application/json' | ||
181 | ]); | ||
182 | |||
183 | $request = Request::createFromEnvironment($env); | ||
184 | $request = $request->withParsedBody($link); | ||
185 | $response = $this->controller->putLink($request, new Response(), ['id' => 41]); | ||
186 | |||
187 | $this->assertEquals(409, $response->getStatusCode()); | ||
188 | $data = json_decode((string) $response->getBody(), true); | ||
189 | $this->assertEquals(self::NB_FIELDS_LINK, count($data)); | ||
190 | $this->assertEquals(7, $data['id']); | ||
191 | $this->assertEquals('IuWvgA', $data['shorturl']); | ||
192 | $this->assertEquals('http://mediagoblin.org/', $data['url']); | ||
193 | $this->assertEquals('MediaGoblin', $data['title']); | ||
194 | $this->assertEquals('A free software media publishing platform #hashtagOther', $data['description']); | ||
195 | $this->assertEquals(['gnu', 'media', 'web', '.hidden', 'hashtag'], $data['tags']); | ||
196 | $this->assertEquals(false, $data['private']); | ||
197 | $this->assertEquals( | ||
198 | \DateTime::createFromFormat(\LinkDB::LINK_DATE_FORMAT, '20130614_184135'), | ||
199 | \DateTime::createFromFormat(\DateTime::ATOM, $data['created']) | ||
200 | ); | ||
201 | $this->assertEquals( | ||
202 | \DateTime::createFromFormat(\LinkDB::LINK_DATE_FORMAT, '20130615_184230'), | ||
203 | \DateTime::createFromFormat(\DateTime::ATOM, $data['updated']) | ||
204 | ); | ||
205 | } | ||
206 | |||
207 | /** | ||
208 | * Test link update on non existent link => ApiLinkNotFoundException. | ||
209 | * | ||
210 | * @expectedException Shaarli\Api\Exceptions\ApiLinkNotFoundException | ||
211 | * @expectedExceptionMessage Link not found | ||
212 | */ | ||
213 | public function testGetLink404() | ||
214 | { | ||
215 | $env = Environment::mock([ | ||
216 | 'REQUEST_METHOD' => 'PUT', | ||
217 | ]); | ||
218 | $request = Request::createFromEnvironment($env); | ||
219 | |||
220 | $this->controller->putLink($request, new Response(), ['id' => -1]); | ||
221 | } | ||
222 | } | ||