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