better test example

james-d-elliott · Nov 9, 2022 · 7a080b1 · 7a080b1
1 parent 11886f2
commit 7a080b1
Show file tree

Hide file tree

Showing 7 changed files with 40 additions and 30 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -42,7 +42,7 @@ First, set this environment variable:
 export GODEBUG="tracebackancestors=1000"
 ```
 
-Then, no magic, just `go test`. Read the test template [lab_test.go](../lab_test.go) to get started.
+Then, no magic, just `go test`. Read the test template [rod_test.go](../rod_test.go) to get started.
 
 The entry point of tests is [setup_test.go](../setup_test.go). All the test helpers are defined in it.
 

diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
@@ -17,14 +17,14 @@ Rod Version: v0.0.0
    cd rod
    ```
 
-1. Use your code to replace the content of function `TestLab` in file `lab_test.go`.
+1. Use your code to replace the content of function `TestRod` in file `rod_test.go`.
 
-1. Test your code with: `go test -run TestLab`, make sure it fails as expected.
+1. Test your code with: `go test -run TestRod`, make sure it fails as expected.
 
-1. Replace ALL THE CONTENT under "The code to demonstrate your question" with your `TestLab` function, like below:
+1. Replace ALL THE CONTENT under "The code to demonstrate your question" with your `TestRod` function, like below:
 
 ```go
-func TestLab(t *testing.T) {
+func TestRod(t *testing.T) {
     g := setup(t)
     g.Eq(1, 2) // the test should fail, here 1 doesn't equal 2
 }

diff --git a/lab_test.go b/lab_test.go
diff --git a/lib/utils/check-issue/body-invalid.txt b/lib/utils/check-issue/body-invalid.txt
@@ -7,7 +7,7 @@ test
 ```
 
 ```go
-func TestLab(t *testing.T) {
+func TestRod(t *testing.T) {
     g := setup(t)
     g.Eq(1, 1)
 

diff --git a/lib/utils/check-issue/body.txt b/lib/utils/check-issue/body.txt
@@ -17,14 +17,14 @@ Rod Version: v1.0.0
    cd rod
    ```
 
-1. Use your code to replace the content of function `TestLab` in file `lab_test.go`.
+1. Use your code to replace the content of function `TestRod` in file `rod_test.go`.
 
-1. Test your code with: `go test -run TestLab`.
+1. Test your code with: `go test -run TestRod`.
 
-1. Replace this section with your entire `lab_test.go` content, like below:
+1. Replace this section with your entire `rod_test.go` content, like below:
 
 ```go
-func TestLab(t *testing.T) {
+func TestRod(t *testing.T) {
     g := setup(t)
     g.Eq(1, 1)
 }

diff --git a/rod_test.go b/rod_test.go
@@ -0,0 +1,26 @@
+package rod_test
+
+import (
+	"testing"
+)
+
+// This is the template to demonstrate how to test Rod.
+func TestRod(t *testing.T) {
+	g := setup(t)
+	g.cancelTimeout() // Cancel timeout protection
+
+	// You can use the pre-launched g.browser or g.page for testing
+	browser, page := g.browser, g.page
+
+	// You can also use the g.html to serve static html content
+	page.MustNavigate(g.html(doc)).MustWaitLoad()
+
+	g.Eq(browser.MustVersion().ProtocolVersion, "1.3")
+	g.Has(page.MustElement("body").MustText(), "ok")
+}
+
+const doc = `
+<html>
+  <body>ok</body>
+</html>
+`
diff --git a/setup_test.go b/setup_test.go
@@ -168,6 +168,10 @@ func (g G) blank() string {
 	return g.srcFile("./fixtures/blank.html")
 }
 
+func (g G) html(content string) string {
+	return g.Serve().Route("/", "", content).URL()
+}
+
 // Get abs file path from fixtures folder, such as "file:///a/b/click.html".
 // Usually the path can be used for html src attribute like:
 //