Merge pull request #11683 from Vlad0n20/feature/ENG-9822

[ENG-9822] - add required_metadata_template to API

Author: adlius

api/providers/serializers.py

@@ -77,6 +77,12 @@ class Meta:
         related_view_kwargs={'provider_id': '<_id>'},
     )
 
+    required_metadata_template = RelationshipField(
+        related_view='cedar-metadata-templates:cedar-metadata-template-detail',
+        related_view_kwargs={'template_id': '<required_metadata_template._id>'},
+        read_only=True,
+    )
+
     schemas = TypedRelationshipField(
         related_view='providers:registration-providers:registration-schema-list',
         related_view_kwargs={'provider_id': '<_id>'},

api_tests/providers/collections/views/test_collection_provider_detail.py

@@ -2,6 +2,7 @@
 
 from api.base.settings.defaults import API_BASE
 from api_tests.providers.mixins import ProviderExistsMixin
+from osf.models import CedarMetadataTemplate
 from osf_tests.factories import (
     CollectionProviderFactory,
     BrandFactory,
@@ -55,3 +56,40 @@ def test_registration_provider_with_special_fields(self, app, provider_with_bran
         data = res.json['data']
 
         assert data['relationships']['brand']['data']['id'] == str(brand.id)
+
+
+@pytest.mark.django_db
+class TestCollectionProviderRequiredMetadataTemplate:
+
+    @pytest.fixture()
+    def provider(self):
+        return CollectionProviderFactory()
+
+    @pytest.fixture()
+    def provider_url(self, provider):
+        return f'/{API_BASE}providers/collections/{provider._id}/?version=2.20'
+
+    @pytest.fixture()
+    def cedar_template(self):
+        return CedarMetadataTemplate.objects.create(
+            schema_name='Test Schema',
+            cedar_id='https://repo.metadatacenter.org/templates/test',
+            template_version=1,
+            template={},
+            active=True,
+        )
+
+    def test_required_metadata_template_is_null_by_default(self, app, provider, provider_url):
+        res = app.get(provider_url)
+        assert res.status_code == 200
+        assert res.json['data']['relationships']['required_metadata_template']['data'] is None
+
+    def test_required_metadata_template_when_set(self, app, provider, provider_url, cedar_template):
+        from osf.models import AbstractProvider
+        AbstractProvider.objects.filter(pk=provider.pk).update(required_metadata_template=cedar_template)
+
+        res = app.get(provider_url)
+        assert res.status_code == 200
+        rel = res.json['data']['relationships']['required_metadata_template']
+        assert rel['data']['id'] == cedar_template._id
+        assert rel['data']['type'] == 'cedar-metadata-templates'

api_tests/providers/preprints/views/test_preprint_provider_detail.py

@@ -3,6 +3,7 @@
 from api.base.settings.defaults import API_BASE
 from api.base.settings import REST_FRAMEWORK
 from api_tests.providers.mixins import ProviderExistsMixin
+from osf.models import CedarMetadataTemplate
 from osf_tests.factories import (
     PreprintProviderFactory,
     ProviderAssetFileFactory,
@@ -216,3 +217,40 @@ def test_asset_attribute_correct(self, app, provider_one, provider_two, provider
 
         res = app.get(provider_two_url)
         assert res.json['data']['attributes']['assets'][provider_asset_two.name] == provider_asset_two.file.url
+
+
+@pytest.mark.django_db
+class TestPreprintProviderRequiredMetadataTemplate:
+
+    @pytest.fixture()
+    def provider(self):
+        return PreprintProviderFactory()
+
+    @pytest.fixture()
+    def provider_url(self, provider):
+        return f'/{API_BASE}providers/preprints/{provider._id}/?version=2.20'
+
+    @pytest.fixture()
+    def cedar_template(self):
+        return CedarMetadataTemplate.objects.create(
+            schema_name='Test Schema',
+            cedar_id='https://repo.metadatacenter.org/templates/test',
+            template_version=1,
+            template={},
+            active=True,
+        )
+
+    def test_required_metadata_template_is_null_by_default(self, app, provider, provider_url):
+        res = app.get(provider_url)
+        assert res.status_code == 200
+        assert res.json['data']['relationships']['required_metadata_template']['data'] is None
+
+    def test_required_metadata_template_when_set(self, app, provider, provider_url, cedar_template):
+        from osf.models import AbstractProvider
+        AbstractProvider.objects.filter(pk=provider.pk).update(required_metadata_template=cedar_template)
+
+        res = app.get(provider_url)
+        assert res.status_code == 200
+        rel = res.json['data']['relationships']['required_metadata_template']
+        assert rel['data']['id'] == cedar_template._id
+        assert rel['data']['type'] == 'cedar-metadata-templates'

api_tests/providers/registrations/views/test_registration_provider_detail.py

@@ -2,6 +2,7 @@
 
 from api.base.settings.defaults import API_BASE
 from api_tests.providers.mixins import ProviderDetailViewTestBaseMixin
+from osf.models import CedarMetadataTemplate
 from osf_tests.factories import (
     BrandFactory,
     RegistrationProviderFactory,
@@ -58,3 +59,40 @@ def test_registration_provider_with_special_fields(self, app, provider_with_bran
 
         assert data['relationships']['brand']['data']['id'] == str(brand.id)
         assert data['attributes']['branded_discovery_page'] == provider_with_brand.branded_discovery_page
+
+
+@pytest.mark.django_db
+class TestRegistrationProviderRequiredMetadataTemplate:
+
+    @pytest.fixture()
+    def provider(self):
+        return RegistrationProviderFactory()
+
+    @pytest.fixture()
+    def provider_url(self, provider):
+        return f'/{API_BASE}providers/registrations/{provider._id}/?version=2.20'
+
+    @pytest.fixture()
+    def cedar_template(self):
+        return CedarMetadataTemplate.objects.create(
+            schema_name='Test Schema',
+            cedar_id='https://repo.metadatacenter.org/templates/test',
+            template_version=1,
+            template={},
+            active=True,
+        )
+
+    def test_required_metadata_template_is_null_by_default(self, app, provider, provider_url):
+        res = app.get(provider_url)
+        assert res.status_code == 200
+        assert res.json['data']['relationships']['required_metadata_template']['data'] is None
+
+    def test_required_metadata_template_when_set(self, app, provider, provider_url, cedar_template):
+        from osf.models import AbstractProvider
+        AbstractProvider.objects.filter(pk=provider.pk).update(required_metadata_template=cedar_template)
+
+        res = app.get(provider_url)
+        assert res.status_code == 200
+        rel = res.json['data']['relationships']['required_metadata_template']
+        assert rel['data']['id'] == cedar_template._id
+        assert rel['data']['type'] == 'cedar-metadata-templates'

osf_tests/metadata/test_serialized_metadata.py

@@ -210,6 +210,7 @@ def setUp(self):
             mock.patch('osf.models.base.Guid.objects.get_or_create', new=osfguid_sequence.get_or_create),
             mock.patch('django.utils.timezone.now', new=forever_now),
             mock.patch('osf.models.mixins.timezone.now', new=forever_now),
+            mock.patch('osf.models.nodelog.timezone.now', new=forever_now),
             mock.patch('osf.models.metaschema.RegistrationSchema.absolute_api_v2_url', new='http://fake.example/schema/for/test'),
             mock.patch('osf.models.node.Node.get_verified_links', return_value=[
                 {'target_url': 'https://foo.bar', 'resource_type': 'Other'}