ruby_aem_aws_odysseas 1.4.2

data/lib/ruby_aem_aws/mixins/healthy_state_verifier.rb

@@ -0,0 +1,45 @@
+# 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 EC2 instance state.
+  # Add this to a component to make it capable of determining its own health.
+  module HealthyStateVerifier
+    # @return true if there are one or more instances matching the descriptor and they are all healthy.
+    def healthy?
+      has_instance = false
+      get_all_instances.each do |i|
+        next if i.nil? || i.state.code != Constants::INSTANCE_STATE_CODE_RUNNING
+
+        has_instance = true
+        return false if i.state.name != Constants::INSTANCE_STATE_HEALTHY
+      end
+      has_instance
+    end
+
+    def wait_until_healthy
+      instance_healthy = false
+      get_all_instances.each do |i|
+        next if i.nil? || i.state.code != Constants::INSTANCE_STATE_CODE_RUNNING
+
+        i.wait_until_running
+        instance_healthy = true
+        return false if i.state.name != Constants::INSTANCE_STATE_HEALTHY
+      end
+      instance_healthy
+    end
+  end
+end

data/lib/ruby_aem_aws/mixins/instance_describer.rb

@@ -0,0 +1,34 @@
+# 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
+  # Mixin for describing component EC2 instance state.
+  # Add this to a component to make it capable of describing its instances.
+  module InstanceDescriber
+    # @return a string containing instance descriptions.
+    def describe_instances
+      descriptions = []
+      get_all_instances.each do |i|
+        next if i.nil?
+
+        descriptions.push(describe_instance(i))
+      end
+      descriptions.join(', ')
+    end
+
+    def describe_instance(instance)
+      "#{instance.instance_id} (#{instance.state.name})"
+    end
+  end
+end

data/lib/ruby_aem_aws/mixins/metric_verifier.rb

@@ -0,0 +1,189 @@
+# 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/cloudwatch'
+require_relative '../client/cloudwatch'
+
+module RubyAemAws
+  # Mixin for checking that an instance has associated CloudWatch metrics.
+  module MetricVerifier
+    include CloudwatchClient
+    include AbstractCloudwatch
+
+    # @param alarm_name name of the Cloudwatch alarm
+    # @return True if Cloudwatch alarm exists for component
+    def component_alarm?(alarm_name)
+      alarm?(alarm_name)
+    end
+
+    # @param namespace Cloudwatch metric namespace
+    # @param metric_name Cloudwatch metric name
+    # @return True if Cloudwatch metric exists for component
+    def component_metric?(namespace, metric_name)
+      dimensions_name = 'FixedDimension'
+      dimensions_value = "#{@descriptor.stack_prefix_in}-#{@descriptor.ec2.component}"
+      response = metric?(namespace, metric_name, dimensions_name, dimensions_value)
+      return true if response.eql? true
+    end
+
+    # @param metric_name Cloudwatch EC2 metric name
+    # @return True if Cloudwatch EC2 metric exists for all component instances
+    def component_ec2_metric?(metric_name)
+      namespace = 'AWS/EC2'
+      dimensions_name = 'InstanceId'
+      instances_with_metric = []
+      instances = get_all_instances
+      instances_found = instances.count
+
+      instances.each do |instance|
+        next if instance.nil?
+
+        instance_id = instance.instance_id
+        dimensions_value = instance.instance_id
+
+        response = metric?(namespace, metric_name, dimensions_name, dimensions_value)
+
+        instances_with_metric.push(instance_id) if response.eql? true
+      end
+
+      instances_with_metric = instances_with_metric.count
+
+      return true unless instances_with_metric < instances_found
+    end
+
+    # @param log_stream_name Cloudwatch log stream name
+    # @param log_message name of the logfile of the log stream
+    # @return True if log message exists in Cloudwatch log stream for all component instances
+    def component_log_event?(log_stream_name, log_message)
+      instances_with_log_stream = []
+      loggroup_name = "#{@descriptor.stack_prefix_in}#{log_stream_name}"
+
+      instances = get_all_instances
+      instances_found = instances.count
+
+      instances.each do |instance|
+        next if instance.nil?
+
+        instance_id = instance.instance_id
+        log_stream_name = "#{@descriptor.ec2.component}/#{instance_id}"
+
+        response = log_event?(loggroup_name, log_stream_name, log_message)
+
+        instances_with_log_stream.push(instance_id) if response.eql? true
+      end
+      instances_with_log_stream = instances_with_log_stream.count
+
+      return true unless instances_with_log_stream < instances_found
+    end
+
+    # @param log_stream_name Cloudwatch log stream name
+    # @return True if Cloudwatch loggroup exists for component
+    def component_loggroup?(log_stream_name)
+      loggroup_name = "#{@descriptor.stack_prefix_in}#{log_stream_name}"
+
+      response = loggroup?(loggroup_name)
+
+      return true if response.eql? true
+    end
+
+    # @param log_stream_name Cloudwatch log stream name
+    # @return True if Cloudwatch log stream exists for all component instances
+    def component_log_stream?(log_stream_name)
+      instances_with_log_stream = []
+      loggroup_name = "#{@descriptor.stack_prefix_in}#{log_stream_name}"
+
+      instances = get_all_instances
+      instances_found = instances.count
+
+      instances.each do |instance|
+        next if instance.nil?
+
+        instance_id = instance.instance_id
+        log_stream_name = "#{@descriptor.ec2.component}/#{instance_id}"
+
+        response = log_stream?(loggroup_name, log_stream_name)
+
+        instances_with_log_stream.push(instance_id) if response.eql? true
+      end
+      instances_with_log_stream = instances_with_log_stream.count
+
+      return true unless instances_with_log_stream < instances_found
+    end
+
+    # @param alarm_name name of the Cloudwatch alarm
+    # @return True if Cloudwatch alarm exists
+    def alarm?(alarm_name)
+      response = get_alarm(alarm_name)
+
+      return true unless response.metric_alarms.empty?
+    end
+
+    # @param namespace Cloudwatch metric namespace
+    # @param metric_name Cloudwatch metric name
+    # @param dimensions_name Cloudwatch metric dimension name
+    # @param dimensions_value Cloudwatch metric dimension value
+    # @return True if Cloudwatch metric exists
+    def metric?(namespace, metric_name, dimensions_name, dimensions_value)
+      dimension_values = dimensions_value_filter_for_cloudwatch_metric(dimensions_name, dimensions_value)
+      dimension_filter = dimensions_filter_for_cloudwatch_metric(dimension_values)
+
+      response = get_metrics(namespace, metric_name, dimension_filter)
+
+      return true unless response.metrics.empty?
+    end
+
+    # @param loggroup_name Cloudwatch loggroup name
+    # @param log_stream_name Cloudwatch log stream name
+    # @return True if Cloudwatch log stream exists
+    def log_stream?(loggroup_name, log_stream_name)
+      response = loggroup?(loggroup_name)
+      return false unless response.eql? true
+
+      response = get_log_streams(loggroup_name, log_stream_name)
+
+      return true unless response.log_streams.empty?
+    end
+
+    # @param loggroup_name Cloudwatch loggroup name
+    # @param log_stream_name Cloudwatch log stream name
+    # @param log_message name of the logfile of the log stream
+    # @return True if Cloudwatch log event exists
+    def log_event?(loggroup_name, log_stream_name, log_message)
+      response = loggroup?(loggroup_name)
+      return false unless response.eql? true
+
+      response = log_stream?(loggroup_name, log_stream_name)
+      return false unless response.eql? true
+
+      response = get_log_event(loggroup_name, log_stream_name, log_message)
+      return true unless response.events.empty?
+    end
+
+    # @param loggroup Cloudwatch loggroup name
+    # @return True if Cloudwatch loggroup exists
+    def loggroup?(loggroup_name)
+      namespace = 'AWS/Logs'
+      metric_name = 'IncomingLogEvents'
+      dimensions_name = 'LogGroupName'
+      dimensions_value = loggroup_name
+
+      dimension_values = dimensions_value_filter_for_cloudwatch_metric(dimensions_name, dimensions_value)
+      dimension_filter = dimensions_filter_for_cloudwatch_metric(dimension_values)
+
+      response = get_metrics(namespace, metric_name, dimension_filter)
+
+      return true unless response.metrics.empty?
+    end
+  end
+end

data/lib/ruby_aem_aws/mixins/snapshot_verifier.rb

@@ -0,0 +1,37 @@
+# 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
+  # Mixin for checking snapshots of a component via EC2 client
+  # Add this to a component to make it capable of determining its own snapshots.
+  module SnapshotVerifier
+    # @param snapshot_id AWS Snapshot ID
+    # @return true if snapshot exists, nil if no snapshot exists
+    def snapshot?(snapshot_id)
+      return true unless get_snapshot_by_id(snapshot_id).nil?
+    end
+
+    # @param snapshot_type AEM snapshot type
+    # @return true if snapshots exist, false is no snapshots exist
+    def snapshots?(snapshot_type)
+      has_snapshot = false
+      get_snapshots_by_type(snapshot_type).each do |s|
+        next if s.nil?
+
+        has_snapshot = true
+      end
+      has_snapshot
+    end
+  end
+end

data/lib/ruby_aem_aws_odysseas.rb

@@ -0,0 +1,152 @@
+# 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 'ruby_aem_aws/architecture/consolidated_stack'
+require_relative 'ruby_aem_aws/architecture/full_set_stack'
+require_relative 'ruby_aem_aws/architecture/stack_manager'
+
+module RubyAemAws
+  # AemAws class represents the AWS stack for AEM.
+  class AemAws
+    # @param conf configuration hash of the following configuration values:
+    # - region: the AWS region (eg ap-southeast-2)
+    # - aws_access_key_id: the AWS access key
+    # - aws_secret_access_key: the AWS secret access key
+    # - aws_profile: AWS profile name
+    # @return new RubyAemAws::AemAws instance
+    def initialize(conf = {})
+      conf[:region] ||= Constants::REGION_DEFAULT
+      conf[:aws_access_key_id] ||= Constants::ACCESS_KEY_ID
+      conf[:aws_secret_access_key] ||= Constants::SECRET_ACCESS_KEY
+      conf[:aws_profile] ||= Constants::PROFILE
+
+      Aws.config.update(region: conf[:region])
+
+      credentials = Aws::Credentials.new(conf[:aws_access_key_id], conf[:aws_secret_access_key]) unless conf[:aws_access_key_id].nil?
+      credentials = Aws::SharedCredentials.new(profile_name: conf[:aws_profile]) unless conf[:aws_profile].nil?
+      credentials = Aws::InstanceProfileCredentials.new if conf[:aws_profile].nil? && conf[:aws_access_key_id].nil?
+      raise RubyAemAws::ArgumentError unless defined? credentials
+
+      Aws.config.update(credentials: credentials)
+
+      @aws = AwsCreator.create_aws
+    end
+
+    # Test connection to Amazon AWS
+    #
+    # @return One or more regions that are currently available.
+    def test_connection
+      result = []
+      ec2_client = @aws[:Ec2Client]
+      ec2_client.describe_regions.regions.each do |region|
+        result.push("Region #{region.region_name} (#{region.endpoint})")
+      end
+      !result.empty?
+    end
+
+    # Create a consolidated instance.
+    #
+    # @param stack_prefix AWS tag: StackPrefix
+    # @param aws_clients Array of AWS Clients and Resource connections:
+    # - CloudFormationClient: AWS Cloudformation Client.
+    # - CloudWatchClient: AWS Cloudwatch Client.
+    # - CloudWatchLogsClient: AWS Cloudwatch Logs Client.
+    # - Ec2Resource: AWS EC2 Resource connection.
+    # @return new RubyAemAws::ConsolidatedStack instance
+    def consolidated(stack_prefix)
+      aws_clients = {
+        CloudFormationClient: @aws[:CloudFormationClient],
+        CloudWatchClient: @aws[:CloudWatchClient],
+        CloudWatchLogsClient: @aws[:CloudWatchLogsClient],
+        Ec2Resource: @aws[:Ec2Resource]
+      }
+
+      RubyAemAws::ConsolidatedStack.new(stack_prefix, aws_clients)
+    end
+
+    # Create a full set instance.
+    #
+    # @param stack_prefix AWS tag: StackPrefix
+    # @param aws_clients Array of AWS Clients and Resource connections:
+    # - AutoScalingClient: AWS AutoScalingGroup Client.
+    # - CloudFormationClient: AWS Cloudformation Client.
+    # - CloudWatchClient: AWS Cloudwatch Client.
+    # - CloudWatchLogsClient: AWS Cloudwatch Logs Client.
+    # - Ec2Resource: AWS EC2 Resource connection.
+    # - ElbClient: AWS ElasticLoadBalancer Client.
+    # @return new RubyAemAws::FullSetStack instance
+    def full_set(stack_prefix)
+      aws_clients = {
+        AutoScalingClient: @aws[:AutoScalingClient],
+        CloudFormationClient: @aws[:CloudFormationClient],
+        CloudWatchClient: @aws[:CloudWatchClient],
+        CloudWatchLogsClient: @aws[:CloudWatchLogsClient],
+        Ec2Resource: @aws[:Ec2Resource],
+        ElbClient: @aws[:ElbClient]
+      }
+
+      RubyAemAws::FullSetStack.new(stack_prefix, aws_clients)
+    end
+
+    # Create Stack Manager resources
+    #
+    # @param stack_prefix AWS tag: StackPrefix
+    # @param aws_clients Array of AWS Clients and Resource connections:
+    # - CloudFormationClient: AWS Cloudformation Client.
+    # - 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 instance
+    def stack_manager(stack_prefix)
+      aws_clients = {
+        CloudFormationClient: @aws[:CloudFormationClient],
+        CloudWatchClient: @aws[:CloudWatchClient],
+        CloudWatchLogsClient: @aws[:CloudWatchLogsClient],
+        DynamoDBClient: @aws[:DynamoDBClient],
+        S3Client: @aws[:S3Client],
+        S3Resource: @aws[:S3Resource]
+      }
+
+      RubyAemAws::StackManager.new(stack_prefix, aws_clients)
+    end
+  end
+
+  # Encapsulate AWS class creation for mocking.
+  class AwsCreator
+    def self.create_aws
+      {
+        Ec2Client: Aws::EC2::Client.new,
+        Ec2Resource: Aws::EC2::Resource.new,
+        ElbClient: Aws::ElasticLoadBalancing::Client.new(
+          retry_limit: 20
+        ),
+        AutoScalingClient: Aws::AutoScaling::Client.new(
+          retry_limit: 20
+        ),
+        CloudFormationClient: Aws::CloudFormation::Client.new,
+        CloudWatchClient: Aws::CloudWatch::Client.new(
+          retry_limit: 20
+        ),
+        CloudWatchLogsClient: Aws::CloudWatchLogs::Client.new(
+          retry_limit: 20
+        ),
+        DynamoDBClient: Aws::DynamoDB::Client.new,
+        S3Client: Aws::S3::Client.new,
+        S3Resource: Aws::S3::Resource.new
+      }
+    end
+  end
+end