upgraded to symfony 4 #74 (#81)

src/Command/CreateUserCommand.php

@@ -0,0 +1,132 @@
+<?php
+
+/*
+ * This file is part of the Kimai package.
+ *
+ * (c) Kevin Papst <kevin@kevinpapst.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Command;
+
+use App\Entity\User;
+use Doctrine\Bundle\DoctrineBundle\Registry;
+use Symfony\Bridge\Doctrine\RegistryInterface;
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputArgument;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+use Symfony\Component\Security\Core\Encoder\UserPasswordEncoder;
+use Symfony\Component\Security\Core\Encoder\UserPasswordEncoderInterface;
+use Symfony\Component\Validator\Validator\ValidatorInterface;
+
+/**
+ * Command used to create application user.
+ *
+ * @author Kevin Papst <kevin@kevinpapst.de>
+ */
+class CreateUserCommand extends Command
+{
+    /**
+     * @var UserPasswordEncoder
+     */
+    protected $encoder;
+    /**
+     * @var Registry
+     */
+    protected $doctrine;
+    /**
+     * @var ValidatorInterface
+     */
+    protected $validator;
+
+    /**
+     * @param UserPasswordEncoderInterface $encoder
+     * @param RegistryInterface $registry
+     * @param ValidatorInterface $validator
+     */
+    public function __construct(
+        UserPasswordEncoderInterface $encoder,
+        RegistryInterface $registry,
+        ValidatorInterface $validator
+    ) {
+        $this->encoder = $encoder;
+        $this->doctrine = $registry;
+        $this->validator = $validator;
+
+        parent::__construct();
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function configure()
+    {
+        $this
+            ->setName('kimai:create-user')
+            ->setDescription('Create a new user')
+            ->setHelp('This command allows you to create a new user.')
+            ->addArgument('username', InputArgument::REQUIRED, 'New username (must be unique)')
+            ->addArgument('email', InputArgument::REQUIRED, 'Users email address (must be unique)')
+            ->addArgument('password', InputArgument::REQUIRED, 'Users password')
+            ->addArgument('language', InputArgument::OPTIONAL, 'Users language', User::DEFAULT_LANGUAGE)
+            ->addArgument('role', InputArgument::OPTIONAL, 'Users role (comma separated list)', User::DEFAULT_ROLE)
+        ;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $io = new SymfonyStyle($input, $output);
+
+        $username = $input->getArgument('username');
+        $email = $input->getArgument('email');
+        $password = $input->getArgument('password');
+        $language = $input->getArgument('language');
+        $role = $input->getArgument('role');
+
+        $language = $language ?: User::DEFAULT_LANGUAGE;
+        $role = $role ?: User::DEFAULT_ROLE;
+
+        $user = new User();
+        $user->setUsername($username)
+            ->setPlainPassword($password)
+            ->setEmail($email)
+            ->setLanguage($language)
+            ->setRoles(explode(',', $role))
+        ;
+
+        $pwd = $this->encoder->encodePassword($user, $user->getPlainPassword());
+        $user->setPassword($pwd);
+
+        $errors = $this->validator->validate($user);
+        if ($errors->count() > 0) {
+            /** @var \Symfony\Component\Validator\ConstraintViolation $error */
+            foreach ($errors as $error) {
+                $value = $error->getInvalidValue();
+                $io->error(
+                    $error->getPropertyPath()
+                    . " (" . (is_array($value) ? implode(',', $value) : $value) .")"
+                    . "\n    "
+                    . $error->getMessage()
+                );
+            }
+            return;
+        }
+
+        try {
+            $entityManager = $this->doctrine->getManager();
+            $entityManager->persist($user);
+            $entityManager->flush();
+            $io->success('Success! Created user: ' . $user->getUsername());
+        } catch (\Exception $ex) {
+            $io->error('Failed to create user: ' . $user->getUsername());
+            $io->error('Reason: ' . $ex->getMessage());
+        }
+    }
+}

src/Command/InstallCommand.php

@@ -0,0 +1,100 @@
+<?php
+
+/*
+ * This file is part of the Kimai package.
+ *
+ * (c) Kevin Papst <kevin@kevinpapst.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Command;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\ArrayInput;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+/**
+ * Command used to execute all the basic application bootstrapping AFTER "composer install" was executed.
+ *
+ * @author Kevin Papst <kevin@kevinpapst.de>
+ */
+class InstallCommand extends Command
+{
+
+    /**
+     * @inheritdoc
+     */
+    protected function configure()
+    {
+        $this
+            ->setName('kimai:install')
+            ->setDescription('Execute all the basic installation tasks')
+            ->setHelp('This command will bootstrap Kimai, copies asset installation by default')
+            ->addOption('symlink', null, InputOption::VALUE_NONE, 'Symlinks the assets instead of copying it')
+            ->addOption('relative', null, InputOption::VALUE_NONE, 'Make relative symlinks')
+        ;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $io = new SymfonyStyle($input, $output);
+
+        $arguments = [];
+
+        if ($input->getOption('relative')) {
+            $arguments = [
+                '--relative' => true,
+            ];
+        } elseif ($input->getOption('symlink')) {
+            $arguments = [
+                '--symlink' => true,
+            ];
+        }
+
+        try {
+            $command = $this->getApplication()->find('doctrine:database:create');
+            $command->run(new ArrayInput([]), $output);
+        } catch (\Exception $ex) {
+            $io->error('Failed to create database: ' . $ex->getMessage());
+            return 1;
+        }
+
+        try {
+            $command = $this->getApplication()->find('doctrine:schema:create');
+            $command->run(new ArrayInput([]), $output);
+        } catch (\Exception $ex) {
+            $io->error('Failed to create database schema ('.$ex->getCode().'): ' . $ex->getMessage());
+            return 2;
+        }
+
+        try {
+            $command = $this->getApplication()->find('avanzu:admin:fetch-vendor');
+            $command->run([], $output);
+        } catch (\Exception $ex) {
+            $io->error('Failed to fetch vendors for avanzu-admin-theme: ' . $ex->getMessage());
+            return 3;
+        }
+        try {
+            $command = $this->getApplication()->find('avanzu:admin:initialize');
+            $command->run(new ArrayInput(array_merge(['--web-dir' => 'public'], $arguments)), $output);
+        } catch (\Exception $ex) {
+            $io->error('Failed to initialize avanzu-admin-theme: ' . $ex->getMessage());
+            return 4;
+        }
+        try {
+            $command = $this->getApplication()->find('assets:install');
+            $command->run(new ArrayInput($arguments), $output);
+        } catch (\Exception $ex) {
+            $io->error('Failed to install assets: ' . $ex->getMessage());
+            return 5;
+        }
+    }
+}

src/Command/ResetCommand.php

@@ -0,0 +1,126 @@
+<?php
+
+/*
+ * This file is part of the Kimai package.
+ *
+ * (c) Kevin Papst <kevin@kevinpapst.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Command;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\ArrayInput;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Input\InputOption;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Question\ConfirmationQuestion;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+/**
+ * Command used to execute all the basic application bootstrapping AFTER "composer install" was executed.
+ *
+ * @author Kevin Papst <kevin@kevinpapst.de>
+ */
+class ResetCommand extends Command
+{
+
+    /**
+     * @inheritdoc
+     */
+    protected function configure()
+    {
+        $this
+            ->setName('kimai:reset-dev')
+            ->setDescription('Resets the dev environment')
+            ->setHelp(<<<EOT
+    This command will drop and re-create the database and its schemas, load development fixtures and clear the cache.
+    Use the <info>-n</info> switch to skip the question.
+EOT
+            )
+            ->addOption('no-cache', null, InputOption::VALUE_NONE, 'Skip cache flushing')
+        ;
+    }
+
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @return int|null
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $io = new SymfonyStyle($input, $output);
+
+        if ($this->askConfirmation($input, $output, 'Do you want to create the database y/N ?')) {
+            try {
+                $command = $this->getApplication()->find('doctrine:database:create');
+                $command->run(new ArrayInput([]), $output);
+            } catch (\Exception $ex) {
+                $io->error('Failed to create database: ' . $ex->getMessage());
+                return 1;
+            }
+        }
+
+        if ($this->askConfirmation($input, $output, 'Do you want to drop and re-create the schema y/N ?')) {
+            try {
+                $command = $this->getApplication()->find('doctrine:schema:drop');
+                $command->run(new ArrayInput(['--force' => true]), $output);
+            } catch (\Exception $ex) {
+                $io->error('Failed to drop database schema: ' . $ex->getMessage());
+                return 2;
+            }
+
+            try {
+                $command = $this->getApplication()->find('doctrine:schema:create');
+                $command->run(new ArrayInput([]), $output);
+            } catch (\Exception $ex) {
+                $io->error('Failed to create database schema: ' . $ex->getMessage());
+                return 3;
+            }
+        }
+
+        try {
+            $command = $this->getApplication()->find('doctrine:fixtures:load');
+            $cmdInput = new ArrayInput([]);
+            $cmdInput->setInteractive(false);
+            $command->run($cmdInput, $output);
+        } catch (\Exception $ex) {
+            $io->error('Failed to import fixtures: ' . $ex->getMessage());
+            return 4;
+        }
+
+        if (!$input->getOption('no-cache')) {
+            $command = $this->getApplication()->find('cache:clear');
+            try {
+                $command->run(new ArrayInput([]), $output);
+            } catch (\Exception $ex) {
+                $io->error('Failed to clear cache: ' . $ex->getMessage());
+                return 5;
+            }
+        }
+
+        return 0;
+    }
+
+
+    /**
+     * @param InputInterface $input
+     * @param OutputInterface $output
+     * @param string $question
+     * @param bool $default
+     * @return bool
+     */
+    private function askConfirmation(InputInterface $input, OutputInterface $output, $question, $default = false)
+    {
+        if (!$input->isInteractive()) {
+            return true;
+        }
+
+        $questionHelper = $this->getHelperSet()->get('question');
+        $question = new ConfirmationQuestion('<question>' . $question . '</question>', $default);
+
+        return $questionHelper->ask($input, $output, $question);
+    }
+}

src/Command/RunCodeSnifferCommand.php

@@ -0,0 +1,84 @@
+<?php
+
+/*
+ * This file is part of the Kimai package.
+ *
+ * (c) Kevin Papst <kevin@kevinpapst.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Command;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+/**
+ * Command used to check the project coding styles.
+ *
+ * @author Kevin Papst <kevin@kevinpapst.de>
+ */
+class RunCodeSnifferCommand extends Command
+{
+    /**
+     * @var string
+     */
+    protected $rootDir;
+
+    /**
+     * RunCodeSnifferCommand constructor.
+     * @param $projectDirectory
+     */
+    public function __construct($projectDirectory)
+    {
+        $this->rootDir = realpath($projectDirectory);
+        parent::__construct();
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function configure()
+    {
+        $this
+            ->setName('kimai:phpcs')
+            ->setDescription('Run PHP_CodeSniffer to check for the projects coding style')
+        ;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $io = new SymfonyStyle($input, $output);
+
+        $this->executeCodeSniffer($io, '/src');
+        $this->executeCodeSniffer($io, '/tests');
+        $this->executeCodeSniffer($io, '/templates');
+    }
+
+    /**
+     * @param string $directory
+     */
+    protected function executeCodeSniffer(SymfonyStyle $io, $directory)
+    {
+        $directory = $this->rootDir . $directory;
+
+        $exitCode = 0;
+        ob_start();
+        passthru($this->rootDir . '/bin/phpcs --standard=PSR2 ' . $directory, $exitCode);
+        $result = ob_get_clean();
+
+        $io->write($result);
+
+        if ($exitCode > 0) {
+            $io->error('Found problems while checking sources at: ' . $directory);
+        } else {
+            $io->success('All sources look good at: ' . $directory);
+        }
+    }
+}

src/Command/RunIntegrationTestsCommand.php

@@ -0,0 +1,46 @@
+<?php
+
+/*
+ * This file is part of the Kimai package.
+ *
+ * (c) Kevin Papst <kevin@kevinpapst.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Command;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+/**
+ * Command used to run all integration tests.
+ *
+ * @author Kevin Papst <kevin@kevinpapst.de>
+ */
+class RunIntegrationTestsCommand extends RunUnitTestsCommand
+{
+    /**
+     * @inheritdoc
+     */
+    protected function configure()
+    {
+        $this
+            ->setName('kimai:test-integration')
+            ->setDescription('Run all integration tests')
+            ->setHelp('This command will execute all integration tests with the annotation "@group integration".')
+        ;
+    }
+
+    /**
+     * @param $directory
+     * @return string
+     */
+    protected function createPhpunitCmdLine($directory)
+    {
+        return $this->rootDir . '/bin/phpunit --group integration ' . $directory;
+    }
+}

src/Command/RunUnitTestsCommand.php

@@ -0,0 +1,93 @@
+<?php
+
+/*
+ * This file is part of the Kimai package.
+ *
+ * (c) Kevin Papst <kevin@kevinpapst.de>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace App\Command;
+
+use Symfony\Component\Console\Command\Command;
+use Symfony\Component\Console\Input\InputInterface;
+use Symfony\Component\Console\Output\OutputInterface;
+use Symfony\Component\Console\Style\SymfonyStyle;
+
+/**
+ * Command used to run all unit tests.
+ *
+ * @author Kevin Papst <kevin@kevinpapst.de>
+ */
+class RunUnitTestsCommand extends Command
+{
+
+    /**
+     * @var string
+     */
+    protected $rootDir;
+
+    /**
+     * RunCodeSnifferCommand constructor.
+     * @param string $projectDirectory
+     */
+    public function __construct($projectDirectory)
+    {
+        $this->rootDir = realpath($projectDirectory);
+        parent::__construct();
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function configure()
+    {
+        $this
+            ->setName('kimai:test-unit')
+            ->setDescription('Run all unit tests')
+            ->setHelp('This command will execute all unit tests. Skips all tests with "@group integration" annotation.')
+        ;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    protected function execute(InputInterface $input, OutputInterface $output)
+    {
+        $io = new SymfonyStyle($input, $output);
+
+        $this->executeTests($io, '/tests');
+    }
+
+    /**
+     * @param $directory
+     * @return string
+     */
+    protected function createPhpunitCmdLine($directory)
+    {
+        return $this->rootDir . '/bin/phpunit --exclude-group integration ' . $directory;
+    }
+
+    /**
+     * @param string $directory
+     */
+    protected function executeTests(SymfonyStyle $io, $directory)
+    {
+        $directory = $this->rootDir . $directory;
+
+        $exitCode = 0;
+        ob_start();
+        passthru($this->createPhpunitCmdLine($directory), $exitCode);
+        $result = ob_get_clean();
+
+        $io->write($result);
+
+        if ($exitCode > 0) {
+            $io->error('Found problems while running tests at: ' . $directory);
+        } else {
+            $io->success('All tests performed good at: ' . $directory);
+        }
+    }
+}