Add DeleteCookie functionality and tests.

Author: heraclmene

remote_driver_cookie.go

@@ -33,6 +33,12 @@ type AddCookieResponse struct {
 	State string
 }
 
+// DeleteCookieResponse is the result returned from calling the DeleteCookie
+// method.
+type DeleteCookieResponse struct {
+	State string
+}
+
 func (s *seleniumWebDriver) AllCookies() (*AllCookiesResponse, error) {
 	if len(s.sessionID) == 0 {
 		return nil, newSessionIDError("AllCookies")
@@ -95,6 +101,7 @@ func (s *seleniumWebDriver) AddCookie(c *Cookie) (*AddCookieResponse, error) {
 	if err != nil {
 		return nil, newMarshallingError(err, "AddCookie", c)
 	}
+
 	body := bytes.NewReader(b)
 	resp, err := s.stateRequest(&request{
 		url:           url,
@@ -108,3 +115,25 @@ func (s *seleniumWebDriver) AddCookie(c *Cookie) (*AddCookieResponse, error) {
 
 	return &AddCookieResponse{State: resp.State}, nil
 }
+
+func (s *seleniumWebDriver) DeleteCookie(name string) (*DeleteCookieResponse, error) {
+	if len(s.sessionID) == 0 {
+		return nil, newSessionIDError("DeleteCookie")
+	}
+
+	var err error
+
+	url := fmt.Sprintf("%s/session/%s/cookie/%s", s.seleniumURL, s.sessionID, name)
+
+	resp, err := s.stateRequest(&request{
+		url:           url,
+		body:          nil,
+		method:        "DELETE",
+		callingMethod: "DeleteCookie",
+	})
+	if err != nil {
+		return nil, err
+	}
+
+	return &DeleteCookieResponse{State: resp.State}, nil
+}

remote_driver_cookie_test.go

@@ -206,16 +206,7 @@ func Test_CookieAddCookie_UnmarshallingErrorIsReturnedCorrectly(t *testing.T) {
 func Test_CookieAddCookie_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"
-			}
+			"state": "success"
 		}`,
 		errorToReturn: nil,
 	}
@@ -228,3 +219,66 @@ func Test_CookieAddCookie_CorrectResponseIsReturned(t *testing.T) {
 		t.Errorf(correctResponseErrorText)
 	}
 }
+
+/*
+	DeleteCookie tests
+*/
+func Test_CookieDeleteCookie_InvalidSessionIdResultsInError(t *testing.T) {
+	api := &testableAPIService{
+		jsonToReturn:  "",
+		errorToReturn: nil,
+	}
+
+	d := setUpDriver(setUpDefaultCaps(), api)
+	_, err := d.DeleteCookie("")
+	if err == nil || !IsSessionIDError(err) {
+		t.Errorf(sessionIDErrorText)
+	}
+}
+
+func Test_CookieDeleteCookie_CommunicationErrorIsReturnedCorrectly(t *testing.T) {
+	api := &testableAPIService{
+		jsonToReturn:  "",
+		errorToReturn: errors.New("An error :<"),
+	}
+
+	d := setUpDriver(setUpDefaultCaps(), api)
+	d.sessionID = "12345"
+
+	_, err := d.DeleteCookie("")
+	if err == nil || !IsCommunicationError(err) {
+		t.Errorf(apiCommunicationErrorText)
+	}
+}
+
+func Test_CookieDeleteCookie_UnmarshallingErrorIsReturnedCorrectly(t *testing.T) {
+	api := &testableAPIService{
+		jsonToReturn:  "Invalid JSON!",
+		errorToReturn: nil,
+	}
+
+	d := setUpDriver(setUpDefaultCaps(), api)
+	d.sessionID = "12345"
+
+	_, err := d.DeleteCookie("")
+	if err == nil || !IsUnmarshallingError(err) {
+		t.Errorf(unmarshallingErrorText)
+	}
+}
+
+func Test_CookieDeleteCookie_CorrectResponseIsReturned(t *testing.T) {
+	api := &testableAPIService{
+		jsonToReturn: `{
+			"state": "success"
+		}`,
+		errorToReturn: nil,
+	}
+
+	d := setUpDriver(setUpDefaultCaps(), api)
+	d.sessionID = "12345"
+
+	resp, err := d.DeleteCookie("")
+	if err != nil || resp.State != "success" {
+		t.Errorf(correctResponseErrorText)
+	}
+}

test/integration_tests/cookie_deletecookie_test.go

@@ -0,0 +1,76 @@
+package integrationtests
+
+import "testing"
+
+func Test_CookieDeleteCookie_CanDeleteSpecifiedCookie(t *testing.T) {
+	setUp()
+	defer tearDown()
+
+	tests := []struct {
+		url        string
+		cookieName string
+	}{
+		{
+			url:        "https://news.ycombinator.com",
+			cookieName: "__cfduid",
+		},
+		{
+			url:        "https://www.google.com",
+			cookieName: "CONSENT",
+		},
+	}
+	for _, te := range tests {
+		driver := createDriver(t)
+		_, err := driver.CreateSession()
+		if err != nil {
+			t.Errorf("Session creation failed")
+		}
+
+		_, err = driver.Go(te.url)
+		if err != nil {
+			t.Errorf("Navigation failed")
+		}
+
+		resp, err := driver.DeleteCookie(te.cookieName)
+		if err != nil || resp.State != "success" {
+			t.Errorf("Error whilst deleting cookie or was not a success.")
+		}
+
+		cookie, err := driver.Cookie(te.cookieName)
+		if err != nil || cookie.Cookie.Name == te.cookieName {
+			t.Errorf("Cookie still exists or an error occurred.")
+		}
+
+		driver.DeleteSession()
+
+		printObjectResult(resp)
+	}
+}
+
+func Test_CookieDeleteCookie_CanDeleteAllCookies(t *testing.T) {
+	setUp()
+	defer tearDown()
+
+	driver := createDriver(t)
+	_, err := driver.CreateSession()
+	if err != nil {
+		t.Errorf("Session creation failed")
+	}
+
+	_, err = driver.Go("https://www.google.com")
+	if err != nil {
+		t.Errorf("Navigation failed")
+	}
+
+	resp, err := driver.DeleteCookie("")
+	if err != nil || resp.State != "success" {
+		t.Errorf("Error whilst deleting cookie or was not a success.")
+	}
+
+	cookies, err := driver.AllCookies()
+	if err != nil || len(cookies.Cookies) != 0 {
+		t.Errorf("Cookies still exist or error was returned.")
+	}
+
+	printObjectResult(resp)
+}

web_driver.go

@@ -201,6 +201,11 @@ type WebDriver interface {
 
 	// AddCookie adds a cookie to the current browsing context.
 	AddCookie(c *Cookie) (*AddCookieResponse, error)
+
+	// DeleteCookie deletes a cookie from the current browsing session. If name
+	// is passed as an empty string, all cookies for the current address will
+	// be deleted.
+	DeleteCookie(name string) (*DeleteCookieResponse, error)
 }
 
 // Element is an interface which specifies what all WebDriver elements