#77 - Create Cookies trait (#79)

* Create Cookies trait

* csf

* Apply suggestions from code review

Co-authored-by: Jakub Kermes <[email protected]>

* Suggestion from code review to ensure that exostomg request is also used for accesing the cookies

* @when cookie :name with value :value is set

* deleteCookie() changes

---------

Co-authored-by: Jakub Kermes <[email protected]>

src/Features/Cookies.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Blumilk\BLT\Features;
+
+use Behat\Behat\Context\Context;
+use Blumilk\BLT\Features\Traits\Cookies as CookiesTrait;
+
+class Cookies implements Context
+{
+    use CookiesTrait;
+}

src/Features/Toolbox.php

@@ -8,6 +8,7 @@
 use Blumilk\BLT\Features\Traits\Application;
 use Blumilk\BLT\Features\Traits\Authentication;
 use Blumilk\BLT\Features\Traits\Console;
+use Blumilk\BLT\Features\Traits\Cookies;
 use Blumilk\BLT\Features\Traits\Database;
 use Blumilk\BLT\Features\Traits\Dispatcher;
 use Blumilk\BLT\Features\Traits\Eloquent;
@@ -36,4 +37,5 @@ class Toolbox implements Context
     use Translations;
     use View;
     use Notification;
+    use Cookies;
 }

src/Features/Traits/Cookies.php

@@ -0,0 +1,70 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Blumilk\BLT\Features\Traits;
+
+use Behat\Gherkin\Node\TableNode;
+use Illuminate\Contracts\Cookie\QueueingFactory as CookieFactory;
+use PHPUnit\Framework\Assert;
+
+trait Cookies
+{
+    use Application;
+    use HttpRequest;
+
+    /**
+     * @When cookie :name with value :value is set
+     * @When cookie named :name with value :value is created
+     * @When cookie :name with value :value is added
+     */
+    public function setCookie(string $name, string $value): void
+    {
+        $cookieFactory = $this->getContainer()->make(CookieFactory::class);
+        $cookieFactory->queue($name, $value);
+    }
+
+    /**
+     * @Then cookie :name should have value :value
+     * @Then the cookie :name should contain value :value
+     * @Then the cookie named :name should have the value :value
+     */
+    public function assertCookieValue(string $name, string $value): void
+    {
+        $cookieValue = $this->request->cookies->get($name);
+        Assert::assertEquals($value, $cookieValue, "Cookie $name does not have the expected value $value.");
+    }
+
+    /**
+     * @When cookie :name is deleted
+     * @When cookie :name is removed
+     * @When cookie :name is cleared
+     */
+    public function deleteCookie(string $name): void
+    {
+        $cookieFactory = $this->getContainer()->make(CookieFactory::class);
+        $cookieFactory->queue($cookieFactory->forget($name));
+    }
+
+    /**
+     * @Then the cookie :name should be missing
+     * @Then the cookie named :name should not be present
+     */
+    public function assertCookieNotExists(string $name): void
+    {
+        $cookieValue = $this->request->cookies->get($name);
+        Assert::assertNull($cookieValue, "Cookie $name should not exist.");
+    }
+
+    /**
+     * @Then the following cookies should be present:
+     * @Then the cookies should be set to:
+     */
+    public function assertCookiesExist(TableNode $table): void
+    {
+        foreach ($table as $row) {
+            $cookieValue = $this->request->cookies->get($row["name"]);
+            Assert::assertEquals($row["value"], $cookieValue, "Cookie {$row["name"]} does not have the expected value {$row["value"]}.");
+        }
+    }
+}

src/Features/Traits/HttpRequest.php

@@ -76,16 +76,6 @@ public function requestQueryParamsContains(TableNode $table): void
         }
     }
 
-    /**
-     * @Given request cookies contains:
-     */
-    public function requestCookiesContains(TableNode $table): void
-    {
-        foreach ($table as $row) {
-            $this->request->cookies->set($row["key"], $row["value"]);
-        }
-    }
-
     /**
      * @Given request server params contains:
      */

src/Features/Traits/HttpResponse.php

@@ -79,17 +79,6 @@ public function aResponseShouldContainJsonFragment(TableNode $table): void
         }
     }
 
-    /**
-     * @Then the response should have cookie :name
-     */
-    public function aResponseShouldHaveCookie(string $name): void
-    {
-        Assert::assertTrue($this->response->headers->has("Set-Cookie"));
-        $cookies = $this->response->headers->getCookies();
-        $cookieNames = array_map(fn($cookie) => $cookie->getName(), $cookies);
-        Assert::assertContains($name, $cookieNames);
-    }
-
     /**
      * @Then the response should have header :header
      */