README.rst 2.1 KB

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