tests/screentest: hide OSI link in screentests to reduce testflake
When the deps.dev API is missing a module or responds with an error
when loading the doc pages, the link does not appear. Hiding the
element from snapshots reduces noise from screentests.
Change-Id: I2f0dbd9c054eb7311050819d870e7269efaeb43e
Reviewed-on: https://go-review.googlesource.com/c/pkgsite/+/432855
Reviewed-by: Hyang-Ah Hana Kim <hyangah@gmail.com>
Run-TryBot: Jamal Carvalho <jamal@golang.org>
diff --git a/tests/README.md b/tests/README.md
index b068a2b..e38da53 100644
--- a/tests/README.md
+++ b/tests/README.md
@@ -71,7 +71,13 @@
## Screentest
-The screentest/ directory contains visual diff tests for pages on pkg.go.dev
+The screentest/ directory contains visual diff tests for pages on pkg.go.dev.
+Tests are written for the screentest tool from golang.org/x/website.
+See the [command](https://pkg.go.dev/golang.org/x/website/cmd/screentest) and
+[package](https://pkg.go.dev/golang.org/x/website/internal/screentest) docs for
+more information.
+
+### Running the tests
In order to run the tests, run this command from the root of the repository:
```
@@ -94,10 +100,3 @@
testdata directory that show the cause of the failure.
Use `./devtools/docker/compose.sh logs` to get detailed logs of the docker containers.
-
-### Adding Testcases
-
-Tests are written for the screentest tool from golang.org/x/website.
-See the [command](https://pkg.go.dev/golang.org/x/website/cmd/screentest) and
-[package](https://pkg.go.dev/golang.org/x/website/internal/screentest) docs for
-more information.
diff --git a/tests/screentest/testcases.txt b/tests/screentest/testcases.txt
index bbf57b7..e1e1e69 100644
--- a/tests/screentest/testcases.txt
+++ b/tests/screentest/testcases.txt
@@ -7,13 +7,13 @@
block https://codecov.io/* https://travis-ci.com/*
{{$ready := "[role='treeitem'][aria-selected='true']"}}
-{{$hideImportedby := "document.querySelector(\"[data-test-id='UnitHeader-importedby']\")?.remove();"}}
+{{$hideElements := "document.querySelector(\"[data-test-id='UnitHeader-importedby']\")?.remove();document.querySelector(\"[data-test-id='meta-link-depsdev']\")?.remove();"}}
{{$scrollTop := "window.scrollTo({top:0});"}}
test short readme has no toggle
pathname /rsc.io/quote
wait {{$ready}}
-eval {{$hideImportedby}}
+eval {{$hideElements}}
capture viewport
capture viewport 540x1080
@@ -21,7 +21,7 @@
pathname /golang.org/x/tools@v0.1.1
wait {{$ready}}
eval {{$scrollTop}}
-eval {{$hideImportedby}}
+eval {{$hideElements}}
capture viewport
capture viewport 540x1080
@@ -29,7 +29,7 @@
pathname /golang.org/x/tools@v0.1.1#section-readme
wait {{$ready}}
eval {{$scrollTop}}
-eval {{$hideImportedby}}
+eval {{$hideElements}}
capture viewport
capture viewport 540x1080
@@ -38,7 +38,7 @@
# wait {{$ready}}
# click [data-test-id="directories-toggle"]
# eval {{$scrollTop}}
-# eval {{$hideImportedby}}
+# eval {{$hideElements}}
# capture fullscreen
# capture fullscreen 540x1080
@@ -47,34 +47,34 @@
# pathname /golang.org/x/tools@v0.1.1
# wait {{$ready}}
# click [data-test-id="jump-to-button"]
-# eval {{$hideImportedby}}
+# eval {{$hideElements}}
# capture viewport
test standard library package
pathname /errors@go1.16.3
wait {{$ready}}
-eval {{$hideImportedby}}
+eval {{$hideElements}}
capture fullscreen
capture fullscreen 540x1080
test really long import path
pathname /github.com/envoyproxy/go-control-plane@v0.9.8/envoy/config/filter/network/http_connection_manager/v2
wait {{$ready}}
-eval {{$hideImportedby}}
+eval {{$hideElements}}
capture viewport
capture viewport 540x1080
test package that exists in multiple modules at the same versions
pathname /github.com/hashicorp/vault/api@v1.0.3
wait {{$ready}}
-eval {{$hideImportedby}}
+eval {{$hideElements}}
capture viewport
capture viewport 540x1080
test no documentation
pathname /github.com/tendermint/tendermint@v0.34.10/cmd/contract_tests
wait {{$ready}}
-eval {{$hideImportedby}}
+eval {{$hideElements}}
capture viewport
capture viewport 540x1080
@@ -82,21 +82,21 @@
pathname /gocloud.dev@v0.22.0
block https://github.com/google/go-cloud/raw/v0.22.0/internal/website/static/go-cdk-logo-gopherblue.png
wait {{$ready}}
-eval {{$hideImportedby}}
+eval {{$hideElements}}
capture viewport
capture viewport 540x1080
test package not at latest version of a module
pathname /github.com/julieqiu/api-demo/oldpkg
wait {{$ready}}
-eval {{$hideImportedby}}
+eval {{$hideElements}}
capture viewport
capture viewport 540x1080
test standard library
pathname /std@go1.16.3
wait {{$ready}}
-eval {{$hideImportedby}}
+eval {{$hideElements}}
capture fullscreen
capture fullscreen 540x1080
@@ -104,42 +104,42 @@
pathname /github.com/apache/thrift@v0.14.1
block https://github.com/apache/thrift/raw/v0.14.1/doc/images/thrift-layers.png
wait {{$ready}}
-eval {{$hideImportedby}}
+eval {{$hideElements}}
capture viewport
capture viewport 540x1080
test package with higher major version
pathname /rsc.io/quote
wait {{$ready}}
-eval {{$hideImportedby}}
+eval {{$hideElements}}
capture viewport
capture viewport 540x1080
test package with multi-GOOS
pathname /github.com/creack/pty@v1.1.11
wait {{$ready}}
-eval {{$hideImportedby}}
+eval {{$hideElements}}
capture viewport
capture viewport 540x1080
test retracted package
pathname /k8s.io/client-go@v1.5.2
wait {{$ready}}
-eval {{$hideImportedby}}
+eval {{$hideElements}}
capture viewport
capture viewport 540x1080
test deprecated package
pathname /github.com/jba/bit
wait {{$ready}}
-eval {{$hideImportedby}}
+eval {{$hideElements}}
capture viewport
capture viewport 540x1080
test package with deprecated symbols
pathname /database/sql/driver@go1.16.3
wait {{$ready}}
-eval {{$hideImportedby}}
+eval {{$hideElements}}
capture fullscreen
capture fullscreen 540x1080
diff --git a/tests/screentest/testdata/deprecated-package-540x1080.a.png b/tests/screentest/testdata/deprecated-package-540x1080.a.png
index 8071a57..65bbc2a 100644
--- a/tests/screentest/testdata/deprecated-package-540x1080.a.png
+++ b/tests/screentest/testdata/deprecated-package-540x1080.a.png
Binary files differ
diff --git a/tests/screentest/testdata/deprecated-package.a.png b/tests/screentest/testdata/deprecated-package.a.png
index ff86224..58c7967 100644
--- a/tests/screentest/testdata/deprecated-package.a.png
+++ b/tests/screentest/testdata/deprecated-package.a.png
Binary files differ
diff --git a/tests/screentest/testdata/module-that-is-also-a-package-540x1080.a.png b/tests/screentest/testdata/module-that-is-also-a-package-540x1080.a.png
index fe876b1..af2aadc 100644
--- a/tests/screentest/testdata/module-that-is-also-a-package-540x1080.a.png
+++ b/tests/screentest/testdata/module-that-is-also-a-package-540x1080.a.png
Binary files differ
diff --git a/tests/screentest/testdata/module-that-is-also-a-package.a.png b/tests/screentest/testdata/module-that-is-also-a-package.a.png
index 073b0fc..8ac02c9 100644
--- a/tests/screentest/testdata/module-that-is-also-a-package.a.png
+++ b/tests/screentest/testdata/module-that-is-also-a-package.a.png
Binary files differ
diff --git a/tests/screentest/testdata/no-documentation-540x1080.a.png b/tests/screentest/testdata/no-documentation-540x1080.a.png
index 8f6d53a..6b163e1 100644
--- a/tests/screentest/testdata/no-documentation-540x1080.a.png
+++ b/tests/screentest/testdata/no-documentation-540x1080.a.png
Binary files differ
diff --git a/tests/screentest/testdata/no-documentation.a.png b/tests/screentest/testdata/no-documentation.a.png
index ff64754..379ef54 100644
--- a/tests/screentest/testdata/no-documentation.a.png
+++ b/tests/screentest/testdata/no-documentation.a.png
Binary files differ
diff --git a/tests/screentest/testdata/package-not-at-latest-version-of-a-module-540x1080.a.png b/tests/screentest/testdata/package-not-at-latest-version-of-a-module-540x1080.a.png
index 9d4c5de..0e0fdbb 100644
--- a/tests/screentest/testdata/package-not-at-latest-version-of-a-module-540x1080.a.png
+++ b/tests/screentest/testdata/package-not-at-latest-version-of-a-module-540x1080.a.png
Binary files differ
diff --git a/tests/screentest/testdata/package-not-at-latest-version-of-a-module.a.png b/tests/screentest/testdata/package-not-at-latest-version-of-a-module.a.png
index aea88bc..6fd2db2 100644
--- a/tests/screentest/testdata/package-not-at-latest-version-of-a-module.a.png
+++ b/tests/screentest/testdata/package-not-at-latest-version-of-a-module.a.png
Binary files differ
diff --git a/tests/screentest/testdata/package-that-exists-in-multiple-modules-at-the-same-versions-540x1080.a.png b/tests/screentest/testdata/package-that-exists-in-multiple-modules-at-the-same-versions-540x1080.a.png
index 7e290e4..343f7dc 100644
--- a/tests/screentest/testdata/package-that-exists-in-multiple-modules-at-the-same-versions-540x1080.a.png
+++ b/tests/screentest/testdata/package-that-exists-in-multiple-modules-at-the-same-versions-540x1080.a.png
Binary files differ
diff --git a/tests/screentest/testdata/package-that-exists-in-multiple-modules-at-the-same-versions.a.png b/tests/screentest/testdata/package-that-exists-in-multiple-modules-at-the-same-versions.a.png
index 315c5a2..448a628 100644
--- a/tests/screentest/testdata/package-that-exists-in-multiple-modules-at-the-same-versions.a.png
+++ b/tests/screentest/testdata/package-that-exists-in-multiple-modules-at-the-same-versions.a.png
Binary files differ
diff --git a/tests/screentest/testdata/package-with-higher-major-version-540x1080.a.png b/tests/screentest/testdata/package-with-higher-major-version-540x1080.a.png
index 61ba397..4ab8906 100644
--- a/tests/screentest/testdata/package-with-higher-major-version-540x1080.a.png
+++ b/tests/screentest/testdata/package-with-higher-major-version-540x1080.a.png
Binary files differ
diff --git a/tests/screentest/testdata/package-with-higher-major-version.a.png b/tests/screentest/testdata/package-with-higher-major-version.a.png
index 25b233c..8b788da 100644
--- a/tests/screentest/testdata/package-with-higher-major-version.a.png
+++ b/tests/screentest/testdata/package-with-higher-major-version.a.png
Binary files differ
diff --git a/tests/screentest/testdata/package-with-multi-GOOS-540x1080.a.png b/tests/screentest/testdata/package-with-multi-GOOS-540x1080.a.png
index b286804..747a424 100644
--- a/tests/screentest/testdata/package-with-multi-GOOS-540x1080.a.png
+++ b/tests/screentest/testdata/package-with-multi-GOOS-540x1080.a.png
Binary files differ
diff --git a/tests/screentest/testdata/package-with-multi-GOOS.a.png b/tests/screentest/testdata/package-with-multi-GOOS.a.png
index 954e08c..114f065 100644
--- a/tests/screentest/testdata/package-with-multi-GOOS.a.png
+++ b/tests/screentest/testdata/package-with-multi-GOOS.a.png
Binary files differ
diff --git a/tests/screentest/testdata/package-with-multiple-licenses-540x1080.a.png b/tests/screentest/testdata/package-with-multiple-licenses-540x1080.a.png
index 0183db5..deb5b36 100644
--- a/tests/screentest/testdata/package-with-multiple-licenses-540x1080.a.png
+++ b/tests/screentest/testdata/package-with-multiple-licenses-540x1080.a.png
Binary files differ
diff --git a/tests/screentest/testdata/package-with-multiple-licenses.a.png b/tests/screentest/testdata/package-with-multiple-licenses.a.png
index 986129b..747dbbe 100644
--- a/tests/screentest/testdata/package-with-multiple-licenses.a.png
+++ b/tests/screentest/testdata/package-with-multiple-licenses.a.png
Binary files differ
diff --git a/tests/screentest/testdata/really-long-import-path-540x1080.a.png b/tests/screentest/testdata/really-long-import-path-540x1080.a.png
index 95e54cd..3a26bb6 100644
--- a/tests/screentest/testdata/really-long-import-path-540x1080.a.png
+++ b/tests/screentest/testdata/really-long-import-path-540x1080.a.png
Binary files differ
diff --git a/tests/screentest/testdata/really-long-import-path.a.png b/tests/screentest/testdata/really-long-import-path.a.png
index 5efdfbe..ab7c146 100644
--- a/tests/screentest/testdata/really-long-import-path.a.png
+++ b/tests/screentest/testdata/really-long-import-path.a.png
Binary files differ
diff --git a/tests/screentest/testdata/retracted-package-540x1080.a.png b/tests/screentest/testdata/retracted-package-540x1080.a.png
index 93d2de0..52d35ac 100644
--- a/tests/screentest/testdata/retracted-package-540x1080.a.png
+++ b/tests/screentest/testdata/retracted-package-540x1080.a.png
Binary files differ
diff --git a/tests/screentest/testdata/retracted-package.a.png b/tests/screentest/testdata/retracted-package.a.png
index 1b0191d..fb551b0 100644
--- a/tests/screentest/testdata/retracted-package.a.png
+++ b/tests/screentest/testdata/retracted-package.a.png
Binary files differ
diff --git a/tests/screentest/testdata/short-readme-has-no-toggle-540x1080.a.png b/tests/screentest/testdata/short-readme-has-no-toggle-540x1080.a.png
index 61ba397..4ab8906 100644
--- a/tests/screentest/testdata/short-readme-has-no-toggle-540x1080.a.png
+++ b/tests/screentest/testdata/short-readme-has-no-toggle-540x1080.a.png
Binary files differ
diff --git a/tests/screentest/testdata/short-readme-has-no-toggle.a.png b/tests/screentest/testdata/short-readme-has-no-toggle.a.png
index 25b233c..8b788da 100644
--- a/tests/screentest/testdata/short-readme-has-no-toggle.a.png
+++ b/tests/screentest/testdata/short-readme-has-no-toggle.a.png
Binary files differ
diff --git a/tests/screentest/testdata/x-tools-540x1080.a.png b/tests/screentest/testdata/x-tools-540x1080.a.png
index beb6ad5..8bce49f 100644
--- a/tests/screentest/testdata/x-tools-540x1080.a.png
+++ b/tests/screentest/testdata/x-tools-540x1080.a.png
Binary files differ
diff --git a/tests/screentest/testdata/x-tools-readme-expanded-540x1080.a.png b/tests/screentest/testdata/x-tools-readme-expanded-540x1080.a.png
index a615b54..cdbc8da 100644
--- a/tests/screentest/testdata/x-tools-readme-expanded-540x1080.a.png
+++ b/tests/screentest/testdata/x-tools-readme-expanded-540x1080.a.png
Binary files differ
diff --git a/tests/screentest/testdata/x-tools-readme-expanded.a.png b/tests/screentest/testdata/x-tools-readme-expanded.a.png
index 2c3f483..465f562 100644
--- a/tests/screentest/testdata/x-tools-readme-expanded.a.png
+++ b/tests/screentest/testdata/x-tools-readme-expanded.a.png
Binary files differ
diff --git a/tests/screentest/testdata/x-tools.a.png b/tests/screentest/testdata/x-tools.a.png
index cdefe07..d586efa 100644
--- a/tests/screentest/testdata/x-tools.a.png
+++ b/tests/screentest/testdata/x-tools.a.png
Binary files differ
