Add AllCookies functionality and tests.

Author: heraclmene

remote_driver_cookie.go

@@ -0,0 +1,44 @@
+package goselenium
+
+import (
+	"encoding/json"
+	"fmt"
+)
+
+// AllCookiesResponse is the response returned from the AllCookies method.
+type AllCookiesResponse struct {
+	State   string   `json:"state"`
+	Cookies []Cookie `json:"value"`
+}
+
+// Cookie represents a browser cookie.
+type Cookie struct {
+	Name       string `json:"name"`
+	Value      string `json:"value"`
+	Path       string `json:"path"`
+	Domain     string `json:"domain"`
+	SecureOnly bool   `json:"secure"`
+	HTTPOnly   bool   `json:"httpOnly"`
+}
+
+func (s *seleniumWebDriver) AllCookies() (*AllCookiesResponse, error) {
+	if len(s.sessionID) == 0 {
+		return nil, newSessionIDError("AllCookies")
+	}
+
+	var response AllCookiesResponse
+	var err error
+	url := fmt.Sprintf("%s/session/%s/cookie", s.seleniumURL, s.sessionID)
+
+	resp, err := s.apiService.performRequest(url, "GET", nil)
+	if err != nil {
+		return nil, newCommunicationError(err, "AllCookies", url, nil)
+	}
+
+	err = json.Unmarshal(resp, &response)
+	if err != nil {
+		return nil, newUnmarshallingError(err, "AllCookies", string(resp))
+	}
+
+	return &response, nil
+}

remote_driver_cookie_test.go

@@ -0,0 +1,80 @@
+package goselenium
+
+import (
+	"errors"
+	"testing"
+)
+
+func Test_CookieAllCookies_InvalidSessionIdResultsInError(t *testing.T) {
+	api := &testableAPIService{
+		jsonToReturn:  "",
+		errorToReturn: nil,
+	}
+
+	d := setUpDriver(setUpDefaultCaps(), api)
+	_, err := d.AllCookies()
+	if err == nil || !IsSessionIDError(err) {
+		t.Errorf(sessionIDErrorText)
+	}
+}
+
+func Test_CookieAllCookies_CommunicationErrorIsReturnedCorrectly(t *testing.T) {
+	api := &testableAPIService{
+		jsonToReturn:  "",
+		errorToReturn: errors.New("An error :<"),
+	}
+
+	d := setUpDriver(setUpDefaultCaps(), api)
+	d.sessionID = "12345"
+
+	_, err := d.AllCookies()
+	if err == nil || !IsCommunicationError(err) {
+		t.Errorf(apiCommunicationErrorText)
+	}
+}
+
+func Test_CookieAllCookies_UnmarshallingErrorIsReturnedCorrectly(t *testing.T) {
+	api := &testableAPIService{
+		jsonToReturn:  "Invalid JSON!",
+		errorToReturn: nil,
+	}
+
+	d := setUpDriver(setUpDefaultCaps(), api)
+	d.sessionID = "12345"
+
+	_, err := d.AllCookies()
+	if err == nil || !IsUnmarshallingError(err) {
+		t.Errorf(unmarshallingErrorText)
+	}
+}
+
+func Test_CookieAllCookies_CorrectResponseIsReturned(t *testing.T) {
+	api := &testableAPIService{
+		jsonToReturn: `{
+			"state": "success",
+			"value": [
+				{
+					"name": "Test Cookie",
+					"value": "Test Value",
+					"path": "/",
+					"domain": "www.google.com",
+					"secure": true,
+					"httpOnly": true,
+					"expiry": "2016-12-25T00:00:00Z"
+				}
+			]
+		}`,
+		errorToReturn: nil,
+	}
+
+	d := setUpDriver(setUpDefaultCaps(), api)
+	d.sessionID = "12345"
+
+	resp, err := d.AllCookies()
+	if err != nil || resp.State != "success" || resp.Cookies[0].Name != "Test Cookie" ||
+		resp.Cookies[0].Value != "Test Value" || resp.Cookies[0].Path != "/" ||
+		resp.Cookies[0].Domain != "www.google.com" || !resp.Cookies[0].SecureOnly ||
+		!resp.Cookies[0].HTTPOnly {
+		t.Errorf(correctResponseErrorText)
+	}
+}

test/integration_tests/cookie_allcookies_test.go

@@ -0,0 +1,26 @@
+package integrationtests
+
+import "testing"
+
+func Test_CookieAllCookies_CanRetrieveAllCookiesFromWebPage(t *testing.T) {
+	setUp()
+	defer tearDown()
+
+	driver := createDriver(t)
+	_, err := driver.CreateSession()
+	if err != nil {
+		errorAndWrap(t, "Error thrown whilst creating session.", err)
+	}
+
+	_, err = driver.Go("https://news.ycombinator.com")
+	if err != nil {
+		errorAndWrap(t, "Error was thrown whilst navigating or result was not a success.", err)
+	}
+
+	resp, err := driver.AllCookies()
+	if err != nil || resp.State != "success" || resp.Cookies[0].Name == "" {
+		errorAndWrap(t, "Error was thrown whilst retrieving cookies", err)
+	}
+
+	printObjectResult(resp)
+}

web_driver.go

@@ -186,6 +186,14 @@ type WebDriver interface {
 	//		doLongWindedTask();
 	//		callback();
 	ExecuteScriptAsync(script string) (*ExecuteScriptResponse, error)
+
+	/*
+		COOKIE METHODS
+	*/
+
+	// AllCookies returns all cookies associated with the active URL of the
+	// current browsing context.
+	AllCookies() (*AllCookiesResponse, error)
 }
 
 // Element is an interface which specifies what all WebDriver elements