Fix Psalm errors in Behat files

psalm.xml

@@ -15,7 +15,6 @@
         <directory name="tests"/>
         <ignoreFiles>
             <directory name="tests/Application"/>
-            <directory name="tests/Behat"/>
             <directory name="vendor"/>
         </ignoreFiles>
     </projectFiles>

tests/Behat/Context/Setup/ProductCalloutContext.php

@@ -14,31 +14,16 @@
 use Sylius\Component\Core\Model\ChannelInterface;
 use Sylius\Component\Core\Model\TaxonInterface;
 use Sylius\Component\Resource\Factory\FactoryInterface;
+use Webmozart\Assert\Assert;
 
 final class ProductCalloutContext implements Context
 {
-    /** @var CalloutRuleFactoryInterface */
-    private $calloutRuleFactory;
-
-    /** @var FactoryInterface */
-    private $calloutFactory;
-
-    /** @var ObjectManager */
-    private $objectManager;
-
-    /** @var SharedStorageInterface */
-    private $sharedStorage;
-
     public function __construct(
-        CalloutRuleFactoryInterface $calloutRuleFactory,
-        FactoryInterface $calloutFactory,
-        ObjectManager $objectManager,
-        SharedStorageInterface $sharedStorage,
+        private readonly CalloutRuleFactoryInterface $calloutRuleFactory,
+        private readonly FactoryInterface $calloutFactory,
+        private readonly ObjectManager $objectManager,
+        private readonly SharedStorageInterface $sharedStorage,
     ) {
-        $this->calloutRuleFactory = $calloutRuleFactory;
-        $this->calloutFactory = $calloutFactory;
-        $this->objectManager = $objectManager;
-        $this->sharedStorage = $sharedStorage;
     }
 
     /**
@@ -111,24 +96,37 @@ private function createCallout(string $name, string $html, ChannelInterface $cha
         $callout = $this->calloutFactory->createNew();
         $this->sharedStorage->set('callout', $callout);
 
-        if (null === $channel && $this->sharedStorage->has('channel')) {
-            $channel = $this->sharedStorage->get('channel');
+        $channel = $channel ?? $this->getChannel();
+
+        if (null !== $channel) {
+            $callout->addChannel($channel);
+
+            foreach ($channel->getLocales() as $locale) {
+                $callout->setCurrentLocale((string) $locale->getCode());
+                $callout->setFallbackLocale((string) $locale->getCode());
+
+                $callout->setName($name);
+                $callout->setText($html);
+            }
         }
 
         $callout->setCode(StringInflector::nameToCode($name));
-        $callout->setPosition(CalloutInterface::POSITION_TOP_LEFT);
+        $callout->setPosition('top_left');
         $callout->setPriority(0);
-        $callout->addChannel($channel);
         $callout->setEnabled(true);
 
-        foreach ($channel->getLocales() as $locale) {
-            $callout->setCurrentLocale($locale->getCode());
-            $callout->setFallbackLocale($locale->getCode());
+        return $callout;
+    }
 
-            $callout->setName($name);
-            $callout->setText($html);
+    private function getChannel(): ?ChannelInterface
+    {
+        if (!$this->sharedStorage->has('channel')) {
+            return null;
         }
 
-        return $callout;
+        $channel = $this->sharedStorage->get('channel');
+        Assert::isInstanceOf($channel, ChannelInterface::class);
+
+        return $channel;
     }
 }

tests/Behat/Context/Transform/CalloutContext.php

@@ -5,27 +5,26 @@
 namespace Tests\Setono\SyliusCalloutPlugin\Behat\Context\Transform;
 
 use Behat\Behat\Context\Context;
+use Setono\SyliusCalloutPlugin\Model\CalloutInterface;
 use Setono\SyliusCalloutPlugin\Repository\CalloutRepositoryInterface;
 use Webmozart\Assert\Assert;
 
 final class CalloutContext implements Context
 {
-    /** @var CalloutRepositoryInterface */
-    private $calloutRepository;
-
-    public function __construct(CalloutRepositoryInterface $calloutRepository)
+    public function __construct(private readonly CalloutRepositoryInterface $calloutRepository)
     {
-        $this->calloutRepository = $calloutRepository;
     }
 
     /**
      * @Transform /^callout "([^"]+)"$/
      * @Transform /^"([^"]+)" callout/
      * @Transform :callout
      */
-    public function getCalloutByName($calloutName)
+    public function getCalloutByName(string $calloutName): CalloutInterface
     {
-        $callouts = $this->calloutRepository->findByName($calloutName);
+        $callouts = $this->calloutRepository->findBy([
+            'name' => $calloutName,
+        ]);
 
         Assert::eq(
             count($callouts),
@@ -35,12 +34,4 @@ public function getCalloutByName($calloutName)
 
         return $callouts[0];
     }
-
-    /**
-     * @Transform all callouts
-     */
-    public function getAllChannels()
-    {
-        return $this->channelRepository->findAll();
-    }
 }

tests/Behat/Context/Ui/Admin/ProductCalloutContext.php

@@ -11,17 +11,10 @@
 
 final class ProductCalloutContext implements Context
 {
-    /** @var CreatePageInterface */
-    private $createPage;
-
-    private $notificationChecker;
-
     public function __construct(
-        CreatePageInterface $createPage,
-        NotificationCheckerInterface $notificationChecker,
+        private readonly CreatePageInterface $createPage,
+        private readonly NotificationCheckerInterface $notificationChecker,
     ) {
-        $this->createPage = $createPage;
-        $this->notificationChecker = $notificationChecker;
     }
 
     /**
@@ -80,22 +73,14 @@ public function iNameItIn(string $name): void
         $this->createPage->fillName($name);
     }
 
-    /**
-     * @When I fill the html with :html
-     */
-    public function iFillTheHtmlWith(string $html): void
-    {
-        $this->createPage->fillHtml($html);
-    }
-
     /**
      * @When I add the "Has taxon" rule configured with :arg2 and :arg3
      */
-    public function iAddTheRuleConfiguredWithAnd(...$taxons): void
+    public function iAddTheRuleConfiguredWithAnd(string ...$taxons): void
     {
         $this->createPage->addRule('Has taxon');
 
-        $this->createPage->selectAutocompleteRuleOption('taxons', $taxons, true);
+        $this->createPage->selectAutocompleteRuleOption('taxons', $taxons);
     }
 
     /**
@@ -111,15 +96,15 @@ public function iAddTheRuleConfiguredWithTheProduct(string $productName): void
     /**
      * @When I add it
      */
-    public function iAddIt()
+    public function iAddIt(): void
     {
         $this->createPage->create();
     }
 
     /**
      * @Then I should be notified that it has been successfully created
      */
-    public function iShouldBeNotifiedThatItHasBeenSuccessfullyCreated()
+    public function iShouldBeNotifiedThatItHasBeenSuccessfullyCreated(): void
     {
         $this->notificationChecker->checkNotification('has been successfully created.', NotificationType::success());
     }

tests/Behat/Context/Ui/Shop/ProductContext.php

@@ -5,39 +5,28 @@
 namespace Tests\Setono\SyliusCalloutPlugin\Behat\Context\Ui\Shop;
 
 use Behat\Behat\Context\Context;
-use Setono\SyliusCalloutPlugin\Model\CalloutInterface;
 use Setono\SyliusCalloutPlugin\Repository\CalloutRepositoryInterface;
 use Sylius\Component\Core\Formatter\StringInflector;
 use Tests\Setono\SyliusCalloutPlugin\Behat\Page\Shop\Product\IndexPageInterface;
 use Webmozart\Assert\Assert;
 
 final class ProductContext implements Context
 {
-    /** @var IndexPageInterface */
-    private $indexPage;
-
-    /** @var CalloutRepositoryInterface */
-    private $calloutRepository;
-
     public function __construct(
-        IndexPageInterface $indexPage,
-        CalloutRepositoryInterface $calloutRepository,
+        private readonly IndexPageInterface $indexPage,
+        private readonly CalloutRepositoryInterface $calloutRepository,
     ) {
-        $this->indexPage = $indexPage;
-        $this->calloutRepository = $calloutRepository;
     }
 
     /**
      * @Then I should see :count products with callout :name
      * @Then I should see :count product with callout :name
      */
-    public function iShouldSeeProductsWithProductCallout(int $count, string $name)
+    public function iShouldSeeProductsWithProductCallout(int $count, string $name): void
     {
-        /** @var CalloutInterface $callout */
-        $callout = $this->calloutRepository->findOneBy([
-            'code' => StringInflector::nameToCode($name),
-        ]);
+        $callout = $this->calloutRepository->findOneByCode(StringInflector::nameToCode($name));
 
-        Assert::same($this->indexPage->countProductsWithCallouts(strip_tags($callout->getText())), $count);
+        Assert::notNull($callout);
+        Assert::same($this->indexPage->countProductsWithCallouts(strip_tags((string) $callout->getText())), $count);
     }
 }

tests/Behat/Page/Admin/ProductCallout/CreatePage.php

@@ -54,28 +54,28 @@ public function addRule(string $ruleName): void
         $this->selectRuleOption('Type', $ruleName);
     }
 
-    public function selectAutocompleteRuleOption(string $option, $value, bool $multiple = false): void
+    public function selectAutocompleteRuleOption(string $option, array|string $value): void
     {
         $option = strtolower(str_replace(' ', '_', $option));
 
         $ruleAutocomplete = $this
             ->getLastCollectionItem('rules')
             ->find('css', sprintf('input[type="hidden"][name*="[%s]"]', $option))
-            ->getParent()
+            ?->getParent()
         ;
 
-        if ($multiple && is_array($value)) {
-            AutocompleteHelper::chooseValues($this->getSession(), $ruleAutocomplete, $value);
+        Assert::notNull($ruleAutocomplete, sprintf('Could not find autocomplete for option "%s"', $option));
 
-            return;
+        if (is_array($value)) {
+            AutocompleteHelper::chooseValues($this->getSession(), $ruleAutocomplete, $value);
+        } else {
+            AutocompleteHelper::chooseValue($this->getSession(), $ruleAutocomplete, $value);
         }
-
-        AutocompleteHelper::chooseValue($this->getSession(), $ruleAutocomplete, $value);
     }
 
     public function selectRuleOption(string $option, string $value, bool $multiple = false): void
     {
-        $this->getLastCollectionItem('rules')->find('named', ['select', $option])->selectOption($value, $multiple);
+        $this->getLastCollectionItem('rules')->find('named', ['select', $option])?->selectOption($value, $multiple);
     }
 
     protected function getDefinedElements(): array
@@ -85,13 +85,12 @@ protected function getDefinedElements(): array
         ];
     }
 
+    /**
+     * @return NodeElement[]
+     */
     private function getCollectionItems(string $collection): array
     {
-        $items = $this->getElement($collection)->findAll('css', 'div[data-form-collection="item"]');
-
-        Assert::isArray($items);
-
-        return $items;
+        return $this->getElement($collection)->findAll('css', 'div[data-form-collection="item"]');
     }
 
     private function getLastCollectionItem(string $collection): NodeElement

tests/Behat/Page/Admin/ProductCallout/CreatePageInterface.php

@@ -22,5 +22,8 @@ public function fillName(string $name): void;
 
     public function addRule(string $ruleName): void;
 
-    public function selectAutocompleteRuleOption(string $option, $value, bool $multiple = false): void;
+    /**
+     * @param string[]|string $value
+     */
+    public function selectAutocompleteRuleOption(string $option, array|string $value): void;
 }