Update tests

Author: stsewd

pytest.ini

@@ -1,8 +1,8 @@
 [pytest]
 addopts = --reuse-db --strict-markers
 markers =
+    sphinx
     search
-    serve
     proxito
 python_files = tests.py test_*.py *_tests.py
 filterwarnings =

readthedocs/api/v2/proxied_urls.py

@@ -15,7 +15,7 @@
 api_footer_urls = [
     url(r'footer_html/', ProxiedFooterHTML.as_view(), name='footer_html'),
     url(r'search/$', ProxiedPageSearchAPIView.as_view(), name='search_api'),
-    url(r'embed/', ProxiedEmbedAPI.as_view(), name='embed_api'),
+    url(r'embed/', ProxiedEmbedAPI.as_view(), name='api_embed'),
     url(r'analytics/$', AnalyticsView.as_view(), name='analytics_api'),
 ]
 

readthedocs/embed/tests/test_api.py

@@ -17,8 +17,9 @@
 data_path = Path(__file__).parent.resolve() / 'data'
 
 
+@pytest.mark.sphinx
 @pytest.mark.django_db
-class TestEmbedAPI:
+class BaseTestEmbedAPISphinx:
 
     @pytest.fixture(autouse=True)
     def setup_method(self, settings):
@@ -57,6 +58,9 @@ def _get_html_content(self, html_file):
         section_content = [PyQuery(html_file.open().read()).outerHtml()]
         return section_content
 
+    def get(self, client, *args, **kwargs):
+        return client.get(*args, **kwargs)
+
     def test_invalid_arguments(self, client):
         query_params = (
             {
@@ -72,7 +76,7 @@ def test_invalid_arguments(self, client):
 
         api_endpoint = reverse('api_embed')
         for param in query_params:
-            r = client.get(api_endpoint, param)
+            r = self.get(client, api_endpoint, param)
             assert r.status_code == status.HTTP_400_BAD_REQUEST
 
     @mock.patch('readthedocs.embed.views.build_media_storage')
@@ -123,7 +127,7 @@ def test_valid_arguments(self, storage_mock, client):
         )
         api_endpoint = reverse('api_embed')
         for param in query_params:
-            r = client.get(api_endpoint, param)
+            r = self.get(client, api_endpoint, param)
             assert r.status_code == status.HTTP_200_OK
 
     @mock.patch('readthedocs.embed.views.build_media_storage')
@@ -137,7 +141,8 @@ def test_embed_unknown_section(self, storage_mock, client):
             html_file=html_file,
         )
 
-        response = client.get(
+        response = self.get(
+            client,
             reverse('api_embed'),
             {
                 'project': self.project.slug,
@@ -184,7 +189,8 @@ def test_embed_sphinx(self, storage_mock, section, client):
             html_file=html_file,
         )
 
-        response = client.get(
+        response = self.get(
+            client,
             reverse('api_embed'),
             {
                 'project': self.project.slug,
@@ -234,7 +240,7 @@ def test_embed_sphinx(self, storage_mock, section, client):
         ]
     )
     @mock.patch('readthedocs.embed.views.build_media_storage')
-    def test_embed_sphinx_bibtex(self, storage_mock, section):
+    def test_embed_sphinx_bibtex(self, storage_mock, section, client):
         json_file = data_path / 'sphinx/bibtex/page.json'
         html_file = data_path / 'sphinx/bibtex/page.html'
 
@@ -244,11 +250,15 @@ def test_embed_sphinx_bibtex(self, storage_mock, section):
             html_file=html_file,
         )
 
-        response = do_embed(
-            project=self.project,
-            version=self.version,
-            section=section,
-            path='index.html',
+        response = self.get(
+            client,
+            reverse('api_embed'),
+            {
+                'project': self.project.slug,
+                'version': self.version.slug,
+                'section': section,
+                'path': 'index.html',
+            }
         )
 
         section_content = self._get_html_content(
@@ -267,7 +277,7 @@ def test_embed_sphinx_bibtex(self, storage_mock, section):
             'meta': {
                 'project': 'project',
                 'version': 'latest',
-                'doc': None,
+                'doc': 'index',
                 'section': section,
             },
         }
@@ -294,7 +304,7 @@ def test_embed_sphinx_bibtex(self, storage_mock, section):
         ]
     )
     @mock.patch('readthedocs.embed.views.build_media_storage')
-    def test_embed_sphinx_glossary(self, storage_mock, section):
+    def test_embed_sphinx_glossary(self, storage_mock, section, client):
         # TODO: render definition lists as a definition list with one element.
         json_file = data_path / 'sphinx/glossary/page.json'
         html_file = data_path / 'sphinx/glossary/page.html'
@@ -305,11 +315,15 @@ def test_embed_sphinx_glossary(self, storage_mock, section):
             html_file=html_file,
         )
 
-        response = do_embed(
-            project=self.project,
-            version=self.version,
-            section=section,
-            path='index.html',
+        response = self.get(
+            client,
+            reverse('api_embed'),
+            {
+                'project': self.project.slug,
+                'version': self.version.slug,
+                'section': section,
+                'path': 'index.html',
+            }
         )
 
         section_content = self._get_html_content(
@@ -325,56 +339,25 @@ def test_embed_sphinx_glossary(self, storage_mock, section):
             'meta': {
                 'project': 'project',
                 'version': 'latest',
-                'doc': None,
+                'doc': 'index',
                 'section': section,
             },
         }
 
+        assert response.status_code == status.HTTP_200_OK
         assert response.data == expected
 
-    @mock.patch('readthedocs.embed.views.build_media_storage')
-    def test_embed_mkdocs(self, storage_mock, client):
-        json_file = data_path / 'mkdocs/latest/index.json'
-        storage_mock.exists.return_value = True
-        storage_mock.open.side_effect = self._mock_open(
-            json_file.open().read()
-        )
 
-        self.version.documentation_type = MKDOCS
-        self.version.save()
+class TestEmbedAPISphinx(BaseTestEmbedAPISphinx):
 
-        response = client.get(
-            reverse('api_embed'),
-            {
-                'project': self.project.slug,
-                'version': self.version.slug,
-                'path': 'index.html',
-                'section': 'Installation',
-            }
-        )
+    pass
 
-        expected = {
-            'content': mock.ANY,  # too long to compare here
-            'headers': [
-                {'Overview': 'overview'},
-                {'Installation': 'installation'},
-                {'Getting Started': 'getting-started'},
-                {'Adding pages': 'adding-pages'},
-                {'Theming our documentation': 'theming-our-documentation'},
-                {'Changing the Favicon Icon': 'changing-the-favicon-icon'},
-                {'Building the site': 'building-the-site'},
-                {'Other Commands and Options': 'other-commands-and-options'},
-                {'Deploying': 'deploying'},
-                {'Getting help': 'getting-help'},
-            ],
-            'url': 'http://project.readthedocs.io/en/latest/index.html',
-            'meta': {
-                'project': 'project',
-                'version': 'latest',
-                'doc': 'index',
-                'section': 'Installation',
-            },
-        }
 
-        assert response.status_code == status.HTTP_200_OK
-        assert response.data == expected
+@pytest.mark.proxito
+class TestProxiedEmbedAPISphinx(BaseTestEmbedAPISphinx):
+
+    host = 'project.readthedocs.io'
+
+    def get(self, client, *args, **kwargs):
+        r = client.get(*args, HTTP_HOST=self.host, **kwargs)
+        return r