Merge pull request #44 from aws-solutions/feature/v2.6.1

updated to version v2.6.1

Author: aijunpeng

CHANGELOG.md

@@ -3,8 +3,11 @@
 
  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).
-
-
+ 
+## [2.6.1] - 2023-04
+ ### Added
+ - Added support to block customer misconfiguration for 'Terminate Unused Workspaces' feature. The feature will terminate workspaces only on the last day of the month to avoid accidental termination due to misconfiguration.
+ 
  ## [2.6.0] - 2023-03
  ### Added
  - Updated the solution to use CDK V2 to generate CloudFormation templates and support CDK deployments.

source/workspaces_app/workspaces_app/__tests__/test_workspaces_helper.py

@@ -566,14 +566,27 @@ def test_check_if_workspace_needs_to_be_terminated_returns_yes_is_dry_run_false(
     # 'terminateUnusedWorkspaces': 'Yes'
     # 'isDryRun': False
 
+    start_time = time.strftime("%Y-%m") + '-01T00:00:00Z'
+    end_time = time.strftime("%Y-%m") + '-02T00:00:00Z'
     settings = {
         'region': 'us-east-1',
         'hourlyLimits': 10,
         'testEndOfMonth': 'yes',
         'isDryRun': False,
         'startTime': 1,
         'endTime': 2,
-        'terminateUnusedWorkspaces': 'Yes'
+        'terminateUnusedWorkspaces': 'Yes',
+        'dateTimeValues': {
+            "start_time_for_current_month": '',
+            "end_time_for_current_month": '',
+            "last_day_current_month": '',
+            "first_day_selected_month": '',
+            "start_time_selected_date": start_time,
+            "end_time_selected_date": end_time,
+            "current_month_last_day": True,
+            "date_today": '',
+            "date_for_s3_key": ''
+        }
     }
     workspace_id = "123qwe123qwe"
     workspace_helper = workspaces_helper.WorkspacesHelper(session, settings)
@@ -652,6 +665,9 @@ def test_get_last_known_user_connection_timestamp_returns_resource_unavailable_f
 
 
 def test_get_termination_status_returns_empty_string_for_terminate_workspaces_no(session):
+    start_time = time.strftime("%Y-%m") + '-01T00:00:00Z'
+    end_time = time.strftime("%Y-%m") + '-02T00:00:00Z'
+
     workspace_utils.TERMINATE_UNUSED_WORKSPACES = 'No'
     settings = {
         'region': 'us-east-1',
@@ -660,7 +676,18 @@ def test_get_termination_status_returns_empty_string_for_terminate_workspaces_no
         'isDryRun': True,
         'startTime': 1,
         'endTime': 2,
-        'TerminateUnusedWorkspaces': 'No'
+        'TerminateUnusedWorkspaces': 'No',
+        'dateTimeValues': {
+            "start_time_for_current_month": '',
+            "end_time_for_current_month": '',
+            "last_day_current_month": '',
+            "first_day_selected_month": '',
+            "start_time_selected_date": start_time,
+            "end_time_selected_date": end_time,
+            "current_month_last_day": True,
+            "date_today": '',
+            "date_for_s3_key": ''
+        }
     }
     workspace_id = "123qwe123qwe"
     billable_time = 0
@@ -755,14 +782,27 @@ def test_get_termination_status_returns_dry_run_for_terminate_workspaces_dry_run
 
 
 def test_get_termination_status_returns_empty_string_when_workspace_used(mocker, session):
+    start_time = time.strftime("%Y-%m") + '-01T00:00:00Z'
+    end_time = time.strftime("%Y-%m") + '-02T00:00:00Z'
     settings = {
         'region': 'us-east-1',
         'hourlyLimits': 10,
         'testEndOfMonth': 'yes',
         'isDryRun': True,
         'startTime': 1,
         'endTime': 2,
-        'TerminateUnusedWorkspaces': 'Dry Run'
+        'TerminateUnusedWorkspaces': 'Dry Run',
+        'dateTimeValues': {
+            "start_time_for_current_month": '',
+            "end_time_for_current_month": '',
+            "last_day_current_month": '',
+            "first_day_selected_month": '',
+            "start_time_selected_date": start_time,
+            "end_time_selected_date": end_time,
+            "current_month_last_day": True,
+            "date_today": '',
+            "date_for_s3_key": ''
+        }
     }
     workspace_id = "123qwe123qwe"
     billable_time = 0
@@ -784,14 +824,27 @@ def test_get_termination_status_returns_empty_string_when_workspace_used(mocker,
 
 
 def test_get_termination_status_returns_empty_string_when_workspace_not_available_first_day(mocker, session):
+    start_time = time.strftime("%Y-%m") + '-01T00:00:00Z'
+    end_time = time.strftime("%Y-%m") + '-02T00:00:00Z'
     settings = {
         'region': 'us-east-1',
         'hourlyLimits': 10,
         'testEndOfMonth': True,
         'isDryRun': True,
         'startTime': 1,
         'endTime': 2,
-        'terminateUnusedWorkspaces': 'Dry Run'
+        'terminateUnusedWorkspaces': 'Dry Run',
+        'dateTimeValues': {
+            "start_time_for_current_month": '',
+            "end_time_for_current_month": '',
+            "last_day_current_month": '',
+            "first_day_selected_month": '',
+            "start_time_selected_date": start_time,
+            "end_time_selected_date": end_time,
+            "current_month_last_day": True,
+            "date_today": '',
+            "date_for_s3_key": ''
+        }
     }
     workspace_id = "123qwe123qwe"
     billable_time = 0
@@ -1203,3 +1256,36 @@ def test_compare_usage_metrics_for_always_on_returns_no_change_for_end_of_month_
     workspace_helper.modify_workspace_properties.return_value = '-N-'
 
     assert workspace_helper.compare_usage_metrics_for_always_on('ws-112d', 10, 85, "ALWAYS_ON") == expected
+
+
+def test_check_if_workspace_needs_to_be_terminated_returns_empty_string_for_last_day_month_false(session):
+    # 'terminateUnusedWorkspaces': 'Dry Run'
+    # 'isDryRun': True
+
+    start_time = time.strftime("%Y-%m") + '-01T00:00:00Z'
+    end_time = time.strftime("%Y-%m") + '-02T00:00:00Z'
+    settings = {
+        'region': 'us-east-1',
+        'hourlyLimits': 10,
+        'testEndOfMonth': 'yes',
+        'isDryRun': False,
+        'startTime': 1,
+        'endTime': 2,
+        'terminateUnusedWorkspaces': 'Yes',
+        'dateTimeValues': {
+            "start_time_for_current_month": '',
+            "end_time_for_current_month": '',
+            "last_day_current_month": '',
+            "first_day_selected_month": '',
+            "start_time_selected_date": start_time,
+            "end_time_selected_date": end_time,
+            "current_month_last_day": False,
+            "date_today": '',
+            "date_for_s3_key": ''
+        }
+    }
+    workspace_id = "123qwe123qwe"
+    workspace_helper = workspaces_helper.WorkspacesHelper(session, settings)
+    result = workspace_helper.check_if_workspace_needs_to_be_terminated(workspace_id)
+    assert result == ''
+

source/workspaces_app/workspaces_app/workspaces_helper.py

@@ -175,6 +175,7 @@ def get_termination_status(self, workspace_id, billable_time, tags):
         workspace_terminated = ''
         log.debug(f'Getting the termination status for workspace: '
                   f'{workspace_id}, billable time: {billable_time} and tags {tags}')
+        log.debug(f"The value for last month check is {self.settings.get('dateTimeValues').get('current_month_last_day')}")
         try:
             if workspace_utils.is_terminate_workspace_enabled() and (
                     self.settings.get('dateTimeValues').get('current_month_last_day') or
@@ -255,7 +256,7 @@ def check_if_workspace_needs_to_be_terminated(self, workspace_id):
             log.debug(f'Termination option for workspace {workspace_id} is set to DryRun. The report was updated but the'
                       ' terminate action was not called')
             workspace_terminated = 'Yes - Dry Run'
-        elif self.settings.get('terminateUnusedWorkspaces') == 'Yes' and not self.settings.get('isDryRun'):
+        elif self.settings.get('terminateUnusedWorkspaces') == 'Yes' and not self.settings.get('isDryRun') and self.settings.get('dateTimeValues').get('current_month_last_day'):
             log.debug(f'All the criteria for termination of workspace {workspace_id} are met. '
                       f'Calling the terminate action.')
             workspace_terminated = self.terminate_unused_workspace(workspace_id)