Move screenshot-related utilities to a separate package. #8951
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -10,8 +10,7 @@ import 'package:_pub_shared/validation/html/html_validation.dart'; | |
| import 'package:path/path.dart' as p; | ||
| import 'package:puppeteer/puppeteer.dart'; | ||
| import 'package:retry/retry.dart'; | ||
| import 'package:screenshot_tools/screenshot_utils.dart'; | ||
|
|
||
| /// Creates and tracks the headless Chrome environment, its temp directories and | ||
| /// and uncaught exceptions. | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -14,11 +14,11 @@ dependencies: | |
| pub_semver: ^2.0.0 | ||
| puppeteer: 3.16.0 | ||
| retry: ^3.1.2 | ||
| screenshot_tools: | ||
| oauth2: ^2.0.0 | ||
|
|
||
| dev_dependencies: | ||
| coverage: any # test already depends on it | ||
| pubspec_parse: ^1.5.0 | ||
| shelf: ^1.4.0 | ||
| test: ^1.16.5 | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,9 +7,9 @@ import 'dart:convert'; | |
| import 'package:http/http.dart' as http; | ||
| import 'package:pub_integration/src/fake_test_context_provider.dart'; | ||
| import 'package:pub_integration/src/pub_puppeteer_helpers.dart'; | ||
| import 'package:pub_integration/src/test_browser.dart'; | ||
| import 'package:puppeteer/puppeteer.dart'; | ||
| import 'package:screenshot_tools/screenshot_utils.dart'; | ||
| import 'package:test/test.dart'; | ||
|
|
||
| void main() { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,9 +6,9 @@ import 'dart:convert'; | |
|
|
||
| import 'package:http/http.dart' as http; | ||
| import 'package:pub_integration/src/fake_test_context_provider.dart'; | ||
| import 'package:pub_integration/src/test_browser.dart'; | ||
| import 'package:puppeteer/puppeteer.dart'; | ||
| import 'package:screenshot_tools/screenshot_utils.dart'; | ||
| import 'package:test/test.dart'; | ||
|
|
||
| void main() { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,8 +6,8 @@ import 'dart:convert'; | |
|
|
||
| import 'package:http/http.dart' as http; | ||
| import 'package:pub_integration/src/fake_test_context_provider.dart'; | ||
| import 'package:pub_integration/src/test_browser.dart'; | ||
| import 'package:screenshot_tools/screenshot_utils.dart'; | ||
| import 'package:test/test.dart'; | ||
|
|
||
| void main() { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -9,8 +9,8 @@ import 'dart:io' show Platform; | |
| import 'package:http/http.dart' as http; | ||
| import 'package:pub_integration/src/fake_test_context_provider.dart'; | ||
| import 'package:pub_integration/src/pub_puppeteer_helpers.dart'; | ||
| import 'package:pub_integration/src/test_browser.dart'; | ||
| import 'package:screenshot_tools/screenshot_utils.dart'; | ||
| import 'package:test/test.dart'; | ||
|
|
||
| void main() { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -8,8 +8,8 @@ import 'package:_pub_shared/data/admin_api.dart'; | |
| import 'package:http/http.dart' as http; | ||
| import 'package:pub_integration/src/fake_test_context_provider.dart'; | ||
| import 'package:pub_integration/src/pub_puppeteer_helpers.dart'; | ||
| import 'package:pub_integration/src/test_browser.dart'; | ||
| import 'package:screenshot_tools/screenshot_utils.dart'; | ||
| import 'package:test/test.dart'; | ||
|
|
||
| final _caseIdExpr = RegExp(r'[0-9]{8}I[0-9a-f]{10}'); | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -6,9 +6,9 @@ import 'dart:convert'; | |
|
|
||
| import 'package:http/http.dart' as http; | ||
| import 'package:pub_integration/src/fake_test_context_provider.dart'; | ||
| import 'package:pub_integration/src/test_browser.dart'; | ||
| import 'package:puppeteer/puppeteer.dart'; | ||
| import 'package:screenshot_tools/screenshot_utils.dart'; | ||
| import 'package:test/test.dart'; | ||
|
|
||
| void main() { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,9 +7,9 @@ import 'dart:convert'; | |
| import 'package:http/http.dart' as http; | ||
| import 'package:pub_integration/src/fake_test_context_provider.dart'; | ||
| import 'package:pub_integration/src/pub_puppeteer_helpers.dart'; | ||
| import 'package:pub_integration/src/test_browser.dart'; | ||
| import 'package:puppeteer/puppeteer.dart'; | ||
| import 'package:screenshot_tools/screenshot_utils.dart'; | ||
| import 'package:test/test.dart'; | ||
|
|
||
| void main() { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| # Screenshots | ||
|
|
||
| This tool helps create and compare screenshots before/after changes that affect visual styles. | ||
|
|
||
| ## Creating screenshots | ||
|
|
||
| The screenshots are created during the `puppeteer` tests, if the `SCREENSHOT_DIR` | ||
| environment variable is set. | ||
|
|
||
| The tests are instrumented with calls to take screenshots on selected parts of | ||
| the screens. During the method call, it will change the viewport and the main | ||
| theme of the page, taking 6 screenshots for each call. | ||
|
|
||
| ## Before/after screenshots | ||
|
|
||
| To create before/after screenshot comparisons, use the following workflow: | ||
|
|
||
| 1. Generate screenshots by running tests with `SCREENSHOT_DIR=/path/to/before/dir`. | ||
| 1. Make the changes. | ||
| 1. Generate screenshots by running tests with `SCREENSHOT_DIR=/path/to/after/dir`. | ||
| 1. Run `dart bin/compare_screenshots.dart <before-dir> <after-dir> <diff-dir>` | ||
|
|
||
| The comparison will put the files into the `<diff-dir>` with the before/after/diff | ||
| versions, alongside a summary `index.html` file to have a quick overview of them. | ||
|
|
||
| ### Required tool for comparisons | ||
|
|
||
| The comparison is created by the `odiff` tool running in a container using `docker`. | ||
| To build the `odiff` container, user the following command: | ||
|
|
||
| ``` | ||
| cd tool | ||
| docker build . -f Dockerfile.odiff -t odiff | ||
| ``` | ||
|
|
||
| ## Missing features | ||
|
|
||
| - Create a better side-by-side comparison for images, as right now everything is only a list of images. |
File renamed without changes.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: Should we change the name of the main library to align with the package name?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll do the library name changes in a follow-up, after more changes has been done, e.g. the dartdoc-related tooling is also implemented.