diff options
Diffstat (limited to 'tests/api/controllers')
-rw-r--r-- | tests/api/controllers/DeleteLinkTest.php | 126 | ||||
-rw-r--r-- | tests/api/controllers/GetLinkIdTest.php | 1 | ||||
-rw-r--r-- | tests/api/controllers/GetLinksTest.php | 1 | ||||
-rw-r--r-- | tests/api/controllers/HistoryTest.php | 216 | ||||
-rw-r--r-- | tests/api/controllers/InfoTest.php | 1 | ||||
-rw-r--r-- | tests/api/controllers/PostLinkTest.php | 216 | ||||
-rw-r--r-- | tests/api/controllers/PutLinkTest.php | 222 |
7 files changed, 783 insertions, 0 deletions
diff --git a/tests/api/controllers/DeleteLinkTest.php b/tests/api/controllers/DeleteLinkTest.php new file mode 100644 index 00000000..7d797137 --- /dev/null +++ b/tests/api/controllers/DeleteLinkTest.php | |||
@@ -0,0 +1,126 @@ | |||
1 | <?php | ||
2 | |||
3 | |||
4 | namespace Shaarli\Api\Controllers; | ||
5 | |||
6 | use Shaarli\Config\ConfigManager; | ||
7 | use Slim\Container; | ||
8 | use Slim\Http\Environment; | ||
9 | use Slim\Http\Request; | ||
10 | use Slim\Http\Response; | ||
11 | |||
12 | class DeleteLinkTest extends \PHPUnit_Framework_TestCase | ||
13 | { | ||
14 | /** | ||
15 | * @var string datastore to test write operations | ||
16 | */ | ||
17 | protected static $testDatastore = 'sandbox/datastore.php'; | ||
18 | |||
19 | /** | ||
20 | * @var string datastore to test write operations | ||
21 | */ | ||
22 | protected static $testHistory = 'sandbox/history.php'; | ||
23 | |||
24 | /** | ||
25 | * @var ConfigManager instance | ||
26 | */ | ||
27 | protected $conf; | ||
28 | |||
29 | /** | ||
30 | * @var \ReferenceLinkDB instance. | ||
31 | */ | ||
32 | protected $refDB = null; | ||
33 | |||
34 | /** | ||
35 | * @var \LinkDB instance. | ||
36 | */ | ||
37 | protected $linkDB; | ||
38 | |||
39 | /** | ||
40 | * @var \History instance. | ||
41 | */ | ||
42 | protected $history; | ||
43 | |||
44 | /** | ||
45 | * @var Container instance. | ||
46 | */ | ||
47 | protected $container; | ||
48 | |||
49 | /** | ||
50 | * @var Links controller instance. | ||
51 | */ | ||
52 | protected $controller; | ||
53 | |||
54 | /** | ||
55 | * Before each test, instantiate a new Api with its config, plugins and links. | ||
56 | */ | ||
57 | public function setUp() | ||
58 | { | ||
59 | $this->conf = new ConfigManager('tests/utils/config/configJson'); | ||
60 | $this->refDB = new \ReferenceLinkDB(); | ||
61 | $this->refDB->write(self::$testDatastore); | ||
62 | $this->linkDB = new \LinkDB(self::$testDatastore, true, false); | ||
63 | $refHistory = new \ReferenceHistory(); | ||
64 | $refHistory->write(self::$testHistory); | ||
65 | $this->history = new \History(self::$testHistory); | ||
66 | $this->container = new Container(); | ||
67 | $this->container['conf'] = $this->conf; | ||
68 | $this->container['db'] = $this->linkDB; | ||
69 | $this->container['history'] = $this->history; | ||
70 | |||
71 | $this->controller = new Links($this->container); | ||
72 | } | ||
73 | |||
74 | /** | ||
75 | * After each test, remove the test datastore. | ||
76 | */ | ||
77 | public function tearDown() | ||
78 | { | ||
79 | @unlink(self::$testDatastore); | ||
80 | @unlink(self::$testHistory); | ||
81 | } | ||
82 | |||
83 | /** | ||
84 | * Test DELETE link endpoint: the link should be removed. | ||
85 | */ | ||
86 | public function testDeleteLinkValid() | ||
87 | { | ||
88 | $id = '41'; | ||
89 | $this->assertTrue(isset($this->linkDB[$id])); | ||
90 | $env = Environment::mock([ | ||
91 | 'REQUEST_METHOD' => 'DELETE', | ||
92 | ]); | ||
93 | $request = Request::createFromEnvironment($env); | ||
94 | |||
95 | $response = $this->controller->deleteLink($request, new Response(), ['id' => $id]); | ||
96 | $this->assertEquals(204, $response->getStatusCode()); | ||
97 | $this->assertEmpty((string) $response->getBody()); | ||
98 | |||
99 | $this->linkDB = new \LinkDB(self::$testDatastore, true, false); | ||
100 | $this->assertFalse(isset($this->linkDB[$id])); | ||
101 | |||
102 | $historyEntry = $this->history->getHistory()[0]; | ||
103 | $this->assertEquals(\History::DELETED, $historyEntry['event']); | ||
104 | $this->assertTrue( | ||
105 | (new \DateTime())->add(\DateInterval::createFromDateString('-5 seconds')) < $historyEntry['datetime'] | ||
106 | ); | ||
107 | $this->assertEquals($id, $historyEntry['id']); | ||
108 | } | ||
109 | |||
110 | /** | ||
111 | * Test DELETE link endpoint: reach not existing ID. | ||
112 | * | ||
113 | * @expectedException Shaarli\Api\Exceptions\ApiLinkNotFoundException | ||
114 | */ | ||
115 | public function testDeleteLink404() | ||
116 | { | ||
117 | $id = -1; | ||
118 | $this->assertFalse(isset($this->linkDB[$id])); | ||
119 | $env = Environment::mock([ | ||
120 | 'REQUEST_METHOD' => 'DELETE', | ||
121 | ]); | ||
122 | $request = Request::createFromEnvironment($env); | ||
123 | |||
124 | $this->controller->deleteLink($request, new Response(), ['id' => $id]); | ||
125 | } | ||
126 | } | ||
diff --git a/tests/api/controllers/GetLinkIdTest.php b/tests/api/controllers/GetLinkIdTest.php index 45b18e6a..57528d5a 100644 --- a/tests/api/controllers/GetLinkIdTest.php +++ b/tests/api/controllers/GetLinkIdTest.php | |||
@@ -62,6 +62,7 @@ class GetLinkIdTest extends \PHPUnit_Framework_TestCase | |||
62 | $this->container = new Container(); | 62 | $this->container = new Container(); |
63 | $this->container['conf'] = $this->conf; | 63 | $this->container['conf'] = $this->conf; |
64 | $this->container['db'] = new \LinkDB(self::$testDatastore, true, false); | 64 | $this->container['db'] = new \LinkDB(self::$testDatastore, true, false); |
65 | $this->container['history'] = null; | ||
65 | 66 | ||
66 | $this->controller = new Links($this->container); | 67 | $this->controller = new Links($this->container); |
67 | } | 68 | } |
diff --git a/tests/api/controllers/GetLinksTest.php b/tests/api/controllers/GetLinksTest.php index f1b262bc..4cb70224 100644 --- a/tests/api/controllers/GetLinksTest.php +++ b/tests/api/controllers/GetLinksTest.php | |||
@@ -61,6 +61,7 @@ class GetLinksTest extends \PHPUnit_Framework_TestCase | |||
61 | $this->container = new Container(); | 61 | $this->container = new Container(); |
62 | $this->container['conf'] = $this->conf; | 62 | $this->container['conf'] = $this->conf; |
63 | $this->container['db'] = new \LinkDB(self::$testDatastore, true, false); | 63 | $this->container['db'] = new \LinkDB(self::$testDatastore, true, false); |
64 | $this->container['history'] = null; | ||
64 | 65 | ||
65 | $this->controller = new Links($this->container); | 66 | $this->controller = new Links($this->container); |
66 | } | 67 | } |
diff --git a/tests/api/controllers/HistoryTest.php b/tests/api/controllers/HistoryTest.php new file mode 100644 index 00000000..61046d97 --- /dev/null +++ b/tests/api/controllers/HistoryTest.php | |||
@@ -0,0 +1,216 @@ | |||
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 | require_once 'tests/utils/ReferenceHistory.php'; | ||
14 | |||
15 | class HistoryTest extends \PHPUnit_Framework_TestCase | ||
16 | { | ||
17 | /** | ||
18 | * @var string datastore to test write operations | ||
19 | */ | ||
20 | protected static $testHistory = 'sandbox/history.php'; | ||
21 | |||
22 | /** | ||
23 | * @var ConfigManager instance | ||
24 | */ | ||
25 | protected $conf; | ||
26 | |||
27 | /** | ||
28 | * @var \ReferenceHistory instance. | ||
29 | */ | ||
30 | protected $refHistory = null; | ||
31 | |||
32 | /** | ||
33 | * @var Container instance. | ||
34 | */ | ||
35 | protected $container; | ||
36 | |||
37 | /** | ||
38 | * @var History controller instance. | ||
39 | */ | ||
40 | protected $controller; | ||
41 | |||
42 | /** | ||
43 | * Before every test, instantiate a new Api with its config, plugins and links. | ||
44 | */ | ||
45 | public function setUp() | ||
46 | { | ||
47 | $this->conf = new ConfigManager('tests/utils/config/configJson.json.php'); | ||
48 | $this->refHistory = new \ReferenceHistory(); | ||
49 | $this->refHistory->write(self::$testHistory); | ||
50 | $this->container = new Container(); | ||
51 | $this->container['conf'] = $this->conf; | ||
52 | $this->container['db'] = true; | ||
53 | $this->container['history'] = new \History(self::$testHistory); | ||
54 | |||
55 | $this->controller = new History($this->container); | ||
56 | } | ||
57 | |||
58 | /** | ||
59 | * After every test, remove the test datastore. | ||
60 | */ | ||
61 | public function tearDown() | ||
62 | { | ||
63 | @unlink(self::$testHistory); | ||
64 | } | ||
65 | |||
66 | /** | ||
67 | * Test /history service without parameter. | ||
68 | */ | ||
69 | public function testGetHistory() | ||
70 | { | ||
71 | $env = Environment::mock([ | ||
72 | 'REQUEST_METHOD' => 'GET', | ||
73 | ]); | ||
74 | $request = Request::createFromEnvironment($env); | ||
75 | |||
76 | $response = $this->controller->getHistory($request, new Response()); | ||
77 | $this->assertEquals(200, $response->getStatusCode()); | ||
78 | $data = json_decode((string) $response->getBody(), true); | ||
79 | |||
80 | $this->assertEquals($this->refHistory->count(), count($data)); | ||
81 | |||
82 | $this->assertEquals(\History::DELETED, $data[0]['event']); | ||
83 | $this->assertEquals( | ||
84 | \DateTime::createFromFormat('Ymd_His', '20170303_121216')->format(\DateTime::ATOM), | ||
85 | $data[0]['datetime'] | ||
86 | ); | ||
87 | $this->assertEquals(124, $data[0]['id']); | ||
88 | |||
89 | $this->assertEquals(\History::SETTINGS, $data[1]['event']); | ||
90 | $this->assertEquals( | ||
91 | \DateTime::createFromFormat('Ymd_His', '20170302_121215')->format(\DateTime::ATOM), | ||
92 | $data[1]['datetime'] | ||
93 | ); | ||
94 | $this->assertNull($data[1]['id']); | ||
95 | |||
96 | $this->assertEquals(\History::UPDATED, $data[2]['event']); | ||
97 | $this->assertEquals( | ||
98 | \DateTime::createFromFormat('Ymd_His', '20170301_121214')->format(\DateTime::ATOM), | ||
99 | $data[2]['datetime'] | ||
100 | ); | ||
101 | $this->assertEquals(123, $data[2]['id']); | ||
102 | |||
103 | $this->assertEquals(\History::CREATED, $data[3]['event']); | ||
104 | $this->assertEquals( | ||
105 | \DateTime::createFromFormat('Ymd_His', '20170201_121214')->format(\DateTime::ATOM), | ||
106 | $data[3]['datetime'] | ||
107 | ); | ||
108 | $this->assertEquals(124, $data[3]['id']); | ||
109 | |||
110 | $this->assertEquals(\History::CREATED, $data[4]['event']); | ||
111 | $this->assertEquals( | ||
112 | \DateTime::createFromFormat('Ymd_His', '20170101_121212')->format(\DateTime::ATOM), | ||
113 | $data[4]['datetime'] | ||
114 | ); | ||
115 | $this->assertEquals(123, $data[4]['id']); | ||
116 | } | ||
117 | |||
118 | /** | ||
119 | * Test /history service with limit parameter. | ||
120 | */ | ||
121 | public function testGetHistoryLimit() | ||
122 | { | ||
123 | $env = Environment::mock([ | ||
124 | 'REQUEST_METHOD' => 'GET', | ||
125 | 'QUERY_STRING' => 'limit=1' | ||
126 | ]); | ||
127 | $request = Request::createFromEnvironment($env); | ||
128 | |||
129 | $response = $this->controller->getHistory($request, new Response()); | ||
130 | $this->assertEquals(200, $response->getStatusCode()); | ||
131 | $data = json_decode((string) $response->getBody(), true); | ||
132 | |||
133 | $this->assertEquals(1, count($data)); | ||
134 | |||
135 | $this->assertEquals(\History::DELETED, $data[0]['event']); | ||
136 | $this->assertEquals( | ||
137 | \DateTime::createFromFormat('Ymd_His', '20170303_121216')->format(\DateTime::ATOM), | ||
138 | $data[0]['datetime'] | ||
139 | ); | ||
140 | $this->assertEquals(124, $data[0]['id']); | ||
141 | } | ||
142 | |||
143 | /** | ||
144 | * Test /history service with offset parameter. | ||
145 | */ | ||
146 | public function testGetHistoryOffset() | ||
147 | { | ||
148 | $env = Environment::mock([ | ||
149 | 'REQUEST_METHOD' => 'GET', | ||
150 | 'QUERY_STRING' => 'offset=4' | ||
151 | ]); | ||
152 | $request = Request::createFromEnvironment($env); | ||
153 | |||
154 | $response = $this->controller->getHistory($request, new Response()); | ||
155 | $this->assertEquals(200, $response->getStatusCode()); | ||
156 | $data = json_decode((string) $response->getBody(), true); | ||
157 | |||
158 | $this->assertEquals(1, count($data)); | ||
159 | |||
160 | $this->assertEquals(\History::CREATED, $data[0]['event']); | ||
161 | $this->assertEquals( | ||
162 | \DateTime::createFromFormat('Ymd_His', '20170101_121212')->format(\DateTime::ATOM), | ||
163 | $data[0]['datetime'] | ||
164 | ); | ||
165 | $this->assertEquals(123, $data[0]['id']); | ||
166 | } | ||
167 | |||
168 | /** | ||
169 | * Test /history service with since parameter. | ||
170 | */ | ||
171 | public function testGetHistorySince() | ||
172 | { | ||
173 | $env = Environment::mock([ | ||
174 | 'REQUEST_METHOD' => 'GET', | ||
175 | 'QUERY_STRING' => 'since=2017-03-03T00:00:00%2B00:00' | ||
176 | ]); | ||
177 | $request = Request::createFromEnvironment($env); | ||
178 | |||
179 | $response = $this->controller->getHistory($request, new Response()); | ||
180 | $this->assertEquals(200, $response->getStatusCode()); | ||
181 | $data = json_decode((string) $response->getBody(), true); | ||
182 | |||
183 | $this->assertEquals(1, count($data)); | ||
184 | |||
185 | $this->assertEquals(\History::DELETED, $data[0]['event']); | ||
186 | $this->assertEquals( | ||
187 | \DateTime::createFromFormat('Ymd_His', '20170303_121216')->format(\DateTime::ATOM), | ||
188 | $data[0]['datetime'] | ||
189 | ); | ||
190 | $this->assertEquals(124, $data[0]['id']); | ||
191 | } | ||
192 | |||
193 | /** | ||
194 | * Test /history service with since parameter. | ||
195 | */ | ||
196 | public function testGetHistorySinceOffsetLimit() | ||
197 | { | ||
198 | $env = Environment::mock([ | ||
199 | 'REQUEST_METHOD' => 'GET', | ||
200 | 'QUERY_STRING' => 'since=2017-02-01T00:00:00%2B00:00&offset=1&limit=1' | ||
201 | ]); | ||
202 | $request = Request::createFromEnvironment($env); | ||
203 | |||
204 | $response = $this->controller->getHistory($request, new Response()); | ||
205 | $this->assertEquals(200, $response->getStatusCode()); | ||
206 | $data = json_decode((string) $response->getBody(), true); | ||
207 | |||
208 | $this->assertEquals(1, count($data)); | ||
209 | |||
210 | $this->assertEquals(\History::SETTINGS, $data[0]['event']); | ||
211 | $this->assertEquals( | ||
212 | \DateTime::createFromFormat('Ymd_His', '20170302_121215')->format(\DateTime::ATOM), | ||
213 | $data[0]['datetime'] | ||
214 | ); | ||
215 | } | ||
216 | } | ||
diff --git a/tests/api/controllers/InfoTest.php b/tests/api/controllers/InfoTest.php index 5d6a2329..f7e63bfa 100644 --- a/tests/api/controllers/InfoTest.php +++ b/tests/api/controllers/InfoTest.php | |||
@@ -54,6 +54,7 @@ class InfoTest extends \PHPUnit_Framework_TestCase | |||
54 | $this->container = new Container(); | 54 | $this->container = new Container(); |
55 | $this->container['conf'] = $this->conf; | 55 | $this->container['conf'] = $this->conf; |
56 | $this->container['db'] = new \LinkDB(self::$testDatastore, true, false); | 56 | $this->container['db'] = new \LinkDB(self::$testDatastore, true, false); |
57 | $this->container['history'] = null; | ||
57 | 58 | ||
58 | $this->controller = new Info($this->container); | 59 | $this->controller = new Info($this->container); |
59 | } | 60 | } |
diff --git a/tests/api/controllers/PostLinkTest.php b/tests/api/controllers/PostLinkTest.php new file mode 100644 index 00000000..31954e39 --- /dev/null +++ b/tests/api/controllers/PostLinkTest.php | |||
@@ -0,0 +1,216 @@ | |||
1 | <?php | ||
2 | |||
3 | namespace Shaarli\Api\Controllers; | ||
4 | |||
5 | |||
6 | use Shaarli\Config\ConfigManager; | ||
7 | use Slim\Container; | ||
8 | use Slim\Http\Environment; | ||
9 | use Slim\Http\Request; | ||
10 | use Slim\Http\Response; | ||
11 | |||
12 | /** | ||
13 | * Class PostLinkTest | ||
14 | * | ||
15 | * Test POST Link REST API service. | ||
16 | * | ||
17 | * @package Shaarli\Api\Controllers | ||
18 | */ | ||
19 | class PostLinkTest extends \PHPUnit_Framework_TestCase | ||
20 | { | ||
21 | /** | ||
22 | * @var string datastore to test write operations | ||
23 | */ | ||
24 | protected static $testDatastore = 'sandbox/datastore.php'; | ||
25 | |||
26 | /** | ||
27 | * @var string datastore to test write operations | ||
28 | */ | ||
29 | protected static $testHistory = 'sandbox/history.php'; | ||
30 | |||
31 | /** | ||
32 | * @var ConfigManager instance | ||
33 | */ | ||
34 | protected $conf; | ||
35 | |||
36 | /** | ||
37 | * @var \ReferenceLinkDB instance. | ||
38 | */ | ||
39 | protected $refDB = null; | ||
40 | |||
41 | /** | ||
42 | * @var \History instance. | ||
43 | */ | ||
44 | protected $history; | ||
45 | |||
46 | /** | ||
47 | * @var Container instance. | ||
48 | */ | ||
49 | protected $container; | ||
50 | |||
51 | /** | ||
52 | * @var Links controller instance. | ||
53 | */ | ||
54 | protected $controller; | ||
55 | |||
56 | /** | ||
57 | * Number of JSON field per link. | ||
58 | */ | ||
59 | const NB_FIELDS_LINK = 9; | ||
60 | |||
61 | /** | ||
62 | * Before every test, instantiate a new Api with its config, plugins and links. | ||
63 | */ | ||
64 | public function setUp() | ||
65 | { | ||
66 | $this->conf = new ConfigManager('tests/utils/config/configJson.json.php'); | ||
67 | $this->refDB = new \ReferenceLinkDB(); | ||
68 | $this->refDB->write(self::$testDatastore); | ||
69 | |||
70 | $refHistory = new \ReferenceHistory(); | ||
71 | $refHistory->write(self::$testHistory); | ||
72 | $this->history = new \History(self::$testHistory); | ||
73 | |||
74 | $this->container = new Container(); | ||
75 | $this->container['conf'] = $this->conf; | ||
76 | $this->container['db'] = new \LinkDB(self::$testDatastore, true, false); | ||
77 | $this->container['history'] = new \History(self::$testHistory); | ||
78 | |||
79 | $this->controller = new Links($this->container); | ||
80 | |||
81 | $mock = $this->getMock('\Slim\Router', ['relativePathFor']); | ||
82 | $mock->expects($this->any()) | ||
83 | ->method('relativePathFor') | ||
84 | ->willReturn('api/v1/links/1'); | ||
85 | |||
86 | // affect @property-read... seems to work | ||
87 | $this->controller->getCi()->router = $mock; | ||
88 | |||
89 | // Used by index_url(). | ||
90 | $this->controller->getCi()['environment'] = [ | ||
91 | 'SERVER_NAME' => 'domain.tld', | ||
92 | 'SERVER_PORT' => 80, | ||
93 | 'SCRIPT_NAME' => '/', | ||
94 | ]; | ||
95 | } | ||
96 | |||
97 | /** | ||
98 | * After every test, remove the test datastore. | ||
99 | */ | ||
100 | public function tearDown() | ||
101 | { | ||
102 | @unlink(self::$testDatastore); | ||
103 | @unlink(self::$testHistory); | ||
104 | } | ||
105 | |||
106 | /** | ||
107 | * Test link creation without any field: creates a blank note. | ||
108 | */ | ||
109 | public function testPostLinkMinimal() | ||
110 | { | ||
111 | $env = Environment::mock([ | ||
112 | 'REQUEST_METHOD' => 'POST', | ||
113 | ]); | ||
114 | |||
115 | $request = Request::createFromEnvironment($env); | ||
116 | |||
117 | $response = $this->controller->postLink($request, new Response()); | ||
118 | $this->assertEquals(201, $response->getStatusCode()); | ||
119 | $this->assertEquals('api/v1/links/1', $response->getHeader('Location')[0]); | ||
120 | $data = json_decode((string) $response->getBody(), true); | ||
121 | $this->assertEquals(self::NB_FIELDS_LINK, count($data)); | ||
122 | $this->assertEquals(43, $data['id']); | ||
123 | $this->assertRegExp('/[\w-_]{6}/', $data['shorturl']); | ||
124 | $this->assertEquals('http://domain.tld/?' . $data['shorturl'], $data['url']); | ||
125 | $this->assertEquals('?' . $data['shorturl'], $data['title']); | ||
126 | $this->assertEquals('', $data['description']); | ||
127 | $this->assertEquals([], $data['tags']); | ||
128 | $this->assertEquals(false, $data['private']); | ||
129 | $this->assertTrue(new \DateTime('5 seconds ago') < \DateTime::createFromFormat(\DateTime::ATOM, $data['created'])); | ||
130 | $this->assertEquals('', $data['updated']); | ||
131 | |||
132 | $historyEntry = $this->history->getHistory()[0]; | ||
133 | $this->assertEquals(\History::CREATED, $historyEntry['event']); | ||
134 | $this->assertTrue( | ||
135 | (new \DateTime())->add(\DateInterval::createFromDateString('-5 seconds')) < $historyEntry['datetime'] | ||
136 | ); | ||
137 | $this->assertEquals(43, $historyEntry['id']); | ||
138 | } | ||
139 | |||
140 | /** | ||
141 | * Test link creation with all available fields. | ||
142 | */ | ||
143 | public function testPostLinkFull() | ||
144 | { | ||
145 | $link = [ | ||
146 | 'url' => 'website.tld/test?foo=bar', | ||
147 | 'title' => 'new entry', | ||
148 | 'description' => 'shaare description', | ||
149 | 'tags' => ['one', 'two'], | ||
150 | 'private' => true, | ||
151 | ]; | ||
152 | $env = Environment::mock([ | ||
153 | 'REQUEST_METHOD' => 'POST', | ||
154 | 'CONTENT_TYPE' => 'application/json' | ||
155 | ]); | ||
156 | |||
157 | $request = Request::createFromEnvironment($env); | ||
158 | $request = $request->withParsedBody($link); | ||
159 | $response = $this->controller->postLink($request, new Response()); | ||
160 | |||
161 | $this->assertEquals(201, $response->getStatusCode()); | ||
162 | $this->assertEquals('api/v1/links/1', $response->getHeader('Location')[0]); | ||
163 | $data = json_decode((string) $response->getBody(), true); | ||
164 | $this->assertEquals(self::NB_FIELDS_LINK, count($data)); | ||
165 | $this->assertEquals(43, $data['id']); | ||
166 | $this->assertRegExp('/[\w-_]{6}/', $data['shorturl']); | ||
167 | $this->assertEquals('http://' . $link['url'], $data['url']); | ||
168 | $this->assertEquals($link['title'], $data['title']); | ||
169 | $this->assertEquals($link['description'], $data['description']); | ||
170 | $this->assertEquals($link['tags'], $data['tags']); | ||
171 | $this->assertEquals(true, $data['private']); | ||
172 | $this->assertTrue(new \DateTime('2 seconds ago') < \DateTime::createFromFormat(\DateTime::ATOM, $data['created'])); | ||
173 | $this->assertEquals('', $data['updated']); | ||
174 | } | ||
175 | |||
176 | /** | ||
177 | * Test link creation with an existing link (duplicate URL). Should return a 409 HTTP error and the existing link. | ||
178 | */ | ||
179 | public function testPostLinkDuplicate() | ||
180 | { | ||
181 | $link = [ | ||
182 | 'url' => 'mediagoblin.org/', | ||
183 | 'title' => 'new entry', | ||
184 | 'description' => 'shaare description', | ||
185 | 'tags' => ['one', 'two'], | ||
186 | 'private' => true, | ||
187 | ]; | ||
188 | $env = Environment::mock([ | ||
189 | 'REQUEST_METHOD' => 'POST', | ||
190 | 'CONTENT_TYPE' => 'application/json' | ||
191 | ]); | ||
192 | |||
193 | $request = Request::createFromEnvironment($env); | ||
194 | $request = $request->withParsedBody($link); | ||
195 | $response = $this->controller->postLink($request, new Response()); | ||
196 | |||
197 | $this->assertEquals(409, $response->getStatusCode()); | ||
198 | $data = json_decode((string) $response->getBody(), true); | ||
199 | $this->assertEquals(self::NB_FIELDS_LINK, count($data)); | ||
200 | $this->assertEquals(7, $data['id']); | ||
201 | $this->assertEquals('IuWvgA', $data['shorturl']); | ||
202 | $this->assertEquals('http://mediagoblin.org/', $data['url']); | ||
203 | $this->assertEquals('MediaGoblin', $data['title']); | ||
204 | $this->assertEquals('A free software media publishing platform #hashtagOther', $data['description']); | ||
205 | $this->assertEquals(['gnu', 'media', 'web', '.hidden', 'hashtag'], $data['tags']); | ||
206 | $this->assertEquals(false, $data['private']); | ||
207 | $this->assertEquals( | ||
208 | \DateTime::createFromFormat(\LinkDB::LINK_DATE_FORMAT, '20130614_184135'), | ||
209 | \DateTime::createFromFormat(\DateTime::ATOM, $data['created']) | ||
210 | ); | ||
211 | $this->assertEquals( | ||
212 | \DateTime::createFromFormat(\LinkDB::LINK_DATE_FORMAT, '20130615_184230'), | ||
213 | \DateTime::createFromFormat(\DateTime::ATOM, $data['updated']) | ||
214 | ); | ||
215 | } | ||
216 | } | ||
diff --git a/tests/api/controllers/PutLinkTest.php b/tests/api/controllers/PutLinkTest.php new file mode 100644 index 00000000..8a562571 --- /dev/null +++ b/tests/api/controllers/PutLinkTest.php | |||
@@ -0,0 +1,222 @@ | |||
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 | } | ||