Add Pocket CSV import

2025-06-27 16:36:00 +00:00 · 2025-05-24 17:51:45 +02:00 · 2025-05-24 17:51:45 +02:00 · c1397f43ac
commit c1397f43ac
parent 52a16bb75f
17 changed files with 754 additions and 4 deletions
--- a/tests/Wallabag/ImportBundle/Controller/ImportControllerTest.php
+++ b/tests/Wallabag/ImportBundle/Controller/ImportControllerTest.php
@ -24,6 +24,6 @@ class ImportControllerTest extends WallabagCoreTestCase
        $crawler = $client->request('GET', '/import/');

        $this->assertSame(200, $client->getResponse()->getStatusCode());
-        $this->assertSame(13, $crawler->filter('blockquote')->count());
+        $this->assertSame(14, $crawler->filter('blockquote')->count());
    }
 }
--- a/tests/Wallabag/ImportBundle/Controller/PocketCsvControllerTest.php
+++ b/tests/Wallabag/ImportBundle/Controller/PocketCsvControllerTest.php
@ -0,0 +1,155 @@
+<?php
+
+namespace Tests\Wallabag\ImportBundle\Controller;
+
+use Craue\ConfigBundle\Util\Config;
+use Doctrine\ORM\EntityManagerInterface;
+use Predis\Client;
+use Symfony\Component\HttpFoundation\File\UploadedFile;
+use Tests\Wallabag\CoreBundle\WallabagCoreTestCase;
+use Wallabag\CoreBundle\Entity\Entry;
+
+class PocketCsvControllerTest extends WallabagCoreTestCase
+{
+    public function testImportPocketCsv()
+    {
+        $this->logInAs('admin');
+        $client = $this->getTestClient();
+
+        $crawler = $client->request('GET', '/import/pocket_csv');
+
+        $this->assertSame(200, $client->getResponse()->getStatusCode());
+        $this->assertSame(1, $crawler->filter('form[name=upload_import_file] > button[type=submit]')->count());
+        $this->assertSame(1, $crawler->filter('input[type=file]')->count());
+    }
+
+    public function testImportPocketCsvWithRabbitEnabled()
+    {
+        $this->logInAs('admin');
+        $client = $this->getTestClient();
+
+        $client->getContainer()->get(Config::class)->set('import_with_rabbitmq', 1);
+
+        $crawler = $client->request('GET', '/import/pocket_csv');
+
+        $this->assertSame(200, $client->getResponse()->getStatusCode());
+        $this->assertSame(1, $crawler->filter('form[name=upload_import_file] > button[type=submit]')->count());
+        $this->assertSame(1, $crawler->filter('input[type=file]')->count());
+
+        $client->getContainer()->get(Config::class)->set('import_with_rabbitmq', 0);
+    }
+
+    public function testImportPocketCsvBadFile()
+    {
+        $this->logInAs('admin');
+        $client = $this->getTestClient();
+
+        $crawler = $client->request('GET', '/import/pocket_csv');
+        $form = $crawler->filter('form[name=upload_import_file] > button[type=submit]')->form();
+
+        $data = [
+            'upload_import_file[file]' => '',
+        ];
+
+        $client->submit($form, $data);
+
+        $this->assertSame(200, $client->getResponse()->getStatusCode());
+    }
+
+    public function testImportPocketCsvWithRedisEnabled()
+    {
+        $this->checkRedis();
+        $this->logInAs('admin');
+        $client = $this->getTestClient();
+        $client->getContainer()->get(Config::class)->set('import_with_redis', 1);
+
+        $crawler = $client->request('GET', '/import/pocket_csv');
+
+        $this->assertSame(200, $client->getResponse()->getStatusCode());
+        $this->assertSame(1, $crawler->filter('form[name=upload_import_file] > button[type=submit]')->count());
+        $this->assertSame(1, $crawler->filter('input[type=file]')->count());
+
+        $form = $crawler->filter('form[name=upload_import_file] > button[type=submit]')->form();
+
+        $file = new UploadedFile(__DIR__ . '/../fixtures/pocket.csv', 'Bookmarks');
+
+        $data = [
+            'upload_import_file[file]' => $file,
+        ];
+
+        $client->submit($form, $data);
+
+        $this->assertSame(302, $client->getResponse()->getStatusCode());
+
+        $crawler = $client->followRedirect();
+
+        $this->assertGreaterThan(1, $body = $crawler->filter('body')->extract(['_text']));
+        $this->assertStringContainsString('flashes.import.notice.summary', $body[0]);
+
+        $this->assertNotEmpty($client->getContainer()->get(Client::class)->lpop('wallabag.import.pocket_csv'));
+
+        $client->getContainer()->get(Config::class)->set('import_with_redis', 0);
+    }
+
+    public function testImportWallabagWithPocketCsvFile()
+    {
+        $this->logInAs('admin');
+        $client = $this->getTestClient();
+
+        $crawler = $client->request('GET', '/import/pocket_csv');
+        $form = $crawler->filter('form[name=upload_import_file] > button[type=submit]')->form();
+
+        $file = new UploadedFile(__DIR__ . '/../fixtures/pocket.csv', 'Bookmarks');
+
+        $data = [
+            'upload_import_file[file]' => $file,
+        ];
+
+        $client->submit($form, $data);
+
+        $this->assertSame(302, $client->getResponse()->getStatusCode());
+
+        $crawler = $client->followRedirect();
+
+        $this->assertGreaterThan(1, $body = $crawler->filter('body')->extract(['_text']));
+        $this->assertStringContainsString('flashes.import.notice.summary', $body[0]);
+
+        $content = $client->getContainer()
+            ->get(EntityManagerInterface::class)
+            ->getRepository(Entry::class)
+            ->findByUrlAndUserId(
+                'https://jp-lambert.me/est-ce-que-jai-besoin-d-un-scrum-master-604f5a471c73',
+                $this->getLoggedInUserId()
+            );
+
+        $this->assertInstanceOf(Entry::class, $content);
+        $this->assertNotEmpty($content->getMimetype(), 'Mimetype for jp-lambert.me is ok');
+        $this->assertNotEmpty($content->getPreviewPicture(), 'Preview picture for jp-lambert.me is ok');
+        $this->assertNotEmpty($content->getLanguage(), 'Language for jp-lambert.me is ok');
+        $this->assertCount(1, $content->getTags());
+    }
+
+    public function testImportWallabagWithEmptyFile()
+    {
+        $this->logInAs('admin');
+        $client = $this->getTestClient();
+
+        $crawler = $client->request('GET', '/import/pocket_csv');
+        $form = $crawler->filter('form[name=upload_import_file] > button[type=submit]')->form();
+
+        $file = new UploadedFile(__DIR__ . '/../fixtures/test.csv', 'test.csv');
+
+        $data = [
+            'upload_import_file[file]' => $file,
+        ];
+
+        $client->submit($form, $data);
+
+        $this->assertSame(302, $client->getResponse()->getStatusCode());
+
+        $crawler = $client->followRedirect();
+
+        $this->assertGreaterThan(1, $body = $crawler->filter('body')->extract(['_text']));
+        $this->assertStringContainsString('flashes.import.notice.failed', $body[0]);
+    }
+}
--- a/tests/Wallabag/ImportBundle/Import/PocketCsvImportTest.php
+++ b/tests/Wallabag/ImportBundle/Import/PocketCsvImportTest.php
@ -0,0 +1,252 @@
+<?php
+
+namespace Tests\Wallabag\ImportBundle\Import;
+
+use Doctrine\ORM\EntityManager;
+use M6Web\Component\RedisMock\RedisMockFactory;
+use Monolog\Handler\TestHandler;
+use Monolog\Logger;
+use PHPUnit\Framework\TestCase;
+use Predis\Client;
+use Simpleue\Queue\RedisQueue;
+use Symfony\Component\EventDispatcher\EventDispatcher;
+use Wallabag\CoreBundle\Entity\Entry;
+use Wallabag\CoreBundle\Helper\ContentProxy;
+use Wallabag\CoreBundle\Helper\TagsAssigner;
+use Wallabag\CoreBundle\Repository\EntryRepository;
+use Wallabag\ImportBundle\Import\PocketCsvImport;
+use Wallabag\ImportBundle\Redis\Producer;
+use Wallabag\UserBundle\Entity\User;
+
+class PocketCsvImportTest extends TestCase
+{
+    protected $user;
+    protected $em;
+    protected $logHandler;
+    protected $contentProxy;
+    protected $tagsAssigner;
+
+    public function testInit()
+    {
+        $pocketCsvImport = $this->getPocketCsvImport();
+
+        $this->assertSame('Pocket CSV', $pocketCsvImport->getName());
+        $this->assertNotEmpty($pocketCsvImport->getUrl());
+        $this->assertSame('import.pocket_csv.description', $pocketCsvImport->getDescription());
+    }
+
+    public function testImport()
+    {
+        $pocketCsvImport = $this->getPocketCsvImport(false, 7);
+        $pocketCsvImport->setFilepath(__DIR__ . '/../fixtures/pocket.csv');
+
+        $entryRepo = $this->getMockBuilder(EntryRepository::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $entryRepo->expects($this->exactly(7))
+            ->method('findByUrlAndUserId')
+            ->willReturn(false);
+
+        $this->em
+            ->expects($this->any())
+            ->method('getRepository')
+            ->willReturn($entryRepo);
+
+        $entry = $this->getMockBuilder(Entry::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $this->contentProxy
+            ->expects($this->exactly(7))
+            ->method('updateEntry')
+            ->willReturn($entry);
+
+        $res = $pocketCsvImport->import();
+
+        $this->assertTrue($res);
+        $this->assertSame(['skipped' => 0, 'imported' => 7, 'queued' => 0], $pocketCsvImport->getSummary());
+    }
+
+    public function testImportAndMarkAllAsRead()
+    {
+        $pocketCsvImport = $this->getPocketCsvImport(false, 1);
+        $pocketCsvImport->setFilepath(__DIR__ . '/../fixtures/pocket.csv');
+
+        $entryRepo = $this->getMockBuilder(EntryRepository::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $entryRepo->expects($this->exactly(7))
+            ->method('findByUrlAndUserId')
+            ->will($this->onConsecutiveCalls(false, true));
+
+        $this->em
+            ->expects($this->any())
+            ->method('getRepository')
+            ->willReturn($entryRepo);
+
+        $this->contentProxy
+            ->expects($this->exactly(1))
+            ->method('updateEntry')
+            ->willReturn(new Entry($this->user));
+
+        // check that every entry persisted are archived
+        $this->em
+            ->expects($this->any())
+            ->method('persist')
+            ->with($this->callback(fn ($persistedEntry) => (bool) $persistedEntry->isArchived()));
+
+        $res = $pocketCsvImport
+            ->setMarkAsRead(true)
+            ->import();
+
+        $this->assertTrue($res);
+
+        $this->assertSame(['skipped' => 6, 'imported' => 1, 'queued' => 0], $pocketCsvImport->getSummary());
+    }
+
+    public function testImportWithRabbit()
+    {
+        $pocketCsvImport = $this->getPocketCsvImport();
+        $pocketCsvImport->setFilepath(__DIR__ . '/../fixtures/pocket.csv');
+
+        $entryRepo = $this->getMockBuilder(EntryRepository::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $entryRepo->expects($this->never())
+            ->method('findByUrlAndUserId');
+
+        $this->em
+            ->expects($this->never())
+            ->method('getRepository');
+
+        $entry = $this->getMockBuilder(Entry::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $this->contentProxy
+            ->expects($this->never())
+            ->method('updateEntry');
+
+        $producer = $this->getMockBuilder(\OldSound\RabbitMqBundle\RabbitMq\Producer::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $producer
+            ->expects($this->exactly(7))
+            ->method('publish');
+
+        $pocketCsvImport->setProducer($producer);
+
+        $res = $pocketCsvImport->setMarkAsRead(true)->import();
+
+        $this->assertTrue($res);
+        $this->assertSame(['skipped' => 0, 'imported' => 0, 'queued' => 7], $pocketCsvImport->getSummary());
+    }
+
+    public function testImportWithRedis()
+    {
+        $pocketCsvImport = $this->getPocketCsvImport();
+        $pocketCsvImport->setFilepath(__DIR__ . '/../fixtures/pocket.csv');
+
+        $entryRepo = $this->getMockBuilder(EntryRepository::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $entryRepo->expects($this->never())
+            ->method('findByUrlAndUserId');
+
+        $this->em
+            ->expects($this->never())
+            ->method('getRepository');
+
+        $entry = $this->getMockBuilder(Entry::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $this->contentProxy
+            ->expects($this->never())
+            ->method('updateEntry');
+
+        $factory = new RedisMockFactory();
+        $redisMock = $factory->getAdapter(Client::class, true);
+
+        $queue = new RedisQueue($redisMock, 'pocket_csv');
+        $producer = new Producer($queue);
+
+        $pocketCsvImport->setProducer($producer);
+
+        $res = $pocketCsvImport->setMarkAsRead(true)->import();
+
+        $this->assertTrue($res);
+        $this->assertSame(['skipped' => 0, 'imported' => 0, 'queued' => 7], $pocketCsvImport->getSummary());
+
+        $this->assertNotEmpty($redisMock->lpop('pocket_csv'));
+    }
+
+    public function testImportBadFile()
+    {
+        $pocketCsvImport = $this->getPocketCsvImport();
+        $pocketCsvImport->setFilepath(__DIR__ . '/../fixtures/Import/wallabag-v1.jsonx');
+
+        $res = $pocketCsvImport->import();
+
+        $this->assertFalse($res);
+
+        $records = $this->logHandler->getRecords();
+        $this->assertStringContainsString('Pocket CSV Import: unable to read file', $records[0]['message']);
+        $this->assertSame('ERROR', $records[0]['level_name']);
+    }
+
+    public function testImportUserNotDefined()
+    {
+        $pocketCsvImport = $this->getPocketCsvImport(true);
+        $pocketCsvImport->setFilepath(__DIR__ . '/../fixtures/pocket.csv');
+
+        $res = $pocketCsvImport->import();
+
+        $this->assertFalse($res);
+
+        $records = $this->logHandler->getRecords();
+        $this->assertStringContainsString('Pocket CSV Import: user is not defined', $records[0]['message']);
+        $this->assertSame('ERROR', $records[0]['level_name']);
+    }
+
+    private function getPocketCsvImport($unsetUser = false, $dispatched = 0)
+    {
+        $this->user = new User();
+
+        $this->em = $this->getMockBuilder(EntityManager::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $this->contentProxy = $this->getMockBuilder(ContentProxy::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $this->tagsAssigner = $this->getMockBuilder(TagsAssigner::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $dispatcher = $this->getMockBuilder(EventDispatcher::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $dispatcher
+            ->expects($this->exactly($dispatched))
+            ->method('dispatch');
+
+        $this->logHandler = new TestHandler();
+        $logger = new Logger('test', [$this->logHandler]);
+
+        $wallabag = new PocketCsvImport($this->em, $this->contentProxy, $this->tagsAssigner, $dispatcher, $logger);
+
+        if (false === $unsetUser) {
+            $wallabag->setUser($this->user);
+        }
+
+        return $wallabag;
+    }
+}
--- a/tests/Wallabag/ImportBundle/fixtures/pocket.csv
+++ b/tests/Wallabag/ImportBundle/fixtures/pocket.csv
@ -0,0 +1,8 @@
+title,url,time_added,tags,status
+You Might Not Need jQuery,http://youmightnotneedjquery.com/,1600322788,,unread
+Est-ce que j’ai besoin d’un Scrum Master ? | by Jean-Pierre Lambert | Jean-,https://jp-lambert.me/est-ce-que-jai-besoin-d-un-scrum-master-604f5a471c73,1600172739,,unread
+"Avec les accusés d’El Halia, par Gisèle Halimi (Le Monde diplomatique, sept",https://www.monde-diplomatique.fr/2020/09/HALIMI/62165,1599806347,,unread
+ArchiveBox question: How do I import links from a RSS feed?,https://www.reddit.com/r/DataHoarder/comments/ioupbk/archivebox_question_how_do_i_import_links_from_a/,1600961496,,archive
+« Tu vas pleurer les premières fois » : que se passe-t-il au sein du studio,https://www.numerama.com/politique/646826-tu-vas-pleurer-les-premieres-fois-que-se-passe-t-il-au-sein-du-studio-dubisoft-derriere-trackmania.html#utm_medium=distibuted&utm_source=rss&utm_campaign=646826,1599809025,,unread
+Comment Konbini s’est fait piéger par un « père masculiniste »,https://www.nouvelobs.com/rue89/20200911.OBS33165/comment-konbini-s-est-fait-pieger-par-un-pere-masculiniste.html,1599819251,,archive
+Des abeilles pour résoudre les « conflits » entre les humains et les élépha,https://reporterre.net/Des-abeilles-pour-resoudre-les-conflits-entre-les-humains-et-les-elephants,1599890673,,unread
--- a/tests/Wallabag/ImportBundle/fixtures/test.csv
+++ b/tests/Wallabag/ImportBundle/fixtures/test.csv