Add basic support for reading and clearing cookies

Goodie01 · Jun 24, 2024 · 6c1a06b · 6c1a06b
1 parent 464a7a2
commit 6c1a06b
Show file tree

Hide file tree

Showing 5 changed files with 222 additions and 0 deletions.
diff --git a/examples/src/test/java/org/goodiemania/melinoe/samples/standard/MozillaTest.java b/examples/src/test/java/org/goodiemania/melinoe/samples/standard/MozillaTest.java
@@ -31,5 +31,6 @@ public void run() {
 
         mozillaManifestopage.checkPage();
         mozillaManifestopage.validateSubtitle();
+        session.web().cookies().forEach((s, cookie) -> System.out.println(s + ": " + cookie.getValue()));
     }
 }
diff --git a/framework/src/main/java/nz/geek/goodwin/melinoe/framework/api/web/Cookie.java b/framework/src/main/java/nz/geek/goodwin/melinoe/framework/api/web/Cookie.java
@@ -0,0 +1,44 @@
+package nz.geek.goodwin.melinoe.framework.api.web;
+
+import java.util.Date;
+
+/**
+ * @author Goodie
+ */
+public interface Cookie {
+    static Cookie create() {
+        return new CookieImpl();
+    }
+
+    String getName();
+
+    Cookie setName(String name);
+
+    String getValue();
+
+    Cookie setValue(String value);
+
+    String getPath();
+
+    Cookie setPath(String path);
+
+    String getDomain();
+
+    Cookie setDomain(String domain);
+
+    Date getExpiry();
+
+    Cookie setExpiry(Date expiry);
+
+    boolean isSecure();
+
+    Cookie setSecure(boolean secure);
+
+    boolean isHttpOnly();
+
+    Cookie setHttpOnly(boolean httpOnly);
+
+    String getSameSite();
+
+    Cookie setSameSite(String sameSite);
+}
diff --git a/framework/src/main/java/nz/geek/goodwin/melinoe/framework/api/web/CookieImpl.java b/framework/src/main/java/nz/geek/goodwin/melinoe/framework/api/web/CookieImpl.java
@@ -0,0 +1,137 @@
+package nz.geek.goodwin.melinoe.framework.api.web;
+
+import java.util.Date;
+import java.util.Objects;
+
+/**
+ * @author Goodie
+ */
+public final class CookieImpl implements Cookie {
+    private String name;
+    private String value;
+    private String path;
+    private String domain;
+    private Date expiry;
+    private boolean isSecure;
+    private boolean isHttpOnly;
+    private String sameSite;
+
+    public CookieImpl() {
+    }
+
+    public CookieImpl(org.openqa.selenium.Cookie cookie) {
+        this.name = cookie.getName();
+        this.value = cookie.getValue();
+        this.path = cookie.getPath();
+        this.domain = cookie.getDomain();
+        this.expiry = cookie.getExpiry();
+        this.isSecure = cookie.isSecure();
+        this.isHttpOnly = cookie.isHttpOnly();
+        this.sameSite = cookie.getSameSite();
+    }
+
+    @Override
+    public String getName() {
+        return name;
+    }
+
+    @Override
+    public Cookie setName(String name) {
+        this.name = name;
+        return this;
+    }
+
+    @Override
+    public String getValue() {
+        return value;
+    }
+
+    @Override
+    public Cookie setValue(String value) {
+        this.value = value;
+        return this;
+    }
+
+    @Override
+    public String getPath() {
+        return path;
+    }
+
+    @Override
+    public Cookie setPath(String path) {
+        this.path = path;
+        return this;
+    }
+
+    @Override
+    public String getDomain() {
+        return domain;
+    }
+
+    @Override
+    public Cookie setDomain(String domain) {
+        this.domain = domain;
+        return this;
+    }
+
+    @Override
+    public Date getExpiry() {
+        return expiry;
+    }
+
+    @Override
+    public Cookie setExpiry(Date expiry) {
+        this.expiry = expiry;
+        return this;
+    }
+
+    @Override
+    public boolean isSecure() {
+        return isSecure;
+    }
+
+    @Override
+    public Cookie setSecure(boolean secure) {
+        isSecure = secure;
+        return this;
+    }
+
+    @Override
+    public boolean isHttpOnly() {
+        return isHttpOnly;
+    }
+
+    @Override
+    public Cookie setHttpOnly(boolean httpOnly) {
+        isHttpOnly = httpOnly;
+        return this;
+    }
+
+    @Override
+    public String getSameSite() {
+        return sameSite;
+    }
+
+    @Override
+    public Cookie setSameSite(String sameSite) {
+        this.sameSite = sameSite;
+        return this;
+    }
+    @Override
+    public boolean equals(Object other) {
+        if (this == other) {
+            return true;
+        }
+
+        if (other instanceof Cookie otherCookie) {
+            return name.equals(otherCookie.getName());
+        } else {
+            return false;
+        }
+    }
+
+    @Override
+    public int hashCode() {
+        return name.hashCode();
+    }
+}
diff --git a/framework/src/main/java/nz/geek/goodwin/melinoe/framework/api/web/WebDriver.java b/framework/src/main/java/nz/geek/goodwin/melinoe/framework/api/web/WebDriver.java
@@ -4,6 +4,7 @@
 
 import java.util.Arrays;
 import java.util.List;
+import java.util.Map;
 import java.util.function.Predicate;
 
 /**
@@ -24,6 +25,14 @@ public interface WebDriver {
 
     List<WebElement> findElements(By by);
 
+    void clearCookie(String name);
+
+    void clearCookie(Cookie cookie);
+
+    void clearAll();
+
+    Map<String, Cookie> cookies();
+
     void verify(final List<WebValidator> validators);
 
     default void verify(final WebValidator... validators) {

diff --git a/framework/src/main/java/nz/geek/goodwin/melinoe/framework/internal/web/WebDriverImpl.java b/framework/src/main/java/nz/geek/goodwin/melinoe/framework/internal/web/WebDriverImpl.java
@@ -4,6 +4,8 @@
 import nz.geek.goodwin.melinoe.framework.api.Session;
 import nz.geek.goodwin.melinoe.framework.api.log.Logger;
 import nz.geek.goodwin.melinoe.framework.api.web.By;
+import nz.geek.goodwin.melinoe.framework.api.web.Cookie;
+import nz.geek.goodwin.melinoe.framework.api.web.CookieImpl;
 import nz.geek.goodwin.melinoe.framework.api.web.Navigate;
 import nz.geek.goodwin.melinoe.framework.api.web.validation.ValidationResult;
 import nz.geek.goodwin.melinoe.framework.api.web.WebDriver;
@@ -21,6 +23,8 @@
 import java.time.Duration;
 import java.time.Instant;
 import java.util.List;
+import java.util.Map;
+import java.util.function.Function;
 import java.util.function.Predicate;
 import java.util.stream.Collectors;
 
@@ -120,6 +124,33 @@ public List<WebElement> findElements(By by) {
         return new WebElementListImpl(remoteWebDriver, screenshotTaker, pageCheckStatus, logger, by);
     }
 
+    @Override
+    public void clearCookie(String name) {
+        remoteWebDriver.manage().getCookieNamed(name);
+    }
+
+    @Override
+    public void clearCookie(Cookie cookie) {
+        remoteWebDriver.manage().getCookieNamed(cookie.getName());
+    }
+
+    @Override
+    public void clearAll() {
+        remoteWebDriver.manage().deleteAllCookies();
+    }
+
+    @Override
+    public Map<String, Cookie> cookies() {
+        if(!pageCheckStatus.check()) {
+            throw new MelinoeException("Please check run at least one validator before interacting with a pages cookies.");
+        }
+
+        return remoteWebDriver.manage().getCookies()
+                .stream()
+                .map(CookieImpl::new)
+                .collect(Collectors.toMap(CookieImpl::getName, Function.identity()));
+    }
+
     @Override
     public void verify(List<WebValidator> validators) {
         Logger verifyingLogger;