test: mock pypandoc.convert_text when testing export views

conftest.py

@@ -54,3 +54,20 @@ def files(settings, tmp_path):
 def json_data():
     json_file = Path(settings.BASE_DIR) / 'import' / 'catalogs.json'
     return {'elements': json.loads(json_file.read_text())}
+
+
+@pytest.fixture
+def mocked_convert_text(mocker):
+    """Mock the pypandoc.convert_text function.
+
+    `mocked_convert_text` can be used in tests of the export views.
+    Use it to assert pypandoc would have been called with:
+    mocked_convert_text.assert_called(), mocked_convert_text.assert_called_once() or
+    mocked_convert_text.assert_called_once_with().
+
+    See:
+    - <https://pytest-mock.readthedocs.io/en/latest/usage.html>
+    - <https://docs.python.org/3/library/unittest.mock.html#unittest.mock.MagicMock>
+    """
+    from rdmo.core.utils import pypandoc  # noqa: F401
+    return mocker.patch("pypandoc.convert_text")

rdmo/conditions/tests/test_viewset_condition.py

@@ -1,5 +1,3 @@
-import xml.etree.ElementTree as et
-
 import pytest
 
 from django.urls import reverse
@@ -64,19 +62,13 @@ def test_index(db, client, username, password):
 
 @pytest.mark.parametrize('username,password', users)
 @pytest.mark.parametrize('export_format', export_formats)
-def test_export(db, client, username, password, export_format):
+def test_export(db, client, username, password, export_format, mocked_convert_text):
     client.login(username=username, password=password)
 
     url = reverse(urlnames['export']) + export_format + '/'
     response = client.get(url)
     assert response.status_code == status_map['list'][username], response.content
 
-    if response.status_code == 200 and export_format == 'xml':
-        root = et.fromstring(response.content)
-        assert root.tag == 'rdmo'
-        for child in root:
-            assert child.tag in ['condition']
-
 
 def test_export_search(db, client):
     client.login(username='editor', password='editor')
@@ -285,16 +277,10 @@ def test_delete(db, client, username, password):
 
 @pytest.mark.parametrize('username,password', users)
 @pytest.mark.parametrize('export_format', export_formats)
-def test_detail_export(db, client, username, password, export_format):
+def test_detail_export(db, client, username, password, export_format, mocked_convert_text):
     client.login(username=username, password=password)
     instance = Condition.objects.first()
 
     url = reverse(urlnames['detail_export'], args=[instance.pk]) + export_format + '/'
     response = client.get(url)
     assert response.status_code == status_map['detail'][username], response.content
-
-    if response.status_code == 200 and export_format == 'xml':
-        root = et.fromstring(response.content)
-        assert root.tag == 'rdmo'
-        for child in root:
-            assert child.tag in ['condition']

rdmo/conditions/tests/test_viewset_condition_multisite.py

@@ -1,5 +1,3 @@
-import xml.etree.ElementTree as et
-
 import pytest
 
 from django.urls import reverse
@@ -32,19 +30,13 @@ def test_index(db, client, username, password):
 
 @pytest.mark.parametrize('username,password', users)
 @pytest.mark.parametrize('export_format', export_formats)
-def test_export(db, client, username, password, export_format):
+def test_export(db, client, username, password, export_format, mocked_convert_text):
     client.login(username=username, password=password)
 
     url = reverse(urlnames['export']) + export_format + '/'
     response = client.get(url)
     assert response.status_code == status_map['list'][username], response.content
 
-    if response.status_code == 200 and export_format == 'xml':
-        root = et.fromstring(response.content)
-        assert root.tag == 'rdmo'
-        for child in root:
-            assert child.tag in ['condition']
-
 
 @pytest.mark.parametrize('username,password', users)
 def test_detail(db, client, username, password):
@@ -245,16 +237,10 @@ def test_delete(db, client, username, password):
 
 @pytest.mark.parametrize('username,password', users)
 @pytest.mark.parametrize('export_format', export_formats)
-def test_detail_export(db, client, username, password, export_format):
+def test_detail_export(db, client, username, password, export_format, mocked_convert_text):
     client.login(username=username, password=password)
     instance = Condition.objects.first()
 
     url = reverse(urlnames['detail_export'], args=[instance.pk]) + export_format + '/'
     response = client.get(url)
     assert response.status_code == status_map['detail'][username], response.content
-
-    if response.status_code == 200 and export_format == 'xml':
-        root = et.fromstring(response.content)
-        assert root.tag == 'rdmo'
-        for child in root:
-            assert child.tag in ['condition']

rdmo/core/tests/test_utils.py

@@ -1,8 +1,12 @@
+from http import HTTPStatus
 from typing import Optional
 
 import pytest
 
-from rdmo.core.utils import human2bytes, join_url, sanitize_url
+from rdmo.core.utils import human2bytes, join_url, render_to_format, sanitize_url
+from rdmo.projects.models import Project
+from rdmo.projects.utils import get_value_path
+from rdmo.views.utils import ProjectWrapper
 
 urls = (
     ('', ''),
@@ -23,6 +27,8 @@
     ("0", 0),
 )
 
+export_formats = ("invalid", "rtf", "odt", "docx", "html", "markdown", "tex", "pdf")
+
 
 @pytest.mark.parametrize('url,sanitized_url', urls)
 def test_sanitize_url(url, sanitized_url):
@@ -36,3 +42,49 @@ def test_join_url():
 @pytest.mark.parametrize('human,bytes', human2bytes_test_values)
 def test_human2bytes(human: Optional[str], bytes: float):
     assert human2bytes(human) == bytes
+
+
+@pytest.fixture(scope="module")
+def context(django_db_blocker):
+    """A fixture of a view context, to be used when testing 'render_to_format'.
+
+    Note: The fixture queries the database only once for the parametrized tests.
+    """
+    with django_db_blocker.unblock():
+        project = Project.objects.get(id=1)
+        project.catalog.prefetch_elements()
+        return {
+            "format": None, # will be defined in the test function
+            "project": project,
+            "project_wrapper": ProjectWrapper(project),
+            "title": project.title,
+            "resource_path": get_value_path(project)
+        }
+
+
+@pytest.mark.django_db()
+@pytest.mark.parametrize("export_format", export_formats)
+def test_render_to_format(rf, context, export_format):
+    """A test of the 'render_to_format' view with multiple export formats."""
+    context["format"] = export_format
+    title = context["project"].title
+
+    request = rf.get("/projects/project_answers_export")
+    response = render_to_format(
+        request,
+        export_format,
+        title,
+        "projects/project_answers_export.html",
+        context,
+    )
+
+    # an invalid export format should return an error message
+    if export_format == "invalid":
+        assert response.status_code == HTTPStatus.BAD_REQUEST
+        assert "This format is not supported." in str(response.content)
+        return
+    # check for the requested export format in the headers
+    assert response.status_code == HTTPStatus.OK
+    assert export_format in response.headers["Content-Type"]
+    expected = f'filename="{title}.{export_format}"'
+    assert expected in response.headers["Content-Disposition"]

rdmo/domain/tests/test_viewset_attribute.py

@@ -1,5 +1,3 @@
-import xml.etree.ElementTree as et
-
 import pytest
 
 from django.urls import reverse
@@ -54,19 +52,13 @@ def test_list(db, client, username, password):
 
 @pytest.mark.parametrize('username,password', users)
 @pytest.mark.parametrize('export_format', export_formats)
-def test_export(db, client, username, password, export_format):
+def test_export(db, client, username, password, export_format, mocked_convert_text):
     client.login(username=username, password=password)
 
     url = reverse(urlnames['export']) + export_format + '/'
     response = client.get(url)
     assert response.status_code == status_map['list'][username], response.content
 
-    if response.status_code == 200 and export_format == 'xml':
-        root = et.fromstring(response.content)
-        assert root.tag == 'rdmo'
-        for child in root:
-            assert child.tag in ['attribute']
-
 
 def test_export_search(db, client):
     client.login(username='editor', password='editor')
@@ -241,16 +233,10 @@ def test_delete(db, client, username, password):
 
 @pytest.mark.parametrize('username,password', users)
 @pytest.mark.parametrize('export_format', export_formats)
-def test_detail_export(db, client, username, password, export_format):
+def test_detail_export(db, client, username, password, export_format, mocked_convert_text):
     client.login(username=username, password=password)
     instance = Attribute.objects.first()
 
     url = reverse(urlnames['detail_export'], args=[instance.pk]) + export_format + '/'
     response = client.get(url)
     assert response.status_code == status_map['detail'][username], response.content
-
-    if response.status_code == 200 and export_format == 'xml':
-        root = et.fromstring(response.content)
-        assert root.tag == 'rdmo'
-        for child in root:
-            assert child.tag in ['attribute']

rdmo/options/tests/test_viewset_options.py

@@ -1,5 +1,3 @@
-import xml.etree.ElementTree as et
-
 import pytest
 
 from django.db.models import Max
@@ -65,19 +63,13 @@ def test_index(db, client, username, password):
 
 @pytest.mark.parametrize('username,password', users)
 @pytest.mark.parametrize('export_format', export_formats)
-def test_export(db, client, username, password, export_format):
+def test_export(db, client, username, password, export_format, mocked_convert_text):
     client.login(username=username, password=password)
 
     url = reverse(urlnames['export']) + export_format + '/'
     response = client.get(url)
     assert response.status_code == status_map['list'][username], response.content
 
-    if response.status_code == 200 and export_format == 'xml':
-        root = et.fromstring(response.content)
-        assert root.tag == 'rdmo'
-        for child in root:
-            assert child.tag in ['option']
-
 
 def test_export_search(db, client):
     client.login(username='editor', password='editor')
@@ -182,16 +174,10 @@ def test_delete(db, client, username, password):
 
 @pytest.mark.parametrize('username,password', users)
 @pytest.mark.parametrize('export_format', export_formats)
-def test_detail_export(db, client, username, password, export_format):
+def test_detail_export(db, client, username, password, export_format, mocked_convert_text):
     client.login(username=username, password=password)
     instance = Option.objects.first()
 
     url = reverse(urlnames['detail_export'], args=[instance.pk]) + export_format + '/'
     response = client.get(url)
     assert response.status_code == status_map['detail'][username], response.content
-
-    if response.status_code == 200 and export_format == 'xml':
-        root = et.fromstring(response.content)
-        assert root.tag == 'rdmo'
-        for child in root:
-            assert child.tag in ['option']

rdmo/options/tests/test_viewset_optionsets.py

@@ -1,5 +1,3 @@
-import xml.etree.ElementTree as et
-
 import pytest
 
 from django.urls import reverse
@@ -65,19 +63,13 @@ def test_index(db, client, username, password):
 
 @pytest.mark.parametrize('username,password', users)
 @pytest.mark.parametrize('export_format', export_formats)
-def test_export(db, client, username, password, export_format):
+def test_export(db, client, username, password, export_format, mocked_convert_text):
     client.login(username=username, password=password)
 
     url = reverse(urlnames['export']) + export_format + '/'
     response = client.get(url)
     assert response.status_code == status_map['list'][username], response.content
 
-    if response.status_code == 200 and export_format == 'xml':
-        root = et.fromstring(response.content)
-        assert root.tag == 'rdmo'
-        for child in root:
-            assert child.tag in ['optionset', 'option']
-
 
 def test_export_search(db, client):
     client.login(username='editor', password='editor')
@@ -289,16 +281,10 @@ def test_delete(db, client, username, password):
 
 @pytest.mark.parametrize('username,password', users)
 @pytest.mark.parametrize('export_format', export_formats)
-def test_detail_export(db, client, username, password, export_format):
+def test_detail_export(db, client, username, password, export_format, mocked_convert_text):
     client.login(username=username, password=password)
     instance = OptionSet.objects.first()
 
     url = reverse(urlnames['detail_export'], args=[instance.pk]) + export_format + '/'
     response = client.get(url)
     assert response.status_code == status_map['detail'][username], response.content
-
-    if response.status_code == 200 and export_format == 'xml':
-        root = et.fromstring(response.content)
-        assert root.tag == 'rdmo'
-        for child in root:
-            assert child.tag in ['optionset', 'option']

rdmo/projects/tests/test_view_project.py

@@ -690,7 +690,7 @@ def test_project_answers(db, client, username, password, project_id):
 @pytest.mark.parametrize('username,password', users)
 @pytest.mark.parametrize('project_id', projects)
 @pytest.mark.parametrize('export_format', export_formats)
-def test_project_answers_export(db, client, username, password, project_id, export_format):
+def test_project_answers_export(db, client, username, password, project_id, export_format, mocked_convert_text):
     client.login(username=username, password=password)
 
     url = reverse('project_answers_export', args=[project_id, export_format])
@@ -730,7 +730,7 @@ def test_project_view(db, client, username, password, project_id):
 @pytest.mark.parametrize('username,password', users)
 @pytest.mark.parametrize('project_id', projects)
 @pytest.mark.parametrize('export_format', export_formats)
-def test_project_view_export(db, client, username, password, project_id, export_format, files):
+def test_project_view_export(db, client, username, password, project_id, export_format, files, mocked_convert_text):
     client.login(username=username, password=password)
     project_views = Project.objects.get(pk=project_id).views.all()
 

rdmo/questions/tests/test_viewset_catalog.py

@@ -68,19 +68,13 @@ def test_index(db, client, username, password):
 
 @pytest.mark.parametrize('username,password', users)
 @pytest.mark.parametrize('export_format', export_formats)
-def test_export(db, client, username, password, export_format):
+def test_export(db, client, username, password, export_format, mocked_convert_text):
     client.login(username=username, password=password)
 
     url = reverse(urlnames['export']) + export_format + '/'
     response = client.get(url)
     assert response.status_code == status_map['list'][username], response.content
 
-    if response.status_code == 200 and export_format == 'xml':
-        root = et.fromstring(response.content)
-        assert root.tag == 'rdmo'
-        for child in root:
-            assert child.tag in ['catalog', 'section', 'page', 'questionset', 'question']
-
 
 def test_export_search(db, client):
     client.login(username='editor', password='editor')
@@ -238,20 +232,14 @@ def test_delete(db, client, username, password):
 
 @pytest.mark.parametrize('username,password', users)
 @pytest.mark.parametrize('export_format', export_formats)
-def test_detail_export(db, client, username, password, export_format):
+def test_detail_export(db, client, username, password, export_format, mocked_convert_text):
     client.login(username=username, password=password)
     instance = Catalog.objects.first()
 
     url = reverse(urlnames['detail_export'], args=[instance.pk]) + export_format + '/'
     response = client.get(url)
     assert response.status_code == status_map['detail'][username], response.content
 
-    if response.status_code == 200 and export_format == 'xml':
-        root = et.fromstring(response.content)
-        assert root.tag == 'rdmo'
-        for child in root:
-            assert child.tag in ['catalog', 'section', 'page', 'questionset', 'question']
-
 
 def test_detail_export_full(db, client):
     client.login(username='editor', password='editor')