FixtureContext::retry() - Code Metrics - Inspection of "ENHANCEMENT Partially restore behat tests (#326)" - silverstripe/silverstripe-asset-admin - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( ba555a...84256f )

by Ingo

created 2016-12-09 03:51 UTC

FixtureContext::retry() A

↳ Parent: FixtureContext

Complexity

Conditions	3
Paths	2

Size

Total Lines	11
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	11
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	8
nc	2
nop	2

<?php

namespace SilverStripe\AssetAdmin\Tests\Behat\Context;

use Behat\Mink\Element\DocumentElement;
use Behat\Mink\Element\NodeElement;
use SilverStripe\BehatExtension\Context\FixtureContext as BaseFixtureContext;

/**
 * Context used to create fixtures in the SilverStripe ORM.
 */
class FixtureContext extends BaseFixtureContext
{

    /**
     * Select a gallery item by type and name
     *
     * @Given /^I (?:(?:click on)|(?:select)) the "([^"]+)" named "([^"]+)" in the gallery$/
     * @param string $type
     * @param string $name
     */
    public function stepISelectGalleryItem($type, $name)
    {
        $item = $this->getGalleryItem($type, $name);
        assertNotNull($item, ucfirst($type) . " named $name could not be found");
        $item->click();
    }

    /**
     * Check the checkbox for a given gallery item
     * @Given /^I check the "([^"]+)" named "([^"]+)" in the gallery$/
     * @param string $type
     * @param string $name
     */
    public function stepICheckTheGalleryItem($type, $name)
    {
        $item = $this->getGalleryItem($type, $name);
        assertNotNull($item, ucfirst($type) . " named $name could not be found");
        $checkbox = $item->find('css', 'input[type="checkbox"]');
        assertNotNull($checkbox, "Could not find checkbox for file named {$name}");
        $checkbox->check();
    }

    /**
     * @Then /^I should see the "([^"]+)" named "([^"]+)" in the gallery$/
     * @param $type
     * @param $name
     */
    public function iShouldSeeTheGalleryItem($type, $name)
    {
        $item = $this->getGalleryItem($type, $name);
        assertNotNull($item, ucfirst($type) . " named {$name} could not be found");
    }

    /**
     * @Then /^I should not see the "([^"]+)" named "([^"]+)" in the gallery$/
     * @param $type
     * @param $name
     */
    public function iShouldNotSeeTheGalleryItem($type, $name)
    {
        $item = $this->getGalleryItem($type, $name, 0);
        assertNull($item, ucfirst($type) . " named {$name} was found when it should not be visible");
    }

    /**
     * @Then /^I should see the "([^"]*)" form$/
     * @param string $id HTML ID of form
     */
    public function iShouldSeeTheForm($id)
    {
        /** @var DocumentElement $page */
        $page = $this->getSession()->getPage();
        $form = $this->retry(function () use ($page, $id) {
            return $page->find('css', "form#{$id}");
        });
        assertNotNull($form, "form with id $id could not be found");
        assertTrue($form->isVisible(), "form with id $id is not visible");
    }

    /**
     * @Given /^I click on the latest history item$/
     */
    public function iClickOnTheLatestHistoryItem()
    {
        $this->getSession()->wait(
            5000,
            "window.jQuery && window.jQuery('.file-history__list li').size() > 0"
        );

        $page = $this->getSession()->getPage();

        $elements = $page->find('css', '.file-history__list li');

        if (null === $elements) {
            throw new \InvalidArgumentException(sprintf('Could not find list item'));
        }

        $elements->click();
    }

    /**
     * @Given /^I attach the file "([^"]*)" to dropzone$/
     * @see MinkContext::attachFileToField()
     */
    public function iAttachTheFileToDropzone($path)
    {
        // Get path
        $filesPath = $this->getMainContext()->getMinkParameter('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.
    }
}
        if ($filesPath) {
            $fullPath = rtrim(realpath($filesPath), DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR.$path;
            if (is_file($fullPath)) {
                $path = $fullPath;
            }
        }

        // Find field
        $input = $this->getSession()->getPage()->find('css', 'input[type="file"].dz-hidden-input');
        assertNotNull($input, "Could not find dz-hidden-input");

        // Make visible temporarily while attaching
        $this->getSession()->executeScript(
            <<<EOS
window.jQuery('.dz-hidden-input')
    .css('visibility', 'visible')
    .width(1)
    .height(1);
EOS
        );

        // Attach via html5
        $input->attachFile($path);

        // Restore hidden state
        $this->getSession()->executeScript(
            <<<EOS
window.jQuery('.dz-hidden-input')
    .css('visibility', 'hidden')
    .width(0)
    .height(0);
EOS
        );
    }

    /**
     * Helper for finding items in the visible gallery view
     *
     * @param string $type type. E.g. 'folder', 'image'
     * @param string $name Title of item
     * @param int $timeout
     * @return NodeElement
     */
    protected function getGalleryItem($type, $name, $timeout = 3)
    {
        /** @var DocumentElement $page */
        $page = $this->getSession()->getPage();
        return $this->retry(function () use ($page, $type, $name) {
            return $page->find(
                'xpath',
                "//div[contains(@class, 'gallery-item--{$type}')]//div[contains(text(), '{$name}')]"
            );
        }, $timeout);
    }

    /**
     * Invoke $try callback for a non-empty result with a given timeout
     *
     * @param callable $try
     * @param int $timeout Number of seconds to retry for
     * @return mixed Result of invoking $try, or null if timed out
     */
    protected function retry($try, $timeout = 3)
    {
        do {
            $result = $try();
            if ($result) {
                return $result;
            }
            sleep(1);
        } while (--$timeout >= 0);
        return null;
    }
}


1			<?php
2
3			namespace SilverStripe\AssetAdmin\Tests\Behat\Context;
4
5			use Behat\Mink\Element\DocumentElement;
6			use Behat\Mink\Element\NodeElement;
7			use SilverStripe\BehatExtension\Context\FixtureContext as BaseFixtureContext;
8
9			/**
10			* Context used to create fixtures in the SilverStripe ORM.
11			*/
12			class FixtureContext extends BaseFixtureContext
13			{
14
15			/**
16			* Select a gallery item by type and name
17			*
18			* @Given /^I (?:(?:click on)\|(?:select)) the "([^"]+)" named "([^"]+)" in the gallery$/
19			* @param string $type
20			* @param string $name
21			*/
22			public function stepISelectGalleryItem($type, $name)
23			{
24			$item = $this->getGalleryItem($type, $name);
25			assertNotNull($item, ucfirst($type) . " named $name could not be found");
26			$item->click();
27			}
28
29			/**
30			* Check the checkbox for a given gallery item
31			* @Given /^I check the "([^"]+)" named "([^"]+)" in the gallery$/
32			* @param string $type
33			* @param string $name
34			*/
35			public function stepICheckTheGalleryItem($type, $name)
36			{
37			$item = $this->getGalleryItem($type, $name);
38			assertNotNull($item, ucfirst($type) . " named $name could not be found");
39			$checkbox = $item->find('css', 'input[type="checkbox"]');
40			assertNotNull($checkbox, "Could not find checkbox for file named {$name}");
41			$checkbox->check();
42			}
43
44			/**
45			* @Then /^I should see the "([^"]+)" named "([^"]+)" in the gallery$/
46			* @param $type
47			* @param $name
48			*/
49			public function iShouldSeeTheGalleryItem($type, $name)
50			{
51			$item = $this->getGalleryItem($type, $name);
52			assertNotNull($item, ucfirst($type) . " named {$name} could not be found");
53			}
54
55			/**
56			* @Then /^I should not see the "([^"]+)" named "([^"]+)" in the gallery$/
57			* @param $type
58			* @param $name
59			*/
60			public function iShouldNotSeeTheGalleryItem($type, $name)
61			{
62			$item = $this->getGalleryItem($type, $name, 0);
63			assertNull($item, ucfirst($type) . " named {$name} was found when it should not be visible");
64			}
65
66			/**
67			* @Then /^I should see the "([^"]*)" form$/
68			* @param string $id HTML ID of form
69			*/
70			public function iShouldSeeTheForm($id)
71			{
72			/** @var DocumentElement $page */
73			$page = $this->getSession()->getPage();
74			$form = $this->retry(function () use ($page, $id) {
75			return $page->find('css', "form#{$id}");
76			});
77			assertNotNull($form, "form with id $id could not be found");
78			assertTrue($form->isVisible(), "form with id $id is not visible");
79			}
80
81			/**
82			* @Given /^I click on the latest history item$/
83			*/
84			public function iClickOnTheLatestHistoryItem()
85			{
86			$this->getSession()->wait(
87			5000,
88			"window.jQuery && window.jQuery('.file-history__list li').size() > 0"
89			);
90
91			$page = $this->getSession()->getPage();
92
93			$elements = $page->find('css', '.file-history__list li');
94
95			if (null === $elements) {
96			throw new \InvalidArgumentException(sprintf('Could not find list item'));
97			}
98
99			$elements->click();
100			}
101
102			/**
103			* @Given /^I attach the file "([^"]*)" to dropzone$/
104			* @see MinkContext::attachFileToField()
105			*/
106			public function iAttachTheFileToDropzone($path)
107			{
108			// Get path
109			$filesPath = $this->getMainContext()->getMinkParameter('files_path');
			0 ignored issues – show Bug introduced 2016-12-09 02:18 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 `getMinkParameter()` does only exist in the following implementations of said interface: `Behat\MinkExtension\Context\MinkContext`, `Behat\MinkExtension\Context\RawMinkContext`, `SilverStripe\AssetAdmin\...\Context\FeatureContext`, `SilverStripe\BehatExtens...ext\SilverStripeContext`, `SilverStripe\Cms\Test\Behaviour\FeatureContext`. 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...
110			if ($filesPath) {
111			$fullPath = rtrim(realpath($filesPath), DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR.$path;
112			if (is_file($fullPath)) {
113			$path = $fullPath;
114			}
115			}
116
117			// Find field
118			$input = $this->getSession()->getPage()->find('css', 'input[type="file"].dz-hidden-input');
119			assertNotNull($input, "Could not find dz-hidden-input");
120
121			// Make visible temporarily while attaching
122			$this->getSession()->executeScript(
123			<<<EOS
124			window.jQuery('.dz-hidden-input')
125			.css('visibility', 'visible')
126			.width(1)
127			.height(1);
128			EOS
129			);
130
131			// Attach via html5
132			$input->attachFile($path);
133
134			// Restore hidden state
135			$this->getSession()->executeScript(
136			<<<EOS
137			window.jQuery('.dz-hidden-input')
138			.css('visibility', 'hidden')
139			.width(0)
140			.height(0);
141			EOS
142			);
143			}
144
145			/**
146			* Helper for finding items in the visible gallery view
147			*
148			* @param string $type type. E.g. 'folder', 'image'
149			* @param string $name Title of item
150			* @param int $timeout
151			* @return NodeElement
152			*/
153			protected function getGalleryItem($type, $name, $timeout = 3)
154			{
155			/** @var DocumentElement $page */
156			$page = $this->getSession()->getPage();
157			return $this->retry(function () use ($page, $type, $name) {
158			return $page->find(
159			'xpath',
160			"//div[contains(@class, 'gallery-item--{$type}')]//div[contains(text(), '{$name}')]"
161			);
162			}, $timeout);
163			}
164
165			/**
166			* Invoke $try callback for a non-empty result with a given timeout
167			*
168			* @param callable $try
169			* @param int $timeout Number of seconds to retry for
170			* @return mixed Result of invoking $try, or null if timed out
171			*/
172			protected function retry($try, $timeout = 3)
173			{
174			do {
175			$result = $try();
176			if ($result) {
177			return $result;
178			}
179			sleep(1);
180			} while (--$timeout >= 0);
181			return null;
182			}
183			}
184

silverstripe / silverstripe-asset-admin

Push — master ( ba555a...84256f )

FixtureContext::retry() A

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like