tests(example): fully verify date exclusion feature

Write an end-to-end test to verify that the Azure
function does not run the scheduler when the date
exclusion configuration is set up for the current day.

Author: diodonfrost

examples/scheduler-with-exclusion-dates/main.tf renamed to examples/date-exclusion/main.tf

@@ -13,50 +13,12 @@ data "aws_ami" "ubuntu" {
   owners = ["099720109477"] # Canonical
 }
 
-resource "aws_vpc" "test" {
-  cidr_block           = "10.0.0.0/16"
-  enable_dns_hostnames = true
-  enable_dns_support   = true
-}
-
-resource "aws_internet_gateway" "test" {
-  vpc_id = aws_vpc.test.id
-
-  tags = {
-    Name = "scheduler-exclusion-igw-${random_pet.suffix.id}"
-  }
-}
-
-resource "aws_subnet" "public" {
-  vpc_id                  = aws_vpc.test.id
-  cidr_block              = "10.0.1.0/24"
-  availability_zone       = data.aws_availability_zones.available.names[0]
-  map_public_ip_on_launch = true
-}
-
-resource "aws_route_table" "public" {
-  vpc_id = aws_vpc.test.id
-
-  route {
-    cidr_block = "0.0.0.0/0"
-    gateway_id = aws_internet_gateway.test.id
-  }
-}
-
-resource "aws_route_table_association" "public" {
-  subnet_id      = aws_subnet.public.id
-  route_table_id = aws_route_table.public.id
-}
-
-data "aws_availability_zones" "available" {
-  state = "available"
-}
 
 resource "aws_instance" "scheduled" {
   count         = 2
   ami           = data.aws_ami.ubuntu.id
   instance_type = "t2.micro"
-  subnet_id     = aws_subnet.public.id
+  subnet_id     = aws_subnet.test.id
 
   tags = {
     tostop = "true-${random_pet.suffix.id}"
@@ -67,7 +29,7 @@ resource "aws_instance" "scheduled" {
 resource "aws_instance" "not_scheduled" {
   ami           = data.aws_ami.ubuntu.id
   instance_type = "t2.micro"
-  subnet_id     = aws_subnet.public.id
+  subnet_id     = aws_subnet.test.id
 
   tags = {
     tostop = "false"
@@ -85,6 +47,16 @@ module "ec2_stop_with_exclusions" {
   rds_schedule              = false
   autoscaling_schedule      = false
   cloudwatch_alarm_schedule = false
+  scheduler_excluded_dates = [
+    "01-01",                         # New Year's Day
+    "12-25",                         # Christmas Day
+    "12-24",                         # Christmas Eve
+    "07-04",                         # Independence Day (US)
+    "11-24",                         # Thanksgiving (example date)
+    "05-01",                         # Labor Day
+    "12-31",                         # New Year's Eve
+    formatdate("MM-DD", timestamp()) # Current date (for tests purposes)
+  ]
 
   scheduler_tag = {
     key   = "tostop"
@@ -103,19 +75,18 @@ module "ec2_start_with_exclusions" {
   autoscaling_schedule      = false
   cloudwatch_alarm_schedule = false
 
-  scheduler_excluded_dates = [
-    "01-01",                         # New Year's Day
-    "12-25",                         # Christmas Day
-    "12-24",                         # Christmas Eve
-    "07-04",                         # Independence Day (US)
-    "11-24",                         # Thanksgiving (example date)
-    "05-01",                         # Labor Day
-    "12-31",                         # New Year's Eve
-    formatdate("MM-DD", timestamp()) # Current date (for tests purposes)
-  ]
-
   scheduler_tag = {
     key   = "tostop"
     value = "true-${random_pet.suffix.id}"
   }
 }
+
+module "test_execution" {
+  count  = var.test_mode ? 1 : 0
+  source = "./test-execution"
+
+  lambda_stop_name             = module.ec2_stop_with_exclusions.scheduler_lambda_name
+  instance_1_to_scheduled_id   = aws_instance.scheduled[0].id
+  instance_2_to_scheduled_id   = aws_instance.scheduled[1].id
+  instance_not_to_scheduled_id = aws_instance.not_scheduled.id
+}

examples/scheduler-with-exclusion-dates/outputs.tf renamed to examples/date-exclusion/outputs.tf

@@ -0,0 +1,32 @@
+run "create_test_infrastructure" {
+  command = apply
+
+  variables {
+    test_mode = true
+  }
+
+  assert {
+    condition     = module.ec2_stop_with_exclusions.scheduler_lambda_name == "stop-ec2-exclusions-${random_pet.suffix.id}"
+    error_message = "Invalid Stop lambda name"
+  }
+
+  assert {
+    condition     = module.ec2_start_with_exclusions.scheduler_lambda_name == "start-ec2-exclusions-${random_pet.suffix.id}"
+    error_message = "Invalid Start lambda name"
+  }
+
+  assert {
+    condition     = module.test_execution[0].instance_1_scheduled_state == "running"
+    error_message = "Instance 1 should remain running (current date is excluded)"
+  }
+
+  assert {
+    condition     = module.test_execution[0].instance_2_scheduled_state == "running"
+    error_message = "Instance 2 should remain running (current date is excluded)"
+  }
+
+  assert {
+    condition     = module.test_execution[0].instance_not_scheduled_state == "running"
+    error_message = "Instance not scheduled should remain running"
+  }
+}

examples/date-exclusion/terraform.tftest.hcl

@@ -0,0 +1,49 @@
+resource "null_resource" "wait_running_state" {
+  provisioner "local-exec" {
+    command = <<-EOT
+      python3 ${path.module}/wait_instances.py running \
+        ${var.instance_1_to_scheduled_id} \
+        ${var.instance_2_to_scheduled_id}
+    EOT
+  }
+}
+
+resource "aws_lambda_invocation" "this" {
+  function_name = var.lambda_stop_name
+
+  input = jsonencode({
+    key1 = "value1"
+    key2 = "value2"
+  })
+
+  depends_on = [null_resource.wait_running_state]
+}
+
+resource "null_resource" "wait_exclusion_check" {
+  provisioner "local-exec" {
+    command = <<-EOT
+      echo "Waiting for exclusion date verification..."
+      sleep 30
+    EOT
+  }
+
+  depends_on = [aws_lambda_invocation.this]
+}
+
+data "aws_instance" "instance_1_to_scheduled_id" {
+  instance_id = var.instance_1_to_scheduled_id
+
+  depends_on = [null_resource.wait_exclusion_check]
+}
+
+data "aws_instance" "instance_2_to_scheduled_id" {
+  instance_id = var.instance_2_to_scheduled_id
+
+  depends_on = [null_resource.wait_exclusion_check]
+}
+
+data "aws_instance" "instance_not_to_scheduled_id" {
+  instance_id = var.instance_not_to_scheduled_id
+
+  depends_on = [null_resource.wait_exclusion_check]
+}

examples/date-exclusion/test-execution/main.tf

@@ -0,0 +1,14 @@
+output "instance_1_scheduled_state" {
+  description = "State of instance 1 after scheduler execution"
+  value       = data.aws_instance.instance_1_to_scheduled_id.instance_state
+}
+
+output "instance_2_scheduled_state" {
+  description = "State of instance 2 after scheduler execution"
+  value       = data.aws_instance.instance_2_to_scheduled_id.instance_state
+}
+
+output "instance_not_scheduled_state" {
+  description = "State of instance not scheduled after scheduler execution"
+  value       = data.aws_instance.instance_not_to_scheduled_id.instance_state
+}

examples/date-exclusion/test-execution/outputs.tf

@@ -0,0 +1,19 @@
+variable "lambda_stop_name" {
+  description = "Name of the lambda function to stop EC2"
+  type        = string
+}
+
+variable "instance_1_to_scheduled_id" {
+  description = "Instance 1 ID to test scheduled action"
+  type        = string
+}
+
+variable "instance_2_to_scheduled_id" {
+  description = "Instance 2 ID to test scheduled action"
+  type        = string
+}
+
+variable "instance_not_to_scheduled_id" {
+  description = "Instance ID not to be scheduled"
+  type        = string
+}

examples/date-exclusion/test-execution/variables.tf

@@ -0,0 +1,13 @@
+terraform {
+  required_version = ">= 1.3"
+  required_providers {
+    aws = {
+      source  = "hashicorp/aws"
+      version = ">= 5.0"
+    }
+    null = {
+      source  = "hashicorp/null"
+      version = ">= 3.0"
+    }
+  }
+}

examples/date-exclusion/test-execution/versions.tf

@@ -0,0 +1,73 @@
+#!/usr/bin/env python3
+"""Script to wait for AWS instances status."""
+
+import sys
+import time
+from typing import List
+
+import boto3
+from botocore.exceptions import ClientError
+
+
+def wait_for_instances_status(
+    instance_ids: List[str], desired_status: str, region: str = None
+) -> None:
+    """Wait for instances to reach desired status.
+
+    Args:
+        instance_ids: List of instance IDs to check
+        desired_status: Desired status to wait for (e.g. 'running', 'stopped')
+        region: AWS region name
+    """
+    if not instance_ids:
+        return
+
+    ec2 = boto3.client("ec2", region_name=region) if region else boto3.client("ec2")
+    start_time = time.time()
+    timeout = 600  # 10 minutes timeout
+
+    while True:
+        try:
+            # Check if timeout has been reached
+            if time.time() - start_time > timeout:
+                print(
+                    f"Timeout reached after {timeout} seconds. Some instances may not have reached the desired status."
+                )
+                sys.exit(1)
+
+            response = ec2.describe_instances(InstanceIds=instance_ids)
+            all_instances_in_desired_state = True
+
+            for reservation in response["Reservations"]:
+                for instance in reservation["Instances"]:
+                    current_state = instance["State"]["Name"]
+                    if current_state != desired_status:
+                        all_instances_in_desired_state = False
+                        break
+
+                if not all_instances_in_desired_state:
+                    break
+
+            if all_instances_in_desired_state:
+                print(f"All instances are now {desired_status}")
+                return
+
+            print(f"Waiting for instances to be {desired_status}...")
+            time.sleep(10)  # Wait 10 seconds before checking again
+
+        except ClientError as e:
+            print(f"Error checking instance status: {e}")
+            sys.exit(1)
+
+
+if __name__ == "__main__":
+    if len(sys.argv) < 3:
+        print(
+            "Usage: python wait_instances.py <desired_status> <instance_id1> [instance_id2 ...]"
+        )
+        sys.exit(1)
+
+    desired_status = sys.argv[1]
+    instance_ids = sys.argv[2:]
+
+    wait_for_instances_status(instance_ids, desired_status)

examples/date-exclusion/test-execution/wait_instances.py

@@ -0,0 +1,5 @@
+variable "test_mode" {
+  description = "Enable test mode"
+  type        = bool
+  default     = false
+}