From 0b6a7d513c5073f9c424db7665580b8a3f97e011 Mon Sep 17 00:00:00 2001 From: Dan Radez Date: Mon, 17 Feb 2014 10:16:19 -0500 Subject: [PATCH] updating testing readme with more current information. Change-Id: I3ef39f5484170c1886c3b88e81b42450339a0d39 Closes-Bug: 1277179 --- cinder/testing/README.rst | 57 +++++++++------------------------------ 1 file changed, 13 insertions(+), 44 deletions(-) diff --git a/cinder/testing/README.rst b/cinder/testing/README.rst index 9a9d3146216..e83a7cea4dc 100644 --- a/cinder/testing/README.rst +++ b/cinder/testing/README.rst @@ -13,54 +13,23 @@ This README file attempts to provide current and prospective contributors with everything they need to know in order to start creating unit tests and utilizing the convenience code provided in cinder.testing. -Note: the content for the rest of this file will be added as the work items in -the following blueprint are completed: - https://blueprints.launchpad.net/cinder/+spec/consolidate-testing-infrastructure +For more detailed information on cinder unit tests visit: +http://docs.openstack.org/developer/cinder/devref/unit_tests.html - -Test Types: Unit vs. Functional vs. Integration +Running Tests ----------------------------------------------- -TBD +In the root of the cinder source code run the run_tests.sh script. This will +offer to create a virtual environment and populate it with dependencies. +If you don't have dependencies installed that are needed for compiling cinder's +direct dependencies, you'll have to use your operating system's method of +installing extra dependencies. To get help using this script execute it with +the -h parameter to get options `./run_tests.sh -h` Writing Unit Tests ------------------ -TBD - -Using Fakes -~~~~~~~~~~~ - -TBD - -test.TestCase -------------- -The TestCase class from cinder.test (generally imported as test) will -automatically manage self.stubs using the stubout module and self.mox -using the mox module during the setUp step. They will automatically -verify and clean up during the tearDown step. - -If using test.TestCase, calling the super class setUp is required and -calling the super class tearDown is required to be last if tearDown -is overridden. - -Writing Functional Tests ------------------------- - -TBD - -Writing Integration Tests -------------------------- - -TBD - -Tests and assertRaises ----------------------- -When asserting that a test should raise an exception, test against the -most specific exception possible. An overly broad exception type (like -Exception) can mask errors in the unit test itself. - -Example:: - - self.assertRaises(exception.InstanceNotFound, db.instance_get_by_uuid, - elevated, instance_uuid) +- All new unit tests are to be written in python-mock. +- Old tests that are still written in mox should be updated to use python-mock. + Usage of mox has been deprecated for writing Cinder unit tests. +- use addCleanup in favor of tearDown