cthiesfork-awspec 1.0.0

data/lib/awspec/helper/finder/redshift.rb

@@ -0,0 +1,37 @@
+module Awspec::Helper
+  module Finder
+    module Redshift
+      def find_redshift_cluster_identifier(id)
+        res = redshift_client.describe_clusters(cluster_identifier: id)
+        res.clusters.single_resource(id)
+      rescue
+        nil
+      end
+
+      def select_redshift_by_vpc_id(vpc_id)
+        res = redshift_client.describe_clusters
+        res.clusters.select do |clusters|
+          clusters.vpc_id == vpc_id
+        end
+      end
+
+      def select_all_redshift_cluster_parameters(parameter_group)
+        parameters = {}
+        res = redshift_client.describe_cluster_parameters({
+                                                            parameter_group_name: parameter_group
+                                                          })
+        loop do
+          res.parameters.each do |param|
+            parameters[param.parameter_name] = param.parameter_value
+          end
+          break if res.marker.nil?
+          res = redshift_client.describe_cluster_parameters({
+                                                              parameter_group_name: parameter_group,
+                                                              marker: res.marker
+                                                            })
+        end
+        parameters
+      end
+    end
+  end
+end

data/lib/awspec/helper/finder/route53.rb

@@ -0,0 +1,41 @@
+module Awspec::Helper
+  module Finder
+    module Route53
+      def find_hosted_zone(id)
+        res = route53_client.list_hosted_zones
+        selected = []
+        loop do
+          res.hosted_zones.each do |hosted_zone|
+            if hosted_zone[:name] == id || hosted_zone[:id] == '/hostedzone/' + id || hosted_zone[:id] == id
+              selected.push(hosted_zone)
+            end
+          end
+
+          break unless res.is_truncated
+          res = route53_client.list_hosted_zones({
+                                                   marker: res.next_marker
+                                                 })
+        end
+        selected.single_resource(id)
+      end
+
+      def select_record_sets_by_hosted_zone_id(id)
+        selected = []
+        res = route53_client.list_resource_record_sets({
+                                                         hosted_zone_id: id
+                                                       })
+        loop do
+          selected += res.resource_record_sets
+          break unless res.is_truncated
+
+          res = route53_client.list_resource_record_sets({
+                                                           hosted_zone_id: id,
+                                                           start_record_name: res.next_record_name,
+                                                           start_record_type: res.next_record_type
+                                                         })
+        end
+        selected
+      end
+    end
+  end
+end

data/lib/awspec/helper/finder/s3.rb

@@ -0,0 +1,80 @@
+module Awspec::Helper
+  module Finder
+    module S3
+      def find_bucket(id)
+        s3_client.list_buckets[:buckets].find do |bucket|
+          bucket.name == id
+        end
+      end
+
+      def find_bucket_acl(id)
+        s3_client.get_bucket_acl(bucket: id)
+      rescue Aws::S3::Errors::ServiceError
+        nil
+      end
+
+      def head_object(id, key)
+        res = s3_client.head_object({
+                                      bucket: id,
+                                      key: key.sub(%r(\A/), '')
+                                    })
+        res.data.class == Aws::S3::Types::HeadObjectOutput
+      rescue Aws::S3::Errors::NotFound
+        false
+      end
+
+      def find_bucket_cors(id)
+        s3_client.get_bucket_cors(bucket: id)
+      rescue Aws::S3::Errors::ServiceError
+        nil
+      end
+
+      def find_bucket_policy(id)
+        s3_client.get_bucket_policy(bucket: id)
+      rescue Aws::S3::Errors::ServiceError
+        nil
+      end
+
+      def find_bucket_logging(id)
+        s3_client.get_bucket_logging(bucket: id)
+      rescue Aws::S3::Errors::ServiceError
+        nil
+      end
+
+      def find_bucket_tag(id, tag_key)
+        tag = nil
+        begin
+          bucket_tagging = s3_client.get_bucket_tagging(bucket: id)
+          tag_set = bucket_tagging.tag_set
+          tag = tag_set.find { |tag_obj| tag_obj.key == tag_key }
+        rescue Aws::S3::Errors::ServiceError
+          nil
+        end
+        return tag if tag
+      end
+
+      def find_bucket_versioning(id)
+        s3_client.get_bucket_versioning(bucket: id)
+      rescue Aws::S3::Errors::ServiceError
+        nil
+      end
+
+      def find_bucket_lifecycle_configuration(id)
+        s3_client.get_bucket_lifecycle_configuration(bucket: id)
+      rescue Aws::S3::Errors::ServiceError
+        nil
+      end
+
+      def find_bucket_server_side_encryption(id)
+        res = s3_client.get_bucket_encryption(bucket: id)
+        res.server_side_encryption_configuration
+      rescue Aws::S3::Errors::ServiceError
+        nil
+      end
+
+      def select_all_buckets
+        s3_client.list_buckets.buckets
+      end
+    end
+  end
+end

data/lib/awspec/helper/finder/secretsmanager.rb

@@ -0,0 +1,11 @@
+module Awspec::Helper
+  module Finder
+    module Secretsmanager
+      def find_secret(id)
+        secretsmanager_client.describe_secret({
+                                                secret_id: id
+                                              })
+      end
+    end
+  end
+end

data/lib/awspec/helper/finder/security_group.rb

@@ -0,0 +1,35 @@
+module Awspec::Helper
+  module Finder
+    module SecurityGroup
+      def find_security_group(sg_id)
+        resource = select_security_group_by_group_id([sg_id]).single_resource(sg_id)
+        return resource if resource
+
+        resource = select_security_group_by_group_name([sg_id]).single_resource(sg_id)
+        return resource if resource
+
+        select_security_group_by_tag_name([sg_id]).single_resource(sg_id)
+      end
+
+      def select_security_group_by_vpc_id(vpc_id)
+        describe_security_groups({ filters: [{ name: 'vpc-id', values: [vpc_id] }] })
+      end
+
+      def select_security_group_by_group_id(ids)
+        describe_security_groups({ filters: [{ name: 'group-id', values: ids }] })
+      end
+
+      def select_security_group_by_group_name(names)
+        describe_security_groups({ filters: [{ name: 'group-name', values: names }] })
+      end
+
+      def select_security_group_by_tag_name(names)
+        describe_security_groups({ filters: [{ name: 'tag:Name', values: names }] })
+      end
+
+      def describe_security_groups(param)
+        ec2_client.describe_security_groups(param).security_groups
+      end
+    end
+  end
+end

data/lib/awspec/helper/finder/ses.rb

@@ -0,0 +1,13 @@
+module Awspec::Helper
+  module Finder
+    module Ses
+      def find_ses_identity(id)
+        res = ses_client.list_identities
+        ret = res.identities.select do |identity|
+          identity == id
+        end
+        ret.single_resource(id)
+      end
+    end
+  end
+end

data/lib/awspec/helper/finder/sns_topic.rb

@@ -0,0 +1,82 @@
+module Awspec::Helper
+  module Finder
+    module SNSTopic
+      class SnsTopic
+        # to make testing results easier to the eyes instead of using Rspec
+        # include matcher for hashes
+        attr_reader :policy, :owner, :pending_subscriptions, :topic_arn, :effective_delivery_policy,
+                    :display_name, :confirmed_subscriptions, :deleted_subscriptions, :name
+
+        def initialize(attribs)
+          @policy = attribs['Policy']
+          @owner = attribs['Owner']
+          @pending_subscriptions = attribs['SubscriptionsPending'].to_i
+          @topic_arn = attribs['TopicArn']
+          @effective_delivery_policy = attribs['EffectiveDeliveryPolicy']
+          @display_name = attribs['DisplayName']
+          @confirmed_subscriptions = attribs['SubscriptionsConfirmed'].to_i
+          @deleted_subscriptions = attribs['SubscriptionsDeleted'].to_i
+          @name = attribs['TopicArn'].split(':')[-1]
+        end
+
+        def to_s
+          output = ["SnsTopic: #{self.name}"]
+          self.instance_variables.each do |attrib|
+            tmp = attrib.to_s.sub('@', '')
+            output << "  #{tmp} = #{self.send(tmp)}"
+          end
+          output.join("\n")
+        end
+      end
+
+      def find_sns_topic(topic_arn)
+        # Find a SNS topic by searching from it's ARN.
+        # Expects as parameter the SNS topic ARN.
+        # Returns a Awspec::Helper::Finder::SNSTopic::SnsTopic if the topic is
+        # found, nil otherwise.
+        # If the SNS topic does not exist, AWS SDK throws an exception
+        # which is acceptable in some cases, but in others will generate a
+        # NoMethodFound during tests execution.
+        # In order to avoid that and follow a uniform interface, the exception
+        # will be captured and nil will be returned instead.
+        # By convention, the returned object will be checked (see check_existence
+        # method from Awspec::Type::Base class for an example) and an exception
+        # Awspec::NoExistingResource will be raised.
+        begin
+          response = sns_client.get_topic_attributes({ topic_arn: topic_arn })
+          topic = SnsTopic.new(response.attributes)
+        rescue Aws::SNS::Errors::NotFound
+          topic = nil
+        end
+
+        topic
+      end
+
+      def find_sns_topic_subs(topic_arn)
+        # Find a SNS topic subscribers by searching from it's ARN.
+        # Expects as parameter the SNS topic ARN.
+        # Returns a map (with keys as the subscribed ARN and the value instances
+        # of respective objects) if the topic is found, nil otherwise.
+        # If the SNS topic does not exist, AWS SDK throws an exception
+        # which is acceptable in some cases, but in others will generate a
+        # NoMethodFound during tests execution.
+        # In order to avoid that and follow a uniform interface, the exception
+        # will be captured and nil will be returned instead.
+        # By convention, the returned object will be checked (see check_existence
+        # method from Awspec::Type::Base class for an example) and an exception
+        # Awspec::NoExistingResource will be raised.
+        begin
+          response = sns_client.list_subscriptions_by_topic({ topic_arn: topic_arn })
+          subscriptions = {}
+          response.subscriptions.each do |subscribed|
+            subscriptions[subscribed['subscription_arn'].to_sym] = subscribed
+          end
+        rescue Aws::SNS::Errors::NotFound
+          subscriptions = nil
+        end
+
+        subscriptions
+      end
+    end
+  end
+end

data/lib/awspec/helper/finder/sqs.rb

@@ -0,0 +1,17 @@
+module Awspec::Helper
+  module Finder
+    module Sqs
+      def find_queue(queue_name)
+        res = sqs_client.list_queues(queue_name_prefix: queue_name).queue_urls.select do |url|
+          url.split('/').last == queue_name
+        end
+        res.single_resource(queue_name)
+      end
+
+      def find_tags_for_queue(queue_url)
+        res = sqs_client.list_queue_tags({ queue_url: queue_url })
+        res.tags
+      end
+    end
+  end
+end

data/lib/awspec/helper/finder/ssm_parameter.rb

@@ -0,0 +1,32 @@
+module Awspec::Helper
+  module Finder
+    module SsmParameter
+      def find_ssm_parameter(name)
+        ssm_client.describe_parameters(
+          {
+            filters:  [
+              {
+                key: 'Name',
+                values: [name]
+              }
+            ]
+          }).parameters[0]
+      end
+
+      def find_parameter_tag(id, tag_key)
+        tag = nil
+        begin
+          response = ssm_client.list_tags_for_resource(
+            resource_type: 'Parameter',
+            resource_id: id
+          )
+          tag_set = response.tag_list
+          tag = tag_set.find { |tag_obj| tag_obj.key == tag_key }
+        rescue Aws::SSM::Errors::ServiceError
+          nil
+        end
+        return tag if tag
+      end
+    end
+  end
+end

data/lib/awspec/helper/finder/subnet.rb

@@ -0,0 +1,29 @@
+module Awspec::Helper
+  module Finder
+    module Subnet
+      def find_subnet(subnet_id)
+        res = ec2_client.describe_subnets({
+                                            filters: [{ name: 'subnet-id', values: [subnet_id] }]
+                                          })
+        resource = res.subnets.single_resource(subnet_id)
+        return resource if resource
+        res = ec2_client.describe_subnets({
+                                            filters: [{ name: 'tag:Name', values: [subnet_id] }]
+                                          })
+        resource = res.subnets.single_resource(subnet_id)
+        return resource if resource
+        res = ec2_client.describe_subnets({
+                                            filters: [{ name: 'cidrBlock', values: [subnet_id] }]
+                                          })
+        res.subnets.single_resource(subnet_id)
+      end
+
+      def select_subnet_by_vpc_id(vpc_id)
+        res = ec2_client.describe_subnets({
+                                            filters: [{ name: 'vpc-id', values: [vpc_id] }]
+                                          })
+        res.subnets
+      end
+    end
+  end
+end

data/lib/awspec/helper/finder/vpc.rb

@@ -0,0 +1,115 @@
+module Awspec::Helper
+  module Finder
+    module Vpc
+      def find_vpc(id)
+        res = ec2_client.describe_vpcs({
+                                         filters: [{ name: 'vpc-id', values: [id] }]
+                                       })
+        resource = res.vpcs.single_resource(id)
+        return resource if resource
+        res = ec2_client.describe_vpcs({
+                                         filters: [{ name: 'tag:Name', values: [id] }]
+                                       })
+        res.vpcs.single_resource(id)
+      end
+
+      def find_route_table(route_table_id)
+        res = ec2_client.describe_route_tables({
+                                                 filters: [{ name: 'route-table-id', values: [route_table_id] }]
+                                               })
+        resource = res.route_tables.single_resource(route_table_id)
+        return resource if resource
+        res = ec2_client.describe_route_tables({
+                                                 filters: [{ name: 'tag:Name', values: [route_table_id] }]
+                                               })
+        res.route_tables.single_resource(route_table_id)
+      end
+
+      def find_network_acl(id)
+        res = ec2_client.describe_network_acls({
+                                                 filters: [{ name: 'network-acl-id', values: [id] }]
+                                               })
+        resource = res.network_acls.single_resource(id)
+        return resource if resource
+        res = ec2_client.describe_network_acls({
+                                                 filters: [{ name: 'tag:Name', values: [id] }]
+                                               })
+        res.network_acls.single_resource(id)
+      end
+
+      def select_route_table_by_vpc_id(vpc_id)
+        res = ec2_client.describe_route_tables({
+                                                 filters: [{ name: 'vpc-id', values: [vpc_id] }]
+                                               })
+        res.route_tables
+      end
+
+      def select_network_acl_by_vpc_id(vpc_id)
+        res = ec2_client.describe_network_acls({
+                                                 filters: [{ name: 'vpc-id', values: [vpc_id] }]
+                                               })
+        res.network_acls
+      end
+
+      def find_vpc_peering_connection(vpc_peering_connection_id)
+        res = ec2_client.describe_vpc_peering_connections({
+                                                            filters: [
+                                                              {
+                                                                name: 'vpc-peering-connection-id',
+                                                                values: [vpc_peering_connection_id]
+                                                              }
+                                                            ]
+                                                          })
+        resource = res.vpc_peering_connections.single_resource(vpc_peering_connection_id)
+        return resource if resource
+        res = ec2_client.describe_vpc_peering_connections({
+                                                            filters: [
+                                                              {
+                                                                name: 'tag:Name',
+                                                                values: [vpc_peering_connection_id]
+                                                              }
+                                                            ]
+                                                          })
+        res.vpc_peering_connections.single_resource(vpc_peering_connection_id)
+      end
+
+      def select_vpc_peering_connection_by_vpc_id(vpc_id, status_code = nil)
+        params = {}
+        params = { filters: [{ name: 'status-code', values: [status_code] }] } if status_code
+        vpc_peering_connections = ec2_client.describe_vpc_peering_connections(params).map do |res|
+          res.vpc_peering_connections
+        end.flatten
+        vpc_peering_connections.select do |conn|
+          conn.accepter_vpc_info.vpc_id == vpc_id || conn.requester_vpc_info.vpc_id == vpc_id
+        end
+      end
+
+      def find_vpc_attribute(vpc_id, vpc_attribute)
+        res = ec2_client.describe_vpc_attribute({ vpc_id: vpc_id, attribute: vpc_attribute })
+        case vpc_attribute
+        when 'enableDnsSupport' then
+          res.enable_dns_support.value
+        when 'enableDnsHostnames' then
+          res.enable_dns_hostnames.value
+        end
+      end
+
+      def select_vpc_attribute(vpc_id)
+        attributes = {}
+        vpc_attributes = %w(
+          enableDnsHostnames enableDnsSupport
+        )
+        vpc_attributes.each do |vpc_attribute|
+          res = ec2_client.describe_vpc_attribute({ vpc_id: vpc_id, attribute: vpc_attribute })
+          attributes[vpc_attribute] = case vpc_attribute
+                                      when 'enableDnsHostnames' then
+                                        res.enable_dns_hostnames.value
+                                      when 'enableDnsSupport' then
+                                        res.enable_dns_support.value
+                                      end
+        end
+        attributes
+      end
+    end
+  end
+end