Merge pull request #1532 from rtfd/refactor-test-fixtures

Make test fixtures explicit

Author: ericholscher

readthedocs/rtd_tests/base.py

@@ -12,6 +12,7 @@
 
 class RTDTestCase(TestCase):
     def setUp(self):
+        self.original_DOCROOT = settings.DOCROOT
         self.cwd = os.path.dirname(__file__)
         self.build_dir = os.path.join(self.cwd, 'builds')
         log.info("build dir: %s" % self.build_dir)
@@ -21,6 +22,7 @@ def setUp(self):
 
     def tearDown(self):
         shutil.rmtree(self.build_dir)
+        settings.DOCROOT = self.original_DOCROOT
 
 
 @patch('readthedocs.projects.views.private.trigger_build', lambda x, basic: None)

readthedocs/rtd_tests/factories/__init__.py

@@ -9,12 +9,12 @@
 
 
 class TestGitBackend(RTDTestCase):
-    fixtures = ['eric.json']
-
     def setUp(self):
         git_repo = make_test_git()
         super(TestGitBackend, self).setUp()
-        self.eric = User.objects.get(username='eric')
+        self.eric = User(username='eric')
+        self.eric.set_password('test')
+        self.eric.save()
         self.project = Project.objects.create(
             name="Test Project",
             repo_type="git",
@@ -75,12 +75,12 @@ def test_parse_git_tags(self):
 
 
 class TestHgBackend(RTDTestCase):
-    fixtures = ['eric.json']
-
     def setUp(self):
         hg_repo = make_test_hg()
         super(TestHgBackend, self).setUp()
-        self.eric = User.objects.get(username='eric')
+        self.eric = User(username='eric')
+        self.eric.set_password('test')
+        self.eric.save()
         self.project = Project.objects.create(
             name="Test Project",
             repo_type="hg",

readthedocs/rtd_tests/factories/comments_factories.py

@@ -2,10 +2,12 @@
 import subprocess
 
 from django.test import TestCase
+from django_dynamic_fixture import get
+from django_dynamic_fixture import fixture
 import mock
 
+from readthedocs.projects.models import Project
 from readthedocs.projects.tasks import build_docs
-from readthedocs.rtd_tests.factories.projects_factories import ProjectFactory
 from readthedocs.rtd_tests.mocks.paths import fake_paths_lookup
 from readthedocs.doc_builder.loader import get_builder_class
 
@@ -35,8 +37,14 @@ class BuildTests(TestCase):
     @mock.patch('slumber.Resource')
     @mock.patch('os.chdir')
     @mock.patch('readthedocs.projects.models.Project.api_versions')
+    @mock.patch('readthedocs.vcs_support.utils.NonBlockingLock.__enter__')
     @mock.patch('subprocess.Popen')
-    def test_build(self, mock_Popen, mock_api_versions, mock_chdir, mock_apiv2_downloads):
+    def test_build(self,
+                   mock_Popen,
+                   mock_NonBlockingLock_enter,
+                   mock_api_versions,
+                   mock_chdir,
+                   mock_apiv2_downloads):
 
         # subprocess mock logic
 
@@ -46,7 +54,11 @@ def test_build(self, mock_Popen, mock_api_versions, mock_chdir, mock_apiv2_downl
         mock_Popen.return_value = mock_process
         mock_Popen.side_effect = build_subprocess_side_effect
 
-        project = ProjectFactory(allow_comments=True)
+        project = get(Project,
+                      slug='project-1',
+                      documentation_type='sphinx',
+                      conf_py_file='test_conf.py',
+                      versions=[fixture()])
 
         version = project.versions.all()[0]
         mock_api_versions.return_value = [version]
@@ -77,7 +89,10 @@ def test_build(self, mock_Popen, mock_api_versions, mock_chdir, mock_apiv2_downl
     def test_builder_comments(self):
 
         # Normal build
-        project = ProjectFactory(allow_comments=True)
+        project = get(Project,
+                      documentation_type='sphinx',
+                      allow_comments=True,
+                      versions=[fixture()])
         version = project.versions.all()[0]
         builder_class = get_builder_class(project.documentation_type)
         builder = builder_class(version)
@@ -86,7 +101,10 @@ def test_builder_comments(self):
     def test_builder_no_comments(self):
 
         # Normal build
-        project = ProjectFactory(allow_comments=False)
+        project = get(Project,
+                      documentation_type='sphinx',
+                      allow_comments=False,
+                      versions=[fixture()])
         version = project.versions.all()[0]
         builder_class = get_builder_class(project.documentation_type)
         builder = builder_class(version)
@@ -95,13 +113,15 @@ def test_builder_no_comments(self):
     @mock.patch('slumber.Resource')
     @mock.patch('os.chdir')
     @mock.patch('subprocess.Popen')
+    @mock.patch('readthedocs.vcs_support.utils.NonBlockingLock.__enter__')
     @mock.patch('readthedocs.doc_builder.backends.sphinx.HtmlBuilder.build')
     @mock.patch('readthedocs.doc_builder.backends.sphinx.PdfBuilder.build')
     @mock.patch('readthedocs.doc_builder.backends.sphinx.EpubBuilder.build')
     def test_build_respects_pdf_flag(self,
                                      EpubBuilder_build,
                                      PdfBuilder_build,
                                      HtmlBuilder_build,
+                                     mock_NonBlockingLock_enter,
                                      mock_Popen,
                                      mock_chdir,
                                      mock_apiv2_downloads):
@@ -114,9 +134,13 @@ def test_build_respects_pdf_flag(self,
         mock_Popen.return_value = mock_process
         mock_Popen.side_effect = build_subprocess_side_effect
 
-        project = ProjectFactory(
-            enable_pdf_build=True,
-            enable_epub_build=False)
+        project = get(Project,
+                      slug='project-1',
+                      documentation_type='sphinx',
+                      conf_py_file='test_conf.py',
+                      enable_pdf_build=True,
+                      enable_epub_build=False,
+                      versions=[fixture()])
         version = project.versions.all()[0]
 
         conf_path = os.path.join(project.checkout_path(version.slug), project.conf_py_file)
@@ -139,13 +163,15 @@ def test_build_respects_pdf_flag(self,
     @mock.patch('slumber.Resource')
     @mock.patch('os.chdir')
     @mock.patch('subprocess.Popen')
+    @mock.patch('readthedocs.vcs_support.utils.NonBlockingLock.__enter__')
     @mock.patch('readthedocs.doc_builder.backends.sphinx.HtmlBuilder.build')
     @mock.patch('readthedocs.doc_builder.backends.sphinx.PdfBuilder.build')
     @mock.patch('readthedocs.doc_builder.backends.sphinx.EpubBuilder.build')
     def test_build_respects_epub_flag(self,
                                       EpubBuilder_build,
                                       PdfBuilder_build,
                                       HtmlBuilder_build,
+                                      mock_NonBlockingLock_enter,
                                       mock_Popen,
                                       mock_chdir,
                                       mock_apiv2_downloads):
@@ -158,9 +184,13 @@ def test_build_respects_epub_flag(self,
         mock_Popen.return_value = mock_process
         mock_Popen.side_effect = build_subprocess_side_effect
 
-        project = ProjectFactory(
-            enable_pdf_build=False,
-            enable_epub_build=True)
+        project = get(Project,
+                      slug='project-2',
+                      documentation_type='sphinx',
+                      conf_py_file='test_conf.py',
+                      enable_pdf_build=False,
+                      enable_epub_build=True,
+                      versions=[fixture()])
         version = project.versions.all()[0]
 
         conf_path = os.path.join(project.checkout_path(version.slug), project.conf_py_file)

readthedocs/rtd_tests/factories/general_factories.py

@@ -16,13 +16,14 @@
 class TestCeleryBuilding(RTDTestCase):
 
     """These tests run the build functions directly. They don't use celery"""
-    fixtures = ['eric.json']
 
     def setUp(self):
         repo = make_test_git()
         self.repo = repo
         super(TestCeleryBuilding, self).setUp()
-        self.eric = User.objects.get(username='eric')
+        self.eric = User(username='eric')
+        self.eric.set_password('test')
+        self.eric.save()
         self.project = Project.objects.create(
             name="Test Project",
             repo_type="git",