Merge pull request #78 from sanjay-reddy-kandi/main

release/v2.7.5

Author: abewub

CHANGELOG.md

@@ -4,6 +4,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.7.5] - 2025-01
+### Fixed
+- Updated aws-lambda-powertools from version 2.39.1 to 3.4.1
+- Improved handling of workspace termination logic
+
 ## [2.7.4] - 2024-11
 ### Fixed
 - Upgrade cross-spawn to mitigate [CVE-2024-21538](https://nvd.nist.gov/vuln/detail/CVE-2024-21538)

source/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "cost-optimizer-for-amazon-workspaces",
-  "version": "2.7.4",
+  "version": "2.7.5",
   "description": "Cost Optimizer for Amazon Workspaces (SO0018)",
   "license": "Apache-2.0",
   "repository": {
@@ -18,10 +18,10 @@
     "test": "jest --coverage",
     "license-report": "license-report --output=csv --delimiter=' under ' --fields=name --fields=licenseType",
     "cdk": "cdk",
-    "bootstrap": "SOLUTION_VERSION=v2.7.4 SOLUTION_NAME=cost-optimizer-for-amazon-workspaces SOLUTION_TRADEMARKEDNAME=cost-optimizer-for-amazon-workspaces cdk bootstrap",
-    "deploy": "SOLUTION_VERSION=v2.7.4 SOLUTION_NAME=cost-optimizer-for-amazon-workspaces SOLUTION_TRADEMARKEDNAME=cost-optimizer-for-amazon-workspaces cdk deploy cost-optimizer-for-amazon-workspaces",
-    "deploySpoke": "SOLUTION_VERSION=v2.7.4 SOLUTION_NAME=cost-optimizer-for-amazon-workspaces SOLUTION_TRADEMARKEDNAME=cost-optimizer-for-amazon-workspaces cdk deploy cost-optimizer-for-amazon-workspaces-spoke",
-    "synth": "SOLUTION_VERSION=v2.7.4 SOLUTION_NAME=cost-optimizer-for-amazon-workspaces SOLUTION_TRADEMARKEDNAME=cost-optimizer-for-amazon-workspaces DIST_OUTPUT_BUCKET=solutions-reference cdk synth"
+    "bootstrap": "SOLUTION_VERSION=v2.7.5 SOLUTION_NAME=cost-optimizer-for-amazon-workspaces SOLUTION_TRADEMARKEDNAME=cost-optimizer-for-amazon-workspaces cdk bootstrap",
+    "deploy": "SOLUTION_VERSION=v2.7.5 SOLUTION_NAME=cost-optimizer-for-amazon-workspaces SOLUTION_TRADEMARKEDNAME=cost-optimizer-for-amazon-workspaces cdk deploy cost-optimizer-for-amazon-workspaces",
+    "deploySpoke": "SOLUTION_VERSION=v2.7.5 SOLUTION_NAME=cost-optimizer-for-amazon-workspaces SOLUTION_TRADEMARKEDNAME=cost-optimizer-for-amazon-workspaces cdk deploy cost-optimizer-for-amazon-workspaces-spoke",
+    "synth": "SOLUTION_VERSION=v2.7.5 SOLUTION_NAME=cost-optimizer-for-amazon-workspaces SOLUTION_TRADEMARKEDNAME=cost-optimizer-for-amazon-workspaces DIST_OUTPUT_BUCKET=solutions-reference cdk synth"
   },
   "devDependencies": {
     "@aws-cdk/assert": "2.68.0",

source/package.json

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "cost-optimizer-for-amazon-workspaces"
-version = "2.7.4"
+version = "2.7.5"
 description = "Cost Optimizer for Amazon Workspaces (SO0018)"
 authors = ["AWS Solutions"]
 license = "Apache-2.0"
@@ -19,7 +19,7 @@ requests = "^2.31.0"
 s3transfer = "0.10.2"
 six = "1.16.0"
 urllib3 = "2.2.2"
-aws-lambda-powertools = "2.39.1"
+aws-lambda-powertools = "3.4.1"
 
 [tool.poetry.group.dev.dependencies]
 pytest = "^7.2.2"

source/poetry.lock

@@ -618,8 +618,11 @@ def test_check_if_workspace_needs_to_be_terminated_returns_dry_run_is_dry_run_tr
         "terminateUnusedWorkspaces": "Dry Run",
     }
     workspace_id = "123qwe123qwe"
+    billable_time = 0
     workspace_helper = workspaces_helper.WorkspacesHelper(session, settings)
-    result = workspace_helper.check_if_workspace_needs_to_be_terminated(workspace_id)
+    result = workspace_helper.check_if_workspace_needs_to_be_terminated(
+        workspace_id, billable_time
+    )
     assert result == "Yes - Dry Run"
 
 
@@ -639,8 +642,11 @@ def test_check_if_workspace_needs_to_be_terminated_returns_dry_run_is_dry_run_fa
         "terminateUnusedWorkspaces": "Dry Run",
     }
     workspace_id = "123qwe123qwe"
+    billable_time = 0
     workspace_helper = workspaces_helper.WorkspacesHelper(session, settings)
-    result = workspace_helper.check_if_workspace_needs_to_be_terminated(workspace_id)
+    result = workspace_helper.check_if_workspace_needs_to_be_terminated(
+        workspace_id, billable_time
+    )
     assert result == "Yes - Dry Run"
 
 
@@ -660,8 +666,11 @@ def test_check_if_workspace_needs_to_be_terminated_returns_empty_string_is_dry_r
         "terminateUnusedWorkspaces": "Yes",
     }
     workspace_id = "123qwe123qwe"
+    billable_time = 0
     workspace_helper = workspaces_helper.WorkspacesHelper(session, settings)
-    result = workspace_helper.check_if_workspace_needs_to_be_terminated(workspace_id)
+    result = workspace_helper.check_if_workspace_needs_to_be_terminated(
+        workspace_id, billable_time
+    )
     assert result == ""
 
 
@@ -694,10 +703,13 @@ def test_check_if_workspace_needs_to_be_terminated_returns_yes_is_dry_run_false(
         },
     }
     workspace_id = "123qwe123qwe"
+    billable_time = 0
     workspace_helper = workspaces_helper.WorkspacesHelper(session, settings)
     mocker.patch.object(workspace_helper, "terminate_unused_workspace")
     workspace_helper.terminate_unused_workspace.return_value = "Yes"
-    result = workspace_helper.check_if_workspace_needs_to_be_terminated(workspace_id)
+    result = workspace_helper.check_if_workspace_needs_to_be_terminated(
+        workspace_id, billable_time
+    )
     assert result == "Yes"
 
 
@@ -735,6 +747,31 @@ def test_check_if_workspace_used_for_selected_period_returns_true_if_timestamp_i
     assert result is True
 
 
+@freeze_time("2025-01-15 12:00:00")
+def test_check_if_workspace_needs_to_be_terminated_returns_empty_string_with_billable_time(
+    session,
+):
+    settings = {
+        "region": "us-east-1",
+        "hourlyLimits": 10,
+        "testEndOfMonth": "yes",
+        "isDryRun": True,
+        "startTime": 1,
+        "endTime": 2,
+        "terminateUnusedWorkspaces": "Dry Run",
+        "dateTimeValues": {
+            "current_month_last_day": True,
+        },
+    }
+    workspace_id = "123qwe123qwe"
+    billable_time = 5
+    workspace_helper = workspaces_helper.WorkspacesHelper(session, settings)
+    result = workspace_helper.check_if_workspace_needs_to_be_terminated(
+        workspace_id, billable_time
+    )
+    assert result == ""
+
+
 def test_get_last_known_user_connection_timestamp_returns_last_connected_time_value(
     session,
 ):
@@ -769,6 +806,50 @@ def test_get_last_known_user_connection_timestamp_returns_last_connected_time_va
     client_stubber.deactivate()
 
 
+def test_get_last_known_user_connection_timestamp_handles_pagination(session):
+    settings = {
+        "region": "us-east-1",
+        "hourlyLimits": 10,
+        "testEndOfMonth": "yes",
+        "isDryRun": True,
+        "startTime": 1,
+        "endTime": 2,
+    }
+    workspace_id = "ws-12345678"
+    last_known_timestamp = datetime.datetime(
+        2023, 1, 1, 12, 0, 0, tzinfo=datetime.timezone.utc
+    )
+
+    workspace_helper = workspaces_helper.WorkspacesHelper(session, settings)
+    client_stubber = Stubber(workspace_helper.workspaces_client)
+
+    response1 = {"WorkspacesConnectionStatus": [], "NextToken": "next-token"}
+    expected_params1 = {"WorkspaceIds": [workspace_id]}
+
+    response2 = {
+        "WorkspacesConnectionStatus": [
+            {
+                "WorkspaceId": workspace_id,
+                "LastKnownUserConnectionTimestamp": last_known_timestamp,
+            }
+        ]
+    }
+    expected_params2 = {"WorkspaceIds": [workspace_id], "NextToken": "next-token"}
+
+    client_stubber.add_response(
+        "describe_workspaces_connection_status", response1, expected_params1
+    )
+    client_stubber.add_response(
+        "describe_workspaces_connection_status", response2, expected_params2
+    )
+    client_stubber.activate()
+
+    result = workspace_helper.get_last_known_user_connection_timestamp(workspace_id)
+
+    assert result == last_known_timestamp
+    client_stubber.deactivate()
+
+
 def test_get_last_known_user_connection_timestamp_returns_resource_unavailable_for_exception(
     session,
 ):
@@ -1040,6 +1121,60 @@ def test_get_termination_status_returns_empty_string_when_workspace_not_availabl
     assert result == ("", time.strftime("%Y-%m-%d", test_time.timetuple()))
 
 
+def test_get_termination_status_with_billable_hours(mocker, session):
+    settings = {
+        "region": "us-east-1",
+        "hourlyLimits": 10,
+        "testEndOfMonth": True,
+        "isDryRun": True,
+        "startTime": 1,
+        "endTime": 2,
+        "TerminateUnusedWorkspaces": "Dry Run",
+        "dateTimeValues": {
+            "start_time_for_current_month": "",
+            "end_time_for_current_month": "",
+            "last_day_current_month": "",
+            "first_day_selected_month": "2025-01-01",
+            "start_time_selected_date": "2025-01-01T00:00:00Z",
+            "end_time_selected_date": "2025-01-02T00:00:00Z",
+            "current_month_last_day": True,
+            "date_today": "",
+            "date_for_s3_key": "",
+        },
+    }
+    workspace_helper = workspaces_helper.WorkspacesHelper(session, settings)
+
+    workspace_id = "ws-12345678"
+    billable_time = 10
+    tags = [{"Key": "TestTag", "Value": "TestValue"}]
+
+    mock_timestamp = datetime.datetime(2025, 1, 15, 12, 0, 0)
+    mocker.patch.object(
+        workspace_helper,
+        "get_last_known_user_connection_timestamp",
+        return_value=mock_timestamp,
+    )
+    mocker.patch.object(
+        workspace_utils, "is_terminate_workspace_enabled", return_value=True
+    )
+    mocker.patch.object(
+        workspace_helper, "check_if_workspace_available_on_first_day_selected_month"
+    )
+    mocker.patch.object(workspace_utils, "check_if_workspace_used_for_selected_period")
+    mocker.patch.object(workspace_helper, "check_if_workspace_needs_to_be_terminated")
+
+    result = workspace_helper.get_termination_status(workspace_id, billable_time, tags)
+
+    assert result == ("", "2025-01-15")
+    workspace_helper.get_last_known_user_connection_timestamp.assert_called_once_with(
+        workspace_id
+    )
+    workspace_utils.is_terminate_workspace_enabled.assert_called_once()
+    workspace_helper.check_if_workspace_available_on_first_day_selected_month.assert_called_once()
+    workspace_utils.check_if_workspace_used_for_selected_period.assert_called_once()
+    workspace_helper.check_if_workspace_needs_to_be_terminated.assert_not_called()
+
+
 def test_get_workspaces_for_directory_use_next_token(session):
     settings = {
         "region": "us-east-1",
@@ -1486,8 +1621,11 @@ def test_check_if_workspace_needs_to_be_terminated_returns_empty_string_for_last
         },
     }
     workspace_id = "123qwe123qwe"
+    billable_time = 0
     workspace_helper = workspaces_helper.WorkspacesHelper(session, settings)
-    result = workspace_helper.check_if_workspace_needs_to_be_terminated(workspace_id)
+    result = workspace_helper.check_if_workspace_needs_to_be_terminated(
+        workspace_id, billable_time
+    )
     assert result == ""