Add ExecuteScript() functionality and tests

Author: heraclmene

remote_driver.go

@@ -176,6 +176,29 @@ func (s *seleniumWebDriver) elementRequest(req *elRequest) ([]byte, error) {
 	return resp, nil
 }
 
+func (s *seleniumWebDriver) scriptRequest(script string, url string, method string) (*ExecuteScriptResponse, error) {
+	r := map[string]interface{}{
+		"script": script,
+		"args":   []string{""},
+	}
+	b, err := json.Marshal(r)
+	if err != nil {
+		return nil, newMarshallingError(err, method, r)
+	}
+	body := bytes.NewReader(b)
+	resp, err := s.valueRequest(&request{
+		url:           url,
+		method:        "POST",
+		body:          body,
+		callingMethod: method,
+	})
+	if err != nil {
+		return nil, err
+	}
+
+	return &ExecuteScriptResponse{State: resp.State, Response: resp.Value}, nil
+}
+
 type timeout struct {
 	timeoutType string
 	timeout     int

remote_driver_document.go

@@ -9,6 +9,13 @@ type PageSourceResponse struct {
 	Source string
 }
 
+// ExecuteScriptResponse is the response returned from calling the ExecuteScript
+// method.
+type ExecuteScriptResponse struct {
+	State    string
+	Response string
+}
+
 func (s *seleniumWebDriver) PageSource() (*PageSourceResponse, error) {
 	if len(s.sessionID) == 0 {
 		return nil, newSessionIDError("PageSource")
@@ -30,3 +37,13 @@ func (s *seleniumWebDriver) PageSource() (*PageSourceResponse, error) {
 
 	return &PageSourceResponse{State: resp.State, Source: resp.Value}, nil
 }
+
+func (s *seleniumWebDriver) ExecuteScript(script string) (*ExecuteScriptResponse, error) {
+	if len(s.sessionID) == 0 {
+		return nil, newSessionIDError("ExecuteScript")
+	}
+
+	url := fmt.Sprintf("%s/session/%s/execute", s.seleniumURL, s.sessionID)
+
+	return s.scriptRequest(script, url, "ExecuteScript")
+}

remote_driver_document_test.go

@@ -69,3 +69,68 @@ func Test_DocumentPageSource_ResultIsReturnedSuccessfully(t *testing.T) {
 		t.Errorf(correctResponseErrorText)
 	}
 }
+
+/*
+	ExecuteScript tests
+*/
+func Test_CommandExecuteScript_InvalidSessionIDResultsInError(t *testing.T) {
+	api := &testableAPIService{
+		jsonToReturn:  "",
+		errorToReturn: nil,
+	}
+
+	d := setUpDriver(setUpDefaultCaps(), api)
+
+	_, err := d.ExecuteScript("alert('test');")
+	if err == nil || !IsSessionIDError(err) {
+		t.Errorf(sessionIDErrorText)
+	}
+}
+
+func Test_CommandExecuteScript_CommunicationErrorIsReturned(t *testing.T) {
+	api := &testableAPIService{
+		jsonToReturn:  "",
+		errorToReturn: errors.New("An error"),
+	}
+
+	d := setUpDriver(setUpDefaultCaps(), api)
+	d.sessionID = "12345"
+
+	_, err := d.ExecuteScript("alert('test');")
+	if err == nil || !IsCommunicationError(err) {
+		t.Errorf(apiCommunicationErrorText)
+	}
+}
+
+func Test_CommandExecuteScript_UnmarshallingErrorIsReturned(t *testing.T) {
+	api := &testableAPIService{
+		jsonToReturn:  "Invalid JSON",
+		errorToReturn: nil,
+	}
+
+	d := setUpDriver(setUpDefaultCaps(), api)
+	d.sessionID = "12345"
+
+	_, err := d.ExecuteScript("alert('test');")
+	if err == nil || !IsUnmarshallingError(err) {
+		t.Errorf(unmarshallingErrorText)
+	}
+}
+
+func Test_CommandExecuteScript_ResultIsReturnedSuccessfully(t *testing.T) {
+	api := &testableAPIService{
+		jsonToReturn: `{
+			"state": "success",
+			"value": "test"
+		}`,
+		errorToReturn: nil,
+	}
+
+	d := setUpDriver(setUpDefaultCaps(), api)
+	d.sessionID = "12345"
+
+	resp, err := d.ExecuteScript("alert('test');")
+	if err != nil || resp.State != "success" {
+		t.Errorf(correctResponseErrorText)
+	}
+}

test/integration_tests/document_executescript_test.go

@@ -0,0 +1,26 @@
+package integrationtests
+
+import "testing"
+
+func Test_DocumentExecuteScript_CanExecuteScriptsSuccessfully(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.ExecuteScript("return \"Test\";")
+	if err != nil || resp.Response != "Test" {
+		errorAndWrap(t, "Error was thrown whilst executing script or response was not correct", err)
+	}
+
+	printObjectResult(resp)
+}

web_driver.go

@@ -160,6 +160,10 @@ type WebDriver interface {
 
 	// PageSource retrieves the outerHTML value of the current URL.
 	PageSource() (*PageSourceResponse, error)
+
+	// ExecuteScript executes a Javascript script on the currently active
+	// page.
+	ExecuteScript(script string) (*ExecuteScriptResponse, error)
 }
 
 // Element is an interface which specifies what all WebDriver elements