From 078ad4b25e2dd51ada41422a974ba130991655bd Mon Sep 17 00:00:00 2001 From: Will Daly Date: Wed, 21 Aug 2013 20:31:23 -0400 Subject: [PATCH] Added comment justifying ModuleStoreTestCase design. --- .../xmodule/modulestore/tests/django_utils.py | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/common/lib/xmodule/xmodule/modulestore/tests/django_utils.py b/common/lib/xmodule/xmodule/modulestore/tests/django_utils.py index e7b0b98824..1f856d7eba 100644 --- a/common/lib/xmodule/xmodule/modulestore/tests/django_utils.py +++ b/common/lib/xmodule/xmodule/modulestore/tests/django_utils.py @@ -131,6 +131,22 @@ class ModuleStoreTestCase(TestCase): 3. Use factories (e.g. `CourseFactory`, `ItemFactory`) to populate the modulestore with test data. + + NOTE: + * For Mongo-backed courses (created with `CourseFactory`), + the state of the course will be reset before/after each + test method executes. + + * For XML-backed courses, the course state will NOT + reset between test methods (although it will reset + between test classes) + + The reason is: XML courses are not editable, so to reset + a course you have to reload it from disk, which is slow. + + If you do need to reset an XML course, use + `clear_existing_modulestores()` directly in + your `setUp()` method. """ @staticmethod