Merge pull request #262 from CSCfi/CSCMETAX-400-allow-etsin-pid-override

CSCMETAX-400: [ADD] Datasets api: Add query param ?migration_override…

Author: junsk1

src/metax_api/api/rest/base/serializers/catalog_record_serializer.py

@@ -3,7 +3,7 @@
 
 from rest_framework.serializers import ValidationError
 
-from metax_api.models import CatalogRecord, DataCatalog, Contract
+from metax_api.models import CatalogRecord, DataCatalog, Contract, Common
 from metax_api.services import CatalogRecordService as CRS, CommonService
 from .common_serializer import CommonSerializer
 from .contract_serializer import ContractSerializer
@@ -90,7 +90,28 @@ def update(self, instance, validated_data):
         return super(CatalogRecordSerializer, self).update(instance, validated_data)
 
     def create(self, validated_data):
-        return super(CatalogRecordSerializer, self).create(validated_data)
+        if self._migration_override_requested():
+
+            # any custom stuff before create that my be necessary for migration purposes
+
+            if 'preferred_identifier' in validated_data['research_dataset']:
+                # store pid, since it will be overwritten during create otherwise
+                pid = validated_data['research_dataset']['preferred_identifier']
+
+        res = super().create(validated_data)
+
+        if self._migration_override_requested():
+
+            # any custom stuff after create that my be necessary for migration purposes
+
+            if 'preferred_identifier' in validated_data['research_dataset']:
+                # save original pid provided by the requestor
+                res.research_dataset['preferred_identifier'] = pid
+
+                # save, while bypassing normal save-related procedures in CatalogRecord model
+                super(Common, res).save()
+
+        return res
 
     def to_representation(self, instance):
         res = super(CatalogRecordSerializer, self).to_representation(instance)
@@ -341,6 +362,15 @@ def _get_data_catalog_relation(self, identifier_value):
         except DataCatalog.DoesNotExist:
             raise ValidationError({ 'data_catalog': ['identifier %s not found' % str(identifier_value)]})
 
+    def _migration_override_requested(self):
+        """
+        Check presence of query parameter ?migration_override, which enables some specific actions during
+        the request, at this point useful only for migration operations.
+        """
+        if 'request' in self.context:
+            return CommonService.get_boolean_query_param(self.context['request'], 'migration_override')
+        return False
+
     def _set_dataset_schema(self):
         data_catalog = None
         if self._operation_is_create():

src/metax_api/models/catalog_record.py

@@ -292,9 +292,9 @@ def save(self, *args, **kwargs):
             self._post_create_operations()
             _logger.info(
                 'Created a new <CatalogRecord id: %d, '
-                'metadata_version_identifier: %s, '
+                'identifier: %s, '
                 'preferred_identifier: %s >'
-                % (self.id, self.metadata_version_identifier, self.preferred_identifier)
+                % (self.id, self.identifier, self.preferred_identifier)
             )
         else:
             self._pre_update_operations()

src/metax_api/tests/api/rest/base/views/datasets/write.py

@@ -289,6 +289,18 @@ def test_create_catalog_record_editor_field_is_optional(self):
         response = self.client.put('/rest/datasets/%d' % new['id'], new, format="json")
         self.assertEqual(response.status_code, status.HTTP_200_OK, response.data)
 
+    def test_parameter_migration_override_preferred_identifier_when_creating(self):
+        """
+        Normally, when saving to att/ida catalogs, providing a custom preferred_identifier is not
+        permitted. Using the optional query parameter ?migration_override=bool a custom preferred_identifier
+        can be passed.
+        """
+        custom_pid = 'custom-pid-value'
+        self.cr_test_data['research_dataset']['preferred_identifier'] = custom_pid
+        response = self.client.post('/rest/datasets?migration_override', self.cr_test_data, format="json")
+        self.assertEqual(response.status_code, status.HTTP_201_CREATED, response.data)
+        self.assertEqual(response.data['research_dataset']['preferred_identifier'], custom_pid)
+
 
 class CatalogRecordApiWriteIdentifierUniqueness(CatalogRecordApiWriteCommon):
     """