Add tests for aws-wrapper. Fix bugs.

Author: brikis98

modules/bash-commons/src/aws-wrapper.sh

@@ -7,31 +7,34 @@ set -e
 
 source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/log.sh"
 source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/aws.sh"
-source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/assertions.sh"
+source "$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)/assert.sh"
 
-# Get the name of the ASG this EC2 Instance is in
+# Get the name of the ASG this EC2 Instance is in. This is done by looking up the instance's tags. This method will
+# wait up until the specified number of retries if the tags or instances are not yet available.
 function aws_wrapper_get_asg_name {
+  local readonly max_retries="$1"
+  local readonly sleep_between_retries="$2"
+
   local instance_id
   instance_id=$(aws_get_instance_id)
 
   local instance_region
   instance_region=$(aws_get_instance_region)
 
-  aws_wrapper_get_instance_tag "$instance_id" "$instance_region" "aws:autoscaling:groupName"
+  aws_wrapper_get_instance_tag "$instance_id" "$instance_region" "aws:autoscaling:groupName" "$max_retries" "$sleep_between_retries"
 }
 
 # Look up the tags for the specified Instance and extract the value for the specified tag key
 function aws_wrapper_get_instance_tag {
   local readonly instance_id="$1"
   local readonly instance_region="$2"
   local readonly tag_key="$3"
-
-  local readonly max_retries=60
-  local readonly sleep_between_retries=5
+  local readonly max_retries="${4:-60}"
+  local readonly sleep_between_retries="${5:-5}"
 
   for (( i=0; i<"$max_retries"; i++ )); do
     local tags
-    tags=$(aws_wrapper_wait_for_instance_tags "$instance_id" "$instance_region")
+    tags=$(aws_wrapper_wait_for_instance_tags "$instance_id" "$instance_region" "$max_retries" "$sleep_between_retries")
     assert_not_empty_or_null "$tags" "tags for Instance $instance_id in $instance_region"
 
     local tag_value
@@ -57,12 +60,11 @@ function aws_wrapper_get_instance_tag {
 function aws_wrapper_wait_for_instance_tags {
   local readonly instance_id="$1"
   local readonly instance_region="$2"
+  local readonly max_retries="${3:-60}"
+  local readonly sleep_between_retries="${4:-5}"
 
   log_info "Looking up tags for Instance $instance_id in $instance_region"
 
-  local readonly max_retries=60
-  local readonly sleep_between_retries=5
-
   for (( i=0; i<"$max_retries"; i++ )); do
     local tags
     tags=$(aws_get_instance_tags "$instance_id" "$instance_region")
@@ -88,9 +90,8 @@ function aws_wrapper_wait_for_instance_tags {
 function aws_wrapper_get_asg_size {
   local readonly asg_name="$1"
   local readonly aws_region="$2"
-
-  local readonly max_retries=60
-  local readonly sleep_between_retries=5
+  local readonly max_retries="${3:-60}"
+  local readonly sleep_between_retries="${4:-5}"
 
   for (( i=0; i<"$max_retries"; i++ )); do
     log_info "Looking up the size of the Auto Scaling Group $asg_name in $aws_region"
@@ -121,12 +122,12 @@ function aws_wrapper_get_asg_size {
 function aws_wrapper_wait_for_instances_in_asg {
   local readonly asg_name="$1"
   local readonly aws_region="$2"
+  local readonly max_retries="${3:-60}"
+  local readonly sleep_between_retries="${4:-5}"
 
   local asg_size
-  asg_size=$(aws_wrapper_get_asg_size "$asg_name" "$aws_region")
-
-  local readonly max_retries=60
-  local readonly sleep_between_retries=5
+  asg_size=$(aws_wrapper_get_asg_size "$asg_name" "$aws_region" "$max_retries" "$sleep_between_retries")
+  assert_not_empty_or_null "$asg_size" "size of ASG $asg_name in $aws_region"
 
   log_info "Looking up Instances in ASG $asg_name in $aws_region"
   for (( i=0; i<"$max_retries"; i++ )); do
@@ -157,9 +158,11 @@ function aws_wrapper_get_ips_in_asg {
   local readonly asg_name="$1"
   local readonly aws_region="$2"
   local readonly use_public_ips="$3"
+  local readonly max_retries="${4:-60}"
+  local readonly sleep_between_retries="${5:-5}"
 
   local instances
-  instances=$(aws_describe_instances_in_asg "$asg_name" "$aws_region")
+  instances=$(aws_wrapper_wait_for_instances_in_asg "$asg_name" "$aws_region" "$max_retries" "$sleep_between_retries")
   assert_not_empty_or_null "$instances" "Get info about Instances in ASG $asg_name in $aws_region"
 
   local readonly ip_param=$([[ "$use_public_ips" == "true" ]] && echo "PublicIpAddress" || echo "PrivateIpAddress")
@@ -172,9 +175,11 @@ function aws_wrapper_get_hostnames_in_asg {
   local readonly asg_name="$1"
   local readonly aws_region="$2"
   local readonly use_public_hostnames="$3"
+  local readonly max_retries="${4:-60}"
+  local readonly sleep_between_retries="${5:-5}"
 
   local instances
-  instances=$(aws_wrapper_wait_for_instances_in_asg "$asg_name" "$aws_region")
+  instances=$(aws_wrapper_wait_for_instances_in_asg "$asg_name" "$aws_region" "$max_retries" "$sleep_between_retries")
   assert_not_empty_or_null "$instances" "Get info about Instances in ASG $asg_name in $aws_region"
 
   local readonly hostname_param=$([[ "$use_public_hostnames" == "true" ]] && echo "PublicDnsName" || echo "PrivateDnsName")

test/aws-cli.bats

@@ -4,32 +4,12 @@ source "$BATS_TEST_DIRNAME/../modules/bash-commons/src/aws.sh"
 load "test-helper"
 load "aws-helper"
 
-readonly MOTO_TMP_DIR="/tmp/moto"
-readonly MOTO_PID_FILE_PATH="$MOTO_TMP_DIR/moto.pid"
-
 function setup {
-  mkdir -p "$MOTO_TMP_DIR"
-
-  # Start moto server if it isn't already running
-  if [[ ! -f "$MOTO_PID_FILE_PATH" ]]; then
-    moto_server &
-    echo "$!" > "$MOTO_PID_FILE_PATH"
-
-    # Sleep a bit to give moto a chance to start
-    sleep 1
-  fi
+  start_moto
 }
 
 function teardown {
-  # Stop moto if it's running
-  if [[ -f "$MOTO_PID_FILE_PATH" ]]; then
-    local readonly pid=$(cat "$MOTO_PID_FILE_PATH")
-    kill "$pid" 2>&1 > /dev/null
-    rm -f "$MOTO_PID_FILE_PATH"
-
-    # Sleep a bit to give moto a chance to stop
-    sleep 1
-  fi
+  stop_moto
 }
 
 @test "aws_get_instance_tags empty" {

test/aws-ec2-metadata.bats

@@ -1,113 +1,60 @@
 #!/usr/bin/env bats
 
-readonly bash_commons_src_path="$BATS_TEST_DIRNAME/../modules/bash-commons/src"
-source "$bash_commons_src_path/aws.sh"
-source "$bash_commons_src_path/string.sh"
+source "$BATS_TEST_DIRNAME/../modules/bash-commons/src/aws.sh"
 load "test-helper"
+load "aws-helper"
 
-readonly EC2_METADATA_MOCK_APP_PATH="$BATS_TEST_DIRNAME/ec2-metadata-mock/ec2-metadata-mock.py"
-readonly EC2_METADATA_MOCK_TMP_DIR="/tmp/ec2-metadata-mock"
-readonly EC2_METADATA_MOCK_PID_PATH="$EC2_METADATA_MOCK_TMP_DIR/ec2-metadata-mock.pid"
-readonly EC2_METADATA_MOCK_LOG_FILE_PATH="$EC2_METADATA_MOCK_TMP_DIR/ec2-metadata-mock.log"
-
-# Set env vars for ec2-metadata-mock
-export meta_data_local_ipv4="11.22.33.44"
-export meta_data_public_ipv4="55.66.77.88"
-export meta_data_local_hostname="ip-10-251-50-12.ec2.internal"
-export meta_data_public_hostname="ec2-203-0-113-25.compute-1.amazonaws.com"
-export meta_data_instance_id="i-1234567890abcdef0"
-
+readonly local_ipv4="11.22.33.44"
+readonly public_ipv4="55.66.77.88"
+readonly local_hostname="ip-10-251-50-12.ec2.internal"
+readonly public_hostname="ec2-203-0-113-25.compute-1.amazonaws.com"
+readonly instance_id="i-1234567890abcdef0"
 readonly mock_region="us-west-1"
-export meta_data_placement__availability_zone="${mock_region}b"
-export dynamic_data_instance_identity__document=$(cat <<END_HEREDOC
-{
-  "devpayProductCodes" : null,
-  "marketplaceProductCodes" : [ "1abc2defghijklm3nopqrs4tu" ],
-  "availabilityZone" : "$meta_data_placement__availability_zone",
-  "privateIp" : "$meta_data_local_ipv4",
-  "version" : "2017-09-30",
-  "instanceId" : "$meta_data_instance_id",
-  "billingProducts" : null,
-  "instanceType" : "t2.micro",
-  "accountId" : "123456789012",
-  "imageId" : "ami-5fb8c835",
-  "pendingTime" : "2016-11-19T16:32:11Z",
-  "architecture" : "x86_64",
-  "kernelId" : null,
-  "ramdiskId" : null,
-  "region" : "$mock_region"
-}
-END_HEREDOC
-)
+readonly availability_zone="${mock_region}b"
 
-# Configure the server so we can run a mock EC2 metadata endpoint on port 80 with the metadata endpoint's special IP.
 function setup {
-  local config
-  config=$(ifconfig)
-
-  mkdir -p "$EC2_METADATA_MOCK_TMP_DIR"
-
-  # Use ifconfig and iptables to allow us to run a mock server on 169.254.169.254 and on port 80. These steps are
-  # based on https://github.com/NYTimes/mock-ec2-metadata. Note #1: we can't use that project directly as it doesn't
-  # support most EC2 metadata endpoints. Note #2: try to make this code idempotent so we don't try to create the same
-  # configuration multiple times.
-  if ! string_multiline_contains "$config" "lo:1"; then
-    ifconfig lo:1 inet 169.254.169.254 netmask 255.255.255.255 up
-    echo 1 > /proc/sys/net/ipv4/ip_forward
-    iptables -t nat -A OUTPUT -p tcp -d 169.254.169.254/32 --dport 80  -j DNAT --to-destination 169.254.169.254:8111
-    iptables-save
-  fi
-
-  # Start ec2-metadata-mock if it isn't already running
-  if [[ ! -f "$EC2_METADATA_MOCK_PID_PATH" ]]; then
-    FLASK_APP="$EC2_METADATA_MOCK_APP_PATH" flask run --host=0.0.0.0 --port=8111 2>&1 > "$EC2_METADATA_MOCK_LOG_FILE_PATH" &
-    echo "$!" > "$EC2_METADATA_MOCK_PID_PATH"
-
-    # Sleep a bit to give Flask a chance to start
-    sleep 1
-  fi
+  start_ec2_metadata_mock \
+    "$local_ipv4" \
+    "$public_ipv4" \
+    "$local_hostname" \
+    "$public_hostname" \
+    "$instance_id" \
+    "$mock_region" \
+    "$availability_zone"
 }
 
 function teardown {
-  # Stop ec2-metadata-mock if it's running
-  if [[ -f "$EC2_METADATA_MOCK_PID_PATH" ]]; then
-    local readonly pid=$(cat "$EC2_METADATA_MOCK_PID_PATH")
-    kill "$pid" 2>&1 > "$EC2_METADATA_MOCK_LOG_FILE_PATH"
-    rm -f "$EC2_METADATA_MOCK_PID_PATH"
-
-    # Sleep a bit to give Flask a chance to stop
-    sleep 1
-  fi
+  stop_ec2_metadata_mock
 }
 
 @test "aws_get_instance_private_ip" {
   run aws_get_instance_private_ip
   assert_success
-  assert_output "$meta_data_local_ipv4"
+  assert_output "$local_ipv4"
 }
 
 @test "aws_get_instance_public_ip" {
   run aws_get_instance_public_ip
   assert_success
-  assert_output "$meta_data_public_ipv4"
+  assert_output "$public_ipv4"
 }
 
 @test "aws_get_instance_private_hostname" {
   run aws_get_instance_private_hostname
   assert_success
-  assert_output "$meta_data_local_hostname"
+  assert_output "$local_hostname"
 }
 
 @test "aws_get_instance_public_hostname" {
   run aws_get_instance_public_hostname
   assert_success
-  assert_output "$meta_data_public_hostname"
+  assert_output "$public_hostname"
 }
 
 @test "aws_get_instance_id" {
   run aws_get_instance_id
   assert_success
-  assert_output "$meta_data_instance_id"
+  assert_output "$instance_id"
 }
 
 @test "aws_get_instance_region" {
@@ -119,6 +66,6 @@ function teardown {
 @test "aws_get_ec2_instance_availability_zone" {
   run aws_get_ec2_instance_availability_zone
   assert_success
-  assert_output "$meta_data_placement__availability_zone"
+  assert_output "$availability_zone"
 }