ruby_aem_aws 0.9.3 → 1.0.0

data/lib/ruby_aem_aws/component/author_publish_dispatcher.rb

@@ -12,19 +12,18 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require 'aws-sdk'
-require_relative 'abstract_single_component'
-require_relative 'abstract_snapshot'
-require_relative 'mixins/healthy_state_verifier'
-require_relative 'mixins/metric_verifier'
+require_relative '../abstract/single_component'
+require_relative '../abstract/snapshot'
+require_relative '../mixins/healthy_state_verifier'
+require_relative '../mixins/metric_verifier'
 require_relative 'component_descriptor'
-require_relative 'mixins/snapshot_verifier'
+require_relative '../mixins/snapshot_verifier'
 
 module RubyAemAws
   module Component
     # Interface to a single AWS instance running all three AEM components as a consolidated stack.
     class AuthorPublishDispatcher
-      attr_reader :descriptor, :ec2_resource, :cloud_watch_client
+      attr_reader :descriptor, :ec2_resource, :cloud_watch_client, :cloud_watch_log_client
       include AbstractSingleComponent
       include AbstractSnapshot
       include HealthyStateVerifier
@@ -35,14 +34,17 @@ module RubyAemAws
       EC2_NAME = 'AuthorPublishDispatcher'.freeze
 
       # @param stack_prefix AWS tag: StackPrefix
-      # @param ec2_resource AWS EC2 resource
-      # @param cloud_watch_client AWS CloudWatch client
+      # @param params Array of AWS Clients and Resource connections:
+      # - CloudWatchClient: AWS Cloudwatch Client.
+      # - CloudWatchLogsClient: AWS Cloudwatch Logs Client.
+      # - Ec2Resource: AWS EC2 Resource connection.
       # @return new RubyAemAws::Consolidated::AuthorPublishDispatcher instance
-      def initialize(stack_prefix, ec2_resource, cloud_watch_client)
+      def initialize(stack_prefix, params)
         @descriptor = ComponentDescriptor.new(stack_prefix,
                                               EC2Descriptor.new(EC2_COMPONENT, EC2_NAME))
-        @ec2_resource = ec2_resource
-        @cloud_watch_client = cloud_watch_client
+        @cloud_watch_client = params[:CloudWatchClient]
+        @cloud_watch_log_client = params[:CloudWatchLogsClient]
+        @ec2_resource = params[:Ec2Resource]
       end
     end
   end

data/lib/ruby_aem_aws/component/author_standby.rb

@@ -12,20 +12,19 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative 'abstract_single_component'
-require_relative 'abstract_snapshot'
-require_relative 'mixins/healthy_state_verifier'
-require_relative 'mixins/metric_verifier'
-require_relative 'mixins/snapshot_verifier'
+require_relative '../abstract/single_component'
+require_relative '../abstract/snapshot'
+require_relative '../mixins/healthy_state_verifier'
+require_relative '../mixins/metric_verifier'
+require_relative '../mixins/snapshot_verifier'
 
 module RubyAemAws
   module Component
     # Interface to the AWS instance running the Author-Standby component of a full-set AEM stack.
     class AuthorStandby
-      attr_reader :descriptor, :ec2_resource, :cloud_watch_client
+      attr_reader :descriptor, :ec2_resource, :cloud_watch_client, :cloud_watch_log_client
       include AbstractGroupedComponent
       include AbstractSnapshot
-      # Can't verify state by count as there's no ASG.
       include HealthyStateVerifier
       include MetricVerifier
       include SnapshotVerifier
@@ -34,14 +33,17 @@ module RubyAemAws
       EC2_NAME = 'AEM Author - Standby'.freeze
 
       # @param stack_prefix AWS tag: StackPrefix
-      # @param ec2_resource AWS EC2 resource
-      # @param cloud_watch_client AWS CloudWatch client
+      # @param params Array of AWS Clients and Resource connections:
+      # - CloudWatchClient: AWS Cloudwatch Client.
+      # - CloudWatchLogsClient: AWS Cloudwatch Logs Client.
+      # - Ec2Resource: AWS EC2 Resource connection.
       # @return new RubyAemAws::FullSet::AuthorStandby
-      def initialize(stack_prefix, ec2_resource, cloud_watch_client)
+      def initialize(stack_prefix, params)
         @descriptor = ComponentDescriptor.new(stack_prefix,
                                               EC2Descriptor.new(EC2_COMPONENT, EC2_NAME))
-        @ec2_resource = ec2_resource
-        @cloud_watch_client = cloud_watch_client
+        @cloud_watch_client = params[:CloudWatchClient]
+        @cloud_watch_log_client = params[:CloudWatchLogsClient]
+        @ec2_resource = params[:Ec2Resource]
       end
 
       # @return Aws::EC2::Instance

data/lib/ruby_aem_aws/component/chaos_monkey.rb

@@ -12,17 +12,17 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative 'abstract_single_component'
-require_relative 'abstract_snapshot'
-require_relative 'mixins/healthy_state_verifier'
-require_relative 'mixins/metric_verifier'
-require_relative 'mixins/snapshot_verifier'
+require_relative '../abstract/single_component'
+require_relative '../abstract/snapshot'
+require_relative '../mixins/healthy_state_verifier'
+require_relative '../mixins/metric_verifier'
+require_relative '../mixins/snapshot_verifier'
 
 module RubyAemAws
   module Component
     # Interface to the AWS instance running the ChaosMonkey component of a full-set AEM stack.
     class ChaosMonkey
-      attr_reader :descriptor, :ec2_resource, :asg_client, :cloud_watch_client
+      attr_reader :descriptor, :ec2_resource, :asg_client, :cloud_watch_client, :cloud_watch_log_client
       include AbstractSingleComponent
       include AbstractSnapshot
       # Can't verify state by count as there's no ELB.
@@ -34,16 +34,19 @@ module RubyAemAws
       EC2_NAME = 'AEM Chaos Monkey'.freeze
 
       # @param stack_prefix AWS tag: StackPrefix
-      # @param ec2_resource AWS EC2 resource
-      # @param asg_client AWS AutoScalingGroup client
-      # @param cloud_watch_client AWS CloudWatch client
+      # @param params Array of AWS Clients and Resource connections:
+      # - AutoScalingClient: AWS AutoScalingGroup Client.
+      # - CloudWatchClient: AWS Cloudwatch Client.
+      # - CloudWatchLogsClient: AWS Cloudwatch Logs Client.
+      # - Ec2Resource: AWS EC2 Resource connection.
       # @return new RubyAemAws::FullSet::ChaosMonkey
-      def initialize(stack_prefix, ec2_resource, asg_client, cloud_watch_client)
+      def initialize(stack_prefix, params)
         @descriptor = ComponentDescriptor.new(stack_prefix,
                                               EC2Descriptor.new(EC2_COMPONENT, EC2_NAME))
-        @ec2_resource = ec2_resource
-        @asg_client = asg_client
-        @cloud_watch_client = cloud_watch_client
+        @asg_client = params[:AutoScalingClient]
+        @cloud_watch_client = params[:CloudWatchClient]
+        @cloud_watch_log_client = params[:CloudWatchLogsClient]
+        @ec2_resource = params[:Ec2Resource]
       end
 
       # def terminate_all_instances

data/lib/ruby_aem_aws/component/orchestrator.rb

@@ -12,17 +12,17 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative 'abstract_single_component'
-require_relative 'abstract_snapshot'
-require_relative 'mixins/healthy_state_verifier'
-require_relative 'mixins/metric_verifier'
-require_relative 'mixins/snapshot_verifier'
+require_relative '../abstract/single_component'
+require_relative '../abstract/snapshot'
+require_relative '../mixins/healthy_state_verifier'
+require_relative '../mixins/metric_verifier'
+require_relative '../mixins/snapshot_verifier'
 
 module RubyAemAws
   module Component
     # Interface to the AWS instance running the Orchestrator component of a full-set AEM stack.
     class Orchestrator
-      attr_reader :descriptor, :ec2_resource, :asg_client, :cloud_watch_client
+      attr_reader :descriptor, :ec2_resource, :asg_client, :cloud_watch_client, :cloud_watch_log_client
       include AbstractSingleComponent
       include AbstractSnapshot
       # Can't verify state by count as there's no ELB.
@@ -34,16 +34,19 @@ module RubyAemAws
       EC2_NAME = 'AEM Orchestrator'.freeze
 
       # @param stack_prefix AWS tag: StackPrefix
-      # @param ec2_resource AWS EC2 resource
-      # @param asg_client AWS AutoScalingGroup client
-      # @param cloud_watch_client AWS CloudWatch client
+      # @param params Array of AWS Clients and Resource connections:
+      # - AutoScalingClient: AWS AutoScalingGroup Client.
+      # - CloudWatchClient: AWS Cloudwatch Client.
+      # - CloudWatchLogsClient: AWS Cloudwatch Logs Client.
+      # - Ec2Resource: AWS EC2 Resource connection.
       # @return new RubyAemAws::FullSet::Orchestrator
-      def initialize(stack_prefix, ec2_resource, asg_client, cloud_watch_client)
+      def initialize(stack_prefix, params)
         @descriptor = ComponentDescriptor.new(stack_prefix,
                                               EC2Descriptor.new(EC2_COMPONENT, EC2_NAME))
-        @ec2_resource = ec2_resource
-        @asg_client = asg_client
-        @cloud_watch_client = cloud_watch_client
+        @asg_client = params[:AutoScalingClient]
+        @cloud_watch_client = params[:CloudWatchClient]
+        @cloud_watch_log_client = params[:CloudWatchLogsClient]
+        @ec2_resource = params[:Ec2Resource]
       end
 
       # def terminate_all_instances

data/lib/ruby_aem_aws/component/publish.rb

@@ -12,21 +12,20 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative 'abstract_grouped_component'
-require_relative 'abstract_snapshot'
-require_relative 'mixins/healthy_state_verifier'
-require_relative 'mixins/metric_verifier'
-require_relative 'mixins/snapshot_verifier'
+require_relative '../abstract/grouped_component'
+require_relative '../abstract/snapshot'
+require_relative '../mixins/healthy_resource_verifier'
+require_relative '../mixins/metric_verifier'
+require_relative '../mixins/snapshot_verifier'
 
 module RubyAemAws
   module Component
     # Interface to the AWS instance running the Publish component of a full-set AEM stack.
     class Publish
-      attr_reader :descriptor, :ec2_resource, :cloud_watch_client, :asg_client
+      attr_reader :descriptor, :ec2_resource, :cloud_watch_client, :asg_client, :cloud_watch_log_client
       include AbstractGroupedComponent
       include AbstractSnapshot
-      # Can't verify state by count as there's no ELB.
-      include HealthyStateVerifier
+      include HealthyResourceVerifier
       include MetricVerifier
       include SnapshotVerifier
 
@@ -34,16 +33,19 @@ module RubyAemAws
       EC2_NAME = 'AEM Publish'.freeze
 
       # @param stack_prefix AWS tag: StackPrefix
-      # @param ec2_resource AWS EC2 resource
-      # @param asg_client AWS AutoScalingGroup client
-      # @param cloud_watch_client AWS CloudWatch client
+      # @param params Array of AWS Clients and Resource connections:
+      # - AutoScalingClient: AWS AutoScalingGroup Client.
+      # - CloudWatchClient: AWS Cloudwatch Client.
+      # - CloudWatchLogsClient: AWS Cloudwatch Logs Client.
+      # - Ec2Resource: AWS EC2 Resource connection.
       # @return new RubyAemAws::FullSet::AuthorPrimary
-      def initialize(stack_prefix, ec2_resource, asg_client, cloud_watch_client)
+      def initialize(stack_prefix, params)
         @descriptor = ComponentDescriptor.new(stack_prefix,
                                               EC2Descriptor.new(EC2_COMPONENT, EC2_NAME))
-        @ec2_resource = ec2_resource
-        @asg_client = asg_client
-        @cloud_watch_client = cloud_watch_client
+        @asg_client = params[:AutoScalingClient]
+        @cloud_watch_client = params[:CloudWatchClient]
+        @cloud_watch_log_client = params[:CloudWatchLogsClient]
+        @ec2_resource = params[:Ec2Resource]
       end
 
       def terminate_all_instances

data/lib/ruby_aem_aws/component/publish_dispatcher.rb

@@ -12,20 +12,20 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative 'abstract_grouped_component'
-require_relative 'abstract_snapshot'
-require_relative 'mixins/healthy_count_verifier'
-require_relative 'mixins/metric_verifier'
-require_relative 'mixins/snapshot_verifier'
+require_relative '../abstract/grouped_component'
+require_relative '../abstract/snapshot'
+require_relative '../mixins/healthy_resource_verifier'
+require_relative '../mixins/metric_verifier'
+require_relative '../mixins/snapshot_verifier'
 
 module RubyAemAws
   module Component
     # Interface to the AWS instance running the PublishDispatcher component of a full-set AEM stack.
     class PublishDispatcher
-      attr_reader :descriptor, :ec2_resource, :asg_client, :elb_client, :cloud_watch_client
+      attr_reader :descriptor, :ec2_resource, :asg_client, :elb_client, :cloud_watch_client, :cloud_watch_log_client
       include AbstractGroupedComponent
       include AbstractSnapshot
-      include HealthyCountVerifier
+      include HealthyResourceVerifier
       include MetricVerifier
       include SnapshotVerifier
 
@@ -35,19 +35,22 @@ module RubyAemAws
       ELB_NAME = 'AEM Publish Dispatcher Load Balancer'.freeze
 
       # @param stack_prefix AWS tag: StackPrefix
-      # @param ec2_resource AWS EC2 resource
-      # @param asg_client AWS AutoScalingGroup client
-      # @param elb_client AWS ELB client
-      # @param cloud_watch_client AWS CloudWatch client
+      # @param params Array of AWS Clients and Resource connections:
+      # - AutoScalingClient: AWS AutoScalingGroup Client.
+      # - CloudWatchClient: AWS Cloudwatch Client.
+      # - CloudWatchLogsClient: AWS Cloudwatch Logs Client.
+      # - Ec2Resource: AWS EC2 Resource connection.
+      # - ElbClient: AWS ElasticLoadBalancer Client.
       # @return new RubyAemAws::FullSet::PublishDispatcher
-      def initialize(stack_prefix, ec2_resource, asg_client, elb_client, cloud_watch_client)
+      def initialize(stack_prefix, params)
         @descriptor = ComponentDescriptor.new(stack_prefix,
                                               EC2Descriptor.new(EC2_COMPONENT, EC2_NAME),
                                               ELBDescriptor.new(ELB_ID, ELB_NAME))
-        @ec2_resource = ec2_resource
-        @asg_client = asg_client
-        @elb_client = elb_client
-        @cloud_watch_client = cloud_watch_client
+        @asg_client = params[:AutoScalingClient]
+        @cloud_watch_client = params[:CloudWatchClient]
+        @cloud_watch_log_client = params[:CloudWatchLogsClient]
+        @ec2_resource = params[:Ec2Resource]
+        @elb_client = params[:ElbClient]
       end
 
       def terminate_all_instances

data/lib/ruby_aem_aws/component/stack_manager_resources.rb

@@ -12,29 +12,37 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-require_relative 'abstract_stackmanager'
-require_relative 'mixins/sns_topic'
-require_relative 'mixins/dynamo_db'
-require_relative 'mixins/s3'
+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
+      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 s3_client AWS S3 client connection
-      # @param s3_resource AWS S3 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(dynamodb_client, s3_client, s3_resource)
-        @dynamodb_client = dynamodb_client
-        @s3_client = s3_client
-        @s3_resource = s3_resource
+      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

data/lib/ruby_aem_aws/error.rb

@@ -27,6 +27,13 @@ module RubyAemAws
     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')

data/lib/ruby_aem_aws/mixins/healthy_count_verifier.rb

@@ -0,0 +1,148 @@
+# 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