3 namespace Shaarli\Feed
;
7 use Shaarli\Bookmark\Bookmark
;
8 use Shaarli\Bookmark\BookmarkFileService
;
9 use Shaarli\Bookmark\LinkDB
;
10 use Shaarli\Config\ConfigManager
;
11 use Shaarli\Formatter\FormatterFactory
;
15 * FeedBuilderTest class.
17 * Unit tests for FeedBuilder.
19 class FeedBuilderTest
extends \PHPUnit\Framework\TestCase
22 * @var string locale Basque (Spain).
24 public static $LOCALE = 'eu_ES';
27 * @var string language in RSS format.
29 public static $RSS_LANGUAGE = 'eu-es';
32 * @var string language in ATOM format.
34 public static $ATOM_LANGUAGUE = 'eu';
36 protected static $testDatastore = 'sandbox/datastore.php';
38 public static $bookmarkService;
40 public static $formatter;
42 public static $serverInfo;
45 * Called before every test method.
47 public static function setUpBeforeClass()
49 $conf = new ConfigManager('tests/utils/config/configJson');
50 $conf->set('resource.datastore', self
::$testDatastore);
51 $refLinkDB = new \
ReferenceLinkDB();
52 $refLinkDB->write(self
::$testDatastore);
53 $history = new History('sandbox/history.php');
54 $factory = new FormatterFactory($conf, true);
55 self
::$formatter = $factory->getFormatter();
56 self
::$bookmarkService = new BookmarkFileService($conf, $history, true);
58 self
::$serverInfo = array(
60 'SERVER_NAME' => 'host.tld',
61 'SERVER_PORT' => '80',
62 'SCRIPT_NAME' => '/index.php',
63 'REQUEST_URI' => '/index.php?do=feed',
68 * Test buildData with RSS feed.
70 public function testRSSBuildData()
72 $feedBuilder = new FeedBuilder(
73 self
::$bookmarkService,
78 $feedBuilder->setLocale(self
::$LOCALE);
79 $data = $feedBuilder->buildData(FeedBuilder
::$FEED_RSS, null);
81 $this->assertEquals(self
::$RSS_LANGUAGE, $data['language']);
82 $this->assertRegExp('/Wed, 03 Aug 2016 09:30:33 \+\d{4}/', $data['last_update']);
83 $this->assertEquals(true, $data['show_dates']);
84 $this->assertEquals('http://host.tld/index.php?do=feed', $data['self_link']);
85 $this->assertEquals('http://host.tld/', $data['index_url']);
86 $this->assertFalse($data['usepermalinks']);
87 $this->assertEquals(ReferenceLinkDB
::$NB_LINKS_TOTAL, count($data['links']));
89 // Test first not pinned link (note link)
90 $link = $data['links'][array_keys($data['links'])[0]];
91 $this->assertEquals(41, $link['id']);
92 $this->assertEquals(DateTime
::createFromFormat(Bookmark
::LINK_DATE_FORMAT
, '20150310_114651'), $link['created']);
93 $this->assertEquals('http://host.tld/shaare/WDWyig', $link['guid']);
94 $this->assertEquals('http://host.tld/shaare/WDWyig', $link['url']);
95 $this->assertRegExp('/Tue, 10 Mar 2015 11:46:51 \+\d{4}/', $link['pub_iso_date']);
96 $pub = DateTime
::createFromFormat(DateTime
::RSS
, $link['pub_iso_date']);
97 $up = DateTime
::createFromFormat(DateTime
::ATOM
, $link['up_iso_date']);
98 $this->assertEquals($pub, $up);
99 $this->assertContains('Stallman has a beard', $link['description']);
100 $this->assertContains('Permalink', $link['description']);
101 $this->assertContains('http://host.tld/shaare/WDWyig', $link['description']);
102 $this->assertEquals(1, count($link['taglist']));
103 $this->assertEquals('sTuff', $link['taglist'][0]);
105 // Test URL with external link.
106 $this->assertEquals('https://static.fsf.org/nosvn/faif-2.0.pdf', $data['links'][8]['url']);
109 $this->assertEquals(5, count($data['links'][6]['taglist']));
110 $this->assertEquals('css', $data['links'][6]['taglist'][0]);
113 $this->assertRegExp('/2016-08-03T09:30:33\+\d{2}:\d{2}/', $data['links'][8]['up_iso_date']);
117 * Test buildData with ATOM feed (test only specific to ATOM).
119 public function testAtomBuildData()
121 $feedBuilder = new FeedBuilder(
122 self
::$bookmarkService,
127 $feedBuilder->setLocale(self
::$LOCALE);
128 $data = $feedBuilder->buildData(FeedBuilder
::$FEED_ATOM, null);
129 $this->assertEquals(ReferenceLinkDB
::$NB_LINKS_TOTAL, count($data['links']));
130 $this->assertRegExp('/2016-08-03T09:30:33\+\d{2}:\d{2}/', $data['last_update']);
131 $link = $data['links'][array_keys($data['links'])[0]];
132 $this->assertRegExp('/2015-03-10T11:46:51\+\d{2}:\d{2}/', $link['pub_iso_date']);
133 $this->assertRegExp('/2016-08-03T09:30:33\+\d{2}:\d{2}/', $data['links'][8]['up_iso_date']);
137 * Test buildData with search criteria.
139 public function testBuildDataFiltered()
142 'searchtags' => 'stuff',
143 'searchterm' => 'beard',
145 $feedBuilder = new FeedBuilder(
146 self
::$bookmarkService,
151 $feedBuilder->setLocale(self
::$LOCALE);
152 $data = $feedBuilder->buildData(FeedBuilder
::$FEED_ATOM, $criteria);
153 $this->assertEquals(1, count($data['links']));
154 $link = array_shift($data['links']);
155 $this->assertEquals(41, $link['id']);
156 $this->assertEquals(DateTime
::createFromFormat(Bookmark
::LINK_DATE_FORMAT
, '20150310_114651'), $link['created']);
160 * Test buildData with nb limit.
162 public function testBuildDataCount()
167 $feedBuilder = new FeedBuilder(
168 self
::$bookmarkService,
173 $feedBuilder->setLocale(self
::$LOCALE);
174 $data = $feedBuilder->buildData(FeedBuilder
::$FEED_ATOM, $criteria);
175 $this->assertEquals(3, count($data['links']));
176 $link = $data['links'][array_keys($data['links'])[0]];
177 $this->assertEquals(41, $link['id']);
178 $this->assertEquals(DateTime
::createFromFormat(Bookmark
::LINK_DATE_FORMAT
, '20150310_114651'), $link['created']);
182 * Test buildData with permalinks on.
184 public function testBuildDataPermalinks()
186 $feedBuilder = new FeedBuilder(
187 self
::$bookmarkService,
192 $feedBuilder->setLocale(self
::$LOCALE);
193 $feedBuilder->setUsePermalinks(true);
194 $data = $feedBuilder->buildData(FeedBuilder
::$FEED_ATOM, null);
195 $this->assertEquals(ReferenceLinkDB
::$NB_LINKS_TOTAL, count($data['links']));
196 $this->assertTrue($data['usepermalinks']);
197 // First link is a permalink
198 $link = $data['links'][array_keys($data['links'])[0]];
199 $this->assertEquals(41, $link['id']);
200 $this->assertEquals(DateTime
::createFromFormat(Bookmark
::LINK_DATE_FORMAT
, '20150310_114651'), $link['created']);
201 $this->assertEquals('http://host.tld/shaare/WDWyig', $link['guid']);
202 $this->assertEquals('http://host.tld/shaare/WDWyig', $link['url']);
203 $this->assertContains('Direct link', $link['description']);
204 $this->assertContains('http://host.tld/shaare/WDWyig', $link['description']);
205 // Second link is a direct link
206 $link = $data['links'][array_keys($data['links'])[1]];
207 $this->assertEquals(8, $link['id']);
208 $this->assertEquals(DateTime
::createFromFormat(Bookmark
::LINK_DATE_FORMAT
, '20150310_114633'), $link['created']);
209 $this->assertEquals('http://host.tld/shaare/RttfEw', $link['guid']);
210 $this->assertEquals('https://static.fsf.org/nosvn/faif-2.0.pdf', $link['url']);
211 $this->assertContains('Direct link', $link['description']);
212 $this->assertContains('https://static.fsf.org/nosvn/faif-2.0.pdf', $link['description']);
216 * Test buildData with hide dates settings.
218 public function testBuildDataHideDates()
220 $feedBuilder = new FeedBuilder(
221 self
::$bookmarkService,
226 $feedBuilder->setLocale(self
::$LOCALE);
227 $feedBuilder->setHideDates(true);
228 $data = $feedBuilder->buildData(FeedBuilder
::$FEED_ATOM, null);
229 $this->assertEquals(ReferenceLinkDB
::$NB_LINKS_TOTAL, count($data['links']));
230 $this->assertFalse($data['show_dates']);
232 // Show dates while logged in
233 $feedBuilder = new FeedBuilder(
234 self
::$bookmarkService,
239 $feedBuilder->setLocale(self
::$LOCALE);
240 $feedBuilder->setHideDates(true);
241 $data = $feedBuilder->buildData(FeedBuilder
::$FEED_ATOM, null);
242 $this->assertEquals(ReferenceLinkDB
::$NB_LINKS_TOTAL, count($data['links']));
243 $this->assertTrue($data['show_dates']);
247 * Test buildData when Shaarli is served from a subdirectory
249 public function testBuildDataServerSubdir()
253 'SERVER_NAME' => 'host.tld',
254 'SERVER_PORT' => '8080',
255 'SCRIPT_NAME' => '/~user/shaarli/index.php',
256 'REQUEST_URI' => '/~user/shaarli/index.php?do=feed',
258 $feedBuilder = new FeedBuilder(
259 self
::$bookmarkService,
264 $feedBuilder->setLocale(self
::$LOCALE);
265 $data = $feedBuilder->buildData(FeedBuilder
::$FEED_ATOM, null);
268 'http://host.tld:8080/~user/shaarli/index.php?do=feed',
272 // Test first link (note link)
273 $link = $data['links'][array_keys($data['links'])[0]];
274 $this->assertEquals('http://host.tld:8080/~user/shaarli/shaare/WDWyig', $link['guid']);
275 $this->assertEquals('http://host.tld:8080/~user/shaarli/shaare/WDWyig', $link['url']);
276 $this->assertContains('http://host.tld:8080/~user/shaarli/./add-tag/hashtag', $link['description']);