sdk/platform-tools/systrace/catapult/telemetry/third_party/mox3/README.rst

   1 Mox3 - Mock object framework for Python 3
   2 =========================================
   3
   4 Mox3 is an unofficial port of the Google mox framework
   5 (http://code.google.com/p/pymox/) to Python 3. It was meant to be as compatible
   6 with mox as possible, but small enhancements have been made. The library was
   7 tested on Python version 3.2, 2.7 and 2.6.
   8
   9 Use at your own risk ;)
  10
  11 To install:
  12
  13   $ python setup.py install
  14
  15 Running Tests
  16 -------------
  17 The testing system is based on a combination of tox and testr. The canonical
  18 approach to running tests is to simply run the command `tox`. This will
  19 create virtual environments, populate them with depenedencies and run all of
  20 the tests that OpenStack CI systems run. Behind the scenes, tox is running
  21 `testr run --parallel`, but is set up such that you can supply any additional
  22 testr arguments that are needed to tox. For example, you can run:
  23 `tox -- --analyze-isolation` to cause tox to tell testr to add
  24 --analyze-isolation to its argument list.
  25
  26 It is also possible to run the tests inside of a virtual environment
  27 you have created, or it is possible that you have all of the dependencies
  28 installed locally already. In this case, you can interact with the testr
  29 command directly. Running `testr run` will run the entire test suite. `testr
  30 run --parallel` will run it in parallel (this is the default incantation tox
  31 uses.) More information about testr can be found at:
  32 http://wiki.openstack.org/testr
  33
  34 Basic Usage
  35 -----------
  36
  37 The basic usage of mox3 is the same as with mox, but the initial import should
  38 be made from the mox3 module:
  39
  40   from mox3 import mox
  41
  42 To learn how to use mox3 you may check the documentation of the original mox
  43 framework:
  44
  45   http://code.google.com/p/pymox/wiki/MoxDocumentation
  46
  47 Original Copyright
  48 ------------------
  49
  50 Mox is Copyright 2008 Google Inc, and licensed under the Apache
  51 License, Version 2.0; see the file COPYING.txt for details.  If you would
  52 like to help us improve Mox, join the group.
  53
  54 OpenStack Fork
  55 --------------
  56
  57 * Free software: Apache license
  58 * Documentation: http://docs.openstack.org/developer/mox3
  59 * Source: http://git.openstack.org/cgit/openstack/mox3
  60 * Bugs: http://bugs.launchpad.net/python-mox3