Merge pull request #48 from aws-solutions/fix/date_calculation

Remove the date_utils call to avoid incorrect termination of workspaces.

Author: groverlalit

source/workspaces_app/workspaces_app/__tests__/test_workspaces_helper.py

@@ -11,6 +11,8 @@
 from ..utils import workspace_utils
 from botocore.stub import Stubber
 from dateutil.tz import tzutc
+from freezegun import freeze_time
+from ..utils import date_utils
 
 
 @pytest.fixture(scope='module')
@@ -596,23 +598,29 @@ def test_check_if_workspace_needs_to_be_terminated_returns_yes_is_dry_run_false(
     assert result == 'Yes'
 
 
+@freeze_time("2020-11-29 03:21:34")
 def test_check_if_workspace_used_for_selected_period_returns_false_if_timestamp_is_none():
     last_known_user_connection_timestamp = None
-    result = workspace_utils.check_if_workspace_used_for_selected_period(last_known_user_connection_timestamp)
+    first_day_selected_month = date_utils.get_first_day_selected_month()
+    result = workspace_utils.check_if_workspace_used_for_selected_period(last_known_user_connection_timestamp, first_day_selected_month)
     assert result is False
 
 
+@freeze_time("2022-11-29 03:21:34")
 def test_check_if_workspace_used_for_selected_period_returns_false_if_timestamp_is_before_first_day():
     last_known_user_connection_timestamp = datetime.datetime.strptime('2021-01-10 19:35:15.524000+00:00',
                                                                       '%Y-%m-%d %H:%M:%S.%f+00:00')
-    result = workspace_utils.check_if_workspace_used_for_selected_period(last_known_user_connection_timestamp)
+    first_day_selected_month = date_utils.get_first_day_selected_month()
+    result = workspace_utils.check_if_workspace_used_for_selected_period(last_known_user_connection_timestamp, first_day_selected_month)
     assert result is False
 
 
+@freeze_time("2020-11-29 03:21:34")
 def test_check_if_workspace_used_for_selected_period_returns_true_if_timestamp_is_first_day_selected_month():
     last_known_user_connection_timestamp = datetime.datetime.utcnow().today().replace(day=1, hour=0, minute=0, second=0,
                                                                                       microsecond=0)
-    result = workspace_utils.check_if_workspace_used_for_selected_period(last_known_user_connection_timestamp)
+    first_day_selected_month = date_utils.get_first_day_selected_month()
+    result = workspace_utils.check_if_workspace_used_for_selected_period(last_known_user_connection_timestamp, first_day_selected_month)
     assert result is True
 
 
@@ -1289,3 +1297,19 @@ def test_check_if_workspace_needs_to_be_terminated_returns_empty_string_for_last
     result = workspace_helper.check_if_workspace_needs_to_be_terminated(workspace_id)
     assert result == ''
 
+
+@freeze_time('2023-03-31',  auto_tick_seconds=86400)
+def test_check_if_workspace_used_for_selected_period_returns_true_for_multi_day_processing():
+
+    first_day_selected_month = datetime.datetime(year=2023, month=3, day=1).date()
+    last_known_user_connection_timestamp = datetime.datetime.strptime('2023-03-20 19:35:15.524000+00:00', '%Y-%m-%d %H:%M:%S.%f+00:00')
+    result = workspace_utils.check_if_workspace_used_for_selected_period(last_known_user_connection_timestamp, first_day_selected_month)
+    assert result is True
+
+    result1 = date_utils.get_first_day_selected_month()
+    result2 = date_utils.get_first_day_selected_month()
+    assert result2 == datetime.date(2023, 4, 1)
+
+    result = workspace_utils.check_if_workspace_used_for_selected_period(last_known_user_connection_timestamp, first_day_selected_month)
+    assert result is True
+

source/workspaces_app/workspaces_app/utils/__tests__/test_date_utils.py

@@ -68,4 +68,12 @@ def test_get_date_time_values_for_processing_returns_all_the_correct_values():
         "current_month_last_day": False,
         "date_today": '11/29/20',
         "date_for_s3_key": '2020/11/29/'
-    }
+    }
+
+
+@freeze_time("2020-05-31 23:00:00", auto_tick_seconds=86400)
+def test_get_first_day_selected_month_returns_first_day_selected_month_then_returns_next_month_date():
+    result = date_utils.get_first_day_selected_month()
+    assert result == datetime.date(2020, 5, 1)
+    result = date_utils.get_first_day_selected_month()
+    assert result == datetime.date(2020, 6, 1)

source/workspaces_app/workspaces_app/utils/workspace_utils.py

@@ -5,7 +5,6 @@
 
 import logging
 import os
-from . import date_utils
 
 TERMINATE_UNUSED_WORKSPACES = os.getenv('TerminateUnusedWorkspaces')
 RESOURCE_UNAVAILABLE = 'ResourceUnavailable'
@@ -21,7 +20,7 @@ def is_terminate_workspace_enabled():
     return TERMINATE_UNUSED_WORKSPACES == "Yes" or TERMINATE_UNUSED_WORKSPACES == "Dry Run"
 
 
-def check_if_workspace_used_for_selected_period(last_known_user_connection_timestamp):
+def check_if_workspace_used_for_selected_period(last_known_user_connection_timestamp, first_day_selected_month):
     """
     This method returns a boolean value to indicate if the workspace was used in selected period
     :param: last_known_user_connection_timestamp: Last known connection timestamp
@@ -36,7 +35,6 @@ def check_if_workspace_used_for_selected_period(last_known_user_connection_times
         return True
     else:
         log.debug("Last know timestamp value is not None. Processing further.")
-        first_day_selected_month = date_utils.get_first_day_selected_month()
         log.debug(f'First day for selected period is {first_day_selected_month}')
         last_known_user_connection_day = last_known_user_connection_timestamp.date()
         return last_known_user_connection_day >= first_day_selected_month

source/workspaces_app/workspaces_app/workspaces_helper.py

@@ -181,14 +181,15 @@ def get_termination_status(self, workspace_id, billable_time, tags):
                     self.settings.get('dateTimeValues').get('current_month_last_day') or
                     (self.settings.get('testEndOfMonth'))
             ):
-                log.debug('Today is the last day of the month or the TestEndOfMonth parameter is set to yes.')
+                log.debug(f"The value for current_month_last_day is {self.settings.get('dateTimeValues').get('current_month_last_day')}")
+                log.debug(f"The value for testEndOfMonth is {(self.settings.get('testEndOfMonth'))}")
                 log.debug(f'Processing further for workspace id {workspace_id}')
                 last_known_user_connection_timestamp = self.get_last_known_user_connection_timestamp(workspace_id)
                 log.debug(f'Last known user connection time stamp is {last_known_user_connection_timestamp}')
                 workspace_available_on_first_day_of_selected_month = self.check_if_workspace_available_on_first_day_selected_month(workspace_id)
                 log.debug((f'The value for workspace available on first day of selected period is '
                            f'{workspace_available_on_first_day_of_selected_month}'))
-                workspace_used_in_selected_period = workspace_utils.check_if_workspace_used_for_selected_period(last_known_user_connection_timestamp)
+                workspace_used_in_selected_period = workspace_utils.check_if_workspace_used_for_selected_period(last_known_user_connection_timestamp, self.settings.get('dateTimeValues').get('first_day_selected_month'))
                 log.debug(f'The value for workspace used in selected period is {workspace_used_in_selected_period}')
                 if workspace_available_on_first_day_of_selected_month and not workspace_used_in_selected_period:
                     workspace_terminated = self.check_if_workspace_needs_to_be_terminated(workspace_id)