Validation Extension Support

ckanext/xloader/config_declaration.yaml

@@ -112,5 +112,13 @@ groups:
             to True.
         type: bool
         required: false
+      - key: ckanext.xloader.requires_validation
+        default: False
+        example: True
+        description: |
+            Resources are required to pass validation from the ckanext-validation
+            plugin to be able to get xloadered.
+        type: bool
+        required: false
 
 

ckanext/xloader/plugin.py

@@ -107,9 +107,23 @@ def notify(self, entity, operation):
         See: ckan/model/modification.py.DomainObjectModificationExtension
         """
         if operation != DomainObjectOperation.changed \
-        or not isinstance(entity, Resource) \
-        or not getattr(entity, 'url_changed', False):
+        or not isinstance(entity, Resource):
             return
+
+        # If the resource requires validation, stop here if validation
+        # has not been performed or did not succeed. The Validation
+        # extension will call resource_patch and this method should
+        # be called again. However, url_changed will not be in the entity
+        # once Validation does the patch.
+        if _is_validation_plugin_loaded() and \
+        toolkit.asbool(toolkit.config.get('ckanext.xloader.requires_validation')):
+            if entity.__dict__.get('extras', {}).get('validation_status', None) != 'success':
+                log.debug("Skipping xloading resource %s because "
+                          "resource did not pass validation yet.", entity.id)
+                return
+        elif not getattr(entity, 'url_changed', False):
+            return
+
         context = {
             "ignore_auth": True,
         }
@@ -124,6 +138,12 @@ def notify(self, entity, operation):
     # IResourceController
 
     def after_resource_create(self, context, resource_dict):
+        if _is_validation_plugin_loaded() and \
+        toolkit.asbool(toolkit.config.get('ckanext.xloader.requires_validation')) and \
+        resource_dict.get('validation_status', None) != 'success':
+            log.debug("Skipping xloading resource %s because "
+                          "resource did not pass validation yet.", resource_dict.get('id'))
+            return
         self._submit_to_xloader(resource_dict)
 
     def before_resource_show(self, resource_dict):
@@ -225,3 +245,15 @@ def get_helpers(self):
             "xloader_status": xloader_helpers.xloader_status,
             "xloader_status_description": xloader_helpers.xloader_status_description,
         }
+
+
+def _is_validation_plugin_loaded():
+    """
+    Checks the existence of a logic action from the ckanext-validation
+    plugin, thus supporting any extending of the Validation Plugin class.
+    """
+    try:
+        toolkit.get_action('resource_validation_show')
+        return True
+    except KeyError:
+        return False