Add ExecuteScriptAsync functionality and tests.

Author: heraclmene

remote_driver_document.go

@@ -47,3 +47,13 @@ func (s *seleniumWebDriver) ExecuteScript(script string) (*ExecuteScriptResponse
 
 	return s.scriptRequest(script, url, "ExecuteScript")
 }
+
+func (s *seleniumWebDriver) ExecuteScriptAsync(script string) (*ExecuteScriptResponse, error) {
+	if len(s.sessionID) == 0 {
+		return nil, newSessionIDError("ExecuteScriptAsync")
+	}
+
+	url := fmt.Sprintf("%s/session/%s/execute_async", s.seleniumURL, s.sessionID)
+
+	return s.scriptRequest(script, url, "ExecuteScriptAsync")
+}

remote_driver_document_test.go

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

test/integration_tests/document_executescript_test.go

@@ -24,3 +24,26 @@ func Test_DocumentExecuteScript_CanExecuteScriptsSuccessfully(t *testing.T) {
 
 	printObjectResult(resp)
 }
+
+func Test_DocumentExecuteScriptAsync_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.ExecuteScriptAsync("var callback = arguments[arguments.length - 1]; callback('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

@@ -164,6 +164,28 @@ type WebDriver interface {
 	// ExecuteScript executes a Javascript script on the currently active
 	// page.
 	ExecuteScript(script string) (*ExecuteScriptResponse, error)
+
+	// ExecuteScriptAsync executes a Javascript script asynchronously on the
+	// currently active page. If you do not have experience with this call,
+	// there is an example below.
+	//
+	// The async handler runs on the concept of a callback; meaning it will run
+	// your code asynchronously and if it completes, will call the callback.
+	//
+	// Selenium helpfully provides a callback function which is passed in
+	// to the 'arguments' array that you can access within your script. The
+	// callback function is always the LAST element of the array. You can
+	// access it like the below:
+	//		var callback = arguments[arguments.length - 1];
+	// The callback function also accepts one argument as a parameter, this
+	// can be anything and will be assigned to the Response property of
+	// ExecuteScriptResponse.
+	//
+	// An example:
+	//		var callback = arguments[arguments.length - 1];
+	//		doLongWindedTask();
+	//		callback();
+	ExecuteScriptAsync(script string) (*ExecuteScriptResponse, error)
 }
 
 // Element is an interface which specifies what all WebDriver elements