Google Git
Sign in
dart / external / github.com / google / webdriver.dart / eaf9c582e6e72c3551d3a875b2d522cd1ad06593
commiteaf9c582e6e72c3551d3a875b2d522cd1ad06593[log] [tgz]
authorNate Bosch <nbosch@google.com>Thu Oct 05 11:04:33 2023 -0700
committerGitHub <noreply@github.com>Thu Oct 05 11:04:33 2023 -0700
tree0fe32487c8ac36a7ab806cd21dab2b7de43922e9
parentccd01e5b035da8583af30b80d210691f7288a1b5 [diff]
Spawn test server in a background isolate (#285)

Currently the navigation needs to use the async webdriver because the
server is running in the same isolate, and the `sync_http` package
causes the Dart isolate to wait while the request is outstanding, and
the browser will not complete the response until the navigation is
complete. If the server is in the same isolate it will not be able to
serve the content and it causes a deadlock.

Run the server in another isolate. Use isolate ports to communicate the
timing for server shutdown.

Fix some tests which relied on the navigation _not_ happening through
the sync client so that they didn't get recorded by the event listener.
Clear the events after the initial navigation to ignore non-relevant
events.
2 files changed
tree: 0fe32487c8ac36a7ab806cd21dab2b7de43922e9
  1. .github/
  2. lib/
  3. test/
  4. .gitignore
  5. analysis_options.yaml
  6. AUTHORS
  7. CHANGELOG.md
  8. CONTRIBUTING.md
  9. dart_test.yaml
  10. LICENSE
  11. pubspec.yaml
  12. README.md
README.md

CI pub package package publisher

Provides WebDriver bindings for Dart. These use the WebDriver JSON interface, and as such, require the use of the WebDriver remote server.

Using package:webdriver

In your Dart code, you can use:

import 'package:webdriver/io.dart';

WebDriver driver = createDriver(...);

This will use by default the asynchronous, JSON wire spec implementation. You now can also use a synchronous version of WebDriver:

import 'package:webdriver/sync_io.dart';

final driver = createDriver(...);

This version of WebDriver supports both the JSON wire spec and W3C spec, allowing use with modern versions of Firefox. This defaults to the JSON wire spec, but can also be configured to use the W3C spec or even to try and automatically infer the spec during session creation:

final w3cDriver = createDriver(spec: WebDriverSpec.W3c);  // Use W3C spec.

final anyDriver = createDriver(spec: WebDriverSpec.Auto); // Infer spec.

Testing

Unfortunately using bazel with Dart libraries and Dart WebDriver is not yet supported. We hope to add this at some point, but for now pub still works.

As a consequence, running tests is a bit more complicated than we'd like:

  1. Launch a WebDriver binar(ies).

    First, bring up chromedriver / geckodriver. Other conforming WebDriver binaries should work as well, but we test against these:

    chromedriver --port=4444 --url-base=wd/hub --verbose
geckodriver --port=4445

    ChromeDriver is used to test our JSON wire spec implementation, and geckodriver is used to test our W3C spec implementation.

    Synchronous tests are labeled as Chrome/Firefox. All async tests run exclusively against Chrome (as async, like ChromeDriver supports only the old JSON wire spec).

  2. Run a test. All files suffixed with _test.dart are tests.

    dart test test/path/to/the_test.dart -r expanded -p vm

    Or to run all tests:

    dart test -r expanded -p vm

    You should probably go get a coffee or something, this is gonna take a while.