testing/marionette/client/README.md

Thu, 22 Jan 2015 13:21:57 +0100

author
Michael Schloh von Bennewitz <michael@schloh.com>
date
Thu, 22 Jan 2015 13:21:57 +0100
branch
TOR_BUG_9701
changeset 15
b8a032363ba2
permissions
-rw-r--r--

Incorporate requested changes from Mozilla in review:
https://bugzilla.mozilla.org/show_bug.cgi?id=1123480#c6

     1 <!-- This Source Code Form is subject to the terms of the Mozilla Public
     2    - License, v. 2.0. If a copy of the MPL was not distributed with this
     3    - file, You can obtain one at http://mozilla.org/MPL/2.0/. -->
     5 # Marionette Client
     7 [Marionette](https://developer.mozilla.org/en/Marionette) is a 
     8 Mozilla project to enable remote automation in Gecko-based projects,
     9 including desktop Firefox, mobile Firefox, and Boot-to-Gecko.
    11 It utilizes the [remote-debugger](https://wiki.mozilla.org/Platform/JSDebugv2) 
    12 inside Gecko for the transport layer of the Marionette server.  The commands
    13 the Marionette server will eventually implement are based on
    14 Selenium's [JSON Wire Protocol](http://code.google.com/p/selenium/wiki/JsonWireProtocol),
    15 although not all commands are presently implemented, and additional commands
    16 will likely be added.
    18 ## Package Files
    20 - client.py:  This is the Marionette socket client; it speaks the same
    21   socket protocol as the Gecko remote debugger.
    22 - marionette.py:  The Marionette client.  This uses client.py to communicate
    23   with a server that speaks the Gecko remote debugger protocol.
    24   This allows Selenium tests to utilize Marionette.
    25 - testserver.py:  A socket server which mimics the remote debugger in
    26   Gecko, and can be used to test pieces of the Marionette client.
    27 - test_protocol.py:  Tests the Marionette JSON Protocol by using testserver.py.
    29 ## Installation
    31 You'll need the ManifestDestiny and MozHttpd packages from Mozbase:
    33     git clone git://github.com/mozilla/mozbase.git
    34     cd mozbase
    35     python setup_development.py
    37 Other than that, there are no special requirements.
    40 ## Writing and Running Tests Using Marionette
    42 See [Writing Marionette tests](https://developer.mozilla.org/en/Marionette/Tests),
    43 and [Running Marionette tests](https://developer.mozilla.org/en/Marionette/Running_Tests).

mercurial