FixtureContext::iShouldSeeAModalTitled() - Code Metrics - Inspection of "API phpunit9 support" - silverstripe/silverstripe-campaign-admin - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — 1 (#210)

by Steve

created 2021-10-19 01:26 UTC

FixtureContext::iShouldSeeAModalTitled() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	4
c	1
b	0
f	0
dl	0
loc	6
rs	10
cc	1
nc	1
nop	1

<?php

namespace SilverStripe\CampaignAdmin\Tests\Behat\Context;

use Behat\Mink\Element\DocumentElement;
use Behat\Mink\Element\NodeElement;
use PHPUnit\Framework\Assert;
use SilverStripe\BehatExtension\Context\FixtureContext as BaseFixtureContext;
use SilverStripe\BehatExtension\Utility\StepHelper;
use SilverStripe\MinkFacebookWebDriver\FacebookWebDriver;
use SilverStripe\Versioned\ChangeSet;

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

    /**
     * @Then /^I should see the campaign "([^"]+)"$/
     * @param string $name
     */
    public function iShouldSeeTheCampaign($name)
    {
        $item = $this->getCampaign($name);

        Assert::assertNotNull($item, "Could not find campaign \"$name\" in the list");
    }

    /**
     * @Then /^I should not see the campaign "([^"]+)"$/
     * @param string $name
     */
    public function iShouldNotSeeTheCampaign($name)
    {
        $item = $this->getCampaign($name);

        Assert::assertNull($item, "Found campaign \"$name\" in the list");
    }

    /**
     * @Then /^I should see "([^"]+)" in column (\d+) of the "([^"]+)" campaign$/
     * @param string $text
     * @param string $column
     * @param string $name
     */
    public function iShouldSeeInTheCampaignColumn($text, $column, $name)
    {
        $campaignRow = $this->getCampaign($name);
        Assert::assertNotNull($campaignRow, sprintf('Could not find campaign "%s"', $name));

        $cell = $campaignRow->find('xpath', "/td[{$column}][contains(text(), '{$text}')]");

        Assert::assertNotNull($cell, sprintf('Could not find "%s" in column %d of "%s"', $text, $column, $name));
    }

    /**
     * @Given /^I view the campaign "([^"]*)"$/
     * @param $name
     */
    public function iViewTheCampaign($name)
    {
        $item = $this->getCampaign($name);
        Assert::assertNotNull($item, sprintf('Campaign %s not found', $name));

        $item->find('css', 'td')->click();
    }

    /**
     * @Given /^I edit the campaign "([^"]*)"$/
     * @param $name
     */
    public function iEditTheCampaign($name)
    {
        $item = $this->getCampaign($name);
        Assert::assertNotNull($item, sprintf('Campaign %s not found', $name));

        $button = $item->find('css', '.font-icon-cog');
        Assert::assertNotNull($button, sprintf('Campaign %s has no edit button', $name));
        $button->click();
    }

    /**
     * @Given /^I delete the campaign "([^"]*)"$/
     * @param $name
     */
    public function iDeleteTheCampaign($name)
    {
        $item = $this->getCampaign($name);
        Assert::assertNotNull($item, sprintf('Campaign %s not found', $name));

        $button = $item->find('css', '.font-icon-cancel');
        Assert::assertNotNull($button, sprintf('Campaign %s has no delete button', $name));
        $button->click();

        /** @var FacebookWebDriver $driver */
        $driver = $this->getMainContext()->getSession()->getDriver();
        $webDriver = $driver->getWebDriver();
        $webDriver->switchTo()->alert()->accept();
    }

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

    /**
     * Checks that the message box contains specified text.
     *
     * @Then /^I should see "(?P<text>(?:[^"]|\\")*)" in the message box$/
     * @param string $text
     */
    public function Assert::assertMessageBoxContainsText($text)

    {
        /** @var FeatureContext $mainContext */
        $mainContext = $this->getMainContext();
        $mainContext
            ->assertSession()
            ->elementTextContains('css', '.message-box', str_replace('\\"', '"', $text));
    }

    /**
     * @Then I should see a modal titled :title
     * @param string $title
     */
    public function iShouldSeeAModalTitled($title)
    {
        $page = $this->getMainContext()->getSession()->getPage();
        $modalTitle = $page->find('css', '[role=dialog] .modal-header > .modal-title');
        Assert::assertNotNull($modalTitle, 'No modal on the page');
        Assert::assertTrue($modalTitle->getText() == $title);
    }

    /**
     * @Then /^I close the modal$/
     */
    public function iCloseTheModal()
    {
        /** @var DocumentElement $page */
        $page = $this->getMainContext()->getSession()->getPage();
        $button = $page->find('css', '.modal-header .close');
        Assert::assertNotNull($button, 'Close button not found');

        $button->click();
    }

    /**
     * @Given /^I click the "([^"]+)" gallery item$/
     * @param $name
     */
    public function iClickTheGalleryItem($name)
    {
        /** @var DocumentElement $page */
        $page = $this->getMainContext()->getSession()->getPage();
        // Find by cell
        $cell = $page->find(
            'xpath',
            "//div[contains(@class, 'gallery-item')]//div[contains(text(), '{$name}')]"
        );

        Assert::assertNotNull($cell, sprintf('Gallery item "%s" could not be found', $name));

        $cell->click();
    }

    /**
     * @Given /^I should( not? |\s*)see the "([^"]+)" campaign item$/
     * @param $negate boolean
     * @param $name string
     */
    public function iSeeTheCampaignItem($negate, $name)
    {
        $item = $this->getCampaignItem($name);
        $shouldSee = !trim($negate);

        if ($shouldSee) {
            Assert::assertNotNull($item, sprintf('Item "%s" could not be found', $name));
            Assert::assertTrue($item->isVisible(), sprintf('Item "%s" is not visible', $name));
        } elseif ($item) {
            Assert::assertFalse($item->isVisible(), sprintf('Item "%s" is visible', $name));
        } else {
            Assert::assertNull($item, sprintf('Item "%s" exists', $name));
        }
    }

    /**
     * @Given /^I select the "([^"]+)" campaign item$/
     * @param $name
     */
    public function iSelectTheCampaignItem($name)
    {
        $item = $this->getCampaignItem($name);
        Assert::assertNotNull($item, sprintf('Item "%s" could not be found', $name));
        $item->click();
    }

    /**
     * @Given /^a campaign "([^"]+)" with changes (".*)$/
     * @param $id
     * @param $data
     */
    public function stepCreateCampaignWithItems($id, $data)
    {
        $class = $this->convertTypeToClass(ChangeSet::class);
        /* @var ChangeSet $campaign */
        $campaign = $this->getFixtureFactory()->get($class, $id);
        if (!$campaign) {
            $campaign = $this->getFixtureFactory()->createObject($class, $id);
        }

        preg_match_all(
            '/"(?<content_class>[^"]+)"\s*=\s*"(?<identifier>[^"]+)"/',
            $data,
            $matches
        );
        $itemMap = array_combine($matches['content_class'], $matches['identifier']);
        foreach ($itemMap as $contentClass => $identifier) {
            $class = $this->convertTypeToClass($contentClass);
            $record = $this->getFixtureFactory()->get($class, $identifier);
            if (!$record) {
                $record = $this->getFixtureFactory()->createObject($class, $identifier);
            }
            $campaign->addObject($record);
        }
    }

    /**
     * Helper for finding items in the visible campaign view
     *
     * @param string $name Title of item
     * @return NodeElement
     */
    protected function getCampaign($name)
    {
        /** @var DocumentElement $page */
        $page = $this->getMainContext()->getSession()->getPage();
        // Find by row
        $row = $page->find(
            'xpath',
            "//tr[contains(@class, 'grid-field__row')]//td[contains(text(), '{$name}')]/.."
        );

        return $row ?: null;
    }

    /**
     * Gets a change set item in the detail view
     * @param $name
     * @return NodeElement
     */
    protected function getCampaignItem($name)
    {
        /** @var DocumentElement $page */
        $page = $this->getMainContext()->getSession()->getPage();
        return $page->find(
            'xpath',
            "//h4[contains(@class, 'list-group-item__heading') and contains(text(), '{$name}')]"
        );
    }
}


1			<?php
2
3			namespace SilverStripe\CampaignAdmin\Tests\Behat\Context;
4
5			use Behat\Mink\Element\DocumentElement;
6			use Behat\Mink\Element\NodeElement;
7			use PHPUnit\Framework\Assert;
8			use SilverStripe\BehatExtension\Context\FixtureContext as BaseFixtureContext;
9			use SilverStripe\BehatExtension\Utility\StepHelper;
10			use SilverStripe\MinkFacebookWebDriver\FacebookWebDriver;
11			use SilverStripe\Versioned\ChangeSet;
12
13			/**
14			* Context used to create fixtures in the SilverStripe ORM.
15			*/
16			class FixtureContext extends BaseFixtureContext
17			{
18			use StepHelper;
19
20			/**
21			* @Then /^I should see the campaign "([^"]+)"$/
22			* @param string $name
23			*/
24			public function iShouldSeeTheCampaign($name)
25			{
26			$item = $this->getCampaign($name);
27
28			Assert::assertNotNull($item, "Could not find campaign \"$name\" in the list");
29			}
30
31			/**
32			* @Then /^I should not see the campaign "([^"]+)"$/
33			* @param string $name
34			*/
35			public function iShouldNotSeeTheCampaign($name)
36			{
37			$item = $this->getCampaign($name);
38
39			Assert::assertNull($item, "Found campaign \"$name\" in the list");
40			}
41
42			/**
43			* @Then /^I should see "([^"]+)" in column (\d+) of the "([^"]+)" campaign$/
44			* @param string $text
45			* @param string $column
46			* @param string $name
47			*/
48			public function iShouldSeeInTheCampaignColumn($text, $column, $name)
49			{
50			$campaignRow = $this->getCampaign($name);
51			Assert::assertNotNull($campaignRow, sprintf('Could not find campaign "%s"', $name));
52
53			$cell = $campaignRow->find('xpath', "/td[{$column}][contains(text(), '{$text}')]");
54
55			Assert::assertNotNull($cell, sprintf('Could not find "%s" in column %d of "%s"', $text, $column, $name));
56			}
57
58			/**
59			* @Given /^I view the campaign "([^"]*)"$/
60			* @param $name
61			*/
62			public function iViewTheCampaign($name)
63			{
64			$item = $this->getCampaign($name);
65			Assert::assertNotNull($item, sprintf('Campaign %s not found', $name));
66
67			$item->find('css', 'td')->click();
68			}
69
70			/**
71			* @Given /^I edit the campaign "([^"]*)"$/
72			* @param $name
73			*/
74			public function iEditTheCampaign($name)
75			{
76			$item = $this->getCampaign($name);
77			Assert::assertNotNull($item, sprintf('Campaign %s not found', $name));
78
79			$button = $item->find('css', '.font-icon-cog');
80			Assert::assertNotNull($button, sprintf('Campaign %s has no edit button', $name));
81			$button->click();
82			}
83
84			/**
85			* @Given /^I delete the campaign "([^"]*)"$/
86			* @param $name
87			*/
88			public function iDeleteTheCampaign($name)
89			{
90			$item = $this->getCampaign($name);
91			Assert::assertNotNull($item, sprintf('Campaign %s not found', $name));
92
93			$button = $item->find('css', '.font-icon-cancel');
94			Assert::assertNotNull($button, sprintf('Campaign %s has no delete button', $name));
95			$button->click();
96
97			/** @var FacebookWebDriver $driver */
98			$driver = $this->getMainContext()->getSession()->getDriver();
99			$webDriver = $driver->getWebDriver();
100			$webDriver->switchTo()->alert()->accept();
101			}
102
103			/**
104			* @Then /^I should see the "([^"]*)" form$/
105			* @param string $id HTML ID of form
106			*/
107			public function iShouldSeeTheForm($id)
108			{
109			/** @var DocumentElement $page */
110			$page = $this->getMainContext()->getSession()->getPage();
111			$form = $page->find('css', "form#{$id}");
112			Assert::assertNotNull($form, "form with id $id could not be found");
113			Assert::assertTrue($form->isVisible(), "form with id $id is not visible");
114			}
115
116			/**
117			* Checks that the message box contains specified text.
118			*
119			* @Then /^I should see "(?P<text>(?:[^"]\|\\")*)" in the message box$/
120			* @param string $text
121			*/
122			public function Assert::assertMessageBoxContainsText($text)
			0 ignored issues – show Bug introduced 2021-10-19 01:29 UTC by Report Bug Copy Issue Report A parse error occurred: Syntax error, unexpected T_PAAMAYIM_NEKUDOTAYIM, expecting '(' on line 122 at column 26 Loading history...
123			{
124			/** @var FeatureContext $mainContext */
125			$mainContext = $this->getMainContext();
126			$mainContext
127			->assertSession()
128			->elementTextContains('css', '.message-box', str_replace('\\"', '"', $text));
129			}
130
131			/**
132			* @Then I should see a modal titled :title
133			* @param string $title
134			*/
135			public function iShouldSeeAModalTitled($title)
136			{
137			$page = $this->getMainContext()->getSession()->getPage();
138			$modalTitle = $page->find('css', '[role=dialog] .modal-header > .modal-title');
139			Assert::assertNotNull($modalTitle, 'No modal on the page');
140			Assert::assertTrue($modalTitle->getText() == $title);
141			}
142
143			/**
144			* @Then /^I close the modal$/
145			*/
146			public function iCloseTheModal()
147			{
148			/** @var DocumentElement $page */
149			$page = $this->getMainContext()->getSession()->getPage();
150			$button = $page->find('css', '.modal-header .close');
151			Assert::assertNotNull($button, 'Close button not found');
152
153			$button->click();
154			}
155
156			/**
157			* @Given /^I click the "([^"]+)" gallery item$/
158			* @param $name
159			*/
160			public function iClickTheGalleryItem($name)
161			{
162			/** @var DocumentElement $page */
163			$page = $this->getMainContext()->getSession()->getPage();
164			// Find by cell
165			$cell = $page->find(
166			'xpath',
167			"//div[contains(@class, 'gallery-item')]//div[contains(text(), '{$name}')]"
168			);
169
170			Assert::assertNotNull($cell, sprintf('Gallery item "%s" could not be found', $name));
171
172			$cell->click();
173			}
174
175			/**
176			* @Given /^I should( not? \|\s*)see the "([^"]+)" campaign item$/
177			* @param $negate boolean
178			* @param $name string
179			*/
180			public function iSeeTheCampaignItem($negate, $name)
181			{
182			$item = $this->getCampaignItem($name);
183			$shouldSee = !trim($negate);
184
185			if ($shouldSee) {
186			Assert::assertNotNull($item, sprintf('Item "%s" could not be found', $name));
187			Assert::assertTrue($item->isVisible(), sprintf('Item "%s" is not visible', $name));
188			} elseif ($item) {
189			Assert::assertFalse($item->isVisible(), sprintf('Item "%s" is visible', $name));
190			} else {
191			Assert::assertNull($item, sprintf('Item "%s" exists', $name));
192			}
193			}
194
195			/**
196			* @Given /^I select the "([^"]+)" campaign item$/
197			* @param $name
198			*/
199			public function iSelectTheCampaignItem($name)
200			{
201			$item = $this->getCampaignItem($name);
202			Assert::assertNotNull($item, sprintf('Item "%s" could not be found', $name));
203			$item->click();
204			}
205
206			/**
207			* @Given /^a campaign "([^"]+)" with changes (".*)$/
208			* @param $id
209			* @param $data
210			*/
211			public function stepCreateCampaignWithItems($id, $data)
212			{
213			$class = $this->convertTypeToClass(ChangeSet::class);
214			/* @var ChangeSet $campaign */
215			$campaign = $this->getFixtureFactory()->get($class, $id);
216			if (!$campaign) {
217			$campaign = $this->getFixtureFactory()->createObject($class, $id);
218			}
219
220			preg_match_all(
221			'/"(?<content_class>[^"]+)"\s=\s"(?<identifier>[^"]+)"/',
222			$data,
223			$matches
224			);
225			$itemMap = array_combine($matches['content_class'], $matches['identifier']);
226			foreach ($itemMap as $contentClass => $identifier) {
227			$class = $this->convertTypeToClass($contentClass);
228			$record = $this->getFixtureFactory()->get($class, $identifier);
229			if (!$record) {
230			$record = $this->getFixtureFactory()->createObject($class, $identifier);
231			}
232			$campaign->addObject($record);
233			}
234			}
235
236			/**
237			* Helper for finding items in the visible campaign view
238			*
239			* @param string $name Title of item
240			* @return NodeElement
241			*/
242			protected function getCampaign($name)
243			{
244			/** @var DocumentElement $page */
245			$page = $this->getMainContext()->getSession()->getPage();
246			// Find by row
247			$row = $page->find(
248			'xpath',
249			"//tr[contains(@class, 'grid-field__row')]//td[contains(text(), '{$name}')]/.."
250			);
251
252			return $row ?: null;
253			}
254
255			/**
256			* Gets a change set item in the detail view
257			* @param $name
258			* @return NodeElement
259			*/
260			protected function getCampaignItem($name)
261			{
262			/** @var DocumentElement $page */
263			$page = $this->getMainContext()->getSession()->getPage();
264			return $page->find(
265			'xpath',
266			"//h4[contains(@class, 'list-group-item__heading') and contains(text(), '{$name}')]"
267			);
268			}
269			}
270

silverstripe / silverstripe-campaign-admin

Pull Request — 1 (#210)

FixtureContext::iShouldSeeAModalTitled() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like