ruby_aem_aws_odysseas 1.4.2

data/lib/ruby_aem_aws/architecture/stack_manager.rb

@@ -0,0 +1,44 @@
+# 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 '../component/stack_manager_resources'
+
+module RubyAemAws
+  # Interface to interact with AEM StackManager
+  class StackManager
+    attr_reader :sm_resources, :cloudformation_client
+    # @param stack_prefix AWS tag: StackPrefix
+    # @param params 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 initialize(stack_prefix, params)
+      stack_manager_aws_client = {
+        CloudWatchClient: params[:CloudWatchClient],
+        CloudWatchLogsClient: params[:CloudWatchLogsClient],
+        DynamoDBClient: params[:DynamoDBClient],
+        S3Client: params[:S3Client],
+        S3Resource: params[:S3Resource]
+      }
+
+      @sm_resources = RubyAemAws::Component::StackManagerResources.new(stack_manager_aws_client)
+      @cloudformation_client = params[:CloudFormationClient]
+      @stack_prefix = stack_prefix
+    end
+  end
+end

data/lib/ruby_aem_aws/client/cloudwatch.rb

@@ -0,0 +1,87 @@
+# 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 that an instance has associated CloudWatch metrics.
+  module CloudwatchClient
+    # @param alarm_name Cloudwatch alarm name
+    # @return Cloudwatch client describe_alarms response
+    def get_alarm(alarm_name)
+      alarm_filter = filter_for_cloudwatch_alarm(alarm_name)
+
+      response = cloud_watch_client.describe_alarms(alarm_filter)
+
+      until response.next_token.nil?
+        next_token = { next_token: response.next_token }
+        filter.update(next_token)
+        response = cloud_watch_client.describe_alarms(alarm_filter)
+      end
+
+      response
+    end
+
+    # @param loggroup_name Cloudwatch loggroup name
+    # @param log_stream_name Cloudwatch log stream name
+    # @param log_message Log message to filter for
+    # @return Cloudwatch log client filter_log_events response
+    def get_log_event(loggroup_name, log_stream_name, log_message)
+      filter = filter_for_cloudwatch_log_event(loggroup_name, log_stream_name, log_message)
+      response = cloud_watch_log_client.filter_log_events(filter)
+
+      until response.next_token.nil?
+        next_token = { next_token: response.next_token }
+        filter.update(next_token)
+        response = cloud_watch_client.filter_log_events(filter)
+      end
+
+      response
+    end
+
+    # @param loggroup_name Cloudwatch loggroup name
+    # @param log_stream_name Cloudwatch log stream name
+    # @return Cloudwatch log client describe_log_streams response
+    def get_log_streams(loggroup_name, log_stream_name)
+      filter = filter_for_cloudwatch_log_stream(loggroup_name, log_stream_name)
+
+      response = cloud_watch_log_client.describe_log_streams(filter)
+
+      until response.next_token.nil?
+        next_token = { next_token: response.next_token }
+        filter.update(next_token)
+        response = cloud_watch_client.describe_log_streams(filter)
+      end
+
+      response
+    end
+
+    # @param namespace Cloudwatch namespace name
+    # @param metric_name Cloudwatch metric name
+    # @param dimension Cloudwatch dimension filter
+    # @return Cloudwatch client list_metrics response
+    def get_metrics(namespace, metric_name, dimension)
+      filter = filter_for_cloudwatch_metric(namespace, metric_name)
+      filter.update(dimension)
+
+      response = cloud_watch_client.list_metrics(filter)
+
+      until response.next_token.nil?
+        next_token = { next_token: response.next_token }
+        filter.update(next_token)
+        response = cloud_watch_client.list_metrics(filter)
+      end
+
+      response
+    end
+  end
+end

data/lib/ruby_aem_aws/client/dynamo_db.rb

@@ -0,0 +1,36 @@
+# 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 interaction with AWS DynamoDB
+  module DynamoDB
+    # @param filter Filter to scan for
+    # @return scanned attribute
+    def scan(filter)
+      # We need to give AWS time to update the DynamoDB
+      # consistent_read seems not to work everytime
+      sleep 5
+      dynamodb_client.scan(filter)
+    end
+
+    # @param filter Filter to query for
+    # @return queried attribute
+    def query(filter)
+      # We need to give AWS time to update the DynamoDB
+      # consistent_read seems not to work everytime
+      sleep 5
+      dynamodb_client.query(filter)
+    end
+  end
+end

data/lib/ruby_aem_aws/client/s3.rb

@@ -0,0 +1,42 @@
+# 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 interaction with AWS S3
+  module S3Access
+    # @param bucket AWS S3 bucket name
+    # @return AWS S3 resource bucket connection
+    def get_s3_bucket(bucket)
+      s3_resource.bucket(bucket)
+    end
+
+    # @param bucket AWS S3 bucket name
+    # @param s3_object_name AWS S3 object name
+    # @return S3 object
+    def get_s3_bucket_object(bucket, s3_object_name)
+      bucket = get_s3_bucket(bucket)
+      bucket.object(s3_object_name)
+    end
+
+    # @param bucket AWS S3 bucket name
+    # @param s3_object_name AWS S3 object name
+    # @param dest_path Download destionation path
+    # @return S3 object
+    def get_s3_object(bucket, s3_object_name, dest_path)
+      options = { bucket: bucket, key: s3_object_name }
+      options = options.merge(response_target: dest_path) unless dest_path.nil?
+      s3_client.get_object(options)
+    end
+  end
+end

data/lib/ruby_aem_aws/client/sns_topic.rb

@@ -0,0 +1,30 @@
+# 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 interaction with AWS SNS
+  module SNSTopic
+    # @param topicarn the ARN of the SNS Topix to publish the message
+    # @param message the SNS Message to publish
+    # @return Message ID
+    def publish(topicarn, message)
+      client = Aws::SNS::Topic.new(topicarn)
+      sns_message = { subject: 'Publish',
+                      message: message,
+                      message_structure: 'json' }
+      publish = client.publish(sns_message)
+      publish.message_id
+    end
+  end
+end

data/lib/ruby_aem_aws/component/author.rb

@@ -0,0 +1,71 @@
+# 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 'author_primary'
+require_relative 'author_standby'
+
+module RubyAemAws
+  module Component
+    # Interface to the AWS instances running the Author components of a full-set AEM stack.
+    class Author
+      attr_reader :author_primary, :author_standby
+
+      ELB_ID = 'AuthorLoadBalancer'.freeze
+      ELB_NAME = 'AEM Author Load Balancer'.freeze
+
+      # @param stack_prefix AWS tag: StackPrefix
+      # @param params Array of AWS Clients and Resource connections:
+      # - CloudWatchClient: AWS Cloudwatch Client.
+      # - CloudWatchLogsClient: AWS Cloudwatch Logs Client.
+      # - Ec2Resource: AWS EC2 Resource connection.
+      # - ElbClient: AWS ElasticLoadBalancer Client.
+      # @return new RubyAemAws::FullSet::Author
+      def initialize(stack_prefix, params)
+        author_aws_clients = {
+          CloudWatchClient: params[:CloudWatchClient],
+          CloudWatchLogsClient: params[:CloudWatchLogsClient],
+          Ec2Resource: params[:Ec2Resource]
+        }
+
+        @author_primary = Component::AuthorPrimary.new(stack_prefix, author_aws_clients)
+        @author_standby = Component::AuthorStandby.new(stack_prefix, author_aws_clients)
+        @ec2_resource = params[:Ec2Resource]
+        @elb_client = params[:ElbClient]
+      end
+
+      # @return true, if all author instances are healthy
+      def healthy?
+        instance = 0
+        instance += 1 if author_primary.healthy?
+        instance += 1 if author_standby.healthy?
+        return true unless instance < 2
+      end
+
+      # @return true, if all author instances are healthy
+      def wait_until_healthy
+        instance = 0
+        instance += 1 if author_primary.wait_until_healthy.eql? true
+        instance += 1 if author_standby.wait_until_healthy.eql? true
+        return true unless instance < 2
+      end
+
+      def get_tags
+        tags = []
+        tags.push(author_primary.get_tags)
+        tags.push(author_standby.get_tags)
+        tags
+      end
+    end
+  end
+end

data/lib/ruby_aem_aws/component/author_dispatcher.rb

@@ -0,0 +1,84 @@
+# 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/grouped_component'
+require_relative '../abstract/snapshot'
+require_relative '../constants'
+require_relative '../mixins/healthy_resource_verifier'
+require_relative '../mixins/metric_verifier'
+require_relative 'component_descriptor'
+require_relative '../mixins/snapshot_verifier'
+
+module RubyAemAws
+  module Component
+    # Interface to the AWS instances playing and supporting the AuthorDispatcher role in a full-set AEM stack.
+    class AuthorDispatcher
+      attr_reader :descriptor, :ec2_resource, :asg_client, :elb_client, :cloud_watch_client, :cloud_watch_log_client
+      include AbstractGroupedComponent
+      include AbstractSnapshot
+      include HealthyResourceVerifier
+      include MetricVerifier
+      include SnapshotVerifier
+
+      EC2_COMPONENT = 'author-dispatcher'.freeze
+      EC2_NAME = 'AEM Author Dispatcher'.freeze
+      ELB_ID = 'AuthorDispatcherLoadBalancer'.freeze
+      ELB_NAME = 'AEM Author Dispatcher Load Balancer'.freeze
+
+      # @param stack_prefix AWS tag: StackPrefix
+      # @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::AuthorDispatcher
+      def initialize(stack_prefix, params)
+        @descriptor = ComponentDescriptor.new(stack_prefix,
+                                              EC2Descriptor.new(EC2_COMPONENT, EC2_NAME),
+                                              ELBDescriptor.new(ELB_ID, ELB_NAME))
+        @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
+        get_all_instances.each do |i|
+          next if i.nil? || i.state.code != Constants::INSTANCE_STATE_CODE_RUNNING
+
+          i.terminate
+          i.wait_until_terminated
+        end
+      end
+
+      def terminate_random_instance
+        instance = get_random_instance
+        instance.terminate
+        instance.wait_until_terminated
+      end
+
+      def get_tags
+        tags = []
+        get_all_instances.each do |i|
+          next if i.nil? || i.state.code != Constants::INSTANCE_STATE_CODE_RUNNING
+
+          tags.push(i.tags)
+        end
+        tags
+      end
+    end
+  end
+end

data/lib/ruby_aem_aws/component/author_primary.rb

@@ -0,0 +1,62 @@
+# 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/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-Primary component of a full-set AEM stack.
+    class AuthorPrimary
+      attr_reader :descriptor, :ec2_resource, :cloud_watch_client, :cloud_watch_log_client
+      include AbstractSingleComponent
+      include AbstractSnapshot
+      include HealthyStateVerifier
+      include MetricVerifier
+      include SnapshotVerifier
+
+      EC2_COMPONENT = 'author-primary'.freeze
+      EC2_NAME = 'AEM Author - Primary'.freeze
+
+      # @param stack_prefix AWS tag: StackPrefix
+      # @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::AuthorPrimary
+      def initialize(stack_prefix, params)
+        @descriptor = ComponentDescriptor.new(stack_prefix,
+                                              EC2Descriptor.new(EC2_COMPONENT, EC2_NAME))
+        @cloud_watch_client = params[:CloudWatchClient]
+        @cloud_watch_log_client = params[:CloudWatchLogsClient]
+        @ec2_resource = params[:Ec2Resource]
+      end
+
+      # @return Aws::EC2::Instance
+      def terminate
+        instance = get_instance
+        instance.terminate
+        instance.wait_until_terminated
+      end
+
+      def get_tags
+        instance = get_instance
+        instance.tags
+      end
+    end
+  end
+end