*/ class TestV1_2 extends \JKingWeb\Arsse\Test\AbstractTest { protected $h; protected $transaction; protected $userId; protected $feeds = [ // expected sample output of a feed list from the database, and the resultant expected transformation by the REST handler 'db' => [ [ 'id' => 2112, 'url' => 'http://example.com/news.atom', 'icon_url' => 'http://example.com/favicon.png', 'source' => 'http://example.com/', 'folder' => null, 'top_folder' => null, 'pinned' => 0, 'err_count' => 0, 'err_msg' => '', 'order_type' => 0, 'added' => '2017-05-20 13:35:54', 'title' => 'First example feed', 'unread' => 50048, ], [ 'id' => 42, 'url' => 'http://example.org/news.atom', 'icon_url' => 'http://example.org/favicon.png', 'source' => 'http://example.org/', 'folder' => 12, 'top_folder' => 8, 'pinned' => 1, 'err_count' => 0, 'err_msg' => '', 'order_type' => 2, 'added' => '2017-05-20 13:35:54', 'title' => 'Second example feed', 'unread' => 23, ], [ 'id' => 47, 'url' => 'http://example.net/news.atom', 'icon_url' => 'http://example.net/favicon.png', 'source' => 'http://example.net/', 'folder' => null, 'top_folder' => null, 'pinned' => 0, 'err_count' => 0, 'err_msg' => null, 'order_type' => 1, 'added' => '2017-05-20 13:35:54', 'title' => 'Third example feed', 'unread' => 0, ], ], 'rest' => [ [ 'id' => 2112, 'url' => 'http://example.com/news.atom', 'title' => 'First example feed', 'added' => 1495287354, 'pinned' => false, 'link' => 'http://example.com/', 'faviconLink' => 'http://example.com/favicon.png', 'folderId' => 0, 'unreadCount' => 50048, 'ordering' => 0, 'updateErrorCount' => 0, 'lastUpdateError' => '', ], [ 'id' => 42, 'url' => 'http://example.org/news.atom', 'title' => 'Second example feed', 'added' => 1495287354, 'pinned' => true, 'link' => 'http://example.org/', 'faviconLink' => 'http://example.org/favicon.png', 'folderId' => 8, 'unreadCount' => 23, 'ordering' => 2, 'updateErrorCount' => 0, 'lastUpdateError' => '', ], [ 'id' => 47, 'url' => 'http://example.net/news.atom', 'title' => 'Third example feed', 'added' => 1495287354, 'pinned' => false, 'link' => 'http://example.net/', 'faviconLink' => 'http://example.net/favicon.png', 'folderId' => 0, 'unreadCount' => 0, 'ordering' => 1, 'updateErrorCount' => 0, 'lastUpdateError' => '', ], ], ]; protected $articles = [ 'db' => [ [ 'id' => 101, 'url' => 'http://example.com/1', 'title' => 'Article title 1', 'author' => '', 'content' => '
Article content 1
', 'guid' => 'e433653cef2e572eee4215fa299a4a5af9137b2cefd6283c85bd69a32915beda', 'published_date' => '2000-01-01 00:00:00', 'edited_date' => '2000-01-01 00:00:01', 'modified_date' => '2000-01-01 01:00:00', 'unread' => 1, 'starred' => 0, 'edition' => 101, 'subscription' => 8, 'fingerprint' => 'f5cb8bfc1c7396dc9816af212a3e2ac5221585c2a00bf7ccb6aabd95dcfcd6a6:fb0bc8f8cb08913dc5a497db700e327f1d34e4987402687d494a5891f24714d4:18fdd4fa93d693128c43b004399e5c9cea6c261ddfa002518d3669f55d8c2207', 'media_url' => null, 'media_type' => null, ], [ 'id' => 102, 'url' => 'http://example.com/2', 'title' => 'Article title 2', 'author' => '', 'content' => 'Article content 2
', 'guid' => '5be8a5a46ecd52ed132191c8d27fb1af6b3d4edc00234c5d9f8f0e10562ed3b7', 'published_date' => '2000-01-02 00:00:00', 'edited_date' => '2000-01-02 00:00:02', 'modified_date' => '2000-01-02 02:00:00', 'unread' => 0, 'starred' => 0, 'edition' => 202, 'subscription' => 8, 'fingerprint' => '0e86d2de822a174fe3c44a466953e63ca1f1a58a19cbf475fce0855d4e3d5153:13075894189c47ffcfafd1dfe7fbb539f7c74a69d35a399b3abf8518952714f9:2abd0a8cba83b8214a66c8f0293ba63e467d720540e29ff8ddcdab069d4f1c9e', 'media_url' => "http://example.com/text", 'media_type' => "text/plain", ], [ 'id' => 103, 'url' => 'http://example.com/3', 'title' => 'Article title 3', 'author' => '', 'content' => 'Article content 3
', 'guid' => '31a6594500a48b59fcc8a075ce82b946c9c3c782460d088bd7b8ef3ede97ad92', 'published_date' => '2000-01-03 00:00:00', 'edited_date' => '2000-01-03 00:00:03', 'modified_date' => '2000-01-03 03:00:00', 'unread' => 1, 'starred' => 1, 'edition' => 203, 'subscription' => 9, 'fingerprint' => 'f74b06b240bd08abf4d3fdfc20dba6a6f6eb8b4f1a00e9a617efd63a87180a4b:b278380e984cefe63f0e412b88ffc9cb0befdfa06fdc00bace1da99a8daff406:ad622b31e739cd3a3f3c788991082cf4d2f7a8773773008e75f0572e58cd373b', 'media_url' => "http://example.com/video", 'media_type' => "video/webm", ], [ 'id' => 104, 'url' => 'http://example.com/4', 'title' => 'Article title 4', 'author' => '', 'content' => 'Article content 4
', 'guid' => '804e517d623390e71497982c77cf6823180342ebcd2e7d5e32da1e55b09dd180', 'published_date' => '2000-01-04 00:00:00', 'edited_date' => '2000-01-04 00:00:04', 'modified_date' => '2000-01-04 04:00:00', 'unread' => 0, 'starred' => 1, 'edition' => 204, 'subscription' => 9, 'fingerprint' => 'f3615c7f16336d3ea242d35cf3fc17dbc4ee3afb78376bf49da2dd7a5a25dec8:f11c2b4046f207579aeb9c69a8c20ca5461cef49756ccfa5ba5e2344266da3b3:ab2da63276acce431250b18d3d49b988b226a99c7faadf275c90b751aee05be9', 'media_url' => "http://example.com/image", 'media_type' => "image/svg+xml", ], [ 'id' => 105, 'url' => 'http://example.com/5', 'title' => 'Article title 5', 'author' => '', 'content' => 'Article content 5
', 'guid' => 'db3e736c2c492f5def5c5da33ddcbea1824040e9ced2142069276b0a6e291a41', 'published_date' => '2000-01-05 00:00:00', 'edited_date' => '2000-01-05 00:00:05', 'modified_date' => '2000-01-05 05:00:00', 'unread' => 1, 'starred' => 0, 'edition' => 305, 'subscription' => 10, 'fingerprint' => 'd40da96e39eea6c55948ccbe9b3d275b5f931298288dbe953990c5f496097022:834240f84501b5341d375414718204ec421561f3825d34c22bf9182203e42900:43b970ac6ec5f8a9647b2c7e4eed8b1d7f62e154a95eed748b0294c1256764ba', 'media_url' => "http://example.com/audio", 'media_type' => "audio/ogg", ], ], 'rest' => [ [ 'id' => 101, 'guid' => 'e433653cef2e572eee4215fa299a4a5af9137b2cefd6283c85bd69a32915beda', 'guidHash' => "101", 'url' => 'http://example.com/1', 'title' => 'Article title 1', 'author' => '', 'pubDate' => 946684801, 'body' => 'Article content 1
', 'enclosureMime' => "", 'enclosureLink' => "", 'feedId' => 8, 'unread' => true, 'starred' => false, 'lastModified' => 946688400, 'fingerprint' => 'f5cb8bfc1c7396dc9816af212a3e2ac5221585c2a00bf7ccb6aabd95dcfcd6a6:fb0bc8f8cb08913dc5a497db700e327f1d34e4987402687d494a5891f24714d4:18fdd4fa93d693128c43b004399e5c9cea6c261ddfa002518d3669f55d8c2207', ], [ 'id' => 202, 'guid' => '5be8a5a46ecd52ed132191c8d27fb1af6b3d4edc00234c5d9f8f0e10562ed3b7', 'guidHash' => "102", 'url' => 'http://example.com/2', 'title' => 'Article title 2', 'author' => '', 'pubDate' => 946771202, 'body' => 'Article content 2
', 'enclosureMime' => "text/plain", 'enclosureLink' => "http://example.com/text", 'feedId' => 8, 'unread' => false, 'starred' => false, 'lastModified' => 946778400, 'fingerprint' => '0e86d2de822a174fe3c44a466953e63ca1f1a58a19cbf475fce0855d4e3d5153:13075894189c47ffcfafd1dfe7fbb539f7c74a69d35a399b3abf8518952714f9:2abd0a8cba83b8214a66c8f0293ba63e467d720540e29ff8ddcdab069d4f1c9e', ], [ 'id' => 203, 'guid' => '31a6594500a48b59fcc8a075ce82b946c9c3c782460d088bd7b8ef3ede97ad92', 'guidHash' => "103", 'url' => 'http://example.com/3', 'title' => 'Article title 3', 'author' => '', 'pubDate' => 946857603, 'body' => 'Article content 3
', 'enclosureMime' => "video/webm", 'enclosureLink' => "http://example.com/video", 'feedId' => 9, 'unread' => true, 'starred' => true, 'lastModified' => 946868400, 'fingerprint' => 'f74b06b240bd08abf4d3fdfc20dba6a6f6eb8b4f1a00e9a617efd63a87180a4b:b278380e984cefe63f0e412b88ffc9cb0befdfa06fdc00bace1da99a8daff406:ad622b31e739cd3a3f3c788991082cf4d2f7a8773773008e75f0572e58cd373b', ], [ 'id' => 204, 'guid' => '804e517d623390e71497982c77cf6823180342ebcd2e7d5e32da1e55b09dd180', 'guidHash' => "104", 'url' => 'http://example.com/4', 'title' => 'Article title 4', 'author' => '', 'pubDate' => 946944004, 'body' => 'Article content 4
', 'enclosureMime' => "image/svg+xml", 'enclosureLink' => "http://example.com/image", 'feedId' => 9, 'unread' => false, 'starred' => true, 'lastModified' => 946958400, 'fingerprint' => 'f3615c7f16336d3ea242d35cf3fc17dbc4ee3afb78376bf49da2dd7a5a25dec8:f11c2b4046f207579aeb9c69a8c20ca5461cef49756ccfa5ba5e2344266da3b3:ab2da63276acce431250b18d3d49b988b226a99c7faadf275c90b751aee05be9', ], [ 'id' => 305, 'guid' => 'db3e736c2c492f5def5c5da33ddcbea1824040e9ced2142069276b0a6e291a41', 'guidHash' => "105", 'url' => 'http://example.com/5', 'title' => 'Article title 5', 'author' => '', 'pubDate' => 947030405, 'body' => 'Article content 5
', 'enclosureMime' => "audio/ogg", 'enclosureLink' => "http://example.com/audio", 'feedId' => 10, 'unread' => true, 'starred' => false, 'lastModified' => 947048400, 'fingerprint' => 'd40da96e39eea6c55948ccbe9b3d275b5f931298288dbe953990c5f496097022:834240f84501b5341d375414718204ec421561f3825d34c22bf9182203e42900:43b970ac6ec5f8a9647b2c7e4eed8b1d7f62e154a95eed748b0294c1256764ba', ], ], ]; protected function req(string $method, string $target, $data = "", array $headers = [], bool $authenticated = true, bool $body = true): ResponseInterface { Arsse::$obj = $this->objMock->get(); Arsse::$db = $this->dbMock->get(); Arsse::$user = $this->userMock->get(); Arsse::$user->id = $this->userId; $prefix = "/index.php/apps/news/api/v1-2"; $url = $prefix.$target; if ($body) { $params = []; } else { $params = $data; $data = []; } $req = $this->serverRequest($method, $url, $prefix, $headers, [], $data, "application/json", $params, $authenticated ? "john.doe@example.com" : ""); return $this->h->dispatch($req); } public function setUp(): void { parent::setUp(); self::setConf(); // create a mock user manager $this->userId = "john.doe@example.com"; $this->userMock = $this->mock(User::class); $this->userMock->auth->returns(true); $this->userMock->propertiesGet->returns(['admin' => true]); // create a mock database interface $this->dbMock = $this->mock(Database::class); $this->dbMock->begin->returns($this->mock(Transaction::class)); //initialize a handler $this->h = new V1_2; } protected function v($value) { return $value; } public function testSendAuthenticationChallenge(): void { $exp = HTTP::respEmpty(401); $this->assertMessage($exp, $this->req("GET", "/", "", [], false)); } /** @dataProvider provideInvalidPaths */ public function testRespondToInvalidPaths($path, $method, $code, $allow = null): void { $exp = HTTP::respEmpty($code, $allow ? ['Allow' => $allow] : []); $this->assertMessage($exp, $this->req($method, $path)); } public function provideInvalidPaths(): array { return [ ["/", "GET", 404], ["/", "POST", 404], ["/", "PUT", 404], ["/", "DELETE", 404], ["/", "OPTIONS", 404], ["/version/invalid", "GET", 404], ["/version/invalid", "POST", 404], ["/version/invalid", "PUT", 404], ["/version/invalid", "DELETE", 404], ["/version/invalid", "OPTIONS", 404], ["/folders/1/invalid", "GET", 404], ["/folders/1/invalid", "POST", 404], ["/folders/1/invalid", "PUT", 404], ["/folders/1/invalid", "DELETE", 404], ["/folders/1/invalid", "OPTIONS", 404], ["/version", "POST", 405, "GET"], ["/version", "PUT", 405, "GET"], ["/version", "DELETE", 405, "GET"], ["/folders", "PUT", 405, "GET, POST"], ["/folders", "DELETE", 405, "GET, POST"], ["/folders/1", "GET", 405, "PUT, DELETE"], ["/folders/1", "POST", 405, "PUT, DELETE"], ]; } public function testRespondToInvalidInputTypes(): void { $exp = HTTP::respEmpty(415, ['Accept' => "application/json"]); $this->assertMessage($exp, $this->req("PUT", "/folders/1", '', ['Content-Type' => "application/xml"])); $exp = HTTP::respEmpty(400); $this->assertMessage($exp, $this->req("PUT", "/folders/1", '')); $this->assertMessage($exp, $this->req("PUT", "/folders/1", '', ['Content-Type' => null])); } /** @dataProvider provideOptionsRequests */ public function testRespondToOptionsRequests(string $url, string $allow, string $accept): void { $exp = HTTP::respEmpty(204, [ 'Allow' => $allow, 'Accept' => $accept, ]); $this->assertMessage($exp, $this->req("OPTIONS", $url)); } public function provideOptionsRequests(): array { return [ ["/feeds", "HEAD,GET,POST", "application/json"], ["/feeds/2112", "DELETE", "application/json"], ["/user", "HEAD,GET", "application/json"], ]; } public function testListFolders(): void { $list = [ ['id' => 1, 'name' => "Software", 'parent' => null], ['id' => 12, 'name' => "Hardware", 'parent' => null], ]; $out = [ ['id' => 1, 'name' => "Software"], ['id' => 12, 'name' => "Hardware"], ]; $this->dbMock->folderList->with($this->userId, null, false)->returns(new Result($this->v($list))); $exp = HTTP::respJson(['folders' => $out]); $this->assertMessage($exp, $this->req("GET", "/folders")); } /** @dataProvider provideFolderCreations */ public function testAddAFolder(array $input, bool $body, $output, ResponseInterface $exp): void { if ($output instanceof ExceptionInput) { $this->dbMock->folderAdd->throws($output); } else { $this->dbMock->folderAdd->returns($output); $this->dbMock->folderPropertiesGet->returns($this->v(['id' => $output, 'name' => $input['name'], 'parent' => null])); } $act = $this->req("POST", "/folders", $input, [], true, $body); $this->assertMessage($exp, $act); $this->dbMock->folderAdd->calledWith($this->userId, $input); if ($output instanceof ExceptionInput) { $this->dbMock->folderPropertiesGet->never()->called(); } else { $this->dbMock->folderPropertiesGet->calledWith($this->userId, $this->equalTo($output)); } } public function provideFolderCreations(): array { return [ [['name' => "Software"], true, 1, HTTP::respJson(['folders' => [['id' => 1, 'name' => "Software"]]])], [['name' => "Software"], false, 1, HTTP::respJson(['folders' => [['id' => 1, 'name' => "Software"]]])], [['name' => "Hardware"], true, "2", HTTP::respJson(['folders' => [['id' => 2, 'name' => "Hardware"]]])], [['name' => "Hardware"], false, "2", HTTP::respJson(['folders' => [['id' => 2, 'name' => "Hardware"]]])], [['name' => "Software"], true, new ExceptionInput("constraintViolation"), HTTP::respEmpty(409)], [['name' => ""], true, new ExceptionInput("whitespace"), HTTP::respEmpty(422)], [['name' => " "], true, new ExceptionInput("whitespace"), HTTP::respEmpty(422)], [['name' => null], true, new ExceptionInput("missing"), HTTP::respEmpty(422)], ]; } public function testRemoveAFolder(): void { $this->dbMock->folderRemove->with($this->userId, 1)->returns(true)->throws(new ExceptionInput("subjectMissing")); $exp = HTTP::respEmpty(204); $this->assertMessage($exp, $this->req("DELETE", "/folders/1")); // fail on the second invocation because it no longer exists $exp = HTTP::respEmpty(404); $this->assertMessage($exp, $this->req("DELETE", "/folders/1")); $this->dbMock->folderRemove->times(2)->calledWith($this->userId, 1); } /** @dataProvider provideFolderRenamings */ public function testRenameAFolder(array $input, int $id, $output, ResponseInterface $exp): void { if ($output instanceof ExceptionInput) { $this->dbMock->folderPropertiesSet->throws($output); } else { $this->dbMock->folderPropertiesSet->returns($output); } $act = $this->req("PUT", "/folders/$id", $input); $this->assertMessage($exp, $act); $this->dbMock->folderPropertiesSet->calledWith($this->userId, $id, $input); } public function provideFolderRenamings(): array { return [ [['name' => "Software"], 1, true, HTTP::respEmpty(204)], [['name' => "Software"], 2, new ExceptionInput("constraintViolation"), HTTP::respEmpty(409)], [['name' => "Software"], 3, new ExceptionInput("subjectMissing"), HTTP::respEmpty(404)], [['name' => ""], 2, new ExceptionInput("whitespace"), HTTP::respEmpty(422)], [['name' => " "], 2, new ExceptionInput("whitespace"), HTTP::respEmpty(422)], [['name' => null], 2, new ExceptionInput("missing"), HTTP::respEmpty(422)], ]; } public function testRetrieveServerVersion(): void { $exp = HTTP::respJson([ 'version' => V1_2::VERSION, 'arsse_version' => Arsse::VERSION, ]); $this->assertMessage($exp, $this->req("GET", "/version")); } public function testListSubscriptions(): void { $exp1 = [ 'feeds' => [], 'starredCount' => 0, ]; $exp2 = [ 'feeds' => $this->feeds['rest'], 'starredCount' => 5, 'newestItemId' => 4758915, ]; $this->dbMock->subscriptionList->with($this->userId)->returns(new Result([]))->returns(new Result($this->v($this->feeds['db']))); $this->dbMock->articleStarred->with($this->userId)->returns($this->v(['total' => 0]))->returns($this->v(['total' => 5])); $this->dbMock->editionLatest->with($this->userId)->returns(0)->returns(4758915); $exp = HTTP::respJson($exp1); $this->assertMessage($exp, $this->req("GET", "/feeds")); $exp = HTTP::respJson($exp2); $this->assertMessage($exp, $this->req("GET", "/feeds")); } /** @dataProvider provideNewSubscriptions */ public function testAddASubscription(array $input, $id, int $latestEdition, array $output, $moveOutcome, ResponseInterface $exp): void { if ($id instanceof \Exception) { $this->dbMock->subscriptionAdd->throws($id); } else { $this->dbMock->subscriptionAdd->returns($id); } if ($moveOutcome instanceof \Exception) { $this->dbMock->subscriptionPropertiesSet->throws($moveOutcome); } else { $this->dbMock->subscriptionPropertiesSet->returns($moveOutcome); } $this->dbMock->subscriptionPropertiesGet->returns($this->v($output)); $this->dbMock->editionLatest->returns($latestEdition); $act = $this->req("POST", "/feeds", $input); $this->assertMessage($exp, $act); $this->dbMock->subscriptionAdd->calledWith($this->userId, $input['url'] ?? ""); if ($id instanceof \Exception) { $this->dbMock->subscriptionPropertiesSet->never()->called(); $this->dbMock->subscriptionPropertiesGet->never()->called(); $this->dbMock->editionLatest->never()->called(); } else { $this->dbMock->subscriptionPropertiesGet->calledWith($this->userId, $id); $this->dbMock->editionLatest->calledWith($this->userId, $this->equalTo((new Context)->subscription($id)->hidden(false))); if ($input['folderId'] ?? 0) { $this->dbMock->subscriptionPropertiesSet->calledWith($this->userId, $id, ['folder' => (int) $input['folderId']]); } else { $this->dbMock->subscriptionPropertiesSet->never()->called(); } } } public function provideNewSubscriptions(): array { $feedException = new \JKingWeb\Arsse\Feed\Exception("", [], new \PicoFeed\Reader\SubscriptionNotFoundException); return [ [['url' => "http://example.com/news.atom", 'folderId' => 3], 2112, 0, $this->feeds['db'][0], new ExceptionInput("idMissing"), HTTP::respJson(['feeds' => [$this->feeds['rest'][0]]])], [['url' => "http://example.org/news.atom", 'folderId' => 8], 42, 4758915, $this->feeds['db'][1], true, HTTP::respJson(['feeds' => [$this->feeds['rest'][1]], 'newestItemId' => 4758915])], [['url' => "http://example.com/news.atom", 'folderId' => 3], new ExceptionInput("constraintViolation"), 0, $this->feeds['db'][0], new ExceptionInput("idMissing"), HTTP::respEmpty(409)], [['url' => "http://example.org/news.atom", 'folderId' => 8], new ExceptionInput("constraintViolation"), 4758915, $this->feeds['db'][1], true, HTTP::respEmpty(409)], [[], $feedException, 0, [], false, HTTP::respEmpty(422)], [['url' => "http://example.net/news.atom", 'folderId' => -1], 47, 2112, $this->feeds['db'][2], new ExceptionInput("typeViolation"), HTTP::respJson(['feeds' => [$this->feeds['rest'][2]], 'newestItemId' => 2112])], ]; } public function testRemoveASubscription(): void { $this->dbMock->subscriptionRemove->with($this->userId, 1)->returns(true)->throws(new ExceptionInput("subjectMissing")); $exp = HTTP::respEmpty(204); $this->assertMessage($exp, $this->req("DELETE", "/feeds/1")); // fail on the second invocation because it no longer exists $exp = HTTP::respEmpty(404); $this->assertMessage($exp, $this->req("DELETE", "/feeds/1")); $this->dbMock->subscriptionRemove->times(2)->calledWith($this->userId, 1); } public function testMoveASubscription(): void { $in = [ ['folderId' => 0], ['folderId' => 42], ['folderId' => 2112], ['folderId' => 42], ['folderId' => -1], [], ]; $this->dbMock->subscriptionPropertiesSet->with($this->userId, 1, ['folder' => 42])->returns(true); $this->dbMock->subscriptionPropertiesSet->with($this->userId, 1, ['folder' => null])->returns(true); $this->dbMock->subscriptionPropertiesSet->with($this->userId, 1, ['folder' => 2112])->throws(new ExceptionInput("idMissing")); // folder does not exist $this->dbMock->subscriptionPropertiesSet->with($this->userId, 1, ['folder' => -1])->throws(new ExceptionInput("typeViolation")); // folder is invalid $this->dbMock->subscriptionPropertiesSet->with($this->userId, 42, $this->anything())->throws(new ExceptionInput("subjectMissing")); // subscription does not exist $exp = HTTP::respEmpty(204); $this->assertMessage($exp, $this->req("PUT", "/feeds/1/move", json_encode($in[0]))); $exp = HTTP::respEmpty(204); $this->assertMessage($exp, $this->req("PUT", "/feeds/1/move", json_encode($in[1]))); $exp = HTTP::respEmpty(422); $this->assertMessage($exp, $this->req("PUT", "/feeds/1/move", json_encode($in[2]))); $exp = HTTP::respEmpty(404); $this->assertMessage($exp, $this->req("PUT", "/feeds/42/move", json_encode($in[3]))); $exp = HTTP::respEmpty(422); $this->assertMessage($exp, $this->req("PUT", "/feeds/1/move", json_encode($in[4]))); $exp = HTTP::respEmpty(422); $this->assertMessage($exp, $this->req("PUT", "/feeds/1/move", json_encode($in[5]))); } public function testRenameASubscription(): void { $in = [ ['feedTitle' => null], ['feedTitle' => "Ook"], ['feedTitle' => " "], ['feedTitle' => ""], ['feedTitle' => false], ['feedTitle' => "Feed does not exist"], [], ]; $this->dbMock->subscriptionPropertiesSet->with($this->userId, 1, $this->identicalTo(['title' => null]))->returns(true); $this->dbMock->subscriptionPropertiesSet->with($this->userId, 1, $this->identicalTo(['title' => "Ook"]))->returns(true); $this->dbMock->subscriptionPropertiesSet->with($this->userId, 1, $this->identicalTo(['title' => " "]))->throws(new ExceptionInput("whitespace")); $this->dbMock->subscriptionPropertiesSet->with($this->userId, 1, $this->identicalTo(['title' => ""]))->throws(new ExceptionInput("missing")); $this->dbMock->subscriptionPropertiesSet->with($this->userId, 1, $this->identicalTo(['title' => false]))->throws(new ExceptionInput("missing")); $this->dbMock->subscriptionPropertiesSet->with($this->userId, 42, $this->anything())->throws(new ExceptionInput("subjectMissing")); $exp = HTTP::respEmpty(422); $this->assertMessage($exp, $this->req("PUT", "/feeds/1/rename", json_encode($in[0]))); $exp = HTTP::respEmpty(204); $this->assertMessage($exp, $this->req("PUT", "/feeds/1/rename", json_encode($in[1]))); $exp = HTTP::respEmpty(422); $this->assertMessage($exp, $this->req("PUT", "/feeds/1/rename", json_encode($in[2]))); $exp = HTTP::respEmpty(422); $this->assertMessage($exp, $this->req("PUT", "/feeds/1/rename", json_encode($in[3]))); $exp = HTTP::respEmpty(404); $this->assertMessage($exp, $this->req("PUT", "/feeds/42/rename", json_encode($in[4]))); $exp = HTTP::respEmpty(422); $this->assertMessage($exp, $this->req("PUT", "/feeds/1/rename", json_encode($in[6]))); } public function testListStaleFeeds(): void { $out = [ [ 'id' => 42, 'userId' => "", ], [ 'id' => 2112, 'userId' => "", ], ]; $this->dbMock->feedListStale->returns($this->v(array_column($out, "id"))); $exp = HTTP::respJson(['feeds' => $out]); $this->assertMessage($exp, $this->req("GET", "/feeds/all")); } public function testListStaleFeedsWithoutAuthority(): void { $this->userMock->propertiesGet->returns(['admin' => false]); $exp = HTTP::respEmpty(403); $this->assertMessage($exp, $this->req("GET", "/feeds/all")); $this->dbMock->feedListStale->never()->called(); } /** @dataProvider provideFeedUpdates */ public function testUpdateAFeed(array $in, int $exp): void { $this->dbMock->subscriptionUpdate->with("ook", 42)->returns(true); $this->dbMock->subscriptionUpdate->with("eek", 2112)->throws(new ExceptionInput("subjectMissing")); $this->dbMock->subscriptionUpdate->with(null, $this->anything())->throws(new ExceptionInput("subjectMissing")); $this->dbMock->subscriptionUpdate->with($this->anything(), $this->lessThan(1))->throws(new ExceptionInput("typeViolation")); $exp = HTTP::respEmpty($exp); $this->assertMessage($exp, $this->req("GET", "/feeds/update", json_encode($in))); } public function provideFeedUpdates(): iterable { return [ 'Valid input' => [['userId' => "ook", 'feedId' => 42], 204], 'Missing feed' => [['userId' => "eek", 'feedId' => 2112], 404], 'String ID' => [['userId' => "ook", 'feedId' => "ook"], 422], 'Negative ID' => [['userId' => "ook", 'feedId' => -1], 422], 'Bad input 1' => [['userId' => "ook", 'feed' => 42], 422], 'Bad input 2' => [['user' => "ook", 'feedId' => 42], 404], ]; } public function testUpdateAFeedWithoutAuthority(): void { $this->userMock->propertiesGet->returns(['admin' => false]); $exp = HTTP::respEmpty(403); $this->assertMessage($exp, $this->req("GET", "/feeds/update", ['feedId' => 42])); $this->dbMock->subscriptionUpdate->never()->called(); } /** @dataProvider provideArticleQueries */ public function testListArticles(string $url, array $in, Context $c, $out, ResponseInterface $exp): void { if ($out instanceof \Exception) { $this->dbMock->articleList->throws($out); } else { $this->dbMock->articleList->returns($out); } $this->assertMessage($exp, $this->req("GET", $url, $in)); $columns = ["edition", "guid", "id", "url", "title", "author", "edited_date", "content", "media_type", "media_url", "subscription", "unread", "starred", "modified_date", "fingerprint"]; $order = ($in['oldestFirst'] ?? false) ? "edition" : "edition desc"; $this->dbMock->articleList->calledWith($this->userId, $this->equalTo($c), $columns, [$order]); } public function provideArticleQueries(): iterable { $c = (new Context)->hidden(false); $t = Date::normalize(time()); $out = new Result($this->v($this->articles['db'])); $r200 = HTTP::respJson(['items' => $this->articles['rest']]); $r422 = HTTP::respEmpty(422); return [ ["/items", [], clone $c, $out, $r200], ["/items", ['type' => 0, 'id' => 42], (clone $c)->subscription(42), new ExceptionInput("idMissing"), $r422], ["/items", ['type' => 1, 'id' => 2112], (clone $c)->folder(2112), new ExceptionInput("idMissing"), $r422], ["/items", ['type' => 0, 'id' => -1], (clone $c)->subscription(-1), new ExceptionInput("typeViolation"), $r422], ["/items", ['type' => 1, 'id' => -1], (clone $c)->folder(-1), new ExceptionInput("typeViolation"), $r422], ["/items", ['type' => 2, 'id' => 0], (clone $c)->starred(true), $out, $r200], ["/items", ['type' => 3, 'id' => 0], clone $c, $out, $r200], ["/items", ['getRead' => true], clone $c, $out, $r200], ["/items", ['getRead' => false], (clone $c)->unread(true), $out, $r200], ["/items", ['lastModified' => $t->getTimestamp()], (clone $c)->markedRange($t, null), $out, $r200], ["/items", ['oldestFirst' => true, 'batchSize' => 10, 'offset' => 5], (clone $c)->editionRange(6, null)->limit(10), $out, $r200], ["/items", ['oldestFirst' => false, 'batchSize' => 5, 'offset' => 5], (clone $c)->editionRange(null, 4)->limit(5), $out, $r200], ["/items", ['oldestFirst' => false, 'batchSize' => 5, 'offset' => 0], (clone $c)->limit(5), $out, $r200], ["/items/updated", [], clone $c, $out, $r200], ["/items/updated", ['type' => 0, 'id' => 42], (clone $c)->subscription(42), new ExceptionInput("idMissing"), $r422], ["/items/updated", ['type' => 1, 'id' => 2112], (clone $c)->folder(2112), new ExceptionInput("idMissing"), $r422], ["/items/updated", ['type' => 0, 'id' => -1], (clone $c)->subscription(-1), new ExceptionInput("typeViolation"), $r422], ["/items/updated", ['type' => 1, 'id' => -1], (clone $c)->folder(-1), new ExceptionInput("typeViolation"), $r422], ["/items/updated", ['type' => 2, 'id' => 0], (clone $c)->starred(true), $out, $r200], ["/items/updated", ['type' => 3, 'id' => 0], clone $c, $out, $r200], ["/items/updated", ['getRead' => true], clone $c, $out, $r200], ["/items/updated", ['getRead' => false], (clone $c)->unread(true), $out, $r200], ["/items/updated", ['lastModified' => $t->getTimestamp()], (clone $c)->markedRange($t, null), $out, $r200], ["/items/updated", ['oldestFirst' => true, 'batchSize' => 10, 'offset' => 5], (clone $c)->editionRange(6, null)->limit(10), $out, $r200], ["/items/updated", ['oldestFirst' => false, 'batchSize' => 5, 'offset' => 5], (clone $c)->editionRange(null, 4)->limit(5), $out, $r200], ["/items/updated", ['oldestFirst' => false, 'batchSize' => 5, 'offset' => 0], (clone $c)->limit(5), $out, $r200], ]; } public function testMarkAFolderRead(): void { $read = ['read' => true]; $in = json_encode(['newestItemId' => 2112]); $this->dbMock->articleMark->with($this->userId, $read, $this->equalTo((new Context)->folder(1)->editionRange(null, 2112)->hidden(false)))->returns(42); $this->dbMock->articleMark->with($this->userId, $read, $this->equalTo((new Context)->folder(42)->editionRange(null, 2112)->hidden(false)))->throws(new ExceptionInput("idMissing")); // folder doesn't exist $exp = HTTP::respEmpty(204); $this->assertMessage($exp, $this->req("PUT", "/folders/1/read", $in)); $this->assertMessage($exp, $this->req("PUT", "/folders/1/read?newestItemId=2112")); $exp = HTTP::respEmpty(422); $this->assertMessage($exp, $this->req("PUT", "/folders/1/read")); $this->assertMessage($exp, $this->req("PUT", "/folders/1/read?newestItemId=ook")); $exp = HTTP::respEmpty(404); $this->assertMessage($exp, $this->req("PUT", "/folders/42/read", $in)); } public function testMarkASubscriptionRead(): void { $read = ['read' => true]; $in = json_encode(['newestItemId' => 2112]); $this->dbMock->articleMark->with($this->userId, $read, $this->equalTo((new Context)->subscription(1)->editionRange(null, 2112)->hidden(false)))->returns(42); $this->dbMock->articleMark->with($this->userId, $read, $this->equalTo((new Context)->subscription(42)->editionRange(null, 2112)->hidden(false)))->throws(new ExceptionInput("idMissing")); // subscription doesn't exist $exp = HTTP::respEmpty(204); $this->assertMessage($exp, $this->req("PUT", "/feeds/1/read", $in)); $this->assertMessage($exp, $this->req("PUT", "/feeds/1/read?newestItemId=2112")); $exp = HTTP::respEmpty(422); $this->assertMessage($exp, $this->req("PUT", "/feeds/1/read")); $this->assertMessage($exp, $this->req("PUT", "/feeds/1/read?newestItemId=ook")); $exp = HTTP::respEmpty(404); $this->assertMessage($exp, $this->req("PUT", "/feeds/42/read", $in)); } public function testMarkAllItemsRead(): void { $read = ['read' => true]; $in = json_encode(['newestItemId' => 2112]); $this->dbMock->articleMark->with($this->userId, $read, $this->equalTo((new Context)->editionRange(null, 2112)))->returns(42); $exp = HTTP::respEmpty(204); $this->assertMessage($exp, $this->req("PUT", "/items/read", $in)); $this->assertMessage($exp, $this->req("PUT", "/items/read?newestItemId=2112")); $exp = HTTP::respEmpty(422); $this->assertMessage($exp, $this->req("PUT", "/items/read")); $this->assertMessage($exp, $this->req("PUT", "/items/read?newestItemId=ook")); } public function testChangeMarksOfASingleArticle(): void { $read = ['read' => true]; $unread = ['read' => false]; $star = ['starred' => true]; $unstar = ['starred' => false]; $this->dbMock->articleMark->with($this->userId, $read, $this->equalTo((new Context)->edition(1)))->returns(42); $this->dbMock->articleMark->with($this->userId, $read, $this->equalTo((new Context)->edition(42)))->throws(new ExceptionInput("subjectMissing")); // edition doesn't exist doesn't exist $this->dbMock->articleMark->with($this->userId, $unread, $this->equalTo((new Context)->edition(2)))->returns(42); $this->dbMock->articleMark->with($this->userId, $unread, $this->equalTo((new Context)->edition(47)))->throws(new ExceptionInput("subjectMissing")); // edition doesn't exist doesn't exist $this->dbMock->articleMark->with($this->userId, $star, $this->equalTo((new Context)->article(3)))->returns(42); $this->dbMock->articleMark->with($this->userId, $star, $this->equalTo((new Context)->article(2112)))->throws(new ExceptionInput("subjectMissing")); // article doesn't exist doesn't exist $this->dbMock->articleMark->with($this->userId, $unstar, $this->equalTo((new Context)->article(4)))->returns(42); $this->dbMock->articleMark->with($this->userId, $unstar, $this->equalTo((new Context)->article(1337)))->throws(new ExceptionInput("subjectMissing")); // article doesn't exist doesn't exist $exp = HTTP::respEmpty(204); $this->assertMessage($exp, $this->req("PUT", "/items/1/read")); $this->assertMessage($exp, $this->req("PUT", "/items/2/unread")); $this->assertMessage($exp, $this->req("PUT", "/items/1/3/star")); $this->assertMessage($exp, $this->req("PUT", "/items/4400/4/unstar")); $exp = HTTP::respEmpty(404); $this->assertMessage($exp, $this->req("PUT", "/items/42/read")); $this->assertMessage($exp, $this->req("PUT", "/items/47/unread")); $this->assertMessage($exp, $this->req("PUT", "/items/1/2112/star")); $this->assertMessage($exp, $this->req("PUT", "/items/4400/1337/unstar")); $this->dbMock->articleMark->times(8)->calledWith($this->userId, $this->anything(), $this->anything()); } public function testChangeMarksOfMultipleArticles(): void { $read = ['read' => true]; $unread = ['read' => false]; $star = ['starred' => true]; $unstar = ['starred' => false]; $in = [ ["ook","eek","ack"], range(100, 199), ]; $inStar = $in; for ($a = 0; $a < sizeof($inStar); $a++) { for ($b = 0; $b < sizeof($inStar[$a]); $b++) { $inStar[$a][$b] = ['feedId' => 2112, 'guidHash' => $inStar[$a][$b]]; } } $this->dbMock->articleMark->with($this->userId, $this->anything(), $this->anything())->returns(42); $this->dbMock->articleMark->with($this->userId, $this->anything(), $this->equalTo((new Context)->editions([])))->throws(new ExceptionInput("tooShort")); // data model function requires one valid integer for multiples $this->dbMock->articleMark->with($this->userId, $this->anything(), $this->equalTo((new Context)->articles([])))->throws(new ExceptionInput("tooShort")); // data model function requires one valid integer for multiples $exp = HTTP::respEmpty(204); $this->assertMessage($exp, $this->req("PUT", "/items/read/multiple")); $this->assertMessage($exp, $this->req("PUT", "/items/unread/multiple")); $this->assertMessage($exp, $this->req("PUT", "/items/star/multiple")); $this->assertMessage($exp, $this->req("PUT", "/items/unstar/multiple")); $this->assertMessage($exp, $this->req("PUT", "/items/read/multiple", json_encode(['items' => "ook"]))); $this->assertMessage($exp, $this->req("PUT", "/items/unread/multiple", json_encode(['items' => "ook"]))); $this->assertMessage($exp, $this->req("PUT", "/items/star/multiple", json_encode(['items' => "ook"]))); $this->assertMessage($exp, $this->req("PUT", "/items/unstar/multiple", json_encode(['items' => "ook"]))); $this->assertMessage($exp, $this->req("PUT", "/items/read/multiple", json_encode(['items' => []]))); $this->assertMessage($exp, $this->req("PUT", "/items/unread/multiple", json_encode(['items' => []]))); $this->assertMessage($exp, $this->req("PUT", "/items/read/multiple", json_encode(['items' => $in[0]]))); $this->assertMessage($exp, $this->req("PUT", "/items/unread/multiple", json_encode(['items' => $in[0]]))); $this->assertMessage($exp, $this->req("PUT", "/items/read/multiple", json_encode(['items' => $in[1]]))); $this->assertMessage($exp, $this->req("PUT", "/items/unread/multiple", json_encode(['items' => $in[1]]))); $this->assertMessage($exp, $this->req("PUT", "/items/star/multiple", json_encode(['items' => []]))); $this->assertMessage($exp, $this->req("PUT", "/items/unstar/multiple", json_encode(['items' => []]))); $this->assertMessage($exp, $this->req("PUT", "/items/star/multiple", json_encode(['items' => $inStar[0]]))); $this->assertMessage($exp, $this->req("PUT", "/items/unstar/multiple", json_encode(['items' => $inStar[0]]))); $this->assertMessage($exp, $this->req("PUT", "/items/star/multiple", json_encode(['items' => $inStar[1]]))); $this->assertMessage($exp, $this->req("PUT", "/items/unstar/multiple", json_encode(['items' => $inStar[1]]))); // ensure the data model was queried appropriately for read/unread $this->dbMock->articleMark->atLeast(1)->calledWith($this->userId, $read, $this->equalTo((new Context)->editions([]))); $this->dbMock->articleMark->atLeast(1)->calledWith($this->userId, $read, $this->equalTo((new Context)->editions($in[0]))); $this->dbMock->articleMark->atLeast(1)->calledWith($this->userId, $read, $this->equalTo((new Context)->editions($in[1]))); $this->dbMock->articleMark->atLeast(1)->calledWith($this->userId, $unread, $this->equalTo((new Context)->editions([]))); $this->dbMock->articleMark->atLeast(1)->calledWith($this->userId, $unread, $this->equalTo((new Context)->editions($in[0]))); $this->dbMock->articleMark->atLeast(1)->calledWith($this->userId, $unread, $this->equalTo((new Context)->editions($in[1]))); // ensure the data model was queried appropriately for star/unstar $this->dbMock->articleMark->atLeast(1)->calledWith($this->userId, $star, $this->equalTo((new Context)->articles([]))); $this->dbMock->articleMark->atLeast(1)->calledWith($this->userId, $star, $this->equalTo((new Context)->articles($in[0]))); $this->dbMock->articleMark->atLeast(1)->calledWith($this->userId, $star, $this->equalTo((new Context)->articles($in[1]))); $this->dbMock->articleMark->atLeast(1)->calledWith($this->userId, $unstar, $this->equalTo((new Context)->articles([]))); $this->dbMock->articleMark->atLeast(1)->calledWith($this->userId, $unstar, $this->equalTo((new Context)->articles($in[0]))); $this->dbMock->articleMark->atLeast(1)->calledWith($this->userId, $unstar, $this->equalTo((new Context)->articles($in[1]))); } public function testQueryTheServerStatus(): void { $interval = Arsse::$conf->serviceFrequency; $valid = (new \DateTimeImmutable("now", new \DateTimezone("UTC")))->sub($interval); $invalid = $valid->sub($interval)->sub($interval); $this->dbMock->metaGet->with("service_last_checkin")->returns(Date::transform($valid, "sql"))->returns(Date::transform($invalid, "sql")); $this->dbMock->driverCharsetAcceptable->returns(true)->returns(false); $arr1 = $arr2 = [ 'version' => V1_2::VERSION, 'arsse_version' => Arsse::VERSION, 'warnings' => [ 'improperlyConfiguredCron' => false, 'incorrectDbCharset' => false, ], ]; $arr2['warnings']['improperlyConfiguredCron'] = true; $arr2['warnings']['incorrectDbCharset'] = true; $exp = HTTP::respJson($arr1); $this->assertMessage($exp, $this->req("GET", "/status")); } public function testCleanUpBeforeUpdate(): void { $this->dbMock->subscriptionCleanup->with()->returns(true); $exp = HTTP::respEmpty(204); $this->assertMessage($exp, $this->req("GET", "/cleanup/before-update")); $this->dbMock->subscriptionCleanup->calledWith(); } public function testCleanUpBeforeUpdateWithoutAuthority(): void { $this->userMock->propertiesGet->returns(['admin' => false]); $exp = HTTP::respEmpty(403); $this->assertMessage($exp, $this->req("GET", "/cleanup/before-update")); $this->dbMock->subscriptionCleanup->never()->called(); } public function testCleanUpAfterUpdate(): void { $this->dbMock->articleCleanup->with()->returns(true); $exp = HTTP::respEmpty(204); $this->assertMessage($exp, $this->req("GET", "/cleanup/after-update")); $this->dbMock->articleCleanup->calledWith(); } public function testCleanUpAfterUpdateWithoutAuthority(): void { $this->userMock->propertiesGet->returns(['admin' => false]); $exp = HTTP::respEmpty(403); $this->assertMessage($exp, $this->req("GET", "/cleanup/after-update")); $this->dbMock->subscriptionCleanup->never()->called(); } public function testQueryTheUserStatus(): void { $act = $this->req("GET", "/user"); $exp = HTTP::respJson([ 'userId' => $this->userId, 'displayName' => $this->userId, 'lastLoginTimestamp' => $this->approximateTime(json_decode((string) $act->getBody(), true)['lastLoginTimestamp'], new \DateTimeImmutable), 'avatar' => null, ]); $this->assertMessage($exp, $act); } public function testPreferJsonOverQueryParameters(): void { $in = ['name' => "Software"]; $url = "/folders?name=Hardware"; $out1 = ['id' => 1, 'name' => "Software"]; $out2 = ['id' => 2, 'name' => "Hardware"]; $this->dbMock->folderAdd->with($this->anything(), $this->anything())->returns(2); $this->dbMock->folderAdd->with($this->anything(), $in)->returns(1); $this->dbMock->folderPropertiesGet->with($this->userId, 1)->returns($this->v($out1)); $this->dbMock->folderPropertiesGet->with($this->userId, 2)->returns($this->v($out2)); $exp = HTTP::respJson(['folders' => [$out1]]); $this->assertMessage($exp, $this->req("POST", $url, json_encode($in))); } public function testMeldJsonAndQueryParameters(): void { $in = ['oldestFirst' => true]; $url = "/items?type=2"; $this->dbMock->articleList->returns(new Result([])); $this->req("GET", $url, json_encode($in)); $this->dbMock->articleList->calledWith($this->userId, $this->equalTo((new Context)->starred(true)->hidden(false)), $this->anything(), ["edition"]); } }