1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/testing/marionette/client/README.md Wed Dec 31 06:09:35 2014 +0100
1.3 @@ -0,0 +1,44 @@
1.4 +<!-- This Source Code Form is subject to the terms of the Mozilla Public
1.5 + - License, v. 2.0. If a copy of the MPL was not distributed with this
1.6 + - file, You can obtain one at http://mozilla.org/MPL/2.0/. -->
1.7 +
1.8 +# Marionette Client
1.9 +
1.10 +[Marionette](https://developer.mozilla.org/en/Marionette) is a
1.11 +Mozilla project to enable remote automation in Gecko-based projects,
1.12 +including desktop Firefox, mobile Firefox, and Boot-to-Gecko.
1.13 +
1.14 +It utilizes the [remote-debugger](https://wiki.mozilla.org/Platform/JSDebugv2)
1.15 +inside Gecko for the transport layer of the Marionette server. The commands
1.16 +the Marionette server will eventually implement are based on
1.17 +Selenium's [JSON Wire Protocol](http://code.google.com/p/selenium/wiki/JsonWireProtocol),
1.18 +although not all commands are presently implemented, and additional commands
1.19 +will likely be added.
1.20 +
1.21 +## Package Files
1.22 +
1.23 +- client.py: This is the Marionette socket client; it speaks the same
1.24 + socket protocol as the Gecko remote debugger.
1.25 +- marionette.py: The Marionette client. This uses client.py to communicate
1.26 + with a server that speaks the Gecko remote debugger protocol.
1.27 + This allows Selenium tests to utilize Marionette.
1.28 +- testserver.py: A socket server which mimics the remote debugger in
1.29 + Gecko, and can be used to test pieces of the Marionette client.
1.30 +- test_protocol.py: Tests the Marionette JSON Protocol by using testserver.py.
1.31 +
1.32 +## Installation
1.33 +
1.34 +You'll need the ManifestDestiny and MozHttpd packages from Mozbase:
1.35 +
1.36 + git clone git://github.com/mozilla/mozbase.git
1.37 + cd mozbase
1.38 + python setup_development.py
1.39 +
1.40 +Other than that, there are no special requirements.
1.41 +
1.42 +
1.43 +## Writing and Running Tests Using Marionette
1.44 +
1.45 +See [Writing Marionette tests](https://developer.mozilla.org/en/Marionette/Tests),
1.46 +and [Running Marionette tests](https://developer.mozilla.org/en/Marionette/Running_Tests).
1.47 +
