Project API tests now pass with DRF3.

Moved factories to their own package.

DRF3-style test pattern for translations.

Fixes #1080, #1078, #1076, #1075

Author: jMyles

readthedocs/restapi/views/model_views.py

@@ -14,10 +14,12 @@
 from projects.filters import ProjectFilter
 from restapi.permissions import APIPermission
 
-from restapi.serializers import BuildSerializer, ProjectSerializer, VersionSerializer
+from restapi.serializers import BuildSerializer, ProjectSerializer, VersionSerializer,\
+    SimpleProjectSerializer
 from restapi.permissions import RelatedProjectIsOwner
 import restapi.utils as api_utils
 from docutils.utils.math.math2html import Link
+from rest_framework.decorators import detail_route
 
 log = logging.getLogger(__name__)
 
@@ -31,11 +33,11 @@ class ProjectViewSet(viewsets.ModelViewSet):
     paginate_by = 100
     paginate_by_param = 'page_size'
     max_paginate_by = 1000
- 
+
     def get_queryset(self):
         return self.model.objects.api(self.request.user)
 
-    @decorators.list_route()
+    @decorators.detail_route()
     def valid_versions(self, request, **kwargs):
         """
         Maintain state of versions that are wanted.
@@ -51,15 +53,14 @@ def valid_versions(self, request, **kwargs):
             'flat': version_strings,
         })
 
-    @decorators.list_route()
-    def translations(self, request, **kwargs):
-        project = get_object_or_404(Project.objects.api(self.request.user), pk=kwargs['pk'])
-        queryset = project.translations.all()
+    @detail_route()
+    def translations(self, request, pk):
+        translations = self.get_object().translations.all()
         return Response({
-            'translations': ProjectSerializer(queryset, many=True).data
+            'translations': ProjectSerializer(translations, many=True).data
         })
 
-    @decorators.list_route()
+    @detail_route()
     def subprojects(self, request, **kwargs):
         project = get_object_or_404(Project.objects.api(self.request.user), pk=kwargs['pk'])
         rels = project.subprojects.all()
@@ -68,15 +69,15 @@ def subprojects(self, request, **kwargs):
             'subprojects': ProjectSerializer(children, many=True).data
         })
 
-    @decorators.list_route(permission_classes=[permissions.IsAdminUser])
+    @decorators.detail_route(permission_classes=[permissions.IsAdminUser])
     def token(self, request, **kwargs):
         project = get_object_or_404(Project.objects.api(self.request.user), pk=kwargs['pk'])
         token = oauth_utils.get_token_for_project(project, force_local=True)
         return Response({
             'token': token
         })
 
-    @decorators.detail_route(permission_classes=[permissions.IsAdminUser])
+    @decorators.detail_route(permission_classes=[permissions.IsAdminUser], methods=['post'])
     def sync_versions(self, request, **kwargs):
         """
         Sync the version data in the repo (on the build server) with what we have in the database.

readthedocs/rtd_tests/tests/coments_factories.py renamed to readthedocs/rtd_tests/factories/comments_factories.py

@@ -1,14 +1,15 @@
 import factory
 from projects.models import Project
 from builds.models import Version
+from bamboo_boy.materials import Clump
 
 
 class VersionFactory(factory.DjangoModelFactory):
 
     FACTORY_FOR = Version
 
     verbose_name = factory.Sequence(lambda n: "Project %s" % n)
-    slug = factory.Sequence(lambda n: "project-%s" % n) 
+    slug = factory.Sequence(lambda n: "project-%s" % n)
 
 
 class ProjectFactory(factory.DjangoModelFactory):
@@ -19,7 +20,17 @@ class ProjectFactory(factory.DjangoModelFactory):
     slug = factory.Sequence(lambda n: "project-%s" % n)
     documentation_type = "sphinx"
     conf_py_file = "test_conf.py"
-    
+
     version = factory.RelatedFactory(VersionFactory,
                                      'project',
-                                     )
+                                     )
+
+
+class OneProjectWithTranslationsOneWithout(Clump):
+
+    def build_canopy(self):
+        self.project_with_translations = self.include_factory(
+            ProjectFactory, 1)[0]
+        self.first_translation = ProjectFactory(
+            main_language_project=self.project_with_translations)
+        pass

readthedocs/rtd_tests/tests/general_factories.py renamed to readthedocs/rtd_tests/factories/general_factories.py

@@ -1,8 +1,10 @@
+import subprocess
+
 from django.test import TestCase
-from projects.tasks import build_docs
-from rtd_tests.tests.projects_factories import ProjectFactory
 import mock
-import subprocess
+
+from projects.tasks import build_docs
+from rtd_tests.factories.projects_factories import ProjectFactory
 
 
 class MockProcess(object):
@@ -11,7 +13,7 @@ class MockProcess(object):
 
     def __init__(self, communicate_result):
         self.communicate_result = communicate_result
-    
+
     def communicate(self):
         return self.communicate_result
 
@@ -31,37 +33,34 @@ class BuildTests(TestCase):
     @mock.patch('os.chdir')
     @mock.patch('projects.models.Project.api_versions')
     @mock.patch('subprocess.Popen')
-    
     def test_build(self, mock_Popen, mock_api_versions, mock_chdir, mock_apiv2_downloads):
-        
+
         # subprocess mock logic
-        
+
         mock_process = mock.Mock()
         process_return_dict = {'communicate.return_value': ('SOMEGITHASH', '')}
         mock_process.configure_mock(**process_return_dict)
         mock_Popen.return_value = mock_process
         mock_Popen.side_effect = build_subprocess_side_effect
-        
-        
+
         project = ProjectFactory(allow_comments=True)
-        
+
         version = project.versions.all()[0]
         mock_api_versions.return_value = [version]
-        
+
         mock_apiv2_downloads.get.return_value = {'downloads': "no_url_here"}
-        
+
         with mock.patch('codecs.open', mock.mock_open(), create=True):
             built_docs = build_docs(version,
-                       False,
-                       False,
-                       False,
-                       False,
-                       False,
-                       False,
-                       False,
-                       )
-        
+                                    False,
+                                    False,
+                                    False,
+                                    False,
+                                    False,
+                                    False,
+                                    False,
+                                    )
+
         self.assertIn(project.doc_builder().sphinx_builder,
                       str(mock_Popen.call_args_list[1])
-                         )
-        
+                      )

readthedocs/rtd_tests/tests/projects_factories.py renamed to readthedocs/rtd_tests/factories/projects_factories.py

@@ -12,10 +12,10 @@
 from comments.views import add_node, get_metadata, update_node
 from privacy.backend import AdminNotAuthorized
 from projects.views.private import project_comments_moderation
-from rtd_tests.tests.coments_factories import DocumentNodeFactory, \
+from rtd_tests.factories.comments_factories import DocumentNodeFactory, \
     DocumentCommentFactory, ProjectsWithComments
-from rtd_tests.tests.general_factories import UserFactory
-from rtd_tests.tests.projects_factories import ProjectFactory
+from rtd_tests.factories.general_factories import UserFactory
+from rtd_tests.factories.projects_factories import ProjectFactory
 
 
 @with_canopy(ProjectsWithComments)

readthedocs/rtd_tests/tests/test_builds.py

@@ -1,11 +1,14 @@
+from bamboo_boy.utils import with_canopy
 import json
-
 from django.test import TestCase
-
 from projects.models import Project
-from .projects_factories import ProjectFactory
+from rtd_tests.factories.projects_factories import OneProjectWithTranslationsOneWithout,\
+    ProjectFactory
+from rest_framework.reverse import reverse
+from restapi.serializers import ProjectSerializer, SimpleProjectSerializer
 
 
+@with_canopy(OneProjectWithTranslationsOneWithout)
 class TestProject(TestCase):
     fixtures = ["eric", "test_data"]
 
@@ -27,27 +30,23 @@ def test_subprojects(self):
         self.assertEqual(resp['subprojects'][0]['id'], 23)
 
     def test_translations(self):
-        r = self.client.get('/api/v2/project/6/translations/', {})
-        self.assertEqual(r.status_code, 200)
+        p = self.canopy.project_with_translations
+        url = reverse('project-translations', [p.id])
+        response = self.client.get(url)
+        self.assertEqual(response.status_code, 200)
+
+        translation_ids_from_api = [t['id']
+                                    for t in response.data['translations']]
+        translation_ids_from_orm = [t[0]
+                                    for t in p.translations.values_list('id')]
+
+        self.assertEqual(
+            set(translation_ids_from_api),
+            set(translation_ids_from_orm)
+        )
 
     def test_token(self):
         r = self.client.get('/api/v2/project/6/token/', {})
         resp = json.loads(r.content)
         self.assertEqual(r.status_code, 200)
         self.assertEqual(resp['token'], None)
-
-class ProjectCommentTests(TestCase):
-    
-    def test_commentable_project_uses_builder_with_commentable_versioning_method(self):
-        '''
-        Even though we show the user a boolean "commentable" option,
-        we compose this knowledge as a separate class, WebSupportBuilder.
-        '''
-        project = ProjectFactory(allow_comments=True)
-        builder = project.doc_builder()
-        self.assertEqual(getattr(builder, 'versioning_method', None), "commentable")
-        
-    def test_uncommentable_project_uses_builder_without_commentable_verioning_method(self):
-        project = ProjectFactory(allow_comments=False)
-        builder = project.doc_builder()
-        self.assertNotEqual(getattr(builder, 'versioning_method', None), "commentable")