Merge pull request #1319 from rdmorganiser/refactor_tests

Refactor tests

Author: jochenklar

pyproject.toml

@@ -229,13 +229,11 @@ parallel = true
 
 [tool.coverage.report]
 omit = [
-    "*/management/*",
+    "*/management/commands/*",
     "*/migrations/*",
-    "*/tests/*",
 ]
 exclude_lines = [
-    "raise Exception",
-    "except ImportError:"
+    "raise NotImplementedError"
 ]
 
 [tool.typos] # Ref: https://github.com/crate-ci/typos/blob/master/docs/reference.md

rdmo/conditions/tests/test_viewset_condition.py

@@ -41,7 +41,7 @@
     'copy': 'v1-conditions:condition-copy'
 }
 
-export_formats = ('xml', 'rtf', 'odt', 'docx', 'html', 'markdown', 'tex', 'pdf')
+export_formats = ('xml', 'html')
 
 
 @pytest.mark.parametrize('username,password', users)

rdmo/core/pandoc.py

@@ -30,35 +30,35 @@ def get_pandoc_content(html, metadata, export_format, context):
 
     if metadata:
         # create a temporary file for the metadata and close it immediately
-        metadata_tmp_file_name = create_tmp_file('.json')
+        metadata_tmp_file_path = create_tmp_file('.json')
 
         # save metadata
-        log.info('Save metadata file %s %s', metadata_tmp_file_name, str(metadata))
-        with open(metadata_tmp_file_name, 'w') as fp:
+        log.info('Save metadata file %s %s', str(metadata_tmp_file_path), str(metadata))
+        with open(metadata_tmp_file_path, 'w') as fp:
             json.dump(metadata, fp)
 
         # add metadata file to pandoc args
-        pandoc_args.append('--metadata-file=' + metadata_tmp_file_name)
+        pandoc_args.append(f'--metadata-file={metadata_tmp_file_path}')
 
     # create a temporary file and close it immediately
-    tmp_file_name = create_tmp_file(f'.{export_format}')
+    tmp_file_path = create_tmp_file(f'.{export_format}')
 
     # convert the file using pandoc
     log.info('Export %s document using args %s.', export_format, pandoc_args)
     html = re.sub(
         r'(<img.+src=["\'])' + settings.STATIC_URL + r'([\w\-\@?^=%&/~\+#]+)', r'\g<1>' +
         str(Path(settings.STATIC_ROOT)) + r'/\g<2>', html
     )
-    pypandoc.convert_text(html, export_format, format='html', outputfile=tmp_file_name, extra_args=pandoc_args)
+    pypandoc.convert_text(html, export_format, format='html', outputfile=tmp_file_path, extra_args=pandoc_args)
 
     # read the created temporary file
-    with open(tmp_file_name, 'rb') as fp:
+    with open(tmp_file_path, 'rb') as fp:
         pandoc_content = fp.read()
 
     # delete temporary files
     if metadata:
-        os.remove(metadata_tmp_file_name)
-    os.remove(tmp_file_name)
+        os.remove(metadata_tmp_file_path)
+    os.remove(tmp_file_path)
 
     return pandoc_content
 

rdmo/core/tests/test_pandoc.py

@@ -6,7 +6,14 @@
 
 from packaging.version import Version
 
-from ..pandoc import get_pandoc_args, get_pandoc_reference_document, get_pandoc_reference_documents, get_pandoc_version
+from ..pandoc import (
+    get_pandoc_args,
+    get_pandoc_content,
+    get_pandoc_content_disposition,
+    get_pandoc_reference_document,
+    get_pandoc_reference_documents,
+    get_pandoc_version,
+)
 
 rdmo_path = Path(apps.get_app_config('rdmo').path)
 testing_path = rdmo_path.parent / 'testing'
@@ -65,6 +72,7 @@
 class MockedView:
     uri = 'http://example.com/terms/views/view'
 
+
 @pytest.mark.parametrize('pandoc_version', pandoc_versions)
 def test_get_pandoc_version(mocker, pandoc_version):
     mocker.patch('pypandoc.get_pandoc_version', return_value=pandoc_version)
@@ -75,9 +83,21 @@ def test_get_pandoc_version(mocker, pandoc_version):
 @pytest.mark.parametrize('export_format', export_formats)
 def test_get_pandoc_args(settings, mocker, pandoc_version, export_format):
     mocker.patch('pypandoc.get_pandoc_version', return_value=pandoc_version)
+    pandoc_args = pandoc_args_map[pandoc_version].get(export_format, pandoc_args_map[pandoc_version]['other'])
+
+    assert get_pandoc_args(export_format, {}) == pandoc_args
+
+
+@pytest.mark.parametrize('pandoc_version', pandoc_versions)
+@pytest.mark.parametrize('export_format', export_formats)
+def test_get_pandoc_args_resource_path(settings, mocker, pandoc_version, export_format):
+    mocker.patch('pypandoc.get_pandoc_version', return_value=pandoc_version)
+    pandoc_args = pandoc_args_map[pandoc_version].get(export_format, pandoc_args_map[pandoc_version]['other']).copy()
+
+    if Version(pandoc_version) >= Version('2'):
+        pandoc_args.append(f'--resource-path={testing_path}/media_root/test')
 
-    assert get_pandoc_args(export_format, {}) == \
-        pandoc_args_map[pandoc_version].get(export_format, pandoc_args_map[pandoc_version]['other'])
+    assert get_pandoc_args(export_format, {'resource_path': 'test'}) == pandoc_args
 
 
 def test_get_pandoc_reference_document(mocker):
@@ -154,3 +174,29 @@ def test_get_pandoc_reference_documents_settings(settings, export_format):
         assert reference_documents == [mock_file, rdmo_path / 'share' / f'reference.{export_format}']
     else:
         assert reference_documents == []
+
+
+@pytest.mark.parametrize('export_format', export_formats)
+def test_get_pandoc_content(settings, export_format):
+    html_path = settings.BASE_DIR / 'export' / 'project.html'
+    html = html_path.read_text()
+
+    metadata = {
+        'title': 'this is a very nice title',
+        'author': ['author one', 'author two'],
+        'keywords': ['nothing', 'something', 'whatever']
+    }
+
+    assert len(get_pandoc_content(html, metadata, export_format, {})) > 0
+
+
+@pytest.mark.parametrize('export_format', export_formats)
+def test_get_pandoc_content_disposition(export_format):
+    title = 'Test'
+
+    if export_format == 'pdf':
+        content_disposition = f'filename="{title}.{export_format}"'
+    else:
+        content_disposition = f'attachment; filename="{title}.{export_format}"'
+
+    assert get_pandoc_content_disposition(export_format, 'Test') == content_disposition

rdmo/core/tests/test_utils.py

@@ -5,7 +5,14 @@
 
 from django.utils.translation import activate
 
-from rdmo.core.utils import human2bytes, join_url, parse_date_from_string, sanitize_url
+from rdmo.core.utils import (
+    human2bytes,
+    join_url,
+    parse_date_from_string,
+    parse_metadata,
+    remove_double_newlines,
+    sanitize_url,
+)
 
 urls = (
     ('', ''),
@@ -46,6 +53,23 @@
     (datetime.date(2025, 2, 17), "date must be provided as string")
 ]
 
+metadata_html = [
+    ('<html><metadata>{"foo": "bar"}</metadata></html>', {'foo': 'bar'}, '<html></html>'),
+    ('<html><metadata>{"f</metadata></html>', None, '<html><metadata>{"f</metadata></html>'),
+    ('<html></html>', None, '<html></html>')
+]
+
+double_newline_strings = [
+    ('test\n\n\n\ntest', 'test\n\ntest'),
+    ('test\n\n\ntest', 'test\n\ntest'),
+    ('test\n\ntest', 'test\n\ntest'),
+    ('test\ntest', 'test\ntest'),
+]
+
+export_formats = ('xml', 'rtf', 'odt', 'docx', 'html', 'markdown', 'tex', 'pdf')
+
+
+
 @pytest.mark.parametrize('url,sanitized_url', urls)
 def test_sanitize_url(url, sanitized_url):
     assert sanitize_url(url) == sanitized_url
@@ -60,17 +84,27 @@ def test_human2bytes(human: Optional[str], bytes: float):
     assert human2bytes(human) == bytes
 
 
-@pytest.mark.parametrize("locale, date_string, expected_date",valid_date_strings)
+@pytest.mark.parametrize("locale, date_string, expected_date", valid_date_strings)
 def test_parse_date_from_string_valid_formats(settings, locale, date_string, expected_date):
     activate(locale)
     assert parse_date_from_string(date_string) == expected_date
 
 
-@pytest.mark.parametrize("invalid_date, error_msg",invalid_date_strings)
+@pytest.mark.parametrize("invalid_date, error_msg", invalid_date_strings)
 def test_parse_date_from_string_invalid_formats(settings, invalid_date, error_msg):
     if not isinstance(invalid_date,str):
         with pytest.raises(TypeError, match=error_msg):
             parse_date_from_string(invalid_date)
     else:
         with pytest.raises(ValueError,match=error_msg):
             parse_date_from_string(invalid_date)
+
+
+@pytest.mark.parametrize('input_html, metadata, output_html', metadata_html)
+def test_parse_metadata(input_html, metadata, output_html):
+    assert parse_metadata(input_html) == (metadata, output_html)
+
+
+@pytest.mark.parametrize('input_string, output_string', double_newline_strings)
+def test_remove_double_newlines(input_string, output_string):
+    assert remove_double_newlines(input_string) == output_string

rdmo/core/tests/test_viewset_groups.py

@@ -0,0 +1,31 @@
+import pytest
+
+from django.urls import reverse
+
+users = (
+    ('editor', 'editor'),
+    ('reviewer', 'reviewer'),
+    ('user', 'user'),
+    ('site', 'site'),
+    ('api', 'api'),
+    ('anonymous', None)
+)
+
+status_map = {
+    'list': {
+        'editor': 200, 'reviewer': 200, 'user': 403, 'site': 403, 'api': 200, 'anonymous': 401
+    }
+}
+
+urlnames = {
+    'list': 'v1-core:group-list',
+}
+
+
+@pytest.mark.parametrize('username,password', users)
+def test_list(db, client, username, password):
+    client.login(username=username, password=password)
+
+    url = reverse(urlnames['list'])
+    response = client.get(url)
+    assert response.status_code == status_map['list'][username], response.json()

rdmo/core/tests/test_viewset_sites.py

@@ -0,0 +1,31 @@
+import pytest
+
+from django.urls import reverse
+
+users = (
+    ('editor', 'editor'),
+    ('reviewer', 'reviewer'),
+    ('user', 'user'),
+    ('site', 'site'),
+    ('api', 'api'),
+    ('anonymous', None)
+)
+
+status_map = {
+    'list': {
+        'editor': 200, 'reviewer': 200, 'user': 403, 'site': 403, 'api': 200, 'anonymous': 401
+    }
+}
+
+urlnames = {
+    'list': 'v1-core:site-list',
+}
+
+
+@pytest.mark.parametrize('username,password', users)
+def test_list(db, client, username, password):
+    client.login(username=username, password=password)
+
+    url = reverse(urlnames['list'])
+    response = client.get(url)
+    assert response.status_code == status_map['list'][username], response.json()

rdmo/core/utils.py

@@ -209,23 +209,6 @@ def import_class(string):
     return getattr(importlib.import_module(module_name), class_name)
 
 
-def copy_model(instance, **kwargs):
-    # get values from instance which are not id, ForeignKeys or M2M relations
-    data = {}
-    for field in instance._meta.get_fields():
-        if not (field.name == 'id' or field.is_relation):
-            data[field.name] = getattr(instance, field.name)
-
-    # update with the kwargs provided to this function
-    data.update(kwargs)
-
-    # create and save new instance
-    instance_copy = instance._meta.model(**data)
-    instance_copy.save()
-
-    return instance_copy
-
-
 def human2bytes(string):
     if not string or string == '0':
         return 0

rdmo/domain/tests/test_viewset_attribute.py

@@ -40,7 +40,7 @@
     'copy': 'v1-domain:attribute-copy'
 }
 
-export_formats = ('xml', 'csvcomma', 'csvsemicolon', 'rtf', 'odt', 'docx', 'html', 'markdown', 'tex', 'pdf')
+export_formats = ('xml', 'html')
 
 
 @pytest.mark.parametrize('username,password', users)

rdmo/management/tests/test_viewset_meta.py

@@ -0,0 +1,31 @@
+import pytest
+
+from django.urls import reverse
+
+users = (
+    ('editor', 'editor'),
+    ('reviewer', 'reviewer'),
+    ('user', 'user'),
+    ('site', 'site'),
+    ('api', 'api'),
+    ('anonymous', None)
+)
+
+status_map = {
+    'list': {
+        'editor': 200, 'reviewer': 200, 'user': 200, 'site': 200, 'api': 200, 'anonymous': 401
+    }
+}
+
+urlnames = {
+    'list': 'v1-management:meta-list',
+}
+
+
+@pytest.mark.parametrize('username,password', users)
+def test_list(db, client, username, password):
+    client.login(username=username, password=password)
+
+    url = reverse(urlnames['list'])
+    response = client.get(url)
+    assert response.status_code == status_map['list'][username], response.json()