ruby_aem_aws_odysseas 1.4.2

data/lib/ruby_aem_aws/component/stack_manager_resources.rb

@@ -0,0 +1,90 @@
+# Copyright 2018 Shine Solutions
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative '../abstract/stackmanager'
+require_relative '../client/sns_topic'
+require_relative '../client/dynamo_db'
+require_relative '../client/s3'
+require_relative '../mixins/metric_verifier'
+
+module RubyAemAws
+  module Component
+    # Interface to the AWS StackManager to send out commands
+    class StackManagerResources
+      attr_reader :dynamodb_client, :s3_client, :s3_resource, :cloud_watch_client, :cloud_watch_log_client
+      include AbstractStackManager
+      include DynamoDB
+      include MetricVerifier
+      include SNSTopic
+      include S3Access
+
+      # @param dynamodb_client AWS DynamoDB client connection
+      # @param params Array of AWS Clients and Resource connections:
+      # - CloudWatchClient: AWS Cloudwatch Client.
+      # - CloudWatchLogsClient: AWS Cloudwatch Logs Client.
+      # - DynamoDBClient: AWS DynamoDB Client.
+      # - S3Client: AWS S3 Client.
+      # - S3Resource: AWS S3 Resource connection.
+      # @return new RubyAemAws::StackManager::StackManagerResources
+      def initialize(params)
+        @dynamodb_client = params[:DynamoDBClient]
+        @s3_client = params[:S3Client]
+        @s3_resource = params[:S3Resource]
+        @cloud_watch_client = params[:CloudWatchLogsClient]
+        @cloud_watch_log_client = params[:CloudWatchLogsClient]
+      end
+
+      # @param topicarn AWS SNS-Topic ARN
+      # @param task AEM StackManager task
+      # @param stack_prefix AEM Stack-Prefix
+      # @param details AEM StackManager task detail message
+      # @return AWS SNS publish message id
+      def sns_publish(topicarn, task, stack_prefix, details)
+        details = JSON.generate(details).tr('\"', '\'')
+        publish(topicarn, message_for_sns_publish(task, stack_prefix, details))
+      end
+
+      # @param dynamodb_tablename AWS DynamoDB table name
+      # @param attribute_value Attribute value to scan for
+      # @return Scan result
+      def dyn_db_msg_scan(dynamodb_tablename, attribute_value)
+        scan(filter_for_db_scan(dynamodb_tablename, attribute_value))
+      end
+
+      # @param dynamodb_tablename AWS DynamoDB table name
+      # @param attribute_value Attribute value to query for
+      # @return Command state
+      def dyn_db_cmd_query(dynamodb_tablename, attribute_value)
+        key_attribute_value = attribute_value.items[0]['command_id']
+        state = query(filter_for_db_query(dynamodb_tablename, key_attribute_value))
+        state.items[0]['state']
+      end
+
+      # @param s3_bucket_name S3 bucketname
+      # @param s3_object_name S3 Object name
+      # @return AWS S3 resource object
+      def s3_resource_object(s3_bucket_name, s3_object_name)
+        get_s3_bucket_object(s3_bucket_name, s3_object_name)
+      end
+
+      # @param s3_bucket_name S3 bucketname
+      # @param s3_object_name S3 Object name
+      # @param dest_path local download path, default: nil
+      # @return AWS S3 client object
+      def s3_download_object(s3_bucket_name, s3_object_name, dest_path = nil)
+        get_s3_object(s3_bucket_name, s3_object_name, dest_path)
+      end
+    end
+  end
+end

data/lib/ruby_aem_aws/constants.rb

@@ -0,0 +1,53 @@
+# Copyright 2018 Shine Solutions
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module RubyAemAws
+  class InstanceState
+    PENDING = 'pending'.freeze
+    RUNNING = 'running'.freeze
+    SHUTTING_DOWN = 'shutting_down'.freeze
+    TERMINATED = 'terminated'.freeze
+    STOPPING = 'stopping'.freeze
+    STOPPED = 'stopped'.freeze
+
+    ALL_ACTIVE = [PENDING, RUNNING, SHUTTING_DOWN, STOPPING, STOPPED].freeze
+  end
+
+  # API InstanceState codes https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_InstanceState.html
+  class InstanceStateCode
+    PENDING = 0
+    RUNNING = 16
+    SHUTTING_DOWN = 32
+    TERMINATED = 48
+    STOPPING = 64
+    STOPPED = 80
+  end
+
+  class ELBInstanceState
+    INSERVICE = 'InService'.freeze
+    OUTOFSERVICE = 'OutOfService'.freeze
+
+    ALL_ACTIVE = [INSERVICE, OUTOFSERVICE].freeze
+  end
+
+  class Constants
+    REGION_DEFAULT = ENV['AWS_DEFAULT_REGION'] || ENV['aws_default_region'] || 'ap-southeast-2'.freeze
+    ACCESS_KEY_ID = ENV['AWS_ACCESS_KEY_ID'] || ENV['aws_access_key_id']
+    SECRET_ACCESS_KEY = ENV['AWS_SECRET_ACCESS_KEY'] || ENV['aws_scret_access_key']
+    PROFILE = ENV['AWS_PROFILE']
+    INSTANCE_STATE_HEALTHY = RubyAemAws::InstanceState::RUNNING.freeze
+    INSTANCE_STATE_CODE_RUNNING = RubyAemAws::InstanceStateCode::RUNNING
+    ELB_INSTANCE_INSERVICE = RubyAemAws::ELBInstanceState::INSERVICE.freeze
+  end
+end

data/lib/ruby_aem_aws/error.rb

@@ -0,0 +1,68 @@
+# Copyright 2018 Shine Solutions
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module RubyAemAws
+  # Raise this when a method is not yet implemented.
+  class NotYetImplementedError < StandardError
+    def initialize(msg = 'Not yet implemented')
+      super
+    end
+  end
+
+  # Raise this when ELB is misconfigured.
+  class ELBMisconfiguration < StandardError
+    def initialize(msg = 'ELB misconfigured')
+      super
+    end
+  end
+
+  # Raise this when ASG is misconfigured.
+  class ASGMisconfiguration < StandardError
+    def initialize(msg = 'ASG misconfigured')
+      super
+    end
+  end
+
+  # Raise this when a unknown Response received.
+  class UnknownResponse < StandardError
+    def initialize(msg = 'Unknown response code')
+      super
+    end
+  end
+
+  # Raise this when a component unexpectedly has more than one instance.
+  class ExpectedSingleInstanceError < StandardError
+    # def initialize(count, descriptor)
+    #   message << 'Expected exactly one instance'
+    #   message << " but got #{count}" unless count.nil?
+    #   message << "for (#{descriptor.stack_prefix}, #{descriptor.ec2.component}, #{descriptor.ec2.name})" unless descriptor.nil?
+    #   super(message)
+    # end
+
+    def initialize(msg = 'Expected exactly one instance')
+      super
+    end
+  end
+
+  # Raise this when credentials can't be found
+  class ArgumentError < StandardError
+    def initialize(msg = "No credentials found!
+      Set environment variable AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY or AWS_PROFILE.
+      Alternative use following syntax:
+      RubyAemAws::AemAws.new(aws_access_key_id, aws_scret_access_key) or
+      RubyAemAws::AemAws.new(credentials_profile_name)")
+      super
+    end
+  end
+end

data/lib/ruby_aem_aws/mixins/healthy_count_verifier.rb

@@ -0,0 +1,154 @@
+# Copyright 2018 Shine Solutions
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative '../constants'
+
+module RubyAemAws
+  # Mixin for checking health of a component via ELB 'healthy' count vs ASG desired_capacity.
+  # Add this to a component to make it capable of determining its own health.
+  module HealthyCountVerifier
+    # Aggregate health_states considered healthy.
+    # @return health_state is ready or scaling.
+    def healthy?
+      %i[ready scaling].include? health_state
+    end
+
+    # Provides detail of the state of the instances comprising the component.
+    # @return one of:
+    # - no_asg: AutoScalingGroup could not be located (by StackPrefix and Component tags).
+    # - no_elb: ElasticLoadBalancer could not be located (by StackPrefix and aws:cloudformation:logical-id tags).
+    # - misconfigured: AutoScalingGroup.desired_capacity is less than 1.
+    # - recovering: ELB running instance count is less than AutoScalingGroup.desired_capacity.
+    # - scaling: ELB running instance count is more than AutoScalingGroup.desired_capacity.
+    # - ready: ELB running instance count is equal to AutoScalingGroup.desired_capacity.
+    def health_state
+      asg = find_auto_scaling_group(asg_client)
+      return :no_asg if asg.nil?
+
+      # Debug:
+      # unless asg.nil?
+      #   puts("ASG: #{asg} #{asg.auto_scaling_group_name} (#{asg.desired_capacity})")
+      #   asg.instances.each do |i|
+      #     puts("  Instance #{i.instance_id}: #{i.health_status}")
+      #   end
+      # end
+
+      elb = find_elb(elb_client)
+      return :no_elb if elb.nil?
+
+      elb_running_instances = 0
+      get_instances_state_from_elb(elb).each do |i|
+        elb_running_instances += 1 if i[:state] == RubyAemAws::Constants::INSTANCE_STATE_HEALTHY
+      end
+
+      desired_capacity = asg.desired_capacity
+
+      return :misconfigured if desired_capacity < 1
+      return :recovering if elb_running_instances < desired_capacity
+      return :scaling if elb_running_instances > desired_capacity
+
+      :ready
+    end
+
+    # @return true, if all EC2 instances within the ELB are running
+    def wait_until_healthy
+      raise ELBMisconfiguration if health_state.eql?(:misconfigured)
+
+      sleep 60 while health_state.eql?(:recovering) || health_state.eql?(:scaling)
+      return true if health_state.eql?(:ready)
+    end
+
+    private
+
+    # @return AutoScalingGroup by StackPrefix and Component tags.
+    def find_auto_scaling_group(asg_client)
+      autoscaling_groups = asg_client.describe_auto_scaling_groups(max_records: 50)
+      find_auto_scaling_group = find_auto_scaling_group_name(autoscaling_groups)
+
+      return find_auto_scaling_group unless find_auto_scaling_group.nil?
+
+      until autoscaling_groups.next_token.nil?
+        autoscaling_groups = asg_client.describe_auto_scaling_groups(max_records: 50, next_token: autoscaling_groups.next_token)
+        find_auto_scaling_group = find_auto_scaling_group_name(autoscaling_groups)
+        return find_auto_scaling_group unless find_auto_scaling_group.nil?
+      end
+      return nil if find_auto_scaling_group.nil?
+    end
+
+    def find_auto_scaling_group_name(autoscaling_groups)
+      autoscaling_groups.auto_scaling_groups.each do |autoscaling_group|
+        asg_matches_stack_prefix = false
+        asg_matches_component = false
+        tags = autoscaling_group.tags
+        tags.each do |tag|
+          if tag.key == 'StackPrefix' && tag.value == descriptor.stack_prefix
+            asg_matches_stack_prefix = true
+            break if asg_matches_component
+
+            next
+          end
+          if tag.key == 'Component' && tag.value == descriptor.ec2.component
+            asg_matches_component = true
+            break if asg_matches_stack_prefix
+          end
+        end
+        return autoscaling_group if asg_matches_stack_prefix && asg_matches_component
+      end
+      nil
+    end
+
+    # @return ElasticLoadBalancer by StackPrefix and logical-id tags.
+    def find_elb(elb_client)
+      elbs = elb_client.describe_load_balancers.load_balancer_descriptions
+      elbs.each do |elb|
+        elb_matches_stack_prefix = false
+        elb_matches_logical_id = false
+        tag_descriptions = elb_client.describe_tags(load_balancer_names: [elb.load_balancer_name]).tag_descriptions
+        next if tag_descriptions.empty?
+
+        tags = tag_descriptions[0].tags
+        tags.each do |tag|
+          if tag.key == 'StackPrefix' && tag.value == descriptor.stack_prefix
+            elb_matches_stack_prefix = true
+            break if elb_matches_logical_id
+
+            next
+          end
+          if tag.key == 'aws:cloudformation:logical-id' && tag.value == descriptor.elb.id
+            elb_matches_logical_id = true
+            break if elb_matches_stack_prefix
+          end
+        end
+        return elb if elb_matches_stack_prefix && elb_matches_logical_id
+      end
+      nil
+    end
+
+    def get_instances_state_from_elb(elb)
+      stack_prefix_instances = []
+      elb.instances.each do |i|
+        instance = get_instance_by_id(i.instance_id)
+        next if instance.nil?
+
+        instance.tags.each do |tag|
+          next if tag.key != 'StackPrefix'
+          break if tag.value != descriptor.stack_prefix
+
+          stack_prefix_instances.push(id: i.instance_id, state: instance.state.name)
+        end
+      end
+      stack_prefix_instances
+    end
+  end
+end

data/lib/ruby_aem_aws/mixins/healthy_resource_verifier.rb

@@ -0,0 +1,188 @@
+# Copyright 2018 Shine Solutions
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+require_relative '../constants'
+
+module RubyAemAws
+  # Mixin for checking health of a component via ELB 'healthy' count vs ASG desired_capacity.
+  # Add this to a component to make it capable of determining its own health.
+  module HealthyResourceVerifier
+    # Aggregate health_states considered healthy.
+    # @return health_state_elb is ready or scaling.
+    def healthy_elb?
+      %i[ready scaling].include? health_state_elb
+    end
+
+    # Aggregate health_states considered healthy.
+    # @return health_state_asg is ready or scaling.
+    def healthy_asg?
+      %i[ready scaling].include? health_state_asg
+    end
+
+    # Provides detail of the state of the instances comprising the component.
+    # @return one of:
+    # - no_asg: AutoScalingGroup could not be located (by StackPrefix and Component tags).
+    # - no_elb: ElasticLoadBalancer could not be located (by StackPrefix and aws:cloudformation:logical-id tags).
+    # - misconfigured: AutoScalingGroup.desired_capacity is less than 1.
+    # - recovering: ELB running instance count is less than AutoScalingGroup.desired_capacity.
+    # - scaling: ELB running instance count is more than AutoScalingGroup.desired_capacity.
+    # - ready: ELB running instance count is equal to AutoScalingGroup.desired_capacity.
+    def health_state_elb
+      asg = find_auto_scaling_group(asg_client)
+      return :no_asg if asg.nil?
+
+      # Debug:
+      # unless asg.nil?
+      #   puts("ASG: #{asg} #{asg.auto_scaling_group_name} (#{asg.desired_capacity})")
+      #   asg.instances.each do |i|
+      #     puts("  Instance #{i.instance_id}: #{i.health_status}")
+      #   end
+      # end
+
+      elb = find_elb(elb_client)
+      return :no_elb if elb.nil?
+
+      elb_instance_state = elb_client.describe_instance_health(load_balancer_name: elb.load_balancer_name)
+
+      elb_running_instances = 0
+      elb_instance_state.instance_states.each do |i|
+        elb_running_instances += 1 if i.state == RubyAemAws::Constants::ELB_INSTANCE_INSERVICE
+      end
+
+      desired_capacity = asg.desired_capacity
+
+      return :misconfigured if desired_capacity < 1
+      return :recovering if elb_running_instances < desired_capacity
+      return :scaling if elb_running_instances > desired_capacity
+
+      :ready
+    end
+
+    # Provides detail of the state of the instances comprising the component.
+    # @return one of:
+    # - no_asg: AutoScalingGroup could not be located (by StackPrefix and Component tags).
+    # - misconfigured: AutoScalingGroup.desired_capacity is less than 1.
+    # - recovering: ELB running instance count is less than AutoScalingGroup.desired_capacity.
+    # - scaling: ELB running instance count is more than AutoScalingGroup.desired_capacity.
+    # - ready: ELB running instance count is equal to AutoScalingGroup.desired_capacity.
+    def health_state_asg
+      asg = find_auto_scaling_group(asg_client)
+      return :no_asg if asg.nil?
+
+      # Debug:
+      # unless asg.nil?
+      #   puts("ASG: #{asg} #{asg.auto_scaling_group_name} (#{asg.desired_capacity})")
+      #   asg.instances.each do |i|
+      #     puts("  Instance #{i.instance_id}: #{i.health_status}")
+      #   end
+      # end
+      instances_inservice = 0
+      desired_capacity = asg.desired_capacity
+
+      get_all_instances.each do |i|
+        next if i.nil? || i.state.code != Constants::INSTANCE_STATE_CODE_RUNNING
+        return false if i.state.name != Constants::INSTANCE_STATE_HEALTHY
+
+        instances_inservice += 1
+      end
+
+      return :misconfigured if desired_capacity < 1
+      return :recovering if instances_inservice < desired_capacity
+      return :scaling if instances_inservice > desired_capacity
+
+      :ready
+    end
+
+    # @return true, if all instances within the ELB are inService
+    def wait_until_healthy_elb
+      raise ELBMisconfiguration if health_state_elb.eql?(:misconfigured)
+
+      sleep 60 while health_state_elb.eql?(:recovering) || health_state_elb.eql?(:scaling)
+      return true if health_state_elb.eql?(:ready)
+    end
+
+    def wait_until_healthy_asg
+      raise ASGMisconfiguration if health_state_asg.eql?(:misconfigured)
+
+      sleep 60 while health_state_asg.eql?(:recovering) || health_state_asg.eql?(:scaling)
+      return true if health_state_asg.eql?(:ready)
+    end
+
+    private
+
+    # @return AutoScalingGroup by StackPrefix and Component tags.
+    def find_auto_scaling_group(asg_client)
+      autoscaling_groups = asg_client.describe_auto_scaling_groups(max_records: 50)
+      find_auto_scaling_group = find_auto_scaling_group_name(autoscaling_groups)
+
+      return find_auto_scaling_group unless find_auto_scaling_group.nil?
+
+      until autoscaling_groups.next_token.nil?
+        autoscaling_groups = asg_client.describe_auto_scaling_groups(max_records: 50, next_token: autoscaling_groups.next_token)
+        find_auto_scaling_group = find_auto_scaling_group_name(autoscaling_groups)
+        return find_auto_scaling_group unless find_auto_scaling_group.nil?
+      end
+      return nil if find_auto_scaling_group.nil?
+    end
+
+    def find_auto_scaling_group_name(autoscaling_groups)
+      autoscaling_groups.auto_scaling_groups.each do |autoscaling_group|
+        asg_matches_stack_prefix = false
+        asg_matches_component = false
+        tags = autoscaling_group.tags
+        tags.each do |tag|
+          if tag.key == 'StackPrefix' && tag.value == descriptor.stack_prefix
+            asg_matches_stack_prefix = true
+            break if asg_matches_component
+
+            next
+          end
+          if tag.key == 'Component' && tag.value == descriptor.ec2.component
+            asg_matches_component = true
+            break if asg_matches_stack_prefix
+          end
+        end
+        return autoscaling_group if asg_matches_stack_prefix && asg_matches_component
+      end
+      nil
+    end
+
+    # @return ElasticLoadBalancer by StackPrefix and logical-id tags.
+    def find_elb(elb_client)
+      elbs = elb_client.describe_load_balancers.load_balancer_descriptions
+      elbs.each do |elb|
+        elb_matches_stack_prefix = false
+        elb_matches_logical_id = false
+        tag_descriptions = elb_client.describe_tags(load_balancer_names: [elb.load_balancer_name]).tag_descriptions
+        next if tag_descriptions.empty?
+
+        tags = tag_descriptions[0].tags
+        tags.each do |tag|
+          if tag.key == 'StackPrefix' && tag.value == descriptor.stack_prefix
+            elb_matches_stack_prefix = true
+            break if elb_matches_logical_id
+
+            next
+          end
+          if tag.key == 'aws:cloudformation:logical-id' && tag.value == descriptor.elb.id
+            elb_matches_logical_id = true
+            break if elb_matches_stack_prefix
+          end
+        end
+        return elb if elb_matches_stack_prefix && elb_matches_logical_id
+      end
+      nil
+    end
+  end
+end