Add behat contexts for api ExchangeRates

features/currency/managing_exchange_rates/editing_exchange_rate.feature

@@ -21,5 +21,5 @@ Feature: Editing exchange rate
     Scenario: Being unable to change currencies
         Given the exchange rate of "US Dollar" to "British Pound" is 1.30
         When I want to edit this exchange rate
-        Then I should see that the source currency is disabled
-        And I should see that the target currency is disabled
+        Then I should not be able to edit its source currency
+        And I should not be able to edit its target currency

src/Sylius/Behat/Client/ApiClientInterface.php

@@ -64,7 +64,8 @@ interface ApiClientInterface
     /** @param string|int $value */
     public function relatedResourceHasValue(string $resource, string $key, $value): bool;
 
-    public function hasItemWithValue(string $key, string $value): bool;
+    /** @param string|float $value */
+    public function hasItemWithValue(string $key, $value): bool;
 
     public function hasItemOnPositionWithValue(int $position, string $key, string $value): bool;
 

src/Sylius/Behat/Client/ApiPlatformClient.php

@@ -171,7 +171,8 @@ final class ApiPlatformClient implements ApiClientInterface
         return $this->getResponseContentValue($key) === $value;
     }
 
-    public function hasItemWithValue(string $key, string $value): bool
+    /** @param string|float $value */
+    public function hasItemWithValue(string $key, $value): bool
     {
         foreach ($this->getCollection() as $resource) {
             if ($resource[$key] === $value) {

src/Sylius/Behat/Context/Api/Admin/ManagingExchangeRatesContext.php

@@ -0,0 +1,388 @@
+<?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\Api\Admin;
+
+use Behat\Behat\Context\Context;
+use Sylius\Behat\Client\ApiClientInterface;
+use Sylius\Behat\Service\SharedStorageInterface;
+use Sylius\Component\Currency\Model\CurrencyInterface;
+use Sylius\Component\Currency\Model\ExchangeRateInterface;
+use Sylius\Component\Currency\Repository\ExchangeRateRepositoryInterface;
+use Webmozart\Assert\Assert;
+
+final class ManagingExchangeRatesContext implements Context
+{
+    /** @var ApiClientInterface */
+    private $client;
+
+    /** @var ExchangeRateRepositoryInterface */
+    private $exchangeRateRepository;
+
+    /** @var SharedStorageInterface */
+    private $sharedStorage;
+
+    public function __construct(
+        ApiClientInterface $client,
+        ExchangeRateRepositoryInterface $exchangeRateRepository,
+        SharedStorageInterface $sharedStorage
+    ) {
+        $this->client = $client;
+        $this->exchangeRateRepository = $exchangeRateRepository;
+        $this->sharedStorage = $sharedStorage;
+    }
+
+    /**
+     * @When I want to add a new exchange rate
+     */
+    public function iWantToAddNewExchangeRate(): void
+    {
+        $this->client->buildCreateRequest('exchange_rates');
+    }
+
+    /**
+     * @When /^I want to edit (this exchange rate)$/
+     */
+    public function iWantToEditThisExchangeRate(ExchangeRateInterface $exchangeRate): void
+    {
+        $this->sharedStorage->set('exchangeRateId', $exchangeRate->getId());
+    }
+
+    /**
+     * @When /^I am editing (this exchange rate)$/
+     */
+    public function iAmEditingThisExchangeRate(ExchangeRateInterface $exchangeRate): void
+    {
+        $this->client->buildUpdateRequest('exchange_rates', $exchangeRate->getId());
+    }
+
+    /**
+     * @Given I am browsing exchange rates of the store
+     * @When I browse exchange rates
+     * @When I browse exchange rates of the store
+     */
+    public function iBrowseExchangeRatesOfTheStore(): void
+    {
+        $this->client->index('exchange_rates');
+    }
+
+    /**
+     * @When /^I specify its ratio as (-?[0-9\.]+)$/
+     * @When I don't specify its ratio
+     */
+    public function iSpecifyItsRatioAs(?float $ratio = null): void
+    {
+        if($ratio !== null) {
+            $this->client->addRequestData('ratio', $ratio);
+        }
+    }
+
+    /**
+     * @When I choose :currencyCode as the source currency
+     */
+    public function iChooseAsTheSourceCurrency(string $currencyCode): void
+    {
+        $this->client->addRequestData('sourceCurrency', '/new-api/currencies/'.$currencyCode);
+    }
+
+    /**
+     * @When I choose :currencyCode as the target currency
+     */
+    public function iChooseAsTheTargetCurrency(string $currencyCode): void
+    {
+        $this->client->addRequestData('targetCurrency', '/new-api/currencies/'.$currencyCode);
+    }
+
+    /**
+     * @When I (try to) add it
+     */
+    public function iAddIt(): void
+    {
+        $this->client->create();
+    }
+
+    /**
+     * @When I change ratio to :ratio
+     */
+    public function iChangeRatioTo(string $ratio): void
+    {
+        $this->client->addRequestData('ratio', $ratio);
+    }
+
+    /**
+     * @When I save my changes
+     */
+    public function iSaveMyChanges(): void
+    {
+        $this->client->update();
+    }
+
+    /**
+     * @When I delete the exchange rate between :sourceCurrency and :targetCurrency
+     */
+    public function iDeleteTheExchangeRateBetweenAnd(CurrencyInterface $sourceCurrency, CurrencyInterface $targetCurrency) : void
+    {
+        /** @var ExchangeRateInterface */
+        $exchangeRate = $this->getExchangeRateBetweenCurrencies($sourceCurrency->getCode(), $targetCurrency->getCode());
+
+        $this->client->delete('exchange_rates', $exchangeRate->getId());
+    }
+
+    /**
+     * @When I choose :name as a currency filter
+     */
+    public function iChooseCurrencyAsACurrencyFilter(string $name): void
+    {
+        $this->client->buildUpdateRequest('rating', $name);//TODO
+    }
+
+    /**
+     * @When I filter
+     */
+    public function iFilter(): void
+    {
+        //TODO
+    }
+
+    /**
+     * @When I check (also) the exchange rate between :sourceCurrencyName and :targetCurrencyName
+     */
+    public function iCheckTheExchangeRateBetweenAnd(string $sourceCurrencyName, string $targetCurrencyName): void
+    {
+        // Intentionally left blank to fulfill after handling bulk delete
+    }
+
+    /**
+     * @When I delete them
+     */
+    public function iDeleteThem(): void
+    {
+        // Intentionally left blank to fulfill after handling bulk delete
+    }
+
+    /**
+     * @Then I should see :count exchange rates on the list
+     */
+    public function iShouldSeeExchangeRatesOnTheList(int $count = 0): void
+    {
+        Assert::same($this->client->countCollectionItems(), $count);
+    }
+
+    /**
+     * @Then I should see a single exchange rate in the list
+     * @Then I should( still) see one exchange rate on the list
+     */
+    public function iShouldSeeOneExchangeRateOnTheList(): void
+    {
+        $this->client->index('exchange_rates');
+        Assert::same(count($this->client->getCollection()), 1);
+    }
+
+    /**
+     * @Then the exchange rate with ratio :ratio between :sourceCurrency and :targetCurrency should appear in the store
+     */
+    public function theExchangeRateWithRatioBetweenAndShouldAppearInTheStore(
+        float $ratio,
+        CurrencyInterface $sourceCurrency,
+        CurrencyInterface $targetCurrency
+    ): void {
+        Assert::true(
+            $this->hasExchangeRateFromResponse($ratio, $sourceCurrency, $targetCurrency),
+            sprintf(
+                'Exchange rate with ratio %s between %s and %s does not exist',
+                $ratio,
+                $sourceCurrency->getName(),
+                $targetCurrency->getName()
+            )
+        );
+    }
+
+    /**
+     * @Then I should see the exchange rate between :sourceCurrency and :targetCurrency in the list
+     * @Then I should (also) see an exchange rate between :sourceCurrency and :targetCurrency on the list
+     */
+    public function iShouldSeeTheExchangeRateBetweenAndInTheList(
+        CurrencyInterface $sourceCurrency,
+        CurrencyInterface $targetCurrency
+    ): void {
+        Assert::notNull($this->getExchangeRateFromResponse($sourceCurrency, $targetCurrency));
+    }
+
+    /**
+     * @Then it should have a ratio of :ratio
+     */
+    public function itShouldHaveRatioOf(float $ratio): void
+    {
+        $this->client->index('exchange_rates');
+
+        Assert::true(
+            $this->client->hasItemWithValue('ratio', $ratio),
+            sprintf('ExchangeRate with ratio %s does not exist', $ratio)
+        );
+    }
+
+    /**
+     * @Then /^(this exchange rate) should no longer be on the list$/
+     */
+    public function thisExchangeRateShouldNoLongerBeOnTheList(ExchangeRateInterface $exchangeRate): void
+    {
+        Assert::false(
+            $this->hasExchangeRateFromResponse(
+                $exchangeRate->getRatio(),
+                $exchangeRate->getSourceCurrency(),
+                $exchangeRate->getTargetCurrency()
+            ),
+            sprintf(
+                'Exchange rate with ratio %s between %s and %s still exists',
+                $exchangeRate->getRatio(),
+                $exchangeRate->getSourceCurrency()->getName(),
+                $exchangeRate->getTargetCurrency()->getName()
+            )
+        );
+    }
+
+    /**
+     * @Then the exchange rate between :sourceCurrency and :targetCurrency should not be added
+     */
+    public function theExchangeRateBetweenAndShouldNotBeAdded(
+        CurrencyInterface $sourceCurrency,
+        CurrencyInterface $targetCurrency
+    ): void {
+        $this->client->index('exchange_rates');
+
+        Assert::null($this->getExchangeRateFromResponse($sourceCurrency, $targetCurrency));
+    }
+
+    /**
+     * @Then /^(this exchange rate) should have a ratio of ([0-9\.]+)$/
+     */
+    public function thisExchangeRateShouldHaveARatioOf(ExchangeRateInterface $exchangeRate, string $ratio): void
+    {
+        $exchangeRate = $this->getExchangeRateFromResponse(
+            $exchangeRate->getSourceCurrency(),
+            $exchangeRate->getTargetCurrency()
+        );
+
+        $exchangeRate['ratio'] = $ratio;
+    }
+
+    /**
+     * @Then I should not be able to edit its source currency
+     */
+    public function iShouldNotBeAbleToEditItsSourceCurrency(): void
+    {
+        $this->client->buildUpdateRequest('exchange_rates', $this->sharedStorage->get('exchangeRateId'));
+
+        $this->client->addRequestData('sourceCurrency', '/new-api/currencies/EUR');
+        $this->client->update();
+
+        $this->client->index('exchange_rates');
+        Assert::false(
+            $this->client->hasItemOnPositionWithValue(0,'sourceCurrency', '/new-api/currencies/EUR'),
+            'The sourceCurrency field with value \'/new-api/currencies/EUR\' exists'
+        );
+    }
+
+    /**
+     * @Then I should not be able to edit its target currency
+     */
+    public function iShouldNotBeAbleToEditItsTargetCurrency(): void
+    {
+        $this->client->buildUpdateRequest('exchange_rates', $this->sharedStorage->get('exchangeRateId'));
+
+        $this->client->addRequestData('targetCurrency', '/new-api/currencies/EUR');
+        $this->client->update();
+
+        $this->client->index('exchange_rates');
+        Assert::false(
+            $this->client->hasItemOnPositionWithValue(0, 'targetCurrency', '/new-api/currencies/EUR'),
+            'The targetCurrency field with value \'/new-api/currencies/EUR\' exists'
+        );
+    }
+
+    /**
+     * @Then I should be notified that :element is required
+     */
+    public function iShouldBeNotifiedThatIsRequired(string $element): void
+    {
+        Assert::contains($this->client->getError(), sprintf('%s: Please enter exchange rate %s.', $element, $element));
+    }
+
+    /**
+     * @Then I should be notified that the ratio must be greater than zero
+     */
+    public function iShouldBeNotifiedThatRatioMustBeGreaterThanZero(): void
+    {
+        Assert::contains($this->client->getError(), 'The ratio must be greater than 0.');
+    }
+
+    /**
+     * @Then I should be notified that source and target currencies must differ
+     */
+    public function iShouldBeNotifiedThatSourceAndTargetCurrenciesMustDiffer(): void
+    {
+        Assert::contains($this->client->getError(), 'The source and target currencies must differ.');
+    }
+
+    /**
+     * @Then I should be notified that the currency pair must be unique
+     */
+    public function iShouldBeNotifiedThatTheCurrencyPairMustBeUnique(): void
+    {
+        Assert::contains($this->client->getError(), 'The currency pair must be unique.');
+    }
+
+    /**
+     * @Then I should be notified that they have been successfully deleted
+     */
+    public function iShouldBeNotifiedThatTheyHaveBeenSuccessfullyDeleted(): void
+    {
+        // Intentionally left blank to fulfill after handling bulk delete
+    }
+
+    private function getExchangeRateBetweenCurrencies(string $sourceCode, string $targetCode): ExchangeRateInterface
+    {
+        /** @var ExchangeRateInterface|null */
+        $exchangeRate = $this->exchangeRateRepository->findOneWithCurrencyPair($sourceCode, $targetCode);
+
+        Assert::notNull($exchangeRate);
+
+        return $exchangeRate;
+    }
+
+    private function getExchangeRateFromResponse(
+        CurrencyInterface $sourceCurrency,
+        CurrencyInterface $targetCurrency
+    ): ?array {
+        $this->client->index('exchange_rates');
+
+        /** @var array $item */
+        foreach ($this->client->getCollection() as $item)
+        {
+            if (
+                $item['sourceCurrency'] === '/new-api/currencies/'.$sourceCurrency->getCode() &&
+                $item['targetCurrency'] === '/new-api/currencies/'.$targetCurrency->getCode()
+            ) {
+                return $item;
+            }
+        }
+
+        return null;
+    }
+
+    private function hasExchangeRateFromResponse(
+        float $ratio,
+        CurrencyInterface $sourceCurrency,
+        CurrencyInterface $targetCurrency
+    ): bool {
+        return $this->getExchangeRateFromResponse($sourceCurrency, $targetCurrency)['ratio'] === $ratio ? true : false;
+    }
+}

src/Sylius/Behat/Context/Ui/Admin/ManagingExchangeRatesContext.php

@@ -250,17 +250,17 @@ final class ManagingExchangeRatesContext implements Context
     }
 
     /**
-     * @Then I should see that the source currency is disabled
+     * @Then I should not be able to edit its source currency
      */
-    public function iShouldSeeThatTheSourceCurrencyIsDisabled()
+    public function iShouldNotBeAbleToEditItsSourceCurrency(): void
     {
         Assert::true($this->updatePage->isSourceCurrencyDisabled());
     }
 
     /**
-     * @Then I should see that the target currency is disabled
+     * @Then I should not be able to edit its target currency
      */
-    public function iShouldSeeThatTheTargetCurrencyIsDisabled()
+    public function iShouldNotBeAbleToEditItsTargetCurrency(): void
     {
         Assert::true($this->updatePage->isTargetCurrencyDisabled());
     }