ruby_aem_aws_odysseas 1.4.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 811c1de4310ee1713969ee696793020c0e0335777955e3d33bae9b7fd54f25f6
+  data.tar.gz: 1e9af69fa99888518e99d20070bf329afce67ce66b0297d2940cab40963b1fc8
+SHA512:
+  metadata.gz: 8fb3af26a7120360e15f52333bfa262125dda53a7bcd2138e749db8ba0d08110a21b9809b16ccf686e9c03dfa9ee2ff76f7e22dbf23bce53fa8cb3cf77e8826c
+  data.tar.gz: 770ea313144cb4a493c2212d1bf0bfd25c378db81b3635beec6e1cfe8591183217cdb15e49eda375b529ad73db1396aee7c4036da32c3dd82166994c5ccfb87c

data/conf/gem.yaml

@@ -0,0 +1 @@
+version: 1.4.2

data/lib/ruby_aem_aws/abstract/cloudwatch.rb

@@ -0,0 +1,83 @@
+# 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 '../error'
+
+module RubyAemAws
+  # Add common methods to all Components.
+  module AbstractCloudwatch
+    private
+
+    # @param alarm_name Cloudwatch alarm name
+    # @return Array of a Cloudwatch alarm filter to filter for a specific Cloudwatch alarm
+    def filter_for_cloudwatch_alarm(alarm_name)
+      {
+        alarm_names: [alarm_name]
+      }
+    end
+
+    # @param loggroup_name Cloudwatch loggroup name
+    # @param log_stream_name Cloudwatch logstream name
+    # @param log_message log message to filter for
+    # @return Array of a Cloudwatch log event filter to filter for a specific Cloudwatch log event
+    def filter_for_cloudwatch_log_event(loggroup_name, log_stream_name, log_message)
+      {
+        log_group_name: loggroup_name,
+        log_stream_names: [log_stream_name],
+        filter_pattern: log_message
+      }
+    end
+
+    # @param loggroup_name Cloudwatch loggroup name
+    # @param log_stream_name Cloudwatch logstream name
+    # @return Array of a Cloudwatch log stream filter to filter for a specific Cloudwatch log stream
+    def filter_for_cloudwatch_log_stream(log_group_name, log_stream_name)
+      {
+        log_group_name: log_group_name,
+        log_stream_name_prefix: log_stream_name,
+        order_by: 'LogStreamName'
+      }
+    end
+
+    # @param namespace Cloudwatch metric namespace
+    # @param metric_name Cloudwatch metric name
+    # @return Array of a Cloudwatch metric filter to filter for a specific Cloudwatch metric
+    def filter_for_cloudwatch_metric(namespace, metric_name)
+      {
+        namespace: namespace,
+        metric_name: metric_name
+      }
+    end
+
+    # @param dimension_values Cloudwatch Dimension value
+    # @return Array of a Cloudwatch dimension filter for the Cloudwatch metric filter
+    def dimensions_filter_for_cloudwatch_metric(dimension_values)
+      {
+        dimensions: [
+          dimension_values
+        ]
+      }
+    end
+
+    # @param dimensions_name Cloudwatch Dimension name
+    # @param dimension_values Cloudwatch Dimension value
+    # @return Array of a Cloudwatch Dimension value filter for the Cloudwatch dimension filter
+    def dimensions_value_filter_for_cloudwatch_metric(dimensions_name, dimensions_value)
+      {
+        name: dimensions_name,
+        value: dimensions_value
+      }
+    end
+  end
+end

data/lib/ruby_aem_aws/abstract/component.rb

@@ -0,0 +1,54 @@
+# 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/component_descriptor'
+require_relative '../mixins/instance_describer'
+require_relative '../error'
+
+module RubyAemAws
+  # Add common methods to all Components.
+  module AbstractComponent
+    include Component
+    include InstanceDescriber
+
+    def to_s
+      "#{self.class.name.split('::').last}(#{@descriptor&.stack_prefix})"
+    end
+
+    private
+
+    def filter_for_descriptor
+      {
+        filters: [
+          { name: 'tag:StackPrefix', values: [@descriptor.stack_prefix] },
+          { name: 'tag:Component', values: [@descriptor.ec2.component] },
+          { name: 'tag:Name', values: [@descriptor.ec2.name] },
+          { name: 'instance-state-name', values: ['running'] }
+        ]
+      }
+    end
+
+    # @param snapshot_type SnapshotType tag
+    # @return Array of a EC2 filter to filter for a specific Snapshottype
+    def filter_for_snapshot(snapshot_type)
+      {
+        filters: [
+          { name: 'tag:StackPrefix', values: [@descriptor.stack_prefix] },
+          { name: 'tag:SnapshotType', values: [snapshot_type] },
+          { name: 'tag:Component', values: [@descriptor.ec2.component] }
+        ]
+      }
+    end
+  end
+end

data/lib/ruby_aem_aws/abstract/grouped_component.rb

@@ -0,0 +1,39 @@
+# 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 'aws-sdk'
+require_relative 'component'
+
+module RubyAemAws
+  # Add common methods to all Components.
+  module AbstractGroupedComponent
+    include AbstractComponent
+
+    def get_all_instances
+      ec2_resource.instances(filter_for_descriptor)
+    end
+
+    def get_instance_by_id(instance_id)
+      ec2_resource.instance(instance_id)
+    end
+
+    def get_num_of_instances
+      get_all_instances.entries.length
+    end
+
+    def get_random_instance
+      get_all_instances.entries.sample
+    end
+  end
+end

data/lib/ruby_aem_aws/abstract/single_component.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.
+
+require 'aws-sdk'
+require_relative 'component'
+
+module RubyAemAws
+  # Add common methods to all Components.
+  module AbstractSingleComponent
+    include AbstractComponent
+
+    def get_instance
+      instances = ec2_resource.instances(filter_for_descriptor).select { |instance| InstanceState::ALL_ACTIVE.include?(instance.state.name) }
+      count = instances.count
+      raise RubyAemAws::ExpectedSingleInstanceError if count > 1
+      return nil if count.zero?
+
+      instances.first
+    end
+
+    def get_all_instances
+      [get_instance]
+    end
+  end
+end

data/lib/ruby_aem_aws/abstract/snapshot.rb

@@ -0,0 +1,35 @@
+# 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 'aws-sdk'
+require_relative 'component'
+
+module RubyAemAws
+  # Add method to scan for snapshots
+  module AbstractSnapshot
+    include AbstractComponent
+
+    # @param snapshot_id Type of snapsthot to look for
+    # @return Class Aws::EC2::Snapshot
+    def get_snapshot_by_id(snapshot_id)
+      ec2_resource.snapshot(snapshot_id).data
+    end
+
+    # @param snapshot_type Type of snapsthot to look for
+    # @return EC2 Resource snapshots collection
+    def get_snapshots_by_type(snapshot_type)
+      ec2_resource.snapshots(filter_for_snapshot(snapshot_type))
+    end
+  end
+end

data/lib/ruby_aem_aws/abstract/stackmanager.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
+  # Add common methods to StackManager resource
+  module AbstractStackManager
+    private
+
+    # @param dynamodb_tablename AWS DynamoDB table name
+    # @param attribute_value value to scan for
+    # @return Array of a DynamoDB filter to scan for a specific value
+    def filter_for_db_scan(dynamodb_tablename, attribute_value)
+      {
+        table_name: dynamodb_tablename,
+        attributes_to_get: ['command_id'],
+        scan_filter: {
+          'message_id' => {
+            attribute_value_list: [attribute_value],
+            comparison_operator: 'EQ'
+          }
+        },
+        consistent_read: true
+      }
+    end
+
+    # @param dynamodb_tablename AWS DynamoDB table name
+    # @param attkey_attribute_valueribute_value Key value to query for
+    # @return Array of a DynamoDB filter to query for a specific value
+    def filter_for_db_query(dynamodb_tablename, key_attribute_value)
+      {
+        table_name: dynamodb_tablename,
+        consistent_read: true,
+        attributes_to_get: ['state'],
+        key_conditions: {
+          'command_id' => {
+            attribute_value_list: [key_attribute_value],
+            comparison_operator: 'EQ'
+          }
+        },
+        query_filter: {
+          'state' => {
+            attribute_value_list: ['Pending'],
+            comparison_operator: 'NE'
+          }
+        }
+      }
+    end
+
+    # @param task Stack Manager task to trigger
+    # @param stack_prefix Target Stack Prefix name
+    # @param details SNS Message payload
+    # @return Array of a AWS SNS publish filter to query for a specific value
+    def message_for_sns_publish(task, stack_prefix, details)
+      "{ \"default\": \"{ 'task': '#{task}', 'stack_prefix': '#{stack_prefix}', 'details': #{details} }\"}"
+    end
+  end
+end

data/lib/ruby_aem_aws/architecture/consolidated_stack.rb

@@ -0,0 +1,49 @@
+# 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/author_publish_dispatcher'
+
+module RubyAemAws
+  # Factory for the consolidated AEM stack component interface.
+  class ConsolidatedStack
+    attr_reader :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.
+    # - Ec2Resource: AWS EC2 Resource connection.
+    # @return new RubyAemAws::ConsolidatedStack instance
+    def initialize(stack_prefix, params)
+      @consolidated_aws_clients = {
+        CloudWatchClient: params[:CloudWatchClient],
+        CloudWatchLogsClient: params[:CloudWatchLogsClient],
+        Ec2Resource: params[:Ec2Resource]
+      }
+      @cloudformation_client = cloudformation_client
+      @stack_prefix = stack_prefix
+    end
+
+    # @param stack_prefix AWS tag: StackPrefix
+    # @param consolidated_aws_clients Array of AWS Clients and Resource connections:
+    # - CloudWatchClient: AWS Cloudwatch Client.
+    # - CloudWatchLogsClient: AWS Cloudwatch Logs Client.
+    # - Ec2Resource: AWS EC2 Resource connection.
+    # @return new RubyAemAws::Component::AuthorPublishDispatcher instance
+    def author_publish_dispatcher
+      RubyAemAws::Component::AuthorPublishDispatcher.new(@stack_prefix, @consolidated_aws_clients)
+    end
+  end
+end

data/lib/ruby_aem_aws/architecture/full_set_stack.rb

@@ -0,0 +1,141 @@
+# 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/author_dispatcher'
+require_relative '../component/author'
+require_relative '../component/chaos_monkey'
+require_relative '../component/orchestrator'
+require_relative '../component/publish_dispatcher'
+require_relative '../component/publish'
+require_relative '../mixins/metric_verifier'
+
+module RubyAemAws
+  # Factory for the full-set AEM stack component interfaces.
+  class FullSetStack
+    attr_reader :cloudformation_client, :cloud_watch_client
+    include MetricVerifier
+
+    # @param stack_prefix AWS tag: StackPrefix
+    # @param params 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 initialize(stack_prefix, params)
+      @author_aws_clients = {
+        CloudWatchClient: params[:CloudWatchClient],
+        CloudWatchLogsClient: params[:CloudWatchLogsClient],
+        Ec2Resource: params[:Ec2Resource],
+        ElbClient: params[:ElbClient]
+      }
+
+      @dispatcher_aws_clients = {
+        AutoScalingClient: params[:AutoScalingClient],
+        CloudWatchClient: params[:CloudWatchClient],
+        CloudWatchLogsClient: params[:CloudWatchLogsClient],
+        Ec2Resource: params[:Ec2Resource],
+        ElbClient: params[:ElbClient]
+      }
+
+      @publish_aws_clients = {
+        AutoScalingClient: params[:AutoScalingClient],
+        CloudWatchClient: params[:CloudWatchClient],
+        CloudWatchLogsClient: params[:CloudWatchLogsClient],
+        Ec2Resource: params[:Ec2Resource]
+      }
+
+      @aem_java_aws_clients = {
+        AutoScalingClient: params[:AutoScalingClient],
+        CloudWatchClient: params[:CloudWatchClient],
+        CloudWatchLogsClient: params[:CloudWatchLogsClient],
+        Ec2Resource: params[:Ec2Resource]
+      }
+
+      @cloudformation_client = params[:CloudFormationClient]
+      @cloud_watch_client = params[:CloudWatchClient]
+      @stack_prefix = stack_prefix
+    end
+
+    # @param stack_prefix AWS tag: StackPrefix
+    # @param dispatcher_aws_clients 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::Component::AuthorDispatcher instance
+    def author_dispatcher
+      RubyAemAws::Component::AuthorDispatcher.new(@stack_prefix, @dispatcher_aws_clients)
+    end
+
+    # @param stack_prefix AWS tag: StackPrefix
+    # @param author_aws_clients 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::Component::Author instance
+    def author
+      RubyAemAws::Component::Author.new(@stack_prefix, @author_aws_clients)
+    end
+
+    # @param stack_prefix AWS tag: StackPrefix
+    # @param chaos_monkey_aws_clients 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::Component::ChaosMonkey instance
+    def chaos_monkey
+      RubyAemAws::Component::ChaosMonkey.new(@stack_prefix, @aem_java_aws_clients)
+    end
+
+    # @param stack_prefix AWS tag: StackPrefix
+    # @param orchestrator_aws_clients 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::Component::Orchestrator instance
+    def orchestrator
+      RubyAemAws::Component::Orchestrator.new(@stack_prefix, @aem_java_aws_clients)
+    end
+
+    # @param stack_prefix AWS tag: StackPrefix
+    # @param publish_aws_clients 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::Component::Publish instance
+    def publish
+      RubyAemAws::Component::Publish.new(@stack_prefix, @publish_aws_clients)
+    end
+
+    # @param stack_prefix AWS tag: StackPrefix
+    # @param dispatcher_aws_clients 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::Component::PublishDispatcher instance
+    def publish_dispatcher
+      RubyAemAws::Component::PublishDispatcher.new(@stack_prefix, @dispatcher_aws_clients)
+    end
+  end
+end