Issues in InstallerContext.php - All Issues - Inspection of "Merge pull request #6951 from NeverResponse/fix/pr..." - Sylius/Sylius - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0a1951...1a638f )

by Paweł

created 2016-12-08 07:42 UTC

src/Sylius/Behat/Context/Cli/InstallerContext.php (2 issues)

Labels

Bug 2

Severity

Minor 2

Upgrade to new PHP Analysis Engine

These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more

<?php

/*
 * This file is part of the Sylius package.
 *
 * (c) Paweł Jędrzejewski
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace Sylius\Behat\Context\Cli;

use Behat\Behat\Context\Context;
use Sylius\Bundle\CoreBundle\Command\InstallSampleDataCommand;
use Sylius\Bundle\CoreBundle\Command\SetupCommand;
use Symfony\Bundle\FrameworkBundle\Console\Application;
use Symfony\Component\Console\Helper\QuestionHelper;
use Symfony\Component\Console\Tester\CommandTester;
use Symfony\Component\HttpKernel\KernelInterface;
use Webmozart\Assert\Assert;

/**
 * @author Magdalena Banasiak <[email protected]>
 */
final class InstallerContext implements Context
{
    /**
     * @var KernelInterface
     */
    private $kernel;

    /**
     * @var Application
     */
    private $application;

    /**
     * @var CommandTester
     */
    private $tester;

    /**
     * @var QuestionHelper
     */
    private $questionHelper;

    /**
     * @var SetupCommand
     */
    private $command;

    /**
     * @var array
     */
    private $inputChoices = [
        'currency' => 'USD',
        'e-mail' => '[email protected]',
        'password' => 'pswd',
        'confirmation' => 'pswd',
    ];

    /**
     * @param KernelInterface $kernel
     */
    public function __construct(KernelInterface $kernel)
    {
        $this->kernel = $kernel;
    }

    /**
     * @When I run Sylius CLI installer
     */
    public function iRunSyliusCommandLineInstaller()
    {
        $this->application = new Application($this->kernel);
        $this->application->add(new SetupCommand());

        $this->command = $this->application->find('sylius:install:setup');
        $this->tester = new CommandTester($this->command);

        $this->iExecuteCommandWithInputChoices('sylius:install:setup');
    }

    /**
     * @Given I run Sylius Install Load Sample Data command
     */
    public function iRunSyliusInstallSampleDataCommand()
    {
        $this->application = new Application($this->kernel);
        $this->application->add(new InstallSampleDataCommand());
        $this->command = $this->application->find('sylius:install:sample-data');
        $this->tester = new CommandTester($this->command);
    }

    /**
     * @Given I confirm loading sample data
     */
    public function iConfirmLoadingData()
    {
        $this->iExecuteCommandAndConfirm('sylius:install:sample-data');
    }

    /**
     * @Then the command should finish successfully
     */
    public function commandSuccess()
    {
        Assert::same($this->tester->getStatusCode(), 0);
    }

    /**
     * @Then I should see output :text
     */
    public function iShouldSeeOutput($text)
    {
        Assert::contains($this->tester->getDisplay(), $text);
    }

    /**
     * @Given I do not provide an email
     */
    public function iDoNotProvideEmail()
    {
        $this->inputChoices['e-mail'] = '';
    }

    /**
     * @Given I do not provide a correct email
     */
    public function iDoNotProvideCorrectEmail()
    {
        $this->inputChoices['e-mail'] = 'janusz';
    }

    /**
     * @Given I provide full administrator data
     */
    public function iProvideFullAdministratorData()
    {
        $this->inputChoices['e-mail'] = '[email protected]';
        $this->inputChoices['password'] = 'pswd1$';
        $this->inputChoices['confirmation'] = $this->inputChoices['password'];
    }

    /**
     * @param string $input
     *
     * @return resource
     */
    protected function getInputStream($input)
    {
        $stream = fopen('php://memory', 'r+', false);
        fwrite($stream, $input);
        rewind($stream);

        return $stream;
    }

    /**
     * @param string $name
     */
    private function iExecuteCommandWithInputChoices($name)
    {
        $this->questionHelper = $this->command->getHelper('question');
        $inputString = implode(PHP_EOL, $this->inputChoices);
        $this->questionHelper->setInputStream($this->getInputStream($inputString.PHP_EOL));
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        try {
            $this->tester->execute(['command' => $name]);
        } catch (\Exception $e) {
        }
    }

    /**
     * @param string $name
     */
    private function iExecuteCommandAndConfirm($name)
    {
        $this->questionHelper = $this->command->getHelper('question');
        $inputString = 'y'.PHP_EOL;
        $this->questionHelper->setInputStream($this->getInputStream($inputString));
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        try {
            $this->tester->execute(['command' => $name]);
        } catch (\Exception $e) {
        }
    }
}


1			<?php
2
3			/*
4			* This file is part of the Sylius package.
5			*
6			* (c) Paweł Jędrzejewski
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace Sylius\Behat\Context\Cli;
13
14			use Behat\Behat\Context\Context;
15			use Sylius\Bundle\CoreBundle\Command\InstallSampleDataCommand;
16			use Sylius\Bundle\CoreBundle\Command\SetupCommand;
17			use Symfony\Bundle\FrameworkBundle\Console\Application;
18			use Symfony\Component\Console\Helper\QuestionHelper;
19			use Symfony\Component\Console\Tester\CommandTester;
20			use Symfony\Component\HttpKernel\KernelInterface;
21			use Webmozart\Assert\Assert;
22
23			/**
24			* @author Magdalena Banasiak <[email protected]>
25			*/
26			final class InstallerContext implements Context
27			{
28			/**
29			* @var KernelInterface
30			*/
31			private $kernel;
32
33			/**
34			* @var Application
35			*/
36			private $application;
37
38			/**
39			* @var CommandTester
40			*/
41			private $tester;
42
43			/**
44			* @var QuestionHelper
45			*/
46			private $questionHelper;
47
48			/**
49			* @var SetupCommand
50			*/
51			private $command;
52
53			/**
54			* @var array
55			*/
56			private $inputChoices = [
57			'currency' => 'USD',
58			'e-mail' => '[email protected]',
59			'password' => 'pswd',
60			'confirmation' => 'pswd',
61			];
62
63			/**
64			* @param KernelInterface $kernel
65			*/
66			public function __construct(KernelInterface $kernel)
67			{
68			$this->kernel = $kernel;
69			}
70
71			/**
72			* @When I run Sylius CLI installer
73			*/
74			public function iRunSyliusCommandLineInstaller()
75			{
76			$this->application = new Application($this->kernel);
77			$this->application->add(new SetupCommand());
78
79			$this->command = $this->application->find('sylius:install:setup');
80			$this->tester = new CommandTester($this->command);
81
82			$this->iExecuteCommandWithInputChoices('sylius:install:setup');
83			}
84
85			/**
86			* @Given I run Sylius Install Load Sample Data command
87			*/
88			public function iRunSyliusInstallSampleDataCommand()
89			{
90			$this->application = new Application($this->kernel);
91			$this->application->add(new InstallSampleDataCommand());
92			$this->command = $this->application->find('sylius:install:sample-data');
93			$this->tester = new CommandTester($this->command);
94			}
95
96			/**
97			* @Given I confirm loading sample data
98			*/
99			public function iConfirmLoadingData()
100			{
101			$this->iExecuteCommandAndConfirm('sylius:install:sample-data');
102			}
103
104			/**
105			* @Then the command should finish successfully
106			*/
107			public function commandSuccess()
108			{
109			Assert::same($this->tester->getStatusCode(), 0);
110			}
111
112			/**
113			* @Then I should see output :text
114			*/
115			public function iShouldSeeOutput($text)
116			{
117			Assert::contains($this->tester->getDisplay(), $text);
118			}
119
120			/**
121			* @Given I do not provide an email
122			*/
123			public function iDoNotProvideEmail()
124			{
125			$this->inputChoices['e-mail'] = '';
126			}
127
128			/**
129			* @Given I do not provide a correct email
130			*/
131			public function iDoNotProvideCorrectEmail()
132			{
133			$this->inputChoices['e-mail'] = 'janusz';
134			}
135
136			/**
137			* @Given I provide full administrator data
138			*/
139			public function iProvideFullAdministratorData()
140			{
141			$this->inputChoices['e-mail'] = '[email protected]';
142			$this->inputChoices['password'] = 'pswd1$';
143			$this->inputChoices['confirmation'] = $this->inputChoices['password'];
144			}
145
146			/**
147			* @param string $input
148			*
149			* @return resource
150			*/
151			protected function getInputStream($input)
152			{
153			$stream = fopen('php://memory', 'r+', false);
154			fwrite($stream, $input);
155			rewind($stream);
156
157			return $stream;
158			}
159
160			/**
161			* @param string $name
162			*/
163			private function iExecuteCommandWithInputChoices($name)
164			{
165			$this->questionHelper = $this->command->getHelper('question');
166			$inputString = implode(PHP_EOL, $this->inputChoices);
167			$this->questionHelper->setInputStream($this->getInputStream($inputString.PHP_EOL));
			0 ignored issues – show Bug introduced 2016-11-28 17:43 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a concrete implementation and not the interface `Symfony\Component\Console\Helper\HelperInterface` as the method `setInputStream()` does only exist in the following implementations of said interface: `Symfony\Component\Console\Helper\QuestionHelper`, `Symfony\Component\Consol...r\SymfonyQuestionHelper`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
168
169			try {
170			$this->tester->execute(['command' => $name]);
171			} catch (\Exception $e) {
172			}
173			}
174
175			/**
176			* @param string $name
177			*/
178			private function iExecuteCommandAndConfirm($name)
179			{
180			$this->questionHelper = $this->command->getHelper('question');
181			$inputString = 'y'.PHP_EOL;
182			$this->questionHelper->setInputStream($this->getInputStream($inputString));
			0 ignored issues – show Bug introduced 2016-11-28 17:43 UTC by Report Bug Copy Issue Report Show Similar Issues like this It seems like you code against a concrete implementation and not the interface `Symfony\Component\Console\Helper\HelperInterface` as the method `setInputStream()` does only exist in the following implementations of said interface: `Symfony\Component\Console\Helper\QuestionHelper`, `Symfony\Component\Consol...r\SymfonyQuestionHelper`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
183
184			try {
185			$this->tester->execute(['command' => $name]);
186			} catch (\Exception $e) {
187			}
188			}
189			}
190

Sylius / Sylius

Push — master ( 0a1951...1a638f )

src/Sylius/Behat/Context/Cli/InstallerContext.php (2 issues)

Labels

Severity

Introduced By

Upgrade to new PHP Analysis Engine

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like