Allow close time filters in WorkflowExecutionQueryset.filter()

The current code introduces a start time filter if absent, which is incompatible with a close time filter per the API docs. So we have to be smarter and only introduce a default start time filter if no close time filter is passed. SWF docs: http://docs.aws.amazon.com/amazonswf/latest/apireference/API_ListClosedWorkflowExecutions.html#SWF-ListClosedWorkflowExecutions-request-startTimeFilter

Author: jbbarth

swf/querysets/workflow.py

@@ -568,9 +568,27 @@ def filter(self,
  if status == WorkflowExecution.STATUS_OPEN:
  oldest_date = kwargs.pop('oldest_date', 30)
  else:
- oldest_date = kwargs.pop('start_oldest_date', 30)
+ # The SWF docs on ListClosedWorkflowExecutions state that:
+ #
+ # "startTimeFilter and closeTimeFilter are mutually exclusive"
+ #
+ # so we must figure out if we have to add a default value for
+ # start_oldest_date or not.
+ if "close_latest_date" in kwargs or "close_oldest_date" in kwargs:
+ default_oldest_date = None
+ else:
+ default_oldest_date = 30
+ oldest_date = kwargs.pop('start_oldest_date', default_oldest_date)
+
+ # Compute a timestamp from the delta in days we got from params
+ # If oldest_date is blank at this point, it's because we didn't want
+ # it, so let's leave it blank and assume the user provided an other
+ # time filter.
+ if oldest_date:
+ start_oldest_date = int(datetime_timestamp(past_day(oldest_date)))
+ else:
+ start_oldest_date = None
 
- start_oldest_date = datetime_timestamp(past_day(oldest_date))
  return [self.to_WorkflowExecution(self.domain, wfe) for wfe in
  self._list_items(
  *args,
@@ -579,7 +597,7 @@ def filter(self,
  workflow_id=workflow_id,
  workflow_name=workflow_type_name,
  workflow_version=workflow_type_version,
- start_oldest_date=int(start_oldest_date),
+ start_oldest_date=start_oldest_date,
  tag=tag,
  **kwargs
  )]

tests/querysets/test_workflow.py

@@ -2,7 +2,7 @@
 
 import unittest
 
-from mock import patch
+from mock import patch, Mock
 from boto.swf.layer1 import Layer1
 from boto.exception import SWFResponseError
 
@@ -316,4 +316,20 @@ def test_get_invalid_workflow_execution(self):
  "message": "Whatever",
  }
  )
- self.weq.get("mocked-workflow-id", "mocked-run-id")
+ self.weq.get("mocked-workflow-id", "mocked-run-id")
+
+ def test_filter_without_close_time_filter(self):
+ self.weq._list_items = Mock(return_value=[])
+ qs = self.weq.filter()
+ self.weq._list_items.assert_called_once()
+ kwargs = self.weq._list_items.call_args[1]
+ self.assertIsInstance(kwargs["start_oldest_date"], int)
+
+ def test_filter_with_close_time_filter(self):
+ self.weq._list_items = Mock(return_value=[])
+ qs = self.weq.filter(status=WorkflowExecution.STATUS_CLOSED,
+ close_latest_date=5)
+ self.weq._list_items.assert_called_once()
+ kwargs = self.weq._list_items.call_args[1]
+ self.assertIsNone(kwargs["start_oldest_date"])
+ self.assertIsInstance(kwargs["close_latest_date"], int)