infopark-aws_utils 0.6.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5e4eda7134849d7d411e0fd9163df8c56ac911c6
-  data.tar.gz: c512370d7a63a4ba0cf01657efc72dfccf684030
+SHA256:
+  metadata.gz: d3e7e356a45fa25bf635a55425020ea0b6a05af17731565e996ac52d444eec87
+  data.tar.gz: 138f8b6bf8e7266956756eca4511544d6386eb4e41de0c1887c3fc642910ba88
 SHA512:
-  metadata.gz: 75352c70287394b1f55fa1bb54f6c662d6d5bab945630fc6ef44650062d2f6c52952497a4ec4898b83c126c5104f094a83ce2221436983a2abd934802d9dd483
-  data.tar.gz: 629523227982d924ab0afce3b9495bbcbf5fe3fb95944a7dbe69ab7905649a19f6900ae5af2c4a18b208026d034955d5f1f41db8894fed4b1c6022798ea4ba21
+  metadata.gz: e162493fcf4a2de9eb0a68f1cf5781d40a586f6a12e6d49f379002d65dc4009a7aae5b2a5016489b71fe301e24ad587b0343b79e20846adc267f99976e766a5d
+  data.tar.gz: 8e74fb1c214710bc22201e59e3da2d71fc8a68dd0a6ed7e8afd8c3e1e0310736ed1a5d736ac622169899445fc3cd4e190294d67da6fa40b0a3023da3258996b8

data/.travis.yml

@@ -1,14 +1,7 @@
 language: ruby
 rvm:
-- 2.2
-- 2.3
+- 2.4
+- 2.5
+- 2.6
 script:
 - bundle exec rspec spec
-deploy:
-  provider: rubygems
-  api_key:
-    secure: e4QeU1KKglgUR6y0kWCxGTjjhmC1Txmw4p1PiWt5Sj+dg3eSnr5PO5cCU+YsBo1fVBOhxpcZXwDk0iv8q0s3SqWbask6awXCBh9I7nnstLI5HgoR0ydS6rVsOUX7tWSPHVwHFUBL83iArHkuFRvsCZl2HQr3YecvBAQzXVc7EsPfvu1Rpfjyz3N4wWzpkItge+j5m6uX80dacOpPd9YXOMMd1qMzAB3VbySN8KUXszJL3YgMV/MAaEc4djj+s3GiPCnVjTPVdIb5ZVl0HH+LtkXfgVgxHMyDhwPflBmgg/lnYQG51DcrlHn8mNsJOO0crgqc/B6xqjAalaRLf6iBDqSdx08TulgwQeBlhuq+YWBsV7ZL39NZgZiXLU+NW9ZW9iXy1I7z0PAhHlx1JaCVpNxUlG5fGvPkvOywo368taFJaYvdiTjW+IyaPO5UwcxTlWZlR+vQD/QEc7dsIHXu9/pWxfyycZI/hSnGJwa3lOx+mnU8GZbtufWsIRqnfxM6X0BVWS2BNLlK5drluj+jt0aW8tLSiYRNSY1DuL8U2CM9p3TjeOWvgBPGGzwApBI9/2RRP/E4KtW6ms+YnjT5veXE5rz1z/WmCoyWPdVfchd9J421+QGpq8WNGxnYImug0/mZtkGNkHg0b6nRWuorao/fxWkkDstjK/tk7T0iTug=
-  gem: cloudscopes
-  on:
-    tags: true
-    repo: infopark/aws_utils

data/lib/infopark/aws_utils.rb

@@ -6,24 +6,29 @@ module Infopark
     AWS_AMI_OWNER = "137112412989"
 
     class << self
-      def gather_all(client, method, **options)
-        @gather_cache ||= {}
-        cache_key = [client, method, options]
-        return @gather_cache[cache_key] if @gather_cache[cache_key]
+      def gather_all(client:, method:, response_key:, **options)
+        unless block_given?
+          @gather_cache ||= {}
+          cache_key = [client, method, options]
+          return @gather_cache[cache_key] if @gather_cache[cache_key]
+        end
 
         result = []
         loop do
-          response = client.send(method, **options)
-          key = (response.members - [:next_token, :failures]).first
+          response = retry_on_throttle { client.send(method, **options) }
           if response.members.include?(:failures) && !response.failures.empty?
             raise "Failed gathering all #{method}: #{response.failures}"
           end
-          result += response[key]
+          if block_given?
+            response[response_key].each {|entity| retry_on_throttle { yield entity } }
+          else
+            result += response[response_key]
+          end
           unless options[:next_token] = response.members.include?(:next_token) && response.next_token
             break
           end
         end
-        @gather_cache[cache_key] = result
+        @gather_cache[cache_key] = result unless block_given?
       end
 
       def wait_for(progress, client, waiter, delay: 2, max_attempts: 60, **waiter_params)
@@ -46,6 +51,18 @@ module Infopark
           end
         )
       end
+
+      private
+
+      def retry_on_throttle
+        yield
+      rescue => e
+        if e.class.name =~ /Throttl/
+          sleep 0.1
+          retry
+        end
+        raise
+      end
     end
 
     DEV_ACCOUNT_ID = ENV['INFOPARK_AWS_DEV_ACCOUNT_ID'] || self.local_config['dev_account_id']

data/lib/infopark/aws_utils/env.rb

@@ -26,8 +26,22 @@ class Env
 
   def initialize(profile_name = nil)
     @credentials = Aws::SharedCredentials.new(profile_name: profile_name)
+    if @credentials.credentials.nil?
+      raise "No credentials for AWS profile “#{profile_name}” found."\
+          " Please provide them via ~/.aws/credentials."
+    end
+
+    region = Aws.shared_config.region(profile: profile_name)
+    if region.nil?
+      raise "No region for AWS profile “#{profile_name}” found."\
+          " Please provide them via ~/.aws/config."
+    end
+
     @clients = Hash.new do |clients, mod|
-      clients[mod] = mod.const_get(:Client).new(credentials: @credentials, region: 'eu-west-1')
+      clients[mod] = mod.const_get(:Client).new(
+        credentials: @credentials,
+        region: region,
+      )
     end
   end
 
@@ -96,31 +110,45 @@ class Env
         else
           raise "invalid root_device_type: #{root_device_type}"
         end
-    available_images = AwsUtils.gather_all(ec2, :describe_images,
-        owners: [AWS_AMI_OWNER],
-        filters: [
-          {name: "root-device-type", values: root_device_filter_value},
-          {name: "ena-support", values: ["true"]},
-          {name: "image-type", values: ["machine"]},
-          {name: "virtualization-type", values: ["hvm"]},
-        ])
-        .reject {|image| image.name.include?(".rc-") }
-        .reject {|image| image.name.include?("-minimal-") }
-        .reject {|image| image.name.include?("-test") }
-        .reject {|image| image.name.include?("amzn-ami-vpc-nat-") }
-    (reject_image_name_patterns || []) do |pattern|
+    available_images = AwsUtils.gather_all(
+      client: ec2,
+      method: :describe_images,
+      response_key: :image_details,
+      owners: [AWS_AMI_OWNER],
+      filters: [
+        {name: "root-device-type", values: root_device_filter_value},
+        {name: "ena-support", values: ["true"]},
+        {name: "image-type", values: ["machine"]},
+        {name: "virtualization-type", values: ["hvm"]},
+      ],
+    )
+      .reject {|image| image.name.include?(".rc-") }
+      .reject {|image| image.name.include?("-minimal-") }
+      .reject {|image| image.name.include?("-test") }
+      .reject {|image| image.name.include?("amzn-ami-vpc-nat-") }
+    (reject_image_name_patterns || []).each do |pattern|
       available_images.reject! {|image| image.name =~ pattern }
     end
     available_images.sort_by(&:creation_date).last
   end
 
   def find_image_by_id(id)
-    AwsUtils.gather_all(ec2, :describe_images, image_ids: [id]).first
+    AwsUtils.gather_all(
+      client: ec2,
+      method: :describe_images,
+      response_key: :image_details,
+      image_ids: [id],
+    ).first
   end
 
   def find_image_by_name(name)
-    AwsUtils.gather_all(ec2, :describe_images, owners: [DEV_ACCOUNT_ID],
-        filters: [{name: "name", values: [name]}]).first
+    AwsUtils.gather_all(
+      client: ec2,
+      method: :describe_images,
+      response_key: :image_details,
+      owners: [DEV_ACCOUNT_ID],
+      filters: [{name: "name", values: [name]}],
+    ).first
   end
 
   private

data/lib/infopark/aws_utils/version.rb

@@ -1,5 +1,5 @@
 module Infopark
   module AwsUtils
-    VERSION = "0.6.0"
+    VERSION = "1.0.0"
   end
 end

data/spec/env_spec.rb

@@ -1,7 +1,7 @@
 RSpec.describe Infopark::AwsUtils::Env do
   let(:account_id) { nil }
   let(:sts) do
-    Aws::STS::Client.new.tap do |client|
+    Aws::STS::Client.new(region: "eu-west-1").tap do |client|
       allow(client).to receive(:get_caller_identity)
           .and_return(double(:caller_identity, account: account_id))
     end
@@ -18,8 +18,16 @@ RSpec.describe Infopark::AwsUtils::Env do
     subject { Infopark::AwsUtils::Env.profile(requested_profile) }
 
     before do
-      allow(Aws::SharedCredentials).to receive(:new).with(profile_name: requested_profile).
-          and_return(instance_double(Aws::SharedCredentials, profile_name: requested_profile))
+      allow(Aws::SharedCredentials).to receive(:new).with(profile_name: requested_profile)
+        .and_return(
+          instance_double(
+            Aws::SharedCredentials,
+            profile_name: requested_profile,
+            credentials: instance_double(Aws::Credentials),
+          ),
+        )
+      allow(Aws.shared_config).to receive(:region).with(profile: requested_profile)
+        .and_return("eu-west-1")
     end
 
     it { is_expected.to be_a(Infopark::AwsUtils::Env) }
@@ -42,14 +50,55 @@ RSpec.describe Infopark::AwsUtils::Env do
       end
     end
 
+    context "when requested profile has no credentials configured" do
+      before do
+        allow(Aws::SharedCredentials).to receive(:new).with(profile_name: requested_profile)
+          .and_return(
+            instance_double(
+              Aws::SharedCredentials,
+              profile_name: requested_profile,
+              credentials: nil,
+            ),
+          )
+      end
+
+      it "raises an error, asking for the credentials to be configured" do
+        expect {
+          subject
+        }.to raise_error("No credentials for AWS profile “#{requested_profile}” found."\
+                         " Please provide them via ~/.aws/credentials.")
+      end
+    end
+
+    context "when requested profile has no region configured" do
+      before do
+        allow(Aws.shared_config).to receive(:region).with(profile: requested_profile)
+          .and_return(nil)
+      end
+
+      it "raises an error, asking for the region to be configured" do
+        expect {
+          subject
+        }.to raise_error("No region for AWS profile “#{requested_profile}” found."\
+                         " Please provide them via ~/.aws/config.")
+      end
+    end
+
     context "when environment variable is set" do
       let(:value) { "#{requested_profile}_by_env" }
 
       before do
         allow(ENV).to receive(:[]).and_call_original
         allow(ENV).to receive(:[]).with(env_var).and_return(value)
-        allow(Aws::SharedCredentials).to receive(:new).with(profile_name: value).
-            and_return(instance_double(Aws::SharedCredentials, profile_name: value))
+        allow(Aws::SharedCredentials).to receive(:new).with(profile_name: value).and_return(
+          instance_double(
+            Aws::SharedCredentials,
+            profile_name: value,
+            credentials: instance_double(Aws::Credentials),
+          ),
+        )
+        allow(Aws.shared_config).to receive(:region).with(profile: value)
+          .and_return("eu-west-1")
       end
 
       it "uses credentials for this profile" do
@@ -73,6 +122,17 @@ RSpec.describe Infopark::AwsUtils::Env do
   end
 
   describe "#account_type" do
+    before do
+      allow(Aws::SharedCredentials).to receive(:new).and_return(
+        instance_double(
+          Aws::SharedCredentials,
+          profile_name: "foo",
+          credentials: instance_double(Aws::Credentials),
+        ),
+      )
+      allow(Aws.shared_config).to receive(:region).and_return("eu-west-1")
+    end
+
     subject(:account_type) { env.account_type }
 
     context "for profile in development account" do
@@ -99,6 +159,17 @@ RSpec.describe Infopark::AwsUtils::Env do
   end
 
   describe "#dev_account?" do
+    before do
+      allow(Aws::SharedCredentials).to receive(:new).and_return(
+        instance_double(
+          Aws::SharedCredentials,
+          profile_name: "foo",
+          credentials: instance_double(Aws::Credentials),
+        ),
+      )
+      allow(Aws.shared_config).to receive(:region).and_return("eu-west-1")
+    end
+
     subject { env.dev_account? }
 
     context "for development account" do
@@ -121,6 +192,17 @@ RSpec.describe Infopark::AwsUtils::Env do
   end
 
   describe "#prod_account?" do
+    before do
+      allow(Aws::SharedCredentials).to receive(:new).and_return(
+        instance_double(
+          Aws::SharedCredentials,
+          profile_name: "foo",
+          credentials: instance_double(Aws::Credentials),
+        ),
+      )
+      allow(Aws.shared_config).to receive(:region).and_return("eu-west-1")
+    end
+
     subject { env.prod_account? }
 
     context "for development account" do
@@ -154,6 +236,17 @@ RSpec.describe Infopark::AwsUtils::Env do
     [:sts, Aws::STS],
   ].each do |_client, _mod|
     describe "##{_client}" do
+      before do
+        allow(Aws::SharedCredentials).to receive(:new).and_return(
+          instance_double(
+            Aws::SharedCredentials,
+            profile_name: "foo",
+            credentials: instance_double(Aws::Credentials),
+          ),
+        )
+        allow(Aws.shared_config).to receive(:region).and_return("eu-west-1")
+      end
+
       subject(:client) { env.send(_client) }
 
       it { is_expected.to be_a(_mod.const_get("Client")) }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: infopark-aws_utils
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Tilo Prütz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-11 00:00:00.000000000 Z
+date: 2020-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-applicationautoscaling
@@ -200,8 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A utility lib to ease the use of the AWS SDK