2020-11-23 14:31:50 +00:00
< ? php
/** @ license MIT
* Copyright 2017 J . King , Dustin Wilson et al .
* See LICENSE and AUTHORS files for details */
declare ( strict_types = 1 );
2021-04-14 15:17:01 +00:00
2020-12-01 17:08:45 +00:00
namespace JKingWeb\Arsse\TestCase\REST\Miniflux ;
2020-11-23 14:31:50 +00:00
2021-02-28 14:23:38 +00:00
use Eloquent\Phony\Mock\Handle\InstanceHandle ;
use Eloquent\Phony\Phpunit\Phony ;
2020-11-23 14:31:50 +00:00
use JKingWeb\Arsse\Arsse ;
2020-12-14 17:41:09 +00:00
use JKingWeb\Arsse\Context\Context ;
2020-11-23 14:31:50 +00:00
use JKingWeb\Arsse\User ;
use JKingWeb\Arsse\Database ;
use JKingWeb\Arsse\Db\Transaction ;
2020-11-30 15:52:32 +00:00
use JKingWeb\Arsse\Db\ExceptionInput ;
2020-11-23 14:31:50 +00:00
use JKingWeb\Arsse\REST\Miniflux\V1 ;
2020-11-30 15:52:32 +00:00
use JKingWeb\Arsse\REST\Miniflux\ErrorResponse ;
2021-01-23 17:00:11 +00:00
use JKingWeb\Arsse\Feed\Exception as FeedException ;
2021-02-07 18:04:44 +00:00
use JKingWeb\Arsse\ImportExport\Exception as ImportException ;
use JKingWeb\Arsse\ImportExport\OPML ;
2020-12-10 04:39:29 +00:00
use JKingWeb\Arsse\User\ExceptionConflict ;
2020-12-30 22:01:17 +00:00
use JKingWeb\Arsse\User\ExceptionInput as UserExceptionInput ;
2021-02-28 14:23:38 +00:00
use JKingWeb\Arsse\Test\Result ;
2020-11-23 14:31:50 +00:00
use Psr\Http\Message\ResponseInterface ;
2020-11-30 15:52:32 +00:00
use Laminas\Diactoros\Response\JsonResponse as Response ;
use Laminas\Diactoros\Response\EmptyResponse ;
2021-02-07 18:04:44 +00:00
use Laminas\Diactoros\Response\TextResponse ;
2020-11-23 14:31:50 +00:00
/** @covers \JKingWeb\Arsse\REST\Miniflux\V1<extended> */
class TestV1 extends \JKingWeb\Arsse\Test\AbstractTest {
2020-12-11 04:19:26 +00:00
protected const NOW = " 2020-12-09T22:35:10.023419Z " ;
2021-02-03 18:06:36 +00:00
protected const TOKEN = " Tk2o9YubmZIL2fm2w8Z4KlDEQJz532fNSOcTG0s2_xc= " ;
protected const USERS = [
[ 'id' => 1 , 'username' => " john.doe@example.com " , 'last_login_at' => self :: NOW , 'google_id' => " " , 'openid_connect_id' => " " , 'is_admin' => true , 'theme' => " custom " , 'language' => " fr_CA " , 'timezone' => " Asia/Gaza " , 'entry_sorting_direction' => " asc " , 'entries_per_page' => 200 , 'keyboard_shortcuts' => false , 'show_reading_time' => false , 'entry_swipe' => false , 'stylesheet' => " p { } " ],
[ 'id' => 2 , 'username' => " jane.doe@example.com " , 'last_login_at' => self :: NOW , 'google_id' => " " , 'openid_connect_id' => " " , 'is_admin' => false , 'theme' => " light_serif " , 'language' => " en_US " , 'timezone' => " UTC " , 'entry_sorting_direction' => " desc " , 'entries_per_page' => 100 , 'keyboard_shortcuts' => true , 'show_reading_time' => true , 'entry_swipe' => true , 'stylesheet' => " " ],
2020-12-11 04:19:26 +00:00
];
2021-02-03 18:06:36 +00:00
protected const FEEDS = [
2021-01-28 19:55:18 +00:00
[ 'id' => 1 , 'feed' => 12 , 'url' => " http://example.com/ook " , 'title' => " Ook " , 'source' => " http://example.com/ " , 'icon_id' => 47 , 'icon_url' => " http://example.com/icon " , 'folder' => 2112 , 'top_folder' => 5 , 'folder_name' => " Cat Eek " , 'top_folder_name' => " Cat Ook " , 'pinned' => 0 , 'err_count' => 1 , 'err_msg' => " Oopsie " , 'order_type' => 0 , 'keep_rule' => " this|that " , 'block_rule' => " both " , 'added' => " 2020-12-21 21:12:00 " , 'updated' => " 2021-01-05 13:51:32 " , 'edited' => " 2021-01-01 00:00:00 " , 'modified' => " 2020-11-30 04:08:52 " , 'next_fetch' => " 2021-01-20 00:00:00 " , 'etag' => " OOKEEK " , 'scrape' => 0 , 'unread' => 42 ],
[ 'id' => 55 , 'feed' => 12 , 'url' => " http://j%20k:super%20secret@example.com/eek " , 'title' => " Eek " , 'source' => " http://example.com/ " , 'icon_id' => null , 'icon_url' => null , 'folder' => null , 'top_folder' => null , 'folder_name' => null , 'top_folder_name' => null , 'pinned' => 0 , 'err_count' => 0 , 'err_msg' => null , 'order_type' => 0 , 'keep_rule' => null , 'block_rule' => null , 'added' => " 2020-12-21 21:12:00 " , 'updated' => " 2021-01-05 13:51:32 " , 'edited' => null , 'modified' => " 2020-11-30 04:08:52 " , 'next_fetch' => null , 'etag' => null , 'scrape' => 1 , 'unread' => 0 ],
2021-01-22 23:24:33 +00:00
];
2021-02-03 18:06:36 +00:00
protected const FEEDS_OUT = [
2021-02-03 21:27:55 +00:00
[ 'id' => 1 , 'user_id' => 42 , 'feed_url' => " http://example.com/ook " , 'site_url' => " http://example.com/ " , 'title' => " Ook " , 'checked_at' => " 2021-01-05T15:51:32.000000+02:00 " , 'next_check_at' => " 2021-01-20T02:00:00.000000+02:00 " , 'etag_header' => " OOKEEK " , 'last_modified_header' => " Fri, 01 Jan 2021 00:00:00 GMT " , 'parsing_error_message' => " Oopsie " , 'parsing_error_count' => 1 , 'scraper_rules' => " " , 'rewrite_rules' => " " , 'crawler' => false , 'blocklist_rules' => " both " , 'keeplist_rules' => " this|that " , 'user_agent' => " " , 'username' => " " , 'password' => " " , 'disabled' => false , 'ignore_http_cache' => false , 'fetch_via_proxy' => false , 'category' => [ 'id' => 6 , 'title' => " Cat Ook " , 'user_id' => 42 ], 'icon' => [ 'feed_id' => 1 , 'icon_id' => 47 ]],
[ 'id' => 55 , 'user_id' => 42 , 'feed_url' => " http://example.com/eek " , 'site_url' => " http://example.com/ " , 'title' => " Eek " , 'checked_at' => " 2021-01-05T15:51:32.000000+02:00 " , 'next_check_at' => " 0001-01-01T00:00:00Z " , 'etag_header' => " " , 'last_modified_header' => " " , 'parsing_error_message' => " " , 'parsing_error_count' => 0 , 'scraper_rules' => " " , 'rewrite_rules' => " " , 'crawler' => true , 'blocklist_rules' => " " , 'keeplist_rules' => " " , 'user_agent' => " " , 'username' => " j k " , 'password' => " super secret " , 'disabled' => false , 'ignore_http_cache' => false , 'fetch_via_proxy' => false , 'category' => [ 'id' => 1 , 'title' => " All " , 'user_id' => 42 ], 'icon' => null ],
2021-01-22 23:24:33 +00:00
];
2021-02-03 18:06:36 +00:00
protected const ENTRIES = [
2021-02-03 21:27:55 +00:00
[ 'id' => 42 , 'url' => " http://example.com/42 " , 'title' => " Title 42 " , 'subscription' => 55 , 'author' => " Thomas Costain " , 'fingerprint' => " FINGERPRINT " , 'published_date' => " 2021-01-22 02:21:12 " , 'modified_date' => " 2021-01-22 13:44:47 " , 'starred' => 0 , 'unread' => 0 , 'hidden' => 0 , 'content' => " Content 42 " , 'media_url' => null , 'media_type' => null ],
[ 'id' => 44 , 'url' => " http://example.com/44 " , 'title' => " Title 44 " , 'subscription' => 55 , 'author' => null , 'fingerprint' => " FINGERPRINT " , 'published_date' => " 2021-01-22 02:21:12 " , 'modified_date' => " 2021-01-22 13:44:47 " , 'starred' => 1 , 'unread' => 1 , 'hidden' => 0 , 'content' => " Content 44 " , 'media_url' => " http://example.com/44/enclosure " , 'media_type' => null ],
[ 'id' => 47 , 'url' => " http://example.com/47 " , 'title' => " Title 47 " , 'subscription' => 55 , 'author' => null , 'fingerprint' => " FINGERPRINT " , 'published_date' => " 2021-01-22 02:21:12 " , 'modified_date' => " 2021-01-22 13:44:47 " , 'starred' => 0 , 'unread' => 1 , 'hidden' => 1 , 'content' => " Content 47 " , 'media_url' => " http://example.com/47/enclosure " , 'media_type' => " " ],
2021-02-09 00:14:11 +00:00
[ 'id' => 2112 , 'url' => " http://example.com/2112 " , 'title' => " Title 2112 " , 'subscription' => 55 , 'author' => null , 'fingerprint' => " FINGERPRINT " , 'published_date' => " 2021-01-22 02:21:12 " , 'modified_date' => " 2021-01-22 13:44:47 " , 'starred' => 0 , 'unread' => 0 , 'hidden' => 1 , 'content' => " Content 2112 " , 'media_url' => " http://example.com/2112/enclosure " , 'media_type' => " image/png " ],
2021-02-03 18:06:36 +00:00
];
protected const ENTRIES_OUT = [
2021-02-03 21:27:55 +00:00
[ 'id' => 42 , 'user_id' => 42 , 'feed_id' => 55 , 'status' => " read " , 'hash' => " FINGERPRINT " , 'title' => " Title 42 " , 'url' => " http://example.com/42 " , 'comments_url' => " " , 'published_at' => " 2021-01-22T04:21:12+02:00 " , 'created_at' => " 2021-01-22T15:44:47.000000+02:00 " , 'content' => " Content 42 " , 'author' => " Thomas Costain " , 'share_code' => " " , 'starred' => false , 'reading_time' => 0 , 'enclosures' => null , 'feed' => self :: FEEDS_OUT [ 1 ]],
[ 'id' => 44 , 'user_id' => 42 , 'feed_id' => 55 , 'status' => " unread " , 'hash' => " FINGERPRINT " , 'title' => " Title 44 " , 'url' => " http://example.com/44 " , 'comments_url' => " " , 'published_at' => " 2021-01-22T04:21:12+02:00 " , 'created_at' => " 2021-01-22T15:44:47.000000+02:00 " , 'content' => " Content 44 " , 'author' => " " , 'share_code' => " " , 'starred' => true , 'reading_time' => 0 , 'enclosures' => [[ 'id' => 44 , 'user_id' => 42 , 'entry_id' => 44 , 'url' => " http://example.com/44/enclosure " , 'mime_type' => " application/octet-stream " , 'size' => 0 ]], 'feed' => self :: FEEDS_OUT [ 1 ]],
[ 'id' => 47 , 'user_id' => 42 , 'feed_id' => 55 , 'status' => " removed " , 'hash' => " FINGERPRINT " , 'title' => " Title 47 " , 'url' => " http://example.com/47 " , 'comments_url' => " " , 'published_at' => " 2021-01-22T04:21:12+02:00 " , 'created_at' => " 2021-01-22T15:44:47.000000+02:00 " , 'content' => " Content 47 " , 'author' => " " , 'share_code' => " " , 'starred' => false , 'reading_time' => 0 , 'enclosures' => [[ 'id' => 47 , 'user_id' => 42 , 'entry_id' => 47 , 'url' => " http://example.com/47/enclosure " , 'mime_type' => " application/octet-stream " , 'size' => 0 ]], 'feed' => self :: FEEDS_OUT [ 1 ]],
[ 'id' => 2112 , 'user_id' => 42 , 'feed_id' => 55 , 'status' => " removed " , 'hash' => " FINGERPRINT " , 'title' => " Title 2112 " , 'url' => " http://example.com/2112 " , 'comments_url' => " " , 'published_at' => " 2021-01-22T04:21:12+02:00 " , 'created_at' => " 2021-01-22T15:44:47.000000+02:00 " , 'content' => " Content 2112 " , 'author' => " " , 'share_code' => " " , 'starred' => false , 'reading_time' => 0 , 'enclosures' => [[ 'id' => 2112 , 'user_id' => 42 , 'entry_id' => 2112 , 'url' => " http://example.com/2112/enclosure " , 'mime_type' => " image/png " , 'size' => 0 ]], 'feed' => self :: FEEDS_OUT [ 1 ]],
2021-02-03 18:06:36 +00:00
];
protected $h ;
protected $transaction ;
2020-11-23 14:31:50 +00:00
2020-12-11 04:19:26 +00:00
protected function req ( string $method , string $target , $data = " " , array $headers = [], ? string $user = " john.doe@example.com " , bool $body = true ) : ResponseInterface {
2021-02-28 14:23:38 +00:00
Arsse :: $obj = $this -> objMock -> get ();
Arsse :: $db = $this -> dbMock -> get ();
if ( $this -> h instanceof InstanceHandle ) {
$this -> h = $this -> h -> get ();
}
2020-11-23 14:31:50 +00:00
$prefix = " /v1 " ;
$url = $prefix . $target ;
if ( $body ) {
$params = [];
} else {
$params = $data ;
$data = [];
}
2020-12-11 04:19:26 +00:00
$req = $this -> serverRequest ( $method , $url , $prefix , $headers , [], $data , " application/json " , $params , $user );
2020-11-23 14:31:50 +00:00
return $this -> h -> dispatch ( $req );
}
public function setUp () : void {
2021-02-27 20:24:02 +00:00
parent :: setUp ();
2020-11-23 14:31:50 +00:00
self :: setConf ();
2021-02-28 14:23:38 +00:00
// create mock timestamps
$this -> objMock -> get -> with ( \DateTimeImmutable :: class ) -> returns ( new \DateTimeImmutable ( self :: NOW ));
2020-11-23 14:31:50 +00:00
// create a mock database interface
2021-02-28 14:23:38 +00:00
$this -> transaction = $this -> mock ( Transaction :: class );
$this -> dbMock = $this -> mock ( Database :: class );
$this -> dbMock -> begin -> returns ( $this -> transaction -> get ());
2020-12-30 22:01:17 +00:00
// create a mock user manager; we use a PHPUnitmock because Phake for reasons unknown is unable to mock the User class correctly, sometimes
Arsse :: $user = $this -> createMock ( User :: class );
2021-02-03 21:27:55 +00:00
Arsse :: $user -> method ( " propertiesGet " ) -> willReturn ([ 'num' => 42 , 'admin' => false , 'root_folder_name' => null , 'tz' => " Asia/Gaza " ]);
2021-02-28 14:23:38 +00:00
Arsse :: $user -> method ( " begin " ) -> willReturn ( $this -> transaction -> get ());
2020-11-23 14:31:50 +00:00
//initialize a handler
$this -> h = new V1 ();
}
protected function v ( $value ) {
return $value ;
}
2020-11-26 13:42:35 +00:00
/** @dataProvider provideAuthResponses */
2020-11-30 15:52:32 +00:00
public function testAuthenticateAUser ( $token , bool $auth , bool $success ) : void {
2020-12-01 16:06:29 +00:00
$exp = $success ? new EmptyResponse ( 404 ) : new ErrorResponse ( " 401 " , 401 );
2020-11-30 15:52:32 +00:00
$user = " john.doe@example.com " ;
if ( $token !== null ) {
$headers = [ 'X-Auth-Token' => $token ];
} else {
$headers = [];
}
Arsse :: $user -> id = null ;
2021-02-28 14:23:38 +00:00
$this -> dbMock -> tokenLookup -> throws ( new ExceptionInput ( " subjectMissing " ));
$this -> dbMock -> tokenLookup -> with ( " miniflux.login " , self :: TOKEN ) -> returns ([ 'user' => $user ]);
2020-12-11 04:19:26 +00:00
$this -> assertMessage ( $exp , $this -> req ( " GET " , " / " , " " , $headers , $auth ? " john.doe@example.com " : null ));
2020-12-01 16:06:29 +00:00
$this -> assertSame ( $success ? $user : null , Arsse :: $user -> id );
2020-11-30 15:52:32 +00:00
}
public function provideAuthResponses () : iterable {
return [
2021-02-03 18:06:36 +00:00
[ null , false , false ],
[ null , true , true ],
[ self :: TOKEN , false , true ],
[[ self :: TOKEN , " BOGUS " ], false , true ],
[ " " , true , true ],
[[ " " , " BOGUS " ], true , true ],
[ " NOT A TOKEN " , false , false ],
[ " NOT A TOKEN " , true , false ],
[[ " BOGUS " , self :: TOKEN ], false , false ],
[[ " " , self :: TOKEN ], false , false ],
2020-11-30 15:52:32 +00:00
];
2020-11-23 14:31:50 +00:00
}
/** @dataProvider provideInvalidPaths */
2020-12-01 16:06:29 +00:00
public function testRespondToInvalidPaths ( $path , $method , $code , $allow = null ) : void {
2020-11-23 14:31:50 +00:00
$exp = new EmptyResponse ( $code , $allow ? [ 'Allow' => $allow ] : []);
$this -> assertMessage ( $exp , $this -> req ( $method , $path ));
}
public function provideInvalidPaths () : array {
return [
[ " / " , " GET " , 404 ],
2020-12-01 17:08:45 +00:00
[ " / " , " OPTIONS " , 404 ],
2020-12-01 16:06:29 +00:00
[ " /me " , " POST " , 405 , " GET " ],
2020-12-01 17:08:45 +00:00
[ " /me/ " , " GET " , 404 ],
2020-11-23 14:31:50 +00:00
];
}
/** @dataProvider provideOptionsRequests */
2020-12-01 17:08:45 +00:00
public function testRespondToOptionsRequests ( string $url , string $allow , string $accept ) : void {
2020-11-23 14:31:50 +00:00
$exp = new EmptyResponse ( 204 , [
'Allow' => $allow ,
'Accept' => $accept ,
]);
$this -> assertMessage ( $exp , $this -> req ( " OPTIONS " , $url ));
}
public function provideOptionsRequests () : array {
return [
2020-12-01 17:08:45 +00:00
[ " /feeds " , " HEAD, GET, POST " , " application/json " ],
[ " /feeds/2112 " , " HEAD, GET, PUT, DELETE " , " application/json " ],
[ " /me " , " HEAD, GET " , " application/json " ],
[ " /users/someone " , " HEAD, GET " , " application/json " ],
[ " /import " , " POST " , " application/xml, text/xml, text/x-opml " ],
2020-11-23 14:31:50 +00:00
];
}
2020-12-02 23:00:27 +00:00
public function testRejectBadlyTypedData () : void {
2020-12-28 13:12:30 +00:00
$exp = new ErrorResponse ([ " InvalidInputType " , 'field' => " url " , 'expected' => " string " , 'actual' => " integer " ], 422 );
2020-12-02 23:00:27 +00:00
$this -> assertMessage ( $exp , $this -> req ( " POST " , " /discover " , [ 'url' => 2112 ]));
}
2021-01-20 04:17:03 +00:00
/** @dataProvider provideDiscoveries */
public function testDiscoverFeeds ( $in , ResponseInterface $exp ) : void {
$this -> assertMessage ( $exp , $this -> req ( " POST " , " /discover " , [ 'url' => $in ]));
}
public function provideDiscoveries () : iterable {
self :: clearData ();
$discovered = [
2020-12-02 23:00:27 +00:00
[ 'title' => " Feed " , 'type' => " rss " , 'url' => " http://localhost:8000/Feed/Discovery/Feed " ],
[ 'title' => " Feed " , 'type' => " rss " , 'url' => " http://localhost:8000/Feed/Discovery/Missing " ],
2021-01-20 04:17:03 +00:00
];
return [
2021-01-20 23:28:51 +00:00
[ " http://localhost:8000/Feed/Discovery/Valid " , new Response ( $discovered )],
2021-01-20 04:17:03 +00:00
[ " http://localhost:8000/Feed/Discovery/Invalid " , new Response ([])],
[ " http://localhost:8000/Feed/Discovery/Missing " , new ErrorResponse ( " Fetch404 " , 502 )],
2021-01-20 23:28:51 +00:00
[ 1 , new ErrorResponse ([ " InvalidInputType " , 'field' => " url " , 'expected' => " string " , 'actual' => " integer " ], 422 )],
[ " Not a URL " , new ErrorResponse ([ " InvalidInputValue " , 'field' => " url " ], 422 )],
[ null , new ErrorResponse ([ " MissingInputValue " , 'field' => " url " ], 422 )],
2021-01-20 04:17:03 +00:00
];
2020-12-02 23:00:27 +00:00
}
2020-12-10 04:39:29 +00:00
2020-12-11 04:19:26 +00:00
/** @dataProvider provideUserQueries */
public function testQueryUsers ( bool $admin , string $route , ResponseInterface $exp ) : void {
2020-12-10 04:39:29 +00:00
$u = [
2020-12-22 21:13:12 +00:00
[ 'num' => 1 , 'admin' => true , 'theme' => " custom " , 'lang' => " fr_CA " , 'tz' => " Asia/Gaza " , 'sort_asc' => true , 'page_size' => 200 , 'shortcuts' => false , 'reading_time' => false , 'swipe' => false , 'stylesheet' => " p { } " ],
[ 'num' => 2 , 'admin' => false , 'theme' => null , 'lang' => null , 'tz' => null , 'sort_asc' => null , 'page_size' => null , 'shortcuts' => null , 'reading_time' => null , 'swipe' => null , 'stylesheet' => null ],
2020-12-10 04:39:29 +00:00
new ExceptionConflict ( " doesNotExist " ),
];
2020-12-11 04:19:26 +00:00
$user = $admin ? " john.doe@example.com " : " jane.doe@example.com " ;
2020-12-10 04:39:29 +00:00
// FIXME: Phake is somehow unable to mock the User class correctly, so we use PHPUnit's mocks instead
Arsse :: $user = $this -> createMock ( User :: class );
Arsse :: $user -> method ( " list " ) -> willReturn ([ " john.doe@example.com " , " jane.doe@example.com " , " admin@example.com " ]);
Arsse :: $user -> method ( " propertiesGet " ) -> willReturnCallback ( function ( string $user , bool $includeLerge = true ) use ( $u ) {
if ( $user === " john.doe@example.com " ) {
return $u [ 0 ];
} elseif ( $user === " jane.doe@example.com " ) {
return $u [ 1 ];
2020-12-11 01:08:00 +00:00
} else {
throw $u [ 2 ];
}
});
Arsse :: $user -> method ( " lookup " ) -> willReturnCallback ( function ( int $num ) use ( $u ) {
if ( $num === 1 ) {
return " john.doe@example.com " ;
} elseif ( $num === 2 ) {
return " jane.doe@example.com " ;
} else {
2020-12-10 04:39:29 +00:00
throw $u [ 2 ];
}
});
2020-12-11 04:19:26 +00:00
$this -> assertMessage ( $exp , $this -> req ( " GET " , $route , " " , [], $user ));
}
public function provideUserQueries () : iterable {
self :: clearData ();
return [
2021-02-03 18:06:36 +00:00
[ true , " /users " , new Response ( self :: USERS )],
[ true , " /me " , new Response ( self :: USERS [ 0 ])],
[ true , " /users/john.doe@example.com " , new Response ( self :: USERS [ 0 ])],
[ true , " /users/1 " , new Response ( self :: USERS [ 0 ])],
[ true , " /users/jane.doe@example.com " , new Response ( self :: USERS [ 1 ])],
[ true , " /users/2 " , new Response ( self :: USERS [ 1 ])],
2020-12-11 04:19:26 +00:00
[ true , " /users/jack.doe@example.com " , new ErrorResponse ( " 404 " , 404 )],
[ true , " /users/47 " , new ErrorResponse ( " 404 " , 404 )],
[ false , " /users " , new ErrorResponse ( " 403 " , 403 )],
2021-02-03 18:06:36 +00:00
[ false , " /me " , new Response ( self :: USERS [ 1 ])],
2020-12-11 04:19:26 +00:00
[ false , " /users/john.doe@example.com " , new ErrorResponse ( " 403 " , 403 )],
[ false , " /users/1 " , new ErrorResponse ( " 403 " , 403 )],
[ false , " /users/jane.doe@example.com " , new ErrorResponse ( " 403 " , 403 )],
[ false , " /users/2 " , new ErrorResponse ( " 403 " , 403 )],
[ false , " /users/jack.doe@example.com " , new ErrorResponse ( " 403 " , 403 )],
[ false , " /users/47 " , new ErrorResponse ( " 403 " , 403 )],
];
2020-12-10 04:39:29 +00:00
}
2020-12-12 04:47:13 +00:00
2020-12-30 22:01:17 +00:00
/** @dataProvider provideUserModifications */
public function testModifyAUser ( bool $admin , string $url , array $body , $in1 , $out1 , $in2 , $out2 , $in3 , $out3 , ResponseInterface $exp ) : void {
Arsse :: $user = $this -> createMock ( User :: class );
2021-02-28 14:23:38 +00:00
Arsse :: $user -> method ( " begin " ) -> willReturn ( $this -> transaction -> get ());
2020-12-30 22:01:17 +00:00
Arsse :: $user -> method ( " propertiesGet " ) -> willReturnCallback ( function ( string $u , bool $includeLarge ) use ( $admin ) {
if ( $u === " john.doe@example.com " || $u === " ook " ) {
return [ 'num' => 2 , 'admin' => $admin ];
} else {
return [ 'num' => 1 , 'admin' => true ];
}
});
Arsse :: $user -> method ( " lookup " ) -> willReturnCallback ( function ( int $u ) {
if ( $u === 1 ) {
return " jane.doe@example.com " ;
} elseif ( $u === 2 ) {
return " john.doe@example.com " ;
} else {
throw new ExceptionConflict ( " doesNotExist " );
}
});
if ( $out1 instanceof \Exception ) {
Arsse :: $user -> method ( " rename " ) -> willThrowException ( $out1 );
} else {
Arsse :: $user -> method ( " rename " ) -> willReturn ( $out1 ? ? false );
}
if ( $out2 instanceof \Exception ) {
Arsse :: $user -> method ( " passwordSet " ) -> willThrowException ( $out2 );
} else {
Arsse :: $user -> method ( " passwordSet " ) -> willReturn ( $out2 ? ? " " );
}
if ( $out3 instanceof \Exception ) {
Arsse :: $user -> method ( " propertiesSet " ) -> willThrowException ( $out3 );
} else {
Arsse :: $user -> method ( " propertiesSet " ) -> willReturn ( $out3 ? ? []);
}
$user = $url === " /users/1 " ? " jane.doe@example.com " : " john.doe@example.com " ;
if ( $in1 === null ) {
Arsse :: $user -> expects ( $this -> exactly ( 0 )) -> method ( " rename " );
} else {
Arsse :: $user -> expects ( $this -> exactly ( 1 )) -> method ( " rename " ) -> with ( $user , $in1 );
$user = $in1 ;
}
if ( $in2 === null ) {
Arsse :: $user -> expects ( $this -> exactly ( 0 )) -> method ( " passwordSet " );
} else {
Arsse :: $user -> expects ( $this -> exactly ( 1 )) -> method ( " passwordSet " ) -> with ( $user , $in2 );
}
if ( $in3 === null ) {
Arsse :: $user -> expects ( $this -> exactly ( 0 )) -> method ( " propertiesSet " );
} else {
Arsse :: $user -> expects ( $this -> exactly ( 1 )) -> method ( " propertiesSet " ) -> with ( $user , $in3 );
}
$this -> assertMessage ( $exp , $this -> req ( " PUT " , $url , $body ));
}
public function provideUserModifications () : iterable {
$out1 = [ 'num' => 2 , 'admin' => false ];
$out2 = [ 'num' => 1 , 'admin' => false ];
2021-02-03 18:06:36 +00:00
$resp1 = array_merge ( self :: USERS [ 1 ], [ 'username' => " john.doe@example.com " ]);
$resp2 = array_merge ( self :: USERS [ 1 ], [ 'id' => 1 , 'is_admin' => true ]);
2020-12-30 22:01:17 +00:00
return [
[ false , " /users/1 " , [ 'is_admin' => 0 ], null , null , null , null , null , null , new ErrorResponse ([ " InvalidInputType " , 'field' => " is_admin " , 'expected' => " boolean " , 'actual' => " integer " ], 422 )],
[ false , " /users/1 " , [ 'entry_sorting_direction' => " bad " ], null , null , null , null , null , null , new ErrorResponse ([ " InvalidInputValue " , 'field' => " entry_sorting_direction " ], 422 )],
[ false , " /users/1 " , [ 'theme' => " stark " ], null , null , null , null , null , null , new ErrorResponse ( " 403 " , 403 )],
[ false , " /users/2 " , [ 'is_admin' => true ], null , null , null , null , null , null , new ErrorResponse ( " InvalidElevation " , 403 )],
2021-03-18 14:38:20 +00:00
[ false , " /users/2 " , [ 'language' => " fr_CA " ], null , null , null , null , [ 'lang' => " fr_CA " ], $out1 , new Response ( $resp1 , 201 )],
[ false , " /users/2 " , [ 'entry_sorting_direction' => " asc " ], null , null , null , null , [ 'sort_asc' => true ], $out1 , new Response ( $resp1 , 201 )],
[ false , " /users/2 " , [ 'entry_sorting_direction' => " desc " ], null , null , null , null , [ 'sort_asc' => false ], $out1 , new Response ( $resp1 , 201 )],
2020-12-30 22:01:17 +00:00
[ false , " /users/2 " , [ 'entries_per_page' => - 1 ], null , null , null , null , [ 'page_size' => - 1 ], new UserExceptionInput ( " invalidNonZeroInteger " ), new ErrorResponse ([ " InvalidInputValue " , 'field' => " entries_per_page " ], 422 )],
[ false , " /users/2 " , [ 'timezone' => " Ook " ], null , null , null , null , [ 'tz' => " Ook " ], new UserExceptionInput ( " invalidTimezone " ), new ErrorResponse ([ " InvalidInputValue " , 'field' => " timezone " ], 422 )],
[ false , " /users/2 " , [ 'username' => " j:k " ], " j:k " , new UserExceptionInput ( " invalidUsername " ), null , null , null , null , new ErrorResponse ([ " InvalidInputValue " , 'field' => " username " ], 422 )],
[ false , " /users/2 " , [ 'username' => " ook " ], " ook " , new ExceptionConflict ( " alreadyExists " ), null , null , null , null , new ErrorResponse ([ " DuplicateUser " , 'user' => " ook " ], 409 )],
2021-03-18 14:38:20 +00:00
[ false , " /users/2 " , [ 'password' => " ook " ], null , null , " ook " , " ook " , null , null , new Response ( array_merge ( $resp1 , [ 'password' => " ook " ]), 201 )],
[ false , " /users/2 " , [ 'username' => " ook " , 'password' => " ook " ], " ook " , true , " ook " , " ook " , null , null , new Response ( array_merge ( $resp1 , [ 'username' => " ook " , 'password' => " ook " ]), 201 )],
[ true , " /users/1 " , [ 'theme' => " stark " ], null , null , null , null , [ 'theme' => " stark " ], $out2 , new Response ( $resp2 , 201 )],
2020-12-30 22:01:17 +00:00
[ true , " /users/3 " , [ 'theme' => " stark " ], null , null , null , null , null , null , new ErrorResponse ( " 404 " , 404 )],
];
}
2020-12-31 18:57:36 +00:00
/** @dataProvider provideUserAdditions */
public function testAddAUser ( array $body , $in1 , $out1 , $in2 , $out2 , ResponseInterface $exp ) : void {
Arsse :: $user = $this -> createMock ( User :: class );
2021-02-28 14:23:38 +00:00
Arsse :: $user -> method ( " begin " ) -> willReturn ( $this -> transaction -> get ());
2020-12-31 18:57:36 +00:00
Arsse :: $user -> method ( " propertiesGet " ) -> willReturnCallback ( function ( string $u , bool $includeLarge ) {
if ( $u === " john.doe@example.com " ) {
return [ 'num' => 1 , 'admin' => true ];
} else {
return [ 'num' => 2 , 'admin' => false ];
}
});
if ( $out1 instanceof \Exception ) {
Arsse :: $user -> method ( " add " ) -> willThrowException ( $out1 );
} else {
Arsse :: $user -> method ( " add " ) -> willReturn ( $in1 [ 1 ] ? ? " " );
}
if ( $out2 instanceof \Exception ) {
Arsse :: $user -> method ( " propertiesSet " ) -> willThrowException ( $out2 );
} else {
Arsse :: $user -> method ( " propertiesSet " ) -> willReturn ( $out2 ? ? []);
}
if ( $in1 === null ) {
Arsse :: $user -> expects ( $this -> exactly ( 0 )) -> method ( " add " );
} else {
Arsse :: $user -> expects ( $this -> exactly ( 1 )) -> method ( " add " ) -> with ( ... ( $in1 ? ? []));
}
if ( $in2 === null ) {
Arsse :: $user -> expects ( $this -> exactly ( 0 )) -> method ( " propertiesSet " );
} else {
Arsse :: $user -> expects ( $this -> exactly ( 1 )) -> method ( " propertiesSet " ) -> with ( $body [ 'username' ], $in2 );
}
$this -> assertMessage ( $exp , $this -> req ( " POST " , " /users " , $body ));
}
public function provideUserAdditions () : iterable {
2021-02-03 18:06:36 +00:00
$resp1 = array_merge ( self :: USERS [ 1 ], [ 'username' => " ook " , 'password' => " eek " ]);
2020-12-31 18:57:36 +00:00
return [
[[], null , null , null , null , new ErrorResponse ([ " MissingInputValue " , 'field' => " username " ], 422 )],
[[ 'username' => " ook " ], null , null , null , null , new ErrorResponse ([ " MissingInputValue " , 'field' => " password " ], 422 )],
[[ 'username' => " ook " , 'password' => " eek " ], [ " ook " , " eek " ], new ExceptionConflict ( " alreadyExists " ), null , null , new ErrorResponse ([ " DuplicateUser " , 'user' => " ook " ], 409 )],
[[ 'username' => " j:k " , 'password' => " eek " ], [ " j:k " , " eek " ], new UserExceptionInput ( " invalidUsername " ), null , null , new ErrorResponse ([ " InvalidInputValue " , 'field' => " username " ], 422 )],
[[ 'username' => " ook " , 'password' => " eek " , 'timezone' => " ook " ], [ " ook " , " eek " ], " eek " , [ 'tz' => " ook " ], new UserExceptionInput ( " invalidTimezone " ), new ErrorResponse ([ " InvalidInputValue " , 'field' => " timezone " ], 422 )],
[[ 'username' => " ook " , 'password' => " eek " , 'entries_per_page' => - 1 ], [ " ook " , " eek " ], " eek " , [ 'page_size' => - 1 ], new UserExceptionInput ( " invalidNonZeroInteger " ), new ErrorResponse ([ " InvalidInputValue " , 'field' => " entries_per_page " ], 422 )],
[[ 'username' => " ook " , 'password' => " eek " , 'theme' => " default " ], [ " ook " , " eek " ], " eek " , [ 'theme' => " default " ], [ 'theme' => " default " ], new Response ( $resp1 , 201 )],
];
}
public function testAddAUserWithoutAuthority () : void {
$this -> assertMessage ( new ErrorResponse ( " 403 " , 403 ), $this -> req ( " POST " , " /users " , []));
}
2020-12-31 22:03:08 +00:00
public function testDeleteAUser () : void {
Arsse :: $user = $this -> createMock ( User :: class );
Arsse :: $user -> method ( " propertiesGet " ) -> willReturn ([ 'admin' => true ]);
Arsse :: $user -> method ( " lookup " ) -> willReturn ( " john.doe@example.com " );
Arsse :: $user -> method ( " remove " ) -> willReturn ( true );
Arsse :: $user -> expects ( $this -> exactly ( 1 )) -> method ( " lookup " ) -> with ( 2112 );
Arsse :: $user -> expects ( $this -> exactly ( 1 )) -> method ( " remove " ) -> with ( " john.doe@example.com " );
$this -> assertMessage ( new EmptyResponse ( 204 ), $this -> req ( " DELETE " , " /users/2112 " ));
}
public function testDeleteAMissingUser () : void {
Arsse :: $user = $this -> createMock ( User :: class );
Arsse :: $user -> method ( " propertiesGet " ) -> willReturn ([ 'admin' => true ]);
Arsse :: $user -> method ( " lookup " ) -> willThrowException ( new ExceptionConflict ( " doesNotExist " ));
Arsse :: $user -> method ( " remove " ) -> willReturn ( true );
Arsse :: $user -> expects ( $this -> exactly ( 1 )) -> method ( " lookup " ) -> with ( 2112 );
Arsse :: $user -> expects ( $this -> exactly ( 0 )) -> method ( " remove " );
$this -> assertMessage ( new ErrorResponse ( " 404 " , 404 ), $this -> req ( " DELETE " , " /users/2112 " ));
}
public function testDeleteAUserWithoutAuthority () : void {
Arsse :: $user -> expects ( $this -> exactly ( 0 )) -> method ( " lookup " );
Arsse :: $user -> expects ( $this -> exactly ( 0 )) -> method ( " remove " );
$this -> assertMessage ( new ErrorResponse ( " 403 " , 403 ), $this -> req ( " DELETE " , " /users/2112 " ));
}
2020-12-12 04:47:13 +00:00
public function testListCategories () : void {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> folderList -> returns ( new Result ( $this -> v ([
2020-12-12 04:47:13 +00:00
[ 'id' => 1 , 'name' => " Science " ],
[ 'id' => 20 , 'name' => " Technology " ],
])));
$exp = new Response ([
[ 'id' => 1 , 'title' => " All " , 'user_id' => 42 ],
[ 'id' => 2 , 'title' => " Science " , 'user_id' => 42 ],
[ 'id' => 21 , 'title' => " Technology " , 'user_id' => 42 ],
]);
$this -> assertMessage ( $exp , $this -> req ( " GET " , " /categories " ));
2021-02-28 14:23:38 +00:00
$this -> dbMock -> folderList -> calledWith ( " john.doe@example.com " , null , false );
2020-12-12 04:47:13 +00:00
// run test again with a renamed root folder
Arsse :: $user = $this -> createMock ( User :: class );
Arsse :: $user -> method ( " propertiesGet " ) -> willReturn ([ 'num' => 47 , 'admin' => false , 'root_folder_name' => " Uncategorized " ]);
$exp = new Response ([
[ 'id' => 1 , 'title' => " Uncategorized " , 'user_id' => 47 ],
[ 'id' => 2 , 'title' => " Science " , 'user_id' => 47 ],
[ 'id' => 21 , 'title' => " Technology " , 'user_id' => 47 ],
]);
$this -> assertMessage ( $exp , $this -> req ( " GET " , " /categories " ));
}
/** @dataProvider provideCategoryAdditions */
public function testAddACategory ( $title , ResponseInterface $exp ) : void {
if ( ! strlen (( string ) $title )) {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> folderAdd -> throws ( new ExceptionInput ( " missing " ));
2020-12-12 04:47:13 +00:00
} elseif ( ! strlen ( trim (( string ) $title ))) {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> folderAdd -> throws ( new ExceptionInput ( " whitespace " ));
2020-12-12 04:47:13 +00:00
} elseif ( $title === " Duplicate " ) {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> folderAdd -> throws ( new ExceptionInput ( " constraintViolation " ));
2020-12-12 04:47:13 +00:00
} else {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> folderAdd -> returns ( 2111 );
2020-12-12 04:47:13 +00:00
}
$this -> assertMessage ( $exp , $this -> req ( " POST " , " /categories " , [ 'title' => $title ]));
}
public function provideCategoryAdditions () : iterable {
return [
2020-12-28 13:12:30 +00:00
[ " New " , new Response ([ 'id' => 2112 , 'title' => " New " , 'user_id' => 42 ], 201 )],
2020-12-31 20:46:47 +00:00
[ " Duplicate " , new ErrorResponse ([ " DuplicateCategory " , 'title' => " Duplicate " ], 409 )],
[ " " , new ErrorResponse ([ " InvalidCategory " , 'title' => " " ], 422 )],
[ " " , new ErrorResponse ([ " InvalidCategory " , 'title' => " " ], 422 )],
[ null , new ErrorResponse ([ " MissingInputValue " , 'field' => " title " ], 422 )],
2021-01-08 20:47:19 +00:00
[ false , new ErrorResponse ([ " InvalidInputType " , 'field' => " title " , 'actual' => " boolean " , 'expected' => " string " ], 422 )],
2020-12-12 04:47:13 +00:00
];
}
2020-12-13 17:56:57 +00:00
/** @dataProvider provideCategoryUpdates */
2020-12-14 03:10:34 +00:00
public function testRenameACategory ( int $id , $title , $out , ResponseInterface $exp ) : void {
2020-12-13 17:56:57 +00:00
Arsse :: $user -> method ( " propertiesSet " ) -> willReturn ([ 'root_folder_name' => $title ]);
2020-12-14 03:10:34 +00:00
if ( is_string ( $out )) {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> folderPropertiesSet -> throws ( new ExceptionInput ( $out ));
2020-12-13 17:56:57 +00:00
} else {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> folderPropertiesSet -> returns ( $out );
2020-12-13 17:56:57 +00:00
}
2020-12-14 03:10:34 +00:00
$times = ( int ) ( $id === 1 && is_string ( $title ) && strlen ( trim ( $title )));
Arsse :: $user -> expects ( $this -> exactly ( $times )) -> method ( " propertiesSet " ) -> with ( " john.doe@example.com " , [ 'root_folder_name' => $title ]);
2020-12-13 17:56:57 +00:00
$this -> assertMessage ( $exp , $this -> req ( " PUT " , " /categories/ $id " , [ 'title' => $title ]));
2020-12-14 03:10:34 +00:00
$times = ( int ) ( $id !== 1 && is_string ( $title ));
2021-02-28 14:23:38 +00:00
$this -> dbMock -> folderPropertiesSet -> times ( $times ) -> calledWith ( " john.doe@example.com " , $id - 1 , [ 'name' => $title ]);
2020-12-13 17:56:57 +00:00
}
public function provideCategoryUpdates () : iterable {
return [
2020-12-14 03:10:34 +00:00
[ 3 , " New " , " subjectMissing " , new ErrorResponse ( " 404 " , 404 )],
2021-03-18 14:38:20 +00:00
[ 2 , " New " , true , new Response ([ 'id' => 2 , 'title' => " New " , 'user_id' => 42 ], 201 )],
2020-12-31 20:46:47 +00:00
[ 2 , " Duplicate " , " constraintViolation " , new ErrorResponse ([ " DuplicateCategory " , 'title' => " Duplicate " ], 409 )],
[ 2 , " " , " missing " , new ErrorResponse ([ " InvalidCategory " , 'title' => " " ], 422 )],
[ 2 , " " , " whitespace " , new ErrorResponse ([ " InvalidCategory " , 'title' => " " ], 422 )],
[ 2 , null , " missing " , new ErrorResponse ([ " MissingInputValue " , 'field' => " title " ], 422 )],
[ 2 , false , " subjectMissing " , new ErrorResponse ([ " InvalidInputType " , 'field' => " title " , 'actual' => " boolean " , 'expected' => " string " ], 422 )],
2021-03-18 14:38:20 +00:00
[ 1 , " New " , true , new Response ([ 'id' => 1 , 'title' => " New " , 'user_id' => 42 ], 201 )],
[ 1 , " Duplicate " , " constraintViolation " , new Response ([ 'id' => 1 , 'title' => " Duplicate " , 'user_id' => 42 ], 201 )], // This is allowed because the name of the root folder is only a duplicate in circumstances where it is used
2020-12-31 20:46:47 +00:00
[ 1 , " " , " missing " , new ErrorResponse ([ " InvalidCategory " , 'title' => " " ], 422 )],
[ 1 , " " , " whitespace " , new ErrorResponse ([ " InvalidCategory " , 'title' => " " ], 422 )],
[ 1 , null , " missing " , new ErrorResponse ([ " MissingInputValue " , 'field' => " title " ], 422 )],
2020-12-28 13:12:30 +00:00
[ 1 , false , false , new ErrorResponse ([ " InvalidInputType " , 'field' => " title " , 'actual' => " boolean " , 'expected' => " string " ], 422 )],
2020-12-13 17:56:57 +00:00
];
}
2020-12-14 03:10:34 +00:00
public function testDeleteARealCategory () : void {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> folderRemove -> returns ( true ) -> throws ( new ExceptionInput ( " subjectMissing " ));
2020-12-14 03:10:34 +00:00
$this -> assertMessage ( new EmptyResponse ( 204 ), $this -> req ( " DELETE " , " /categories/2112 " ));
2021-02-28 14:23:38 +00:00
$this -> dbMock -> folderRemove -> calledWith ( " john.doe@example.com " , 2111 );
2020-12-14 03:10:34 +00:00
$this -> assertMessage ( new ErrorResponse ( " 404 " , 404 ), $this -> req ( " DELETE " , " /categories/47 " ));
2021-02-28 14:23:38 +00:00
$this -> dbMock -> folderRemove -> calledWith ( " john.doe@example.com " , 46 );
2020-12-14 03:10:34 +00:00
}
public function testDeleteTheSpecialCategory () : void {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionList -> returns ( new Result ( $this -> v ([
2020-12-14 03:10:34 +00:00
[ 'id' => 1 ],
[ 'id' => 47 ],
[ 'id' => 2112 ],
])));
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionRemove -> returns ( true );
2020-12-14 03:10:34 +00:00
$this -> assertMessage ( new EmptyResponse ( 204 ), $this -> req ( " DELETE " , " /categories/1 " ));
2021-02-28 14:23:38 +00:00
Phony :: inOrder (
$this -> dbMock -> begin -> calledWith (),
$this -> dbMock -> subscriptionList -> calledWith ( " john.doe@example.com " , null , false ),
$this -> dbMock -> subscriptionRemove -> calledWith ( " john.doe@example.com " , 1 ),
$this -> dbMock -> subscriptionRemove -> calledWith ( " john.doe@example.com " , 47 ),
$this -> dbMock -> subscriptionRemove -> calledWith ( " john.doe@example.com " , 2112 ),
$this -> transaction -> commit -> called ()
2020-12-14 03:10:34 +00:00
);
}
2020-12-14 17:41:09 +00:00
2021-01-22 23:24:33 +00:00
public function testListFeeds () : void {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionList -> returns ( new Result ( $this -> v ( self :: FEEDS )));
2021-02-03 18:06:36 +00:00
$exp = new Response ( self :: FEEDS_OUT );
2021-01-17 18:02:31 +00:00
$this -> assertMessage ( $exp , $this -> req ( " GET " , " /feeds " ));
}
2021-01-20 23:28:51 +00:00
2021-01-22 23:24:33 +00:00
public function testListFeedsOfACategory () : void {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionList -> returns ( new Result ( $this -> v ( self :: FEEDS )));
2021-02-03 18:06:36 +00:00
$exp = new Response ( self :: FEEDS_OUT );
2021-01-22 23:24:33 +00:00
$this -> assertMessage ( $exp , $this -> req ( " GET " , " /categories/2112/feeds " ));
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionList -> calledWith ( Arsse :: $user -> id , 2111 , true );
2021-01-22 23:24:33 +00:00
}
public function testListFeedsOfTheRootCategory () : void {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionList -> returns ( new Result ( $this -> v ( self :: FEEDS )));
2021-02-03 18:06:36 +00:00
$exp = new Response ( self :: FEEDS_OUT );
2021-01-22 23:24:33 +00:00
$this -> assertMessage ( $exp , $this -> req ( " GET " , " /categories/1/feeds " ));
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionList -> calledWith ( Arsse :: $user -> id , 0 , false );
2021-01-22 23:24:33 +00:00
}
public function testListFeedsOfAMissingCategory () : void {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionList -> throws ( new ExceptionInput ( " idMissing " ));
2021-01-24 16:33:00 +00:00
$exp = new ErrorResponse ( " 404 " , 404 );
2021-01-22 23:24:33 +00:00
$this -> assertMessage ( $exp , $this -> req ( " GET " , " /categories/2112/feeds " ));
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionList -> calledWith ( Arsse :: $user -> id , 2111 , true );
2021-01-22 23:24:33 +00:00
}
2021-01-24 18:54:54 +00:00
public function testGetAFeed () : void {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionPropertiesGet -> returns ( $this -> v ( self :: FEEDS [ 0 ])) -> returns ( $this -> v ( self :: FEEDS [ 1 ]));
2021-02-03 18:06:36 +00:00
$this -> assertMessage ( new Response ( self :: FEEDS_OUT [ 0 ]), $this -> req ( " GET " , " /feeds/1 " ));
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionPropertiesGet -> calledWith ( Arsse :: $user -> id , 1 );
2021-02-03 18:06:36 +00:00
$this -> assertMessage ( new Response ( self :: FEEDS_OUT [ 1 ]), $this -> req ( " GET " , " /feeds/55 " ));
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionPropertiesGet -> calledWith ( Arsse :: $user -> id , 55 );
2021-01-24 18:54:54 +00:00
}
public function testGetAMissingFeed () : void {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionPropertiesGet -> throws ( new ExceptionInput ( " subjectMissing " ));
2021-01-24 18:54:54 +00:00
$this -> assertMessage ( new ErrorResponse ( " 404 " , 404 ), $this -> req ( " GET " , " /feeds/1 " ));
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionPropertiesGet -> calledWith ( Arsse :: $user -> id , 1 );
2021-01-24 18:54:54 +00:00
}
2021-01-20 23:28:51 +00:00
/** @dataProvider provideFeedCreations */
2021-01-24 16:25:38 +00:00
public function testCreateAFeed ( array $in , $out1 , $out2 , $out3 , $out4 , ResponseInterface $exp ) : void {
2021-01-20 23:28:51 +00:00
if ( $out1 instanceof \Exception ) {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> feedAdd -> throws ( $out1 );
2021-01-20 23:28:51 +00:00
} else {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> feedAdd -> returns ( $out1 );
2021-01-20 23:28:51 +00:00
}
if ( $out2 instanceof \Exception ) {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionAdd -> throws ( $out2 );
2021-01-20 23:28:51 +00:00
} else {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionAdd -> returns ( $out2 );
2021-01-20 23:28:51 +00:00
}
if ( $out3 instanceof \Exception ) {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionPropertiesSet -> throws ( $out3 );
2021-01-24 16:25:38 +00:00
} elseif ( $out4 instanceof \Exception ) {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionPropertiesSet -> returns ( $out3 ) -> throws ( $out4 );
2021-01-20 23:28:51 +00:00
} else {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionPropertiesSet -> returns ( $out3 ) -> returns ( $out4 );
2021-01-20 23:28:51 +00:00
}
$this -> assertMessage ( $exp , $this -> req ( " POST " , " /feeds " , $in ));
$in1 = $out1 !== null ;
$in2 = $out2 !== null ;
$in3 = $out3 !== null ;
2021-01-24 16:25:38 +00:00
$in4 = $out4 !== null ;
2021-01-20 23:28:51 +00:00
if ( $in1 ) {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> feedAdd -> calledWith ( $in [ 'feed_url' ], $in [ 'username' ] ? ? " " , $in [ 'password' ] ? ? " " , false , $in [ 'crawler' ] ? ? false );
2021-01-20 23:28:51 +00:00
} else {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> feedAdd -> never () -> called ();
2021-01-20 23:28:51 +00:00
}
if ( $in2 ) {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> begin -> calledWith ();
$this -> dbMock -> subscriptionAdd -> calledWith ( " john.doe@example.com " , $in [ 'feed_url' ], $in [ 'username' ] ? ? " " , $in [ 'password' ] ? ? " " , false , $in [ 'crawler' ] ? ? false );
2021-01-20 23:28:51 +00:00
} else {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> begin -> never () -> called ();
$this -> dbMock -> subscriptionAdd -> never () -> called ();
2021-01-20 23:28:51 +00:00
}
if ( $in3 ) {
$props = [
'folder' => $in [ 'category_id' ] - 1 ,
'scrape' => $in [ 'crawler' ] ? ? false ,
];
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionPropertiesSet -> calledWith ( " john.doe@example.com " , $out2 , $props );
2021-01-24 16:25:38 +00:00
if ( ! $out3 instanceof \Exception ) {
2021-02-28 14:23:38 +00:00
$this -> transaction -> commit -> called ();
2021-01-24 16:25:38 +00:00
}
2021-01-20 23:28:51 +00:00
} else {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionPropertiesSet -> never () -> called ();
2021-01-20 23:28:51 +00:00
}
2021-01-24 16:25:38 +00:00
if ( $in4 ) {
$rules = [
'keep_rule' => $in [ 'keeplist_rules' ] ? ? null ,
'block_rule' => $in [ 'blocklist_rules' ] ? ? null ,
];
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionPropertiesSet -> calledWith ( " john.doe@example.com " , $out2 , $rules );
2021-01-24 16:25:38 +00:00
} else {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionPropertiesSet -> atMost ( 1 ) -> called ();
2021-01-24 16:25:38 +00:00
}
2021-01-20 23:28:51 +00:00
}
public function provideFeedCreations () : iterable {
self :: clearData ();
return [
2021-01-24 16:25:38 +00:00
[[ 'category_id' => 1 ], null , null , null , null , new ErrorResponse ([ " MissingInputValue " , 'field' => " feed_url " ], 422 )],
[[ 'feed_url' => " http://example.com/ " ], null , null , null , null , new ErrorResponse ([ " MissingInputValue " , 'field' => " category_id " ], 422 )],
[[ 'feed_url' => " http://example.com/ " , 'category_id' => " 1 " ], null , null , null , null , new ErrorResponse ([ " InvalidInputType " , 'field' => " category_id " , 'expected' => " integer " , 'actual' => " string " ], 422 )],
[[ 'feed_url' => " Not a URL " , 'category_id' => 1 ], null , null , null , null , new ErrorResponse ([ " InvalidInputValue " , 'field' => " feed_url " ], 422 )],
[[ 'feed_url' => " http://example.com/ " , 'category_id' => 0 ], null , null , null , null , new ErrorResponse ([ " InvalidInputValue " , 'field' => " category_id " ], 422 )],
[[ 'feed_url' => " http://example.com/ " , 'category_id' => 1 , 'keeplist_rules' => " [ " ], null , null , null , null , new ErrorResponse ([ " InvalidInputValue " , 'field' => " keeplist_rules " ], 422 )],
[[ 'feed_url' => " http://example.com/ " , 'category_id' => 1 , 'blocklist_rules' => " [ " ], null , null , null , null , new ErrorResponse ([ " InvalidInputValue " , 'field' => " blocklist_rules " ], 422 )],
[[ 'feed_url' => " http://example.com/ " , 'category_id' => 1 ], new FeedException ( " internalError " ), null , null , null , new ErrorResponse ( " FetchOther " , 502 )],
[[ 'feed_url' => " http://example.com/ " , 'category_id' => 1 ], new FeedException ( " invalidCertificate " ), null , null , null , new ErrorResponse ( " FetchOther " , 502 )],
[[ 'feed_url' => " http://example.com/ " , 'category_id' => 1 ], new FeedException ( " invalidUrl " ), null , null , null , new ErrorResponse ( " Fetch404 " , 502 )],
[[ 'feed_url' => " http://example.com/ " , 'category_id' => 1 ], new FeedException ( " maxRedirect " ), null , null , null , new ErrorResponse ( " FetchOther " , 502 )],
[[ 'feed_url' => " http://example.com/ " , 'category_id' => 1 ], new FeedException ( " maxSize " ), null , null , null , new ErrorResponse ( " FetchOther " , 502 )],
[[ 'feed_url' => " http://example.com/ " , 'category_id' => 1 ], new FeedException ( " timeout " ), null , null , null , new ErrorResponse ( " FetchOther " , 502 )],
[[ 'feed_url' => " http://example.com/ " , 'category_id' => 1 ], new FeedException ( " forbidden " ), null , null , null , new ErrorResponse ( " Fetch403 " , 502 )],
[[ 'feed_url' => " http://example.com/ " , 'category_id' => 1 ], new FeedException ( " unauthorized " ), null , null , null , new ErrorResponse ( " Fetch401 " , 502 )],
[[ 'feed_url' => " http://example.com/ " , 'category_id' => 1 ], new FeedException ( " transmissionError " ), null , null , null , new ErrorResponse ( " FetchOther " , 502 )],
[[ 'feed_url' => " http://example.com/ " , 'category_id' => 1 ], new FeedException ( " connectionFailed " ), null , null , null , new ErrorResponse ( " FetchOther " , 502 )],
[[ 'feed_url' => " http://example.com/ " , 'category_id' => 1 ], new FeedException ( " malformedXml " ), null , null , null , new ErrorResponse ( " FetchOther " , 502 )],
[[ 'feed_url' => " http://example.com/ " , 'category_id' => 1 ], new FeedException ( " xmlEntity " ), null , null , null , new ErrorResponse ( " FetchOther " , 502 )],
[[ 'feed_url' => " http://example.com/ " , 'category_id' => 1 ], new FeedException ( " subscriptionNotFound " ), null , null , null , new ErrorResponse ( " Fetch404 " , 502 )],
[[ 'feed_url' => " http://example.com/ " , 'category_id' => 1 ], new FeedException ( " unsupportedFeedFormat " ), null , null , null , new ErrorResponse ( " FetchFormat " , 502 )],
[[ 'feed_url' => " http://example.com/ " , 'category_id' => 1 ], 2112 , new ExceptionInput ( " constraintViolation " ), null , null , new ErrorResponse ( " DuplicateFeed " , 409 )],
[[ 'feed_url' => " http://example.com/ " , 'category_id' => 1 ], 2112 , 44 , new ExceptionInput ( " idMissing " ), null , new ErrorResponse ( " MissingCategory " , 422 )],
[[ 'feed_url' => " http://example.com/ " , 'category_id' => 1 ], 2112 , 44 , true , null , new Response ([ 'feed_id' => 44 ], 201 )],
[[ 'feed_url' => " http://example.com/ " , 'category_id' => 1 , 'keeplist_rules' => " ^A " ], 2112 , 44 , true , true , new Response ([ 'feed_id' => 44 ], 201 )],
[[ 'feed_url' => " http://example.com/ " , 'category_id' => 1 , 'blocklist_rules' => " A " ], 2112 , 44 , true , true , new Response ([ 'feed_id' => 44 ], 201 )],
2021-01-20 23:28:51 +00:00
];
}
2021-01-25 01:28:00 +00:00
/** @dataProvider provideFeedModifications */
public function testModifyAFeed ( array $in , array $data , $out , ResponseInterface $exp ) : void {
2021-02-28 14:23:38 +00:00
$this -> h = $this -> partialMock ( V1 :: class );
$this -> h -> getFeed -> returns ( new Response ( self :: FEEDS_OUT [ 0 ]));
2021-01-25 01:28:00 +00:00
if ( $out instanceof \Exception ) {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionPropertiesSet -> throws ( $out );
2021-01-25 01:28:00 +00:00
} else {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionPropertiesSet -> returns ( $out );
2021-01-25 01:28:00 +00:00
}
2021-01-26 15:32:27 +00:00
$this -> assertMessage ( $exp , $this -> req ( " PUT " , " /feeds/2112 " , $in ));
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionPropertiesSet -> calledWith ( Arsse :: $user -> id , 2112 , $data );
2021-01-25 01:28:00 +00:00
}
public function provideFeedModifications () : iterable {
self :: clearData ();
2021-03-18 14:38:20 +00:00
$success = new Response ( self :: FEEDS_OUT [ 0 ], 201 );
2021-01-25 01:28:00 +00:00
return [
[[], [], true , $success ],
[[], [], new ExceptionInput ( " subjectMissing " ), new ErrorResponse ( " 404 " , 404 )],
[[ 'title' => " " ], [ 'title' => " " ], new ExceptionInput ( " missing " ), new ErrorResponse ( " InvalidTitle " , 422 )],
[[ 'title' => " " ], [ 'title' => " " ], new ExceptionInput ( " whitespace " ), new ErrorResponse ( " InvalidTitle " , 422 )],
[[ 'title' => " " ], [ 'title' => " " ], new ExceptionInput ( " whitespace " ), new ErrorResponse ( " InvalidTitle " , 422 )],
[[ 'category_id' => 47 ], [ 'folder' => 46 ], new ExceptionInput ( " idMissing " ), new ErrorResponse ( " MissingCategory " , 422 )],
[[ 'crawler' => false ], [ 'scrape' => false ], true , $success ],
[[ 'keeplist_rules' => " " ], [ 'keep_rule' => " " ], true , $success ],
[[ 'blocklist_rules' => " ook " ], [ 'block_rule' => " ook " ], true , $success ],
2021-02-09 00:14:11 +00:00
[[ 'title' => " Ook! " , 'crawler' => true ], [ 'title' => " Ook! " , 'scrape' => true ], true , $success ],
2021-01-25 01:28:00 +00:00
];
}
2021-01-25 02:12:32 +00:00
2021-02-08 00:20:10 +00:00
public function testModifyAFeedWithNoBody () : void {
2021-02-28 14:23:38 +00:00
$this -> h = $this -> partialMock ( V1 :: class );
$this -> h -> getFeed -> returns ( new Response ( self :: FEEDS_OUT [ 0 ]));
$this -> dbMock -> subscriptionPropertiesSet -> returns ( true );
2021-03-18 14:38:20 +00:00
$this -> assertMessage ( new Response ( self :: FEEDS_OUT [ 0 ], 201 ), $this -> req ( " PUT " , " /feeds/2112 " , " " ));
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionPropertiesSet -> calledWith ( Arsse :: $user -> id , 2112 , []);
2021-02-08 00:20:10 +00:00
}
2021-01-25 02:12:32 +00:00
public function testDeleteAFeed () : void {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionRemove -> returns ( true );
2021-01-25 02:12:32 +00:00
$this -> assertMessage ( new EmptyResponse ( 204 ), $this -> req ( " DELETE " , " /feeds/2112 " ));
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionRemove -> calledWith ( Arsse :: $user -> id , 2112 );
2021-01-25 02:12:32 +00:00
}
public function testDeleteAMissingFeed () : void {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionRemove -> throws ( new ExceptionInput ( " subjectMissing " ));
2021-01-25 02:12:32 +00:00
$this -> assertMessage ( new ErrorResponse ( " 404 " , 404 ), $this -> req ( " DELETE " , " /feeds/2112 " ));
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionRemove -> calledWith ( Arsse :: $user -> id , 2112 );
2021-01-25 02:12:32 +00:00
}
2021-01-27 16:53:07 +00:00
/** @dataProvider provideIcons */
public function testGetTheIconOfASubscription ( $out , ResponseInterface $exp ) : void {
if ( $out instanceof \Exception ) {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionIcon -> throws ( $out );
2021-01-27 16:53:07 +00:00
} else {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionIcon -> returns ( $this -> v ( $out ));
2021-01-27 16:53:07 +00:00
}
$this -> assertMessage ( $exp , $this -> req ( " GET " , " /feeds/2112/icon " ));
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionIcon -> calledWith ( Arsse :: $user -> id , 2112 );
2021-01-27 16:53:07 +00:00
}
public function provideIcons () : iterable {
return [
[[ 'id' => 44 , 'type' => " image/svg+xml " , 'data' => " <svg/> " ], new Response ([ 'id' => 44 , 'data' => " image/svg+xml;base64,PHN2Zy8+ " , 'mime_type' => " image/svg+xml " ])],
2021-01-27 18:41:10 +00:00
[[ 'id' => 47 , 'type' => " " , 'data' => " <svg/> " ], new ErrorResponse ( " 404 " , 404 )],
[[ 'id' => 47 , 'type' => null , 'data' => " <svg/> " ], new ErrorResponse ( " 404 " , 404 )],
2021-01-27 16:53:07 +00:00
[[ 'id' => 47 , 'type' => null , 'data' => null ], new ErrorResponse ( " 404 " , 404 )],
[ null , new ErrorResponse ( " 404 " , 404 )],
[ new ExceptionInput ( " subjectMissing " ), new ErrorResponse ( " 404 " , 404 )],
];
}
2021-02-03 18:06:36 +00:00
/** @dataProvider provideEntryQueries */
2021-02-05 01:19:35 +00:00
public function testGetEntries ( string $url , ? Context $c , ? array $order , $out , bool $count , ResponseInterface $exp ) : void {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionList -> returns ( new Result ( $this -> v ( self :: FEEDS )));
$this -> dbMock -> articleCount -> returns ( 2112 );
2021-02-03 18:06:36 +00:00
if ( $out instanceof \Exception ) {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> articleList -> throws ( $out );
2021-02-03 18:06:36 +00:00
} else {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> articleList -> returns ( new Result ( $this -> v ( $out )));
2021-02-03 18:06:36 +00:00
}
$this -> assertMessage ( $exp , $this -> req ( " GET " , $url ));
if ( $c ) {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> articleList -> calledWith ( Arsse :: $user -> id , $this -> equalTo ( $c ), array_keys ( self :: ENTRIES [ 0 ]), $order );
2021-02-03 18:06:36 +00:00
} else {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> articleList -> never () -> called ();
2021-02-03 18:06:36 +00:00
}
2021-02-04 22:07:22 +00:00
if ( $out && ! $out instanceof \Exception ) {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionList -> calledWith ( Arsse :: $user -> id );
2021-02-03 21:27:55 +00:00
} else {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionList -> never () -> called ();
2021-02-03 21:27:55 +00:00
}
2021-02-04 22:07:22 +00:00
if ( $count ) {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> articleCount -> calledWith ( Arsse :: $user -> id , $this -> equalTo (( clone $c ) -> limit ( 0 ) -> offset ( 0 )));
2021-02-04 22:07:22 +00:00
} else {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> articleCount -> never () -> called ();
2021-02-04 22:07:22 +00:00
}
2021-02-03 18:06:36 +00:00
}
public function provideEntryQueries () : iterable {
self :: clearData ();
2021-02-04 22:07:22 +00:00
$c = ( new Context ) -> limit ( 100 );
$o = [ " modified_date " ]; // the default sort order
2021-02-03 18:06:36 +00:00
return [
2021-02-04 22:07:22 +00:00
[ " /entries?after=A " , null , null , [], false , new ErrorResponse ([ " InvalidInputValue " , 'field' => " after " ], 400 )],
[ " /entries?before=B " , null , null , [], false , new ErrorResponse ([ " InvalidInputValue " , 'field' => " before " ], 400 )],
[ " /entries?category_id=0 " , null , null , [], false , new ErrorResponse ([ " InvalidInputValue " , 'field' => " category_id " ], 400 )],
[ " /entries?after_entry_id=0 " , null , null , [], false , new ErrorResponse ([ " InvalidInputValue " , 'field' => " after_entry_id " ], 400 )],
[ " /entries?before_entry_id=0 " , null , null , [], false , new ErrorResponse ([ " InvalidInputValue " , 'field' => " before_entry_id " ], 400 )],
[ " /entries?limit=-1 " , null , null , [], false , new ErrorResponse ([ " InvalidInputValue " , 'field' => " limit " ], 400 )],
[ " /entries?offset=-1 " , null , null , [], false , new ErrorResponse ([ " InvalidInputValue " , 'field' => " offset " ], 400 )],
[ " /entries?direction=sideways " , null , null , [], false , new ErrorResponse ([ " InvalidInputValue " , 'field' => " direction " ], 400 )],
[ " /entries?order=false " , null , null , [], false , new ErrorResponse ([ " InvalidInputValue " , 'field' => " order " ], 400 )],
[ " /entries?starred&starred " , null , null , [], false , new ErrorResponse ([ " DuplicateInputValue " , 'field' => " starred " ], 400 )],
[ " /entries?after&after=0 " , null , null , [], false , new ErrorResponse ([ " DuplicateInputValue " , 'field' => " after " ], 400 )],
[ " /entries " , $c , $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?category_id=47 " , ( clone $c ) -> folder ( 46 ), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?category_id=1 " , ( clone $c ) -> folderShallow ( 0 ), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?status=unread " , ( clone $c ) -> unread ( true ) -> hidden ( false ), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?status=read " , ( clone $c ) -> unread ( false ) -> hidden ( false ), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?status=removed " , ( clone $c ) -> hidden ( true ), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?status=unread&status=read " , ( clone $c ) -> hidden ( false ), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?status=unread&status=removed " , ( clone $c ) -> unread ( true ), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?status=removed&status=read " , ( clone $c ) -> unread ( false ), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?status=removed&status=read&status=removed " , ( clone $c ) -> unread ( false ), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?status=removed&status=read&status=unread " , $c , $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?starred " , ( clone $c ) -> starred ( true ), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?starred= " , ( clone $c ) -> starred ( true ), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?starred=true " , ( clone $c ) -> starred ( true ), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?starred=false " , ( clone $c ) -> starred ( true ), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?after=0 " , ( clone $c ) -> modifiedSince ( 0 ), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
2021-03-06 16:26:14 +00:00
[ " /entries?before=0 " , $c , $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?before=1 " , ( clone $c ) -> notModifiedSince ( 1 ), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
2021-02-04 22:07:22 +00:00
[ " /entries?after_entry_id=42 " , ( clone $c ) -> oldestArticle ( 43 ), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?before_entry_id=47 " , ( clone $c ) -> latestArticle ( 46 ), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?search=alpha%20beta " , ( clone $c ) -> searchTerms ([ " alpha " , " beta " ]), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?limit=4 " , ( clone $c ) -> limit ( 4 ), $o , self :: ENTRIES , true , new Response ([ 'total' => 2112 , 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?offset=20 " , ( clone $c ) -> offset ( 20 ), $o , [], true , new Response ([ 'total' => 2112 , 'entries' => []])],
[ " /entries?direction=asc " , $c , $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?order=id " , $c , [ " id " ], self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?order=published_at " , $c , [ " modified_date " ], self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?order=category_id " , $c , [ " top_folder " ], self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?order=category_title " , $c , [ " top_folder_name " ], self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?order=status " , $c , [ " hidden " , " unread desc " ], self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?direction=desc " , $c , [ " modified_date desc " ], self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?order=id&direction=desc " , $c , [ " id desc " ], self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?order=published_at&direction=desc " , $c , [ " modified_date desc " ], self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?order=category_id&direction=desc " , $c , [ " top_folder desc " ], self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?order=category_title&direction=desc " , $c , [ " top_folder_name desc " ], self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?order=status&direction=desc " , $c , [ " hidden desc " , " unread " ], self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /entries?category_id=2112 " , ( clone $c ) -> folder ( 2111 ), $o , new ExceptionInput ( " idMissing " ), false , new ErrorResponse ( " MissingCategory " )],
2021-02-04 22:52:40 +00:00
[ " /feeds/42/entries " , ( clone $c ) -> subscription ( 42 ), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /feeds/42/entries?category_id=47 " , ( clone $c ) -> subscription ( 42 ) -> folder ( 46 ), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /feeds/2112/entries " , ( clone $c ) -> subscription ( 2112 ), $o , new ExceptionInput ( " idMissing " ), false , new ErrorResponse ( " 404 " , 404 )],
[ " /categories/42/entries " , ( clone $c ) -> folder ( 41 ), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /categories/42/entries?category_id=47 " , ( clone $c ) -> folder ( 41 ), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /categories/42/entries?starred " , ( clone $c ) -> folder ( 41 ) -> starred ( true ), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /categories/1/entries " , ( clone $c ) -> folderShallow ( 0 ), $o , self :: ENTRIES , false , new Response ([ 'total' => sizeof ( self :: ENTRIES_OUT ), 'entries' => self :: ENTRIES_OUT ])],
[ " /categories/2112/entries " , ( clone $c ) -> folder ( 2111 ), $o , new ExceptionInput ( " idMissing " ), false , new ErrorResponse ( " 404 " , 404 )],
2021-02-03 18:06:36 +00:00
];
}
2021-02-05 01:19:35 +00:00
/** @dataProvider provideSingleEntryQueries */
public function testGetASingleEntry ( string $url , Context $c , $out , ResponseInterface $exp ) : void {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionPropertiesGet -> returns ( $this -> v ( self :: FEEDS [ 1 ]));
2021-02-05 01:19:35 +00:00
if ( $out instanceof \Exception ) {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> articleList -> throws ( $out );
2021-02-05 01:19:35 +00:00
} else {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> articleList -> returns ( new Result ( $this -> v ( $out )));
2021-02-05 01:19:35 +00:00
}
$this -> assertMessage ( $exp , $this -> req ( " GET " , $url ));
if ( $c ) {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> articleList -> calledWith ( Arsse :: $user -> id , $this -> equalTo ( $c ), array_keys ( self :: ENTRIES [ 0 ]));
2021-02-05 01:19:35 +00:00
} else {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> articleList -> never () -> called ();
2021-02-05 01:19:35 +00:00
}
if ( $out && is_array ( $out )) {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionPropertiesGet -> calledWith ( Arsse :: $user -> id , 55 );
2021-02-05 01:19:35 +00:00
} else {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionList -> never () -> called ();
2021-02-05 01:19:35 +00:00
}
}
public function provideSingleEntryQueries () : iterable {
2021-02-05 13:48:14 +00:00
self :: clearData ();
2021-02-05 01:19:35 +00:00
$c = new Context ;
return [
[ " /entries/42 " , ( clone $c ) -> article ( 42 ), [ self :: ENTRIES [ 1 ]], new Response ( self :: ENTRIES_OUT [ 1 ])],
[ " /entries/2112 " , ( clone $c ) -> article ( 2112 ), new ExceptionInput ( " subjectMissing " ), new ErrorResponse ( " 404 " , 404 )],
[ " /feeds/47/entries/42 " , ( clone $c ) -> subscription ( 47 ) -> article ( 42 ), [ self :: ENTRIES [ 1 ]], new Response ( self :: ENTRIES_OUT [ 1 ])],
[ " /feeds/47/entries/44 " , ( clone $c ) -> subscription ( 47 ) -> article ( 44 ), [], new ErrorResponse ( " 404 " , 404 )],
[ " /feeds/47/entries/2112 " , ( clone $c ) -> subscription ( 47 ) -> article ( 2112 ), new ExceptionInput ( " subjectMissing " ), new ErrorResponse ( " 404 " , 404 )],
[ " /feeds/2112/entries/47 " , ( clone $c ) -> subscription ( 2112 ) -> article ( 47 ), new ExceptionInput ( " idMissing " ), new ErrorResponse ( " 404 " , 404 )],
[ " /categories/47/entries/42 " , ( clone $c ) -> folder ( 46 ) -> article ( 42 ), [ self :: ENTRIES [ 1 ]], new Response ( self :: ENTRIES_OUT [ 1 ])],
[ " /categories/47/entries/44 " , ( clone $c ) -> folder ( 46 ) -> article ( 44 ), [], new ErrorResponse ( " 404 " , 404 )],
[ " /categories/47/entries/2112 " , ( clone $c ) -> folder ( 46 ) -> article ( 2112 ), new ExceptionInput ( " subjectMissing " ), new ErrorResponse ( " 404 " , 404 )],
[ " /categories/2112/entries/47 " , ( clone $c ) -> folder ( 2111 ) -> article ( 47 ), new ExceptionInput ( " idMissing " ), new ErrorResponse ( " 404 " , 404 )],
[ " /categories/1/entries/42 " , ( clone $c ) -> folderShallow ( 0 ) -> article ( 42 ), [ self :: ENTRIES [ 1 ]], new Response ( self :: ENTRIES_OUT [ 1 ])],
];
}
2021-02-05 13:48:14 +00:00
/** @dataProvider provideEntryMarkings */
public function testMarkEntries ( array $in , ? array $data , ResponseInterface $exp ) : void {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> articleMark -> returns ( 0 );
2021-02-05 13:48:14 +00:00
$this -> assertMessage ( $exp , $this -> req ( " PUT " , " /entries " , $in ));
if ( $data ) {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> articleMark -> calledWith ( Arsse :: $user -> id , $data , ( new Context ) -> articles ( $in [ 'entry_ids' ]));
2021-02-05 13:48:14 +00:00
} else {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> articleMark -> never () -> called ();
2021-02-05 13:48:14 +00:00
}
}
public function provideEntryMarkings () : iterable {
self :: clearData ();
return [
[[ 'status' => " read " ], null , new ErrorResponse ([ " MissingInputValue " , 'field' => " entry_ids " ], 422 )],
[[ 'entry_ids' => [ 1 ]], null , new ErrorResponse ([ " MissingInputValue " , 'field' => " status " ], 422 )],
[[ 'entry_ids' => [], 'status' => " read " ], null , new ErrorResponse ([ " MissingInputValue " , 'field' => " entry_ids " ], 422 )],
[[ 'entry_ids' => 1 , 'status' => " read " ], null , new ErrorResponse ([ " InvalidInputType " , 'field' => " entry_ids " , 'expected' => " array " , 'actual' => " integer " ], 422 )],
[[ 'entry_ids' => [ " 1 " ], 'status' => " read " ], null , new ErrorResponse ([ " InvalidInputType " , 'field' => " entry_ids " , 'expected' => " integer " , 'actual' => " string " ], 422 )],
[[ 'entry_ids' => [ 1 ], 'status' => 1 ], null , new ErrorResponse ([ " InvalidInputType " , 'field' => " status " , 'expected' => " string " , 'actual' => " integer " ], 422 )],
2021-02-09 00:14:11 +00:00
[[ 'entry_ids' => [ 0 ], 'status' => " read " ], null , new ErrorResponse ([ " InvalidInputValue " , 'field' => " entry_ids " ], 422 )],
[[ 'entry_ids' => [ 1 ], 'status' => " reread " ], null , new ErrorResponse ([ " InvalidInputValue " , 'field' => " status " ], 422 )],
2021-02-05 13:48:14 +00:00
[[ 'entry_ids' => [ 1 , 2 ], 'status' => " read " ], [ 'read' => true , 'hidden' => false ], new EmptyResponse ( 204 )],
[[ 'entry_ids' => [ 1 , 2 ], 'status' => " unread " ], [ 'read' => false , 'hidden' => false ], new EmptyResponse ( 204 )],
[[ 'entry_ids' => [ 1 , 2 ], 'status' => " removed " ], [ 'read' => true , 'hidden' => true ], new EmptyResponse ( 204 )],
];
}
/** @dataProvider provideMassMarkings */
public function testMassMarkEntries ( string $url , Context $c , $out , ResponseInterface $exp ) : void {
if ( $out instanceof \Exception ) {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> articleMark -> throws ( $out );
2021-02-05 13:48:14 +00:00
} else {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> articleMark -> returns ( $out );
2021-02-05 13:48:14 +00:00
}
$this -> assertMessage ( $exp , $this -> req ( " PUT " , $url ));
if ( $out !== null ) {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> articleMark -> calledWith ( Arsse :: $user -> id , [ 'read' => true ], $this -> equalTo ( $c ));
2021-02-05 13:48:14 +00:00
} else {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> articleMark -> never () -> called ();
2021-02-05 13:48:14 +00:00
}
}
public function provideMassMarkings () : iterable {
self :: clearData ();
$c = ( new Context ) -> hidden ( false );
return [
[ " /users/42/mark-all-as-read " , $c , 1123 , new EmptyResponse ( 204 )],
[ " /users/2112/mark-all-as-read " , $c , null , new ErrorResponse ( " 403 " , 403 )],
[ " /feeds/47/mark-all-as-read " , ( clone $c ) -> subscription ( 47 ), 2112 , new EmptyResponse ( 204 )],
[ " /feeds/2112/mark-all-as-read " , ( clone $c ) -> subscription ( 2112 ), new ExceptionInput ( " idMissing " ), new ErrorResponse ( " 404 " , 404 )],
[ " /categories/47/mark-all-as-read " , ( clone $c ) -> folder ( 46 ), 1337 , new EmptyResponse ( 204 )],
[ " /categories/2112/mark-all-as-read " , ( clone $c ) -> folder ( 2111 ), new ExceptionInput ( " idMissing " ), new ErrorResponse ( " 404 " , 404 )],
[ " /categories/1/mark-all-as-read " , ( clone $c ) -> folderShallow ( 0 ), 6666 , new EmptyResponse ( 204 )],
];
}
/** @dataProvider provideBookmarkTogglings */
public function testToggleABookmark ( $before , ? bool $after , ResponseInterface $exp ) : void {
$c = ( new Context ) -> article ( 2112 );
2021-02-28 14:23:38 +00:00
$this -> dbMock -> articleMark -> returns ( 1 );
2021-02-05 13:48:14 +00:00
if ( $before instanceof \Exception ) {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> articleCount -> throws ( $before );
2021-02-05 13:48:14 +00:00
} else {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> articleCount -> returns ( $before );
2021-02-05 13:48:14 +00:00
}
$this -> assertMessage ( $exp , $this -> req ( " PUT " , " /entries/2112/bookmark " ));
if ( $after !== null ) {
2021-02-28 14:23:38 +00:00
Phony :: inOrder (
$this -> dbMock -> begin -> calledWith (),
$this -> dbMock -> articleCount -> calledWith ( Arsse :: $user -> id , ( clone $c ) -> starred ( false )),
$this -> dbMock -> articleMark -> calledWith ( Arsse :: $user -> id , [ 'starred' => $after ], $c ),
$this -> transaction -> commit -> called ()
2021-02-05 13:48:14 +00:00
);
} else {
2021-02-28 14:23:38 +00:00
Phony :: inOrder (
$this -> dbMock -> begin -> calledWith (),
$this -> dbMock -> articleCount -> calledWith ( Arsse :: $user -> id , ( clone $c ) -> starred ( false ))
2021-02-05 13:48:14 +00:00
);
2021-02-28 14:23:38 +00:00
$this -> dbMock -> articleMark -> never () -> called ();
$this -> transaction -> commit -> never () -> called ();
2021-02-05 13:48:14 +00:00
}
}
public function provideBookmarkTogglings () : iterable {
self :: clearData ();
return [
[ 1 , true , new EmptyResponse ( 204 )],
[ 0 , false , new EmptyResponse ( 204 )],
[ new ExceptionInput ( " subjectMissing " ), null , new ErrorResponse ( " 404 " , 404 )],
];
}
2021-02-05 14:04:00 +00:00
public function testRefreshAFeed () : void {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionPropertiesGet -> returns ([]);
2021-02-05 14:04:00 +00:00
$this -> assertMessage ( new EmptyResponse ( 204 ), $this -> req ( " PUT " , " /feeds/47/refresh " ));
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionPropertiesGet -> calledWith ( Arsse :: $user -> id , 47 );
2021-02-05 14:04:00 +00:00
}
public function testRefreshAMissingFeed () : void {
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionPropertiesGet -> throws ( new ExceptionInput ( " subjectMissing " ));
2021-02-05 14:04:00 +00:00
$this -> assertMessage ( new ErrorResponse ( " 404 " , 404 ), $this -> req ( " PUT " , " /feeds/2112/refresh " ));
2021-02-28 14:23:38 +00:00
$this -> dbMock -> subscriptionPropertiesGet -> calledWith ( Arsse :: $user -> id , 2112 );
2021-02-05 14:04:00 +00:00
}
public function testRefreshAllFeeds () : void {
$this -> assertMessage ( new EmptyResponse ( 204 ), $this -> req ( " PUT " , " /feeds/refresh " ));
}
2021-02-07 18:04:44 +00:00
/** @dataProvider provideImports */
public function testImport ( $out , ResponseInterface $exp ) : void {
2021-02-28 14:23:38 +00:00
$opml = $this -> mock ( OPML :: class );
$this -> objMock -> get -> with ( OPML :: class ) -> returns ( $opml );
$action = ( $out instanceof \Exception ) ? " throws " : " returns " ;
$opml -> import -> $action ( $out );
2021-02-07 18:04:44 +00:00
$this -> assertMessage ( $exp , $this -> req ( " POST " , " /import " , " IMPORT DATA " ));
2021-02-28 14:23:38 +00:00
$opml -> import -> calledWith ( Arsse :: $user -> id , " IMPORT DATA " );
2021-02-07 18:04:44 +00:00
}
public function provideImports () : iterable {
self :: clearData ();
return [
[ new ImportException ( " invalidSyntax " ), new ErrorResponse ( " InvalidBodyXML " , 400 )],
[ new ImportException ( " invalidSemantics " ), new ErrorResponse ( " InvalidBodyOPML " , 422 )],
[ new ImportException ( " invalidFolderName " ), new ErrorResponse ( " InvalidImportCategory " , 422 )],
[ new ImportException ( " invalidFolderCopy " ), new ErrorResponse ( " DuplicateImportCategory " , 422 )],
[ new ImportException ( " invalidTagName " ), new ErrorResponse ( " InvalidImportLabel " , 422 )],
[ new FeedException ( " invalidUrl " , [ 'url' => " http://example.com/ " ]), new ErrorResponse ([ " FailedImportFeed " , 'url' => " http://example.com/ " , 'code' => 10502 ], 502 )],
[ true , new Response ([ 'message' => Arsse :: $lang -> msg ( " API.Miniflux.ImportSuccess " )])],
];
}
public function testExport () : void {
2021-02-28 14:23:38 +00:00
$opml = $this -> mock ( OPML :: class );
$this -> objMock -> get -> with ( OPML :: class ) -> returns ( $opml );
$opml -> export -> returns ( " EXPORT DATA " );
2021-02-07 18:04:44 +00:00
$this -> assertMessage ( new TextResponse ( " EXPORT DATA " , 200 , [ 'Content-Type' => " application/xml " ]), $this -> req ( " GET " , " /export " ));
2021-02-28 14:23:38 +00:00
$opml -> export -> calledWith ( Arsse :: $user -> id );
2021-02-07 18:04:44 +00:00
}
2021-02-09 00:14:11 +00:00
}