From 8303b037fb4e64b542f6f755828b999fdf6eebb0 Mon Sep 17 00:00:00 2001 From: Thomas Citharel Date: Sun, 22 Jan 2017 12:51:14 +0100 Subject: [PATCH 1/3] add cli export Signed-off-by: Thomas Citharel --- .../CoreBundle/Command/ExportCommand.php | 82 +++++++++++++++++++ .../CoreBundle/Helper/EntriesExport.php | 5 ++ .../CoreBundle/Command/ExportCommandTest.php | 60 ++++++++++++++ 3 files changed, 147 insertions(+) create mode 100644 src/Wallabag/CoreBundle/Command/ExportCommand.php create mode 100644 tests/Wallabag/CoreBundle/Command/ExportCommandTest.php diff --git a/src/Wallabag/CoreBundle/Command/ExportCommand.php b/src/Wallabag/CoreBundle/Command/ExportCommand.php new file mode 100644 index 000000000..9c3c3fefe --- /dev/null +++ b/src/Wallabag/CoreBundle/Command/ExportCommand.php @@ -0,0 +1,82 @@ +setName('wallabag:export') + ->setDescription('Export all entries for an user') + ->setHelp('This command helps you to export all entries for an user') + ->addArgument( + 'username', + InputArgument::REQUIRED, + 'User from which to export entries' + ) + ->addArgument( + 'filename', + InputArgument::OPTIONAL, + 'Path of the exported file' + ) + ; + } + + protected function execute(InputInterface $input, OutputInterface $output) + { + try { + $user = $this->getUser($input->getArgument('username')); + } catch (NoResultException $e) { + $output->writeln(sprintf('User "%s" not found.', $input->getArgument('username'))); + return 1; + } + $entries = $this->getDoctrine() + ->getRepository('WallabagCoreBundle:Entry') + ->getBuilderForAllByUser($user->getId()) + ->getQuery() + ->getResult(); + + $output->write(sprintf('Exporting %d entrie(s) for user « %s »... ', count($entries), $user->getUserName())); + + $filePath = $input->getArgument('filename'); + if (!$filePath) { + $filePath = $this->getContainer()->getParameter('kernel.root_dir') . '/../' . sprintf('%s-export', $user->getUsername()); + } + try { + $data = $this->getContainer()->get('wallabag_core.helper.entries_export') + ->setEntries($entries) + ->updateTitle('All') + ->exportJsonData(); + file_put_contents($filePath, $data); + } catch (\InvalidArgumentException $e) { + $output->writeln(sprintf('Error: "%s"', $e->getMessage())); + } + + $output->writeln('Done.'); + } + + /** + * Fetches a user from its username. + * + * @param string $username + * + * @return \Wallabag\UserBundle\Entity\User + */ + private function getUser($username) + { + return $this->getDoctrine()->getRepository('WallabagUserBundle:User')->findOneByUserName($username); + } + + private function getDoctrine() + { + return $this->getContainer()->get('doctrine'); + } +} diff --git a/src/Wallabag/CoreBundle/Helper/EntriesExport.php b/src/Wallabag/CoreBundle/Helper/EntriesExport.php index 4bf292a4f..93c01fcb4 100644 --- a/src/Wallabag/CoreBundle/Helper/EntriesExport.php +++ b/src/Wallabag/CoreBundle/Helper/EntriesExport.php @@ -89,6 +89,11 @@ class EntriesExport throw new \InvalidArgumentException(sprintf('The format "%s" is not yet supported.', $format)); } + public function exportJsonData() + { + return $this->prepareSerializingContent('json'); + } + /** * Use PHPePub to dump a .epub file. * diff --git a/tests/Wallabag/CoreBundle/Command/ExportCommandTest.php b/tests/Wallabag/CoreBundle/Command/ExportCommandTest.php new file mode 100644 index 000000000..41491838b --- /dev/null +++ b/tests/Wallabag/CoreBundle/Command/ExportCommandTest.php @@ -0,0 +1,60 @@ +getClient()->getKernel()); + $application->add(new ExportCommand()); + + $command = $application->find('wallabag:export'); + + $tester = new CommandTester($command); + $tester->execute([ + 'command' => $command->getName(), + ]); + } + + public function testExportCommandWithBadUsername() + { + $application = new Application($this->getClient()->getKernel()); + $application->add(new ExportCommand()); + + $command = $application->find('wallabag:export'); + + $tester = new CommandTester($command); + $tester->execute([ + 'command' => $command->getName(), + 'username' => 'unknown', + ]); + + $this->assertContains('User "unknown" not found', $tester->getDisplay()); + } + + public function testExportCommand() + { + $application = new Application($this->getClient()->getKernel()); + $application->add(new ExportCommand()); + + $command = $application->find('wallabag:export'); + + $tester = new CommandTester($command); + $tester->execute([ + 'command' => $command->getName(), + 'username' => 'admin', + ]); + + $this->assertContains('Exporting 6 entrie(s) for user « admin »... Done', $tester->getDisplay()); + } +} From a607b7a9c0870bcdfb4b4e7920d20b5ed39f14fe Mon Sep 17 00:00:00 2001 From: Thomas Citharel Date: Sun, 22 Jan 2017 13:19:46 +0100 Subject: [PATCH 2/3] add filepath test Signed-off-by: Thomas Citharel --- .../CoreBundle/Command/ExportCommand.php | 4 ++-- .../CoreBundle/Command/ExportCommandTest.php | 17 +++++++++++++++++ 2 files changed, 19 insertions(+), 2 deletions(-) diff --git a/src/Wallabag/CoreBundle/Command/ExportCommand.php b/src/Wallabag/CoreBundle/Command/ExportCommand.php index 9c3c3fefe..0cf5de488 100644 --- a/src/Wallabag/CoreBundle/Command/ExportCommand.php +++ b/src/Wallabag/CoreBundle/Command/ExportCommand.php @@ -23,7 +23,7 @@ class ExportCommand extends ContainerAwareCommand 'User from which to export entries' ) ->addArgument( - 'filename', + 'filepath', InputArgument::OPTIONAL, 'Path of the exported file' ) @@ -46,7 +46,7 @@ class ExportCommand extends ContainerAwareCommand $output->write(sprintf('Exporting %d entrie(s) for user « %s »... ', count($entries), $user->getUserName())); - $filePath = $input->getArgument('filename'); + $filePath = $input->getArgument('filepath'); if (!$filePath) { $filePath = $this->getContainer()->getParameter('kernel.root_dir') . '/../' . sprintf('%s-export', $user->getUsername()); } diff --git a/tests/Wallabag/CoreBundle/Command/ExportCommandTest.php b/tests/Wallabag/CoreBundle/Command/ExportCommandTest.php index 41491838b..4c66e051c 100644 --- a/tests/Wallabag/CoreBundle/Command/ExportCommandTest.php +++ b/tests/Wallabag/CoreBundle/Command/ExportCommandTest.php @@ -57,4 +57,21 @@ class ExportCommandTest extends WallabagCoreTestCase $this->assertContains('Exporting 6 entrie(s) for user « admin »... Done', $tester->getDisplay()); } + + public function testExportCommandWithSpecialPath() + { + $application = new Application($this->getClient()->getKernel()); + $application->add(new ExportCommand()); + + $command = $application->find('wallabag:export'); + + $tester = new CommandTester($command); + $tester->execute([ + 'command' => $command->getName(), + 'username' => 'admin', + 'filepath' => 'specialexport.json' + ]); + + $this->assertFileExists('specialexport.json'); + } } From 3b0380f049d408f0721e28218170c562153a56e5 Mon Sep 17 00:00:00 2001 From: Thomas Citharel Date: Tue, 24 Jan 2017 20:42:02 +0100 Subject: [PATCH 3/3] Fix phpcs and tests --- .../CoreBundle/Command/ExportCommand.php | 23 ++++++++----------- .../CoreBundle/Command/ExportCommandTest.php | 1 + 2 files changed, 10 insertions(+), 14 deletions(-) diff --git a/src/Wallabag/CoreBundle/Command/ExportCommand.php b/src/Wallabag/CoreBundle/Command/ExportCommand.php index 0cf5de488..e3d3b3995 100644 --- a/src/Wallabag/CoreBundle/Command/ExportCommand.php +++ b/src/Wallabag/CoreBundle/Command/ExportCommand.php @@ -7,7 +7,6 @@ use Symfony\Bundle\FrameworkBundle\Command\ContainerAwareCommand; use Symfony\Component\Console\Input\InputArgument; use Symfony\Component\Console\Input\InputInterface; use Symfony\Component\Console\Output\OutputInterface; -use Symfony\Component\Console\Output\StreamOutput; class ExportCommand extends ContainerAwareCommand { @@ -33,11 +32,13 @@ class ExportCommand extends ContainerAwareCommand protected function execute(InputInterface $input, OutputInterface $output) { try { - $user = $this->getUser($input->getArgument('username')); + $user = $this->getDoctrine()->getRepository('WallabagUserBundle:User')->findOneByUserName($input->getArgument('username')); } catch (NoResultException $e) { $output->writeln(sprintf('User "%s" not found.', $input->getArgument('username'))); + return 1; } + $entries = $this->getDoctrine() ->getRepository('WallabagCoreBundle:Entry') ->getBuilderForAllByUser($user->getId()) @@ -47,9 +48,11 @@ class ExportCommand extends ContainerAwareCommand $output->write(sprintf('Exporting %d entrie(s) for user « %s »... ', count($entries), $user->getUserName())); $filePath = $input->getArgument('filepath'); + if (!$filePath) { - $filePath = $this->getContainer()->getParameter('kernel.root_dir') . '/../' . sprintf('%s-export', $user->getUsername()); + $filePath = $this->getContainer()->getParameter('kernel.root_dir').'/../'.sprintf('%s-export.json', $user->getUsername()); } + try { $data = $this->getContainer()->get('wallabag_core.helper.entries_export') ->setEntries($entries) @@ -58,21 +61,13 @@ class ExportCommand extends ContainerAwareCommand file_put_contents($filePath, $data); } catch (\InvalidArgumentException $e) { $output->writeln(sprintf('Error: "%s"', $e->getMessage())); + + return 1; } $output->writeln('Done.'); - } - /** - * Fetches a user from its username. - * - * @param string $username - * - * @return \Wallabag\UserBundle\Entity\User - */ - private function getUser($username) - { - return $this->getDoctrine()->getRepository('WallabagUserBundle:User')->findOneByUserName($username); + return 0; } private function getDoctrine() diff --git a/tests/Wallabag/CoreBundle/Command/ExportCommandTest.php b/tests/Wallabag/CoreBundle/Command/ExportCommandTest.php index 4c66e051c..6798c5d71 100644 --- a/tests/Wallabag/CoreBundle/Command/ExportCommandTest.php +++ b/tests/Wallabag/CoreBundle/Command/ExportCommandTest.php @@ -56,6 +56,7 @@ class ExportCommandTest extends WallabagCoreTestCase ]); $this->assertContains('Exporting 6 entrie(s) for user « admin »... Done', $tester->getDisplay()); + $this->assertFileExists('admin-export.json'); } public function testExportCommandWithSpecialPath()