From dfc650aa239d3a2c028d0ba13132ce75b4f4c0b4 Mon Sep 17 00:00:00 2001
From: VirtualTam <virtualtam@flibidi.net>
Date: Mon, 3 Dec 2018 00:08:04 +0100
Subject: namespacing: \Shaarli\Feed\{Cache,CachedPage,FeedBuilder}

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
---
 tests/feed/CacheTest.php       |  92 +++++++++++++++
 tests/feed/CachedPageTest.php  | 120 ++++++++++++++++++++
 tests/feed/FeedBuilderTest.php | 250 +++++++++++++++++++++++++++++++++++++++++
 3 files changed, 462 insertions(+)
 create mode 100644 tests/feed/CacheTest.php
 create mode 100644 tests/feed/CachedPageTest.php
 create mode 100644 tests/feed/FeedBuilderTest.php

(limited to 'tests/feed')

diff --git a/tests/feed/CacheTest.php b/tests/feed/CacheTest.php
new file mode 100644
index 00000000..c0a9f26f
--- /dev/null
+++ b/tests/feed/CacheTest.php
@@ -0,0 +1,92 @@
+<?php
+/**
+ * Cache tests
+ */
+namespace Shaarli\Feed;
+
+// required to access $_SESSION array
+session_start();
+
+require_once 'application/feed/Cache.php';
+
+/**
+ * Unitary tests for cached pages
+ */
+class CacheTest extends \PHPUnit\Framework\TestCase
+{
+    // test cache directory
+    protected static $testCacheDir = 'sandbox/dummycache';
+
+    // dummy cached file names / content
+    protected static $pages = array('a', 'toto', 'd7b59c');
+
+
+    /**
+     * Populate the cache with dummy files
+     */
+    public function setUp()
+    {
+        if (!is_dir(self::$testCacheDir)) {
+            mkdir(self::$testCacheDir);
+        } else {
+            array_map('unlink', glob(self::$testCacheDir . '/*'));
+        }
+
+        foreach (self::$pages as $page) {
+            file_put_contents(self::$testCacheDir . '/' . $page . '.cache', $page);
+        }
+        file_put_contents(self::$testCacheDir . '/intru.der', 'ShouldNotBeThere');
+    }
+
+    /**
+     * Remove dummycache folder after each tests.
+     */
+    public function tearDown()
+    {
+        array_map('unlink', glob(self::$testCacheDir . '/*'));
+        rmdir(self::$testCacheDir);
+    }
+
+    /**
+     * Purge cached pages
+     */
+    public function testPurgeCachedPages()
+    {
+        purgeCachedPages(self::$testCacheDir);
+        foreach (self::$pages as $page) {
+            $this->assertFileNotExists(self::$testCacheDir . '/' . $page . '.cache');
+        }
+
+        $this->assertFileExists(self::$testCacheDir . '/intru.der');
+    }
+
+    /**
+     * Purge cached pages - missing directory
+     */
+    public function testPurgeCachedPagesMissingDir()
+    {
+        $oldlog = ini_get('error_log');
+        ini_set('error_log', '/dev/null');
+        $this->assertEquals(
+            'Cannot purge sandbox/dummycache_missing: no directory',
+            purgeCachedPages(self::$testCacheDir . '_missing')
+        );
+        ini_set('error_log', $oldlog);
+    }
+
+    /**
+     * Purge cached pages and session cache
+     */
+    public function testInvalidateCaches()
+    {
+        $this->assertArrayNotHasKey('tags', $_SESSION);
+        $_SESSION['tags'] = array('goodbye', 'cruel', 'world');
+
+        invalidateCaches(self::$testCacheDir);
+        foreach (self::$pages as $page) {
+            $this->assertFileNotExists(self::$testCacheDir . '/' . $page . '.cache');
+        }
+
+        $this->assertArrayNotHasKey('tags', $_SESSION);
+    }
+}
diff --git a/tests/feed/CachedPageTest.php b/tests/feed/CachedPageTest.php
new file mode 100644
index 00000000..0bcc1442
--- /dev/null
+++ b/tests/feed/CachedPageTest.php
@@ -0,0 +1,120 @@
+<?php
+/**
+ * PageCache tests
+ */
+namespace Shaarli\Feed;
+
+/**
+ * Unitary tests for cached pages
+ */
+class CachedPageTest extends \PHPUnit\Framework\TestCase
+{
+    // test cache directory
+    protected static $testCacheDir = 'sandbox/pagecache';
+    protected static $url = 'http://shaar.li/?do=atom';
+    protected static $filename;
+
+    /**
+     * Create the cache directory if needed
+     */
+    public static function setUpBeforeClass()
+    {
+        if (!is_dir(self::$testCacheDir)) {
+            mkdir(self::$testCacheDir);
+        }
+        self::$filename = self::$testCacheDir . '/' . sha1(self::$url) . '.cache';
+    }
+
+    /**
+     * Reset the page cache
+     */
+    public function setUp()
+    {
+        if (file_exists(self::$filename)) {
+            unlink(self::$filename);
+        }
+    }
+
+    /**
+     * Create a new cached page
+     */
+    public function testConstruct()
+    {
+        new CachedPage(self::$testCacheDir, '', true);
+        new CachedPage(self::$testCacheDir, '', false);
+        new CachedPage(self::$testCacheDir, 'http://shaar.li/?do=rss', true);
+        new CachedPage(self::$testCacheDir, 'http://shaar.li/?do=atom', false);
+    }
+
+    /**
+     * Cache a page's content
+     */
+    public function testCache()
+    {
+        $page = new CachedPage(self::$testCacheDir, self::$url, true);
+
+        $this->assertFileNotExists(self::$filename);
+        $page->cache('<p>Some content</p>');
+        $this->assertFileExists(self::$filename);
+        $this->assertEquals(
+            '<p>Some content</p>',
+            file_get_contents(self::$filename)
+        );
+    }
+
+    /**
+     * "Cache" a page's content - the page is not to be cached
+     */
+    public function testShouldNotCache()
+    {
+        $page = new CachedPage(self::$testCacheDir, self::$url, false);
+
+        $this->assertFileNotExists(self::$filename);
+        $page->cache('<p>Some content</p>');
+        $this->assertFileNotExists(self::$filename);
+    }
+
+    /**
+     * Return a page's cached content
+     */
+    public function testCachedVersion()
+    {
+        $page = new CachedPage(self::$testCacheDir, self::$url, true);
+
+        $this->assertFileNotExists(self::$filename);
+        $page->cache('<p>Some content</p>');
+        $this->assertFileExists(self::$filename);
+        $this->assertEquals(
+            '<p>Some content</p>',
+            $page->cachedVersion()
+        );
+    }
+
+    /**
+     * Return a page's cached content - the file does not exist
+     */
+    public function testCachedVersionNoFile()
+    {
+        $page = new CachedPage(self::$testCacheDir, self::$url, true);
+
+        $this->assertFileNotExists(self::$filename);
+        $this->assertEquals(
+            null,
+            $page->cachedVersion()
+        );
+    }
+
+    /**
+     * Return a page's cached content - the page is not to be cached
+     */
+    public function testNoCachedVersion()
+    {
+        $page = new CachedPage(self::$testCacheDir, self::$url, false);
+
+        $this->assertFileNotExists(self::$filename);
+        $this->assertEquals(
+            null,
+            $page->cachedVersion()
+        );
+    }
+}
diff --git a/tests/feed/FeedBuilderTest.php b/tests/feed/FeedBuilderTest.php
new file mode 100644
index 00000000..1fdbc60e
--- /dev/null
+++ b/tests/feed/FeedBuilderTest.php
@@ -0,0 +1,250 @@
+<?php
+
+namespace Shaarli\Feed;
+
+use DateTime;
+use LinkDB;
+use ReferenceLinkDB;
+
+require_once 'application/LinkDB.php';
+
+/**
+ * FeedBuilderTest class.
+ *
+ * Unit tests for FeedBuilder.
+ */
+class FeedBuilderTest extends \PHPUnit\Framework\TestCase
+{
+    /**
+     * @var string locale Basque (Spain).
+     */
+    public static $LOCALE = 'eu_ES';
+
+    /**
+     * @var string language in RSS format.
+     */
+    public static $RSS_LANGUAGE = 'eu-es';
+
+    /**
+     * @var string language in ATOM format.
+     */
+    public static $ATOM_LANGUAGUE = 'eu';
+
+    protected static $testDatastore = 'sandbox/datastore.php';
+
+    public static $linkDB;
+
+    public static $serverInfo;
+
+    /**
+     * Called before every test method.
+     */
+    public static function setUpBeforeClass()
+    {
+        $refLinkDB = new ReferenceLinkDB();
+        $refLinkDB->write(self::$testDatastore);
+        self::$linkDB = new LinkDB(self::$testDatastore, true, false);
+        self::$serverInfo = array(
+            'HTTPS' => 'Off',
+            'SERVER_NAME' => 'host.tld',
+            'SERVER_PORT' => '80',
+            'SCRIPT_NAME' => '/index.php',
+            'REQUEST_URI' => '/index.php?do=feed',
+        );
+    }
+
+    /**
+     * Test GetTypeLanguage().
+     */
+    public function testGetTypeLanguage()
+    {
+        $feedBuilder = new FeedBuilder(null, FeedBuilder::$FEED_ATOM, null, null, false);
+        $feedBuilder->setLocale(self::$LOCALE);
+        $this->assertEquals(self::$ATOM_LANGUAGUE, $feedBuilder->getTypeLanguage());
+        $feedBuilder = new FeedBuilder(null, FeedBuilder::$FEED_RSS, null, null, false);
+        $feedBuilder->setLocale(self::$LOCALE);
+        $this->assertEquals(self::$RSS_LANGUAGE, $feedBuilder->getTypeLanguage());
+        $feedBuilder = new FeedBuilder(null, FeedBuilder::$FEED_ATOM, null, null, false);
+        $this->assertEquals('en', $feedBuilder->getTypeLanguage());
+        $feedBuilder = new FeedBuilder(null, FeedBuilder::$FEED_RSS, null, null, false);
+        $this->assertEquals('en-en', $feedBuilder->getTypeLanguage());
+    }
+
+    /**
+     * Test buildData with RSS feed.
+     */
+    public function testRSSBuildData()
+    {
+        $feedBuilder = new FeedBuilder(self::$linkDB, FeedBuilder::$FEED_RSS, self::$serverInfo, null, false);
+        $feedBuilder->setLocale(self::$LOCALE);
+        $data = $feedBuilder->buildData();
+        // Test headers (RSS)
+        $this->assertEquals(self::$RSS_LANGUAGE, $data['language']);
+        $this->assertRegExp('/Wed, 03 Aug 2016 09:30:33 \+\d{4}/', $data['last_update']);
+        $this->assertEquals(true, $data['show_dates']);
+        $this->assertEquals('http://host.tld/index.php?do=feed', $data['self_link']);
+        $this->assertEquals('http://host.tld/', $data['index_url']);
+        $this->assertFalse($data['usepermalinks']);
+        $this->assertEquals(ReferenceLinkDB::$NB_LINKS_TOTAL, count($data['links']));
+
+        // Test first not pinned link (note link)
+        $link = $data['links'][array_keys($data['links'])[2]];
+        $this->assertEquals(41, $link['id']);
+        $this->assertEquals(DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, '20150310_114651'), $link['created']);
+        $this->assertEquals('http://host.tld/?WDWyig', $link['guid']);
+        $this->assertEquals('http://host.tld/?WDWyig', $link['url']);
+        $this->assertRegExp('/Tue, 10 Mar 2015 11:46:51 \+\d{4}/', $link['pub_iso_date']);
+        $pub = DateTime::createFromFormat(DateTime::RSS, $link['pub_iso_date']);
+        $up = DateTime::createFromFormat(DateTime::ATOM, $link['up_iso_date']);
+        $this->assertEquals($pub, $up);
+        $this->assertContains('Stallman has a beard', $link['description']);
+        $this->assertContains('Permalink', $link['description']);
+        $this->assertContains('http://host.tld/?WDWyig', $link['description']);
+        $this->assertEquals(1, count($link['taglist']));
+        $this->assertEquals('sTuff', $link['taglist'][0]);
+
+        // Test URL with external link.
+        $this->assertEquals('https://static.fsf.org/nosvn/faif-2.0.pdf', $data['links'][8]['url']);
+
+        // Test multitags.
+        $this->assertEquals(5, count($data['links'][6]['taglist']));
+        $this->assertEquals('css', $data['links'][6]['taglist'][0]);
+
+        // Test update date
+        $this->assertRegExp('/2016-08-03T09:30:33\+\d{2}:\d{2}/', $data['links'][8]['up_iso_date']);
+    }
+
+    /**
+     * Test buildData with ATOM feed (test only specific to ATOM).
+     */
+    public function testAtomBuildData()
+    {
+        $feedBuilder = new FeedBuilder(self::$linkDB, FeedBuilder::$FEED_ATOM, self::$serverInfo, null, false);
+        $feedBuilder->setLocale(self::$LOCALE);
+        $data = $feedBuilder->buildData();
+        $this->assertEquals(ReferenceLinkDB::$NB_LINKS_TOTAL, count($data['links']));
+        $this->assertRegExp('/2016-08-03T09:30:33\+\d{2}:\d{2}/', $data['last_update']);
+        $link = $data['links'][array_keys($data['links'])[2]];
+        $this->assertRegExp('/2015-03-10T11:46:51\+\d{2}:\d{2}/', $link['pub_iso_date']);
+        $this->assertRegExp('/2016-08-03T09:30:33\+\d{2}:\d{2}/', $data['links'][8]['up_iso_date']);
+    }
+
+    /**
+     * Test buildData with search criteria.
+     */
+    public function testBuildDataFiltered()
+    {
+        $criteria = array(
+            'searchtags' => 'stuff',
+            'searchterm' => 'beard',
+        );
+        $feedBuilder = new FeedBuilder(self::$linkDB, FeedBuilder::$FEED_ATOM, self::$serverInfo, $criteria, false);
+        $feedBuilder->setLocale(self::$LOCALE);
+        $data = $feedBuilder->buildData();
+        $this->assertEquals(1, count($data['links']));
+        $link = array_shift($data['links']);
+        $this->assertEquals(41, $link['id']);
+        $this->assertEquals(DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, '20150310_114651'), $link['created']);
+    }
+
+    /**
+     * Test buildData with nb limit.
+     */
+    public function testBuildDataCount()
+    {
+        $criteria = array(
+            'nb' => '3',
+        );
+        $feedBuilder = new FeedBuilder(self::$linkDB, FeedBuilder::$FEED_ATOM, self::$serverInfo, $criteria, false);
+        $feedBuilder->setLocale(self::$LOCALE);
+        $data = $feedBuilder->buildData();
+        $this->assertEquals(3, count($data['links']));
+        $link = $data['links'][array_keys($data['links'])[2]];
+        $this->assertEquals(41, $link['id']);
+        $this->assertEquals(DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, '20150310_114651'), $link['created']);
+    }
+
+    /**
+     * Test buildData with permalinks on.
+     */
+    public function testBuildDataPermalinks()
+    {
+        $feedBuilder = new FeedBuilder(self::$linkDB, FeedBuilder::$FEED_ATOM, self::$serverInfo, null, false);
+        $feedBuilder->setLocale(self::$LOCALE);
+        $feedBuilder->setUsePermalinks(true);
+        $data = $feedBuilder->buildData();
+        $this->assertEquals(ReferenceLinkDB::$NB_LINKS_TOTAL, count($data['links']));
+        $this->assertTrue($data['usepermalinks']);
+        // First link is a permalink
+        $link = $data['links'][array_keys($data['links'])[2]];
+        $this->assertEquals(41, $link['id']);
+        $this->assertEquals(DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, '20150310_114651'), $link['created']);
+        $this->assertEquals('http://host.tld/?WDWyig', $link['guid']);
+        $this->assertEquals('http://host.tld/?WDWyig', $link['url']);
+        $this->assertContains('Direct link', $link['description']);
+        $this->assertContains('http://host.tld/?WDWyig', $link['description']);
+        // Second link is a direct link
+        $link = $data['links'][array_keys($data['links'])[3]];
+        $this->assertEquals(8, $link['id']);
+        $this->assertEquals(DateTime::createFromFormat(LinkDB::LINK_DATE_FORMAT, '20150310_114633'), $link['created']);
+        $this->assertEquals('http://host.tld/?RttfEw', $link['guid']);
+        $this->assertEquals('https://static.fsf.org/nosvn/faif-2.0.pdf', $link['url']);
+        $this->assertContains('Direct link', $link['description']);
+        $this->assertContains('https://static.fsf.org/nosvn/faif-2.0.pdf', $link['description']);
+    }
+
+    /**
+     * Test buildData with hide dates settings.
+     */
+    public function testBuildDataHideDates()
+    {
+        $feedBuilder = new FeedBuilder(self::$linkDB, FeedBuilder::$FEED_ATOM, self::$serverInfo, null, false);
+        $feedBuilder->setLocale(self::$LOCALE);
+        $feedBuilder->setHideDates(true);
+        $data = $feedBuilder->buildData();
+        $this->assertEquals(ReferenceLinkDB::$NB_LINKS_TOTAL, count($data['links']));
+        $this->assertFalse($data['show_dates']);
+
+        // Show dates while logged in
+        $feedBuilder = new FeedBuilder(self::$linkDB, FeedBuilder::$FEED_ATOM, self::$serverInfo, null, true);
+        $feedBuilder->setLocale(self::$LOCALE);
+        $feedBuilder->setHideDates(true);
+        $data = $feedBuilder->buildData();
+        $this->assertEquals(ReferenceLinkDB::$NB_LINKS_TOTAL, count($data['links']));
+        $this->assertTrue($data['show_dates']);
+    }
+
+    /**
+     * Test buildData when Shaarli is served from a subdirectory
+     */
+    public function testBuildDataServerSubdir()
+    {
+        $serverInfo = array(
+            'HTTPS' => 'Off',
+            'SERVER_NAME' => 'host.tld',
+            'SERVER_PORT' => '8080',
+            'SCRIPT_NAME' => '/~user/shaarli/index.php',
+            'REQUEST_URI' => '/~user/shaarli/index.php?do=feed',
+        );
+        $feedBuilder = new FeedBuilder(
+            self::$linkDB,
+            FeedBuilder::$FEED_ATOM,
+            $serverInfo,
+            null,
+            false
+        );
+        $feedBuilder->setLocale(self::$LOCALE);
+        $data = $feedBuilder->buildData();
+
+        $this->assertEquals(
+            'http://host.tld:8080/~user/shaarli/index.php?do=feed',
+            $data['self_link']
+        );
+
+        // Test first link (note link)
+        $link = $data['links'][array_keys($data['links'])[2]];
+        $this->assertEquals('http://host.tld:8080/~user/shaarli/?WDWyig', $link['guid']);
+        $this->assertEquals('http://host.tld:8080/~user/shaarli/?WDWyig', $link['url']);
+        $this->assertContains('http://host.tld:8080/~user/shaarli/?addtag=hashtag', $link['description']);
+    }
+}
-- 
cgit v1.2.3


From f24896b237e40718fb6eaa2869592eb0855a47fd Mon Sep 17 00:00:00 2001
From: VirtualTam <virtualtam@flibidi.net>
Date: Mon, 3 Dec 2018 01:10:39 +0100
Subject: namespacing: \Shaarli\Bookmark\LinkDB

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
---
 tests/feed/FeedBuilderTest.php | 4 +---
 1 file changed, 1 insertion(+), 3 deletions(-)

(limited to 'tests/feed')

diff --git a/tests/feed/FeedBuilderTest.php b/tests/feed/FeedBuilderTest.php
index 1fdbc60e..88d1c3ed 100644
--- a/tests/feed/FeedBuilderTest.php
+++ b/tests/feed/FeedBuilderTest.php
@@ -3,11 +3,9 @@
 namespace Shaarli\Feed;
 
 use DateTime;
-use LinkDB;
+use Shaarli\Bookmark\LinkDB;
 use ReferenceLinkDB;
 
-require_once 'application/LinkDB.php';
-
 /**
  * FeedBuilderTest class.
  *
-- 
cgit v1.2.3


From dea72c711ff740b3b829d238fcf85648465143a0 Mon Sep 17 00:00:00 2001
From: VirtualTam <virtualtam@flibidi.net>
Date: Sat, 12 Jan 2019 23:55:38 +0100
Subject: Optimize and cleanup imports

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
---
 tests/feed/FeedBuilderTest.php | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

(limited to 'tests/feed')

diff --git a/tests/feed/FeedBuilderTest.php b/tests/feed/FeedBuilderTest.php
index 88d1c3ed..b496cb4c 100644
--- a/tests/feed/FeedBuilderTest.php
+++ b/tests/feed/FeedBuilderTest.php
@@ -3,8 +3,8 @@
 namespace Shaarli\Feed;
 
 use DateTime;
-use Shaarli\Bookmark\LinkDB;
 use ReferenceLinkDB;
+use Shaarli\Bookmark\LinkDB;
 
 /**
  * FeedBuilderTest class.
-- 
cgit v1.2.3