Merge pull request #3504 from WikiWatershed/eh/validation-test-gwlfe

Author: emilyhu0106

src/mmw/apps/geoprocessing_api/validation.py

@@ -2,6 +2,8 @@
 from numbers import Number
 from uuid import UUID
 
+from django.conf import settings
+
 from rest_framework.exceptions import ValidationError
 
 
@@ -69,3 +71,103 @@ def validate_uuid(uuid):
         return False
 
     return uuid == str(u)
+
+
+def validate_gwlfe_prepare(data):
+    area_of_interest = data.get('area_of_interest')
+    wkaoi = data.get('wkaoi')
+    huc = data.get('huc')
+    layer_overrides = data.get('layer_overrides', {})
+
+    if not check_gwlfe_only_one([area_of_interest, wkaoi, huc]):
+        error = ('Invalid parameter: One and only one type of area object'
+                 ' (area_of_interest, wkaoi, or huc) is allowed')
+        raise ValidationError(error)
+
+    not_valid_layers = check_layer_overrides_keys(layer_overrides)
+
+    if not_valid_layers:
+        error = create_layer_overrides_keys_not_valid_msg(not_valid_layers)
+        raise ValidationError(error)
+
+    if ('__LAND__' in layer_overrides.keys() and
+            not check_land_layer_overrides(layer_overrides)):
+        error = create_layer_overrides_land_not_valid_msg(LAND_LAYER_OVERRIDES)
+        raise ValidationError(error)
+
+    if ('__STREAMS__' in layer_overrides.keys() is not None and
+            not check_streams_layer_overrides(layer_overrides)):
+        error = (f'Invalid __STREAMS__ param: '
+                 f'Must be one of {STREAM_LAYER_OVERRIDES}')
+        raise ValidationError(error)
+
+
+def validate_gwlfe_run(input, job_uuid):
+    if not check_gwlfe_only_one([input, job_uuid]):
+        error = ('Invalid parameter: Only one type of prepared input'
+                 '(input JSON or job_uuid) is allowed')
+        raise ValidationError(error)
+
+    if not check_gwlfe_run_input(input):
+        error = ("Invalid input: Please use the full result "
+                 "of gwlf-e/prepare endpoint's result object")
+        raise ValidationError(error)
+
+
+def check_gwlfe_only_one(params):
+    if sum(map(check_is_none, params)) == 1:
+        return True
+    else:
+        return False
+
+
+def check_is_none(v):
+    if v is None:
+        return 0
+    else:
+        return 1
+
+
+def check_layer_overrides_keys(layers):
+    not_valid_layers = []
+    for layer in layers.keys():
+        if (layer not in settings.GEOP['layers'].keys()):
+            not_valid_layers.append(layer)
+    return not_valid_layers
+
+
+def check_land_layer_overrides(layers):
+    return layers['__LAND__'] in LAND_LAYER_OVERRIDES
+
+
+def check_streams_layer_overrides(layers):
+    return layers['__STREAMS__'] in STREAM_LAYER_OVERRIDES
+
+
+def check_gwlfe_run_input(input):
+    result = all(el in input for el in settings.GWLFE_DEFAULTS.keys())
+    return result
+
+
+def create_layer_overrides_keys_not_valid_msg(layers):
+    error = 'These layers are not standard layers for layer overrides: '
+    for layler in layers:
+        error += layler + ' '
+    error += '. Must be one of: __LAND__, __STREAMS__'
+    return error
+
+
+def create_layer_overrides_land_not_valid_msg(values):
+    return (f'Invalid __LAND__ param: Must be one of {values}')
+
+
+LAND_LAYER_OVERRIDES = [
+     'nlcd-2019-30m-epsg5070-512-byte',
+     'nlcd-2016-30m-epsg5070-512-byte',
+     'nlcd-2011-30m-epsg5070-512-byte',
+     'nlcd-2006-30m-epsg5070-512-byte',
+     'nlcd-2001-30m-epsg5070-512-byte',
+     'nlcd-2011-30m-epsg5070-512-int8',
+]
+
+STREAM_LAYER_OVERRIDES = ['drb', 'nhdhr', 'nhd']

src/mmw/apps/geoprocessing_api/views.py

@@ -43,7 +43,10 @@
 from apps.geoprocessing_api.throttling import (BurstRateThrottle,
                                                SustainedRateThrottle)
 
-from apps.geoprocessing_api.validation import validate_rwd, validate_uuid
+from apps.geoprocessing_api.validation import (validate_rwd,
+                                               validate_uuid,
+                                               validate_gwlfe_prepare,
+                                               validate_gwlfe_run)
 
 
 @swagger_auto_schema(method='post',
@@ -1397,9 +1400,7 @@ def start_modeling_gwlfe_prepare(request, format=None):
     the `input`. Alternatively, the `job_uuid` can be used as well.
     """
     user = request.user if request.user.is_authenticated else None
-    area_of_interest, wkaoi = _parse_modeling_input(request)
-
-    layer_overrides = request.data.get('layer_overrides', {})
+    area_of_interest, wkaoi, layer_overrides = _parse_modeling_input(request)
 
     return start_celery_job([
         multi_mapshed(area_of_interest, wkaoi, layer_overrides),
@@ -1661,7 +1662,11 @@ def _parse_analyze_input(request):
 
 
 def _parse_modeling_input(request):
-    return _parse_aoi(request.data)
+    validate_gwlfe_prepare(request.data)
+    layer_overrides = request.data.get('layer_overrides', {})
+    area_of_interest, wkaoi = _parse_aoi(request.data)
+
+    return area_of_interest, wkaoi, layer_overrides
 
 
 def _parse_aoi(data):
@@ -1703,11 +1708,12 @@ def _parse_gwlfe_input(request, raw_input=True):
         model_input = request.data.get('input')
 
         if model_input:
-            # TODO #3484 Validate model_input
+            validate_gwlfe_run(model_input, job_uuid)
             return model_input, job_uuid, mods, hash
 
     if not job_uuid:
-        raise ValidationError('`job_uuid` must be specified')
+        raise ValidationError('Either `input` or `job_uuid` '
+                              'must be specified.')
 
     if not validate_uuid(job_uuid):
         raise ValidationError(f'Invalid `job_uuid`: {job_uuid}')
@@ -1723,5 +1729,6 @@ def _parse_gwlfe_input(request, raw_input=True):
 
     model_input = json.loads(input_job.result)
 
-    # TODO #3484 Validate model_input
+    validate_gwlfe_run(model_input, job_uuid)
+
     return model_input, job_uuid, mods, hash