Merge pull request #228 from ASFHyP3/develop

Release: new datatypes for api job parameters

Author: asjohnston-asf

CHANGELOG.md

@@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.5.0]
+### Changed
+- The `dem_matching`, `speckle_filter`, `include_dem`, and `include_inc_map` api parameters are now booleans instead of strings.
+- The `resolution` api parameter is now a number instead of a string, and the `10.0` option has been removed.
+
 ## [0.4.0]
 ### Changed
 - Implemented 0.15° buffer and 20% threshold in DEM coverage checks when submitting new jobs.  As a result slightly more granules will be rejected as having insufficient coverage.

api/src/hyp3_api/openapi-spec.yml

@@ -240,10 +240,9 @@ components:
 
     resolution:
       description: Desired output resolution in meters.
-      type: string
+      type: number
       enum:
-        - "30.0"
-        - "10.0"
+        - 30.0
 
     radiometry:
       description: Backscatter coefficient normalization, either by ground area (sigma0) or illuminated area projected into the look direction (gamma0)
@@ -261,31 +260,23 @@ components:
 
     speckle_filter:
       description: Apply an enhanced lee speckle filter
-      type: string
-      enum:
-        - "false"
-        - "true"
+      default: false
+      type: boolean
 
     dem_matching:
-      description: Attempt to match the DEMs otherwise use dead reconing
-      type: string
-      enum:
-        - "false"
-        - "true"
+      description: Attempt to match the DEMs otherwise use dead-reckoning
+      default: false
+      type: boolean
 
     include_dem:
       description: Include the DEM files in the product package
-      type: string
-      enum:
-        - "false"
-        - "true"
+      default: false
+      type: boolean
 
     include_inc_map:
       description: Include the incident angle map in the product package
-      type: string
-      enum:
-        - "false"
-        - "true"
+      default: false
+      type: boolean
 
     datetime:
       description: Date and time object formatted according to ISO 8601

step-function/start-execution/src/main.py

@@ -27,11 +27,20 @@ def get_pending_jobs():
     return response['Items']
 
 
-def lambda_handler(event, context):
-    pending_jobs = get_pending_jobs()
-    for job in pending_jobs:
+def convert_parameters_to_strings(parameters):
+    return {key: str(value) for key, value in parameters.items()}
+
+
+def submit_jobs(jobs):
+    for job in jobs:
+        job['job_parameters'] = convert_parameters_to_strings(job['job_parameters'])
         STEP_FUNCTION.start_execution(
             stateMachineArn=environ['STEP_FUNCTION_ARN'],
-            input=json.dumps(job, cls=DecimalEncoder),
+            input=json.dumps(job, cls=DecimalEncoder, sort_keys=True),
             name=job['job_id']
         )
+
+
+def lambda_handler(event, context):
+    pending_jobs = get_pending_jobs()
+    submit_jobs(pending_jobs)

step-function/start-execution/test_start_execution.py

@@ -0,0 +1,66 @@
+from decimal import Decimal
+from json import dumps
+
+import pytest
+from botocore.stub import Stubber
+from src.main import STEP_FUNCTION, submit_jobs
+
+
+@pytest.fixture(autouse=True)
+def setup_env(monkeypatch):
+    monkeypatch.setenv('AWS_REGION', 'myRegion')
+    monkeypatch.setenv('STEP_FUNCTION_ARN', 'myStepFunctionArn')
+
+
+@pytest.fixture
+def states_stubber():
+    with Stubber(STEP_FUNCTION) as stubber:
+        yield stubber
+        stubber.assert_no_pending_responses()
+
+
+def test_lambda_handler(states_stubber):
+    jobs = [
+          {
+              'job_id': 'myJobId',
+              'string_field': 'value1',
+              'boolean_field': True,
+              'decimal_float_field': Decimal('10.1'),
+              'decimal_integer_field': Decimal('10'),
+              'job_parameters': {
+                  'string_field': 'value1',
+                  'boolean_field': True,
+                  'decimal_float_field': Decimal('10.1'),
+                  'decimal_integer_field': Decimal('10'),
+              },
+          },
+    ]
+
+    states_input = {
+        'job_id': 'myJobId',
+        'string_field': 'value1',
+        'boolean_field': True,
+        'decimal_float_field': 10.1,
+        'decimal_integer_field': 10,
+        'job_parameters': {
+            'string_field': 'value1',
+            'boolean_field': 'True',
+            'decimal_float_field': '10.1',
+            'decimal_integer_field': '10',
+        },
+    }
+
+    states_stubber.add_response(
+        method='start_execution',
+        expected_params={
+            'stateMachineArn': 'myStepFunctionArn',
+            'name': 'myJobId',
+            'input': dumps(states_input, sort_keys=True),
+        },
+        service_response={
+            'executionArn': 'myExecutionArn',
+            'startDate': '2020-01-01',
+        },
+    )
+
+    submit_jobs(jobs)