feat(executor/web): statement to manage browser history actions (#237)

ovh · May 11, 2020 · 24e4e6c · 24e4e6c
1 parent 0d2ed76
commit 24e4e6c
Show file tree

Hide file tree

Showing 3 changed files with 69 additions and 15 deletions.
diff --git a/executors/web/README.md b/executors/web/README.md
@@ -216,6 +216,42 @@ testcases:
       ConfirmPopup: true
 ```
 
+History actions allow you to manipulate browser history actions. The following action are available:
+* back
+* refresh
+* forward
+
+Example:
+
+```yaml
+name: TestSuiteNavigationHistory
+testcases:
+- name: TestCaseNavigationHistory
+  context:
+    type: web
+    driver: chrome
+    debug: true
+  steps:
+  - action:
+      navigate:
+        url: https://www.google.com
+  - action:
+        fill:
+        - find: input[name='q']
+          text: ovh venom github
+    screenshot: search.png
+  - action:
+        click:
+            find: div[jsname='VlcLAe'] input[name='btnK']
+            wait: 2
+  - action:
+        historyAction: back
+  - action:
+        historyAction: refresh
+  - action:
+        historyAction: forward
+```
+
 ## Output
 
 * result.url

diff --git a/executors/web/types.go b/executors/web/types.go
@@ -2,18 +2,19 @@ package web
 
 // Action represents what can be done with web executor
 type Action struct {
-	Click    *Click    `yaml:"click,omitempty"`
-	Fill     []Fill    `yaml:"fill,omitempty"`
-	Find     string    `yaml:"find,omitempty"`
-	Navigate *Navigate `yaml:"navigate,omitempty"`
-	Wait     int64     `yaml:"wait,omitempty"`
-	ConfirmPopup bool  `yaml:"confirmPopup,omitempty"`
-	CancelPopup bool   `yaml:"cancelPopup,omitempty"`
-	Select   *Select   `yaml:"select,omitempty"`
-	UploadFile *UploadFile `yaml:"uploadFile,omitempty"`
-	SelectFrame *SelectFrame `yaml:"selectFrame,omitempty"`
-	SelectRootFrame bool `yaml:"selectRootFrame,omitempty"`
-	NextWindow bool	   `yaml:"nextWindow,omitempty"`
+	Click           *Click       `yaml:"click,omitempty"`
+	Fill            []Fill       `yaml:"fill,omitempty"`
+	Find            string       `yaml:"find,omitempty"`
+	Navigate        *Navigate    `yaml:"navigate,omitempty"`
+	Wait            int64        `yaml:"wait,omitempty"`
+	ConfirmPopup    bool         `yaml:"confirmPopup,omitempty"`
+	CancelPopup     bool         `yaml:"cancelPopup,omitempty"`
+	Select          *Select      `yaml:"select,omitempty"`
+	UploadFile      *UploadFile  `yaml:"uploadFile,omitempty"`
+	SelectFrame     *SelectFrame `yaml:"selectFrame,omitempty"`
+	SelectRootFrame bool         `yaml:"selectRootFrame,omitempty"`
+	NextWindow      bool         `yaml:"nextWindow,omitempty"`
+	HistoryAction   string       `yaml:"historyAction,omitempy"`
 }
 
 // Fill represents informations needed to fill input/textarea
@@ -44,12 +45,12 @@ type Select struct {
 
 // UploadFile represents informations needed to upload files
 type UploadFile struct {
-	Find string `yaml:"find,omitempty"`
+	Find  string   `yaml:"find,omitempty"`
 	Files []string `yaml:"files,omitempty"`
-	Wait int64 `yaml:"wait,omitempty"`
+	Wait  int64    `yaml:"wait,omitempty"`
 }
 
 // SelectFrame represents informations needed to select the frame
 type SelectFrame struct {
-	Find string  `yaml:"find,omitempty"`
+	Find string `yaml:"find,omitempty"`
 }
diff --git a/executors/web/web.go b/executors/web/web.go
@@ -178,6 +178,23 @@ func (Executor) Run(testCaseContext venom.TestCaseContext, l venom.Logger, step
 		if err := ctx.Page.NextWindow(); err != nil {
 			return nil, err
 		}
+	} else if e.Action.HistoryAction != "" {
+		switch strings.ToLower(e.Action.HistoryAction) {
+		case "back":
+			if err := ctx.Page.Back(); err != nil {
+				return nil, err
+			}
+		case "refresh":
+			if err := ctx.Page.Refresh(); err != nil {
+				return nil, err
+			}
+		case "forward":
+			if err := ctx.Page.Forward(); err != nil {
+				return nil, err
+			}
+		default:
+			return nil, fmt.Errorf("History action '%s' is invalid", e.Action.HistoryAction)
+		}
 	}
 
 	// take a screenshot