FeatureContext::setMinkParameters() - Code Metrics - Inspection of "Run shell sript to set up SilverStripe Behat test..." - silverstripe/silverstripe-behat-extension - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#105)

unknown

created 2016-02-19 01:39 UTC

FeatureContext::setMinkParameters() A

↳ Parent: FeatureContext

Complexity

Conditions	2
Paths	2

Size

Total Lines	7
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
dl	0
loc	7
rs	9.4285
c	1
b	0
f	0
cc	2
eloc	4
nc	2
nop	1

<?php

namespace Mysite\Test\Behaviour;

use SilverStripe\BehatExtension\Context\SilverStripeContext,
    SilverStripe\BehatExtension\Context\BasicContext,
    SilverStripe\BehatExtension\Context\LoginContext,
    SilverStripe\BehatExtension\Context\FixtureContext,
    SilverStripe\Framework\Test\Behaviour\CmsFormsContext,
    SilverStripe\Framework\Test\Behaviour\CmsUiContext,
    SilverStripe\Cms\Test\Behaviour;

// PHPUnit
require_once 'PHPUnit/Autoload.php';
require_once 'PHPUnit/Framework/Assert/Functions.php';

/**
 * Features context
 *
 * Context automatically loaded by Behat.
 * Uses subcontexts to extend functionality.
 */
class FeatureContext extends SilverStripeContext {
    
    /**
     * @var FixtureFactory
     */
    protected $fixtureFactory;

    /**
     * Initializes context.
     * Every scenario gets it's own context object.
     *
     * @param array $parameters context parameters (set them up through behat.yml)
     */
    public function __construct(array $parameters) {
        parent::__construct($parameters);

        $this->useContext('BasicContext', new BasicContext($parameters));
        $this->useContext('LoginContext', new LoginContext($parameters));
        $this->useContext('CmsFormsContext', new CmsFormsContext($parameters));
        $this->useContext('CmsUiContext', new CmsUiContext($parameters));

        $fixtureContext = new FixtureContext($parameters);
        $fixtureContext->setFixtureFactory($this->getFixtureFactory());
        $this->useContext('FixtureContext', $fixtureContext);

        // Use blueprints to set user name from identifier
        $factory = $fixtureContext->getFixtureFactory();
        $blueprint = \Injector::inst()->create('FixtureBlueprint', 'Member');
        $blueprint->addCallback('beforeCreate', function($identifier, &$data, &$fixtures) {

            if(!isset($data['FirstName'])) $data['FirstName'] = $identifier;
        });
        $factory->define('Member', $blueprint);

        // Auto-publish pages
        if (class_exists('SiteTree')) {
            foreach(\ClassInfo::subclassesFor('SiteTree') as $id => $class) {
$collection = json_decode($data, true);
if ( ! is_array($collection)) {
    throw new \RuntimeException('$collection must be an array.');
}

foreach ($collection as $item) { /** ... */ }
                $blueprint = \Injector::inst()->create('FixtureBlueprint', $class);
                $blueprint->addCallback('afterCreate', function($obj, $identifier, &$data, &$fixtures) {

                    $obj->publish('Stage', 'Live');
                });
                $factory->define($class, $blueprint);
            }
        }

        $manager = \Injector::inst()->get(
            'FakeManager',
            true,
            // Creates a new database automatically. Session doesn't exist here yet,
            // so we need to take fake database path from internal config.
            // The same path is then set in the browser session
            // and reused across scenarios (see resetFakeDatabase()).
            array(new \FakeDatabase($this->getFakeDatabasePath()))
        );
        
        $this->manager = $manager;
class MyClass { }

$x = new MyClass();
$x->foo = true;
    }

    public function setMinkParameters(array $parameters) {
        parent::setMinkParameters($parameters);
        
        if(isset($parameters['files_path'])) {
            $this->getSubcontext('FixtureContext')->setFilesPath($parameters['files_path']);    
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.
    }
}
        }
    }

    /**
     * @return FixtureFactory
     */
    public function getFixtureFactory() {
        if(!$this->fixtureFactory) {
            $this->fixtureFactory = \Injector::inst()->create('BehatFixtureFactory');
        }

        return $this->fixtureFactory;
    }

    public function setFixtureFactory(FixtureFactory $factory) {
        $this->fixtureFactory = $factory;
    }

    /**
     * "Shares" the database with web requests, see
     * {@link MeridianFakeManagerControllerExtension}
     */
    public function getTestSessionState() {
        return array_merge(
            parent::getTestSessionState(),
            array(
                'useFakeManager' => true,
                'importDatabasePath' => BASE_PATH .'/mysite/tests/fixtures/SS-sample.sql',
                'requireDefaultRecords' => false,
                'fakeDatabasePath' => $this->getFakeDatabasePath(),
            )
        );
    }

    public function getFakeDatabasePath() {
        return BASE_PATH . '/FakeDatabase.json';
    }
    
    /**
     * @BeforeScenario
     */
    public function resetFakeDatabase() {
        $this->manager->getDb()->reset(true);
    }
    //
    // Place your definition and hook methods here:
    //
    //    /**
    //     * @Given /^I have done something with "([^"]*)"$/
    //     */
    //    public function iHaveDoneSomethingWith($argument) {
    //        $container = $this->kernel->getContainer();
    //        $container->get('some_service')->doSomethingWith($argument);
    //    }
    //
}


1			<?php
2
3			namespace Mysite\Test\Behaviour;
4
5			use SilverStripe\BehatExtension\Context\SilverStripeContext,
6			SilverStripe\BehatExtension\Context\BasicContext,
7			SilverStripe\BehatExtension\Context\LoginContext,
8			SilverStripe\BehatExtension\Context\FixtureContext,
9			SilverStripe\Framework\Test\Behaviour\CmsFormsContext,
10			SilverStripe\Framework\Test\Behaviour\CmsUiContext,
11			SilverStripe\Cms\Test\Behaviour;
12
13			// PHPUnit
14			require_once 'PHPUnit/Autoload.php';
15			require_once 'PHPUnit/Framework/Assert/Functions.php';
16
17			/**
18			* Features context
19			*
20			* Context automatically loaded by Behat.
21			* Uses subcontexts to extend functionality.
22			*/
23			class FeatureContext extends SilverStripeContext {
24
25			/**
26			* @var FixtureFactory
27			*/
28			protected $fixtureFactory;
29
30			/**
31			* Initializes context.
32			* Every scenario gets it's own context object.
33			*
34			* @param array $parameters context parameters (set them up through behat.yml)
35			*/
36			public function __construct(array $parameters) {
37			parent::__construct($parameters);
38
39			$this->useContext('BasicContext', new BasicContext($parameters));
40			$this->useContext('LoginContext', new LoginContext($parameters));
41			$this->useContext('CmsFormsContext', new CmsFormsContext($parameters));
42			$this->useContext('CmsUiContext', new CmsUiContext($parameters));
43
44			$fixtureContext = new FixtureContext($parameters);
45			$fixtureContext->setFixtureFactory($this->getFixtureFactory());
46			$this->useContext('FixtureContext', $fixtureContext);
47
48			// Use blueprints to set user name from identifier
49			$factory = $fixtureContext->getFixtureFactory();
50			$blueprint = \Injector::inst()->create('FixtureBlueprint', 'Member');
51			$blueprint->addCallback('beforeCreate', function($identifier, &$data, &$fixtures) {
			0 ignored issues – show Unused Code introduced 2016-02-05 01:57 UTC by Report Bug Copy Issue Report The parameter `$fixtures` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
52			if(!isset($data['FirstName'])) $data['FirstName'] = $identifier;
53			});
54			$factory->define('Member', $blueprint);
55
56			// Auto-publish pages
57			if (class_exists('SiteTree')) {
58			foreach(\ClassInfo::subclassesFor('SiteTree') as $id => $class) {
			0 ignored issues – show Bug introduced 2016-02-05 01:57 UTC by Report Bug Copy Issue Report The expression `\ClassInfo::subclassesFor('SiteTree')` of type `null\|array` is not guaranteed to be traversable. How about adding an additional type check? There are different options of fixing this problem. If you want to be on the safe side, you can add an additional type-check: $collection = json_decode($data, true); if ( ! is_array($collection)) { throw new \RuntimeException('$collection must be an array.'); } foreach ($collection as $item) { /** ... / } If you are sure that the expression is traversable, you might want to add a doc comment cast* to improve IDE auto-completion and static analysis: /** @var array $collection / $collection = json_decode($data, true); foreach ($collection as $item) { /* .. / } Mark the issue as a false-positive*: Just hover the remove button, in the top-right corner of this issue for more options. Loading history...
59			$blueprint = \Injector::inst()->create('FixtureBlueprint', $class);
60			$blueprint->addCallback('afterCreate', function($obj, $identifier, &$data, &$fixtures) {
			0 ignored issues – show Unused Code introduced 2016-02-05 01:57 UTC by Report Bug Copy Issue Report The parameter `$identifier` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2016-02-05 01:57 UTC by Report Bug Copy Issue Report The parameter `$data` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history... Unused Code introduced 2016-02-05 01:57 UTC by Report Bug Copy Issue Report The parameter `$fixtures` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
61			$obj->publish('Stage', 'Live');
62			});
63			$factory->define($class, $blueprint);
64			}
65			}
66
67			$manager = \Injector::inst()->get(
68			'FakeManager',
69			true,
70			// Creates a new database automatically. Session doesn't exist here yet,
71			// so we need to take fake database path from internal config.
72			// The same path is then set in the browser session
73			// and reused across scenarios (see resetFakeDatabase()).
74			array(new \FakeDatabase($this->getFakeDatabasePath()))
75			);
76
77			$this->manager = $manager;
			0 ignored issues – show Bug introduced 2016-02-19 01:41 UTC by Report Bug Copy Issue Report The property `manager` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
78			}
79
80			public function setMinkParameters(array $parameters) {
81			parent::setMinkParameters($parameters);
82
83			if(isset($parameters['files_path'])) {
84			$this->getSubcontext('FixtureContext')->setFilesPath($parameters['files_path']);
			0 ignored issues – show Bug introduced 2016-02-05 01:57 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `Behat\Behat\Context\ExtendedContextInterface` as the method `setFilesPath()` does only exist in the following implementations of said interface: `SilverStripe\BehatExtension\Context\FixtureContext`. 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...
85			}
86			}
87
88			/**
89			* @return FixtureFactory
90			*/
91			public function getFixtureFactory() {
92			if(!$this->fixtureFactory) {
93			$this->fixtureFactory = \Injector::inst()->create('BehatFixtureFactory');
94			}
95
96			return $this->fixtureFactory;
97			}
98
99			public function setFixtureFactory(FixtureFactory $factory) {
100			$this->fixtureFactory = $factory;
101			}
102
103			/**
104			* "Shares" the database with web requests, see
105			* {@link MeridianFakeManagerControllerExtension}
106			*/
107			public function getTestSessionState() {
108			return array_merge(
109			parent::getTestSessionState(),
110			array(
111			'useFakeManager' => true,
112			'importDatabasePath' => BASE_PATH .'/mysite/tests/fixtures/SS-sample.sql',
113			'requireDefaultRecords' => false,
114			'fakeDatabasePath' => $this->getFakeDatabasePath(),
115			)
116			);
117			}
118
119			public function getFakeDatabasePath() {
120			return BASE_PATH . '/FakeDatabase.json';
121			}
122
123			/**
124			* @BeforeScenario
125			*/
126			public function resetFakeDatabase() {
127			$this->manager->getDb()->reset(true);
128			}
129			//
130			// Place your definition and hook methods here:
131			//
132			// /**
133			// * @Given /^I have done something with "([^"]*)"$/
134			// */
135			// public function iHaveDoneSomethingWith($argument) {
136			// $container = $this->kernel->getContainer();
137			// $container->get('some_service')->doSomethingWith($argument);
138			// }
139			//
140			}
141

silverstripe / silverstripe-behat-extension

Pull Request — master (#105)

FeatureContext::setMinkParameters() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like