testing/webdriver/README.md
author David Burns <dburns@mozilla.com>
Tue, 15 Jan 2019 14:14:10 +0000
changeset 513917 060ca330d2aa6eaef17750f20068f96d0bf75d7c
parent 494479 a129c1be29f1c78ba52d4c9689df52c5010350c1
permissions -rw-r--r--
Bug 1520137: Update documentation pointing to #interop instead of #ateam r=whimboo As we move away from #ateam we need to make sure we that we point people to the correct IRC Channel Differential Revision: https://phabricator.services.mozilla.com/D16547

webdriver library
=================

The [webdriver crate] is a library implementation of the wire protocol
for the [W3C WebDriver standard] written in Rust.  WebDriver is a remote
control interface that enables introspection and control of user agents.
It provides a platform- and language-neutral wire protocol as a way
for out-of-process programs to remotely instruct the behaviour of web
browsers.

The webdriver library provides the formal types, error codes, type and
bounds checks, and JSON marshaling conventions for correctly parsing
and emitting the WebDriver protocol.  It also provides an HTTP server
where endpoints are mapped to the different WebDriver commands.

**As of right now, this is an implementation for the server side of the
WebDriver API in Rust, not the client side.**

[webdriver crate]: https://crates.io/crates/webdriver
[W3C WebDriver standard]: https://w3c.github.io/webdriver/


Building
========

The library is built using the usual [Rust conventions]:

	% cargo build

To run the tests:

	% cargo test

[Rust conventions]: http://doc.crates.io/guide.html


Contact
=======

The mailing list for webdriver discussion is
tools-marionette@lists.mozilla.org ([subscribe], [archive]).

There is also an IRC channel to talk about using and developing
webdriver in #interop on irc.mozilla.org.

[subscribe]: https://lists.mozilla.org/listinfo/tools-marionette
[archive]: https://lists.mozilla.org/pipermail/tools-marionette/