MovableInkAWS 2.2.1 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: eb083b13e12b669f0843ea32ea2b8b4280ccce9b5ac6055964d9ca1214d36f60
-  data.tar.gz: 967f30f88ebef0135620f12930075da3bdeb05d4b449c2e5612a267f3197ff73
+  metadata.gz: 46d76e882265a792568c24853fbc6953bcfa54c4677d67b8aaf97d009896cb24
+  data.tar.gz: f02414993d6c9509bd72f5ec246e6bf99fc60c20a036487be9336cb41e780e8f
 SHA512:
-  metadata.gz: 687824a79299c74f15b6c9d1f3fded4663020670ae533619045e2097b99a38782348c3572d51bcb0d130d6b0e4e84b0ee78b778795792ba375b45118a94aaba9
-  data.tar.gz: 85feb71050191506f20429f851fca622597090365fe6817b54091daf539f7c84918466b20ba8566d2c948c1326188f4a33bdc8b3989d2f80e9b82cb6ffeebedf
+  metadata.gz: b987bbb77c3fd5d2c1fc23c84c62e3af00df58074dbbdc9db21fd05fc8181c23f10bf096665f197ee98f79deaf4aaaaabc3fea1418ffcb85f0f256145fe13260
+  data.tar.gz: ddc7c1eff50e05f3d1cd83cb65df72f688c6aadbed822dc3a87cd9e2096451ab23f62293092443f9d22f4e76a84eb7073da2ffb41117987341bfb2663915cc25

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    MovableInkAWS (2.2.1)
+    MovableInkAWS (2.3.0)
       aws-sdk-athena (~> 1)
       aws-sdk-autoscaling (~> 1)
       aws-sdk-cloudwatch (~> 1)
@@ -24,47 +24,47 @@ GEM
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
     aws-eventstream (1.1.1)
-    aws-partitions (1.433.0)
+    aws-partitions (1.445.0)
     aws-sdk-athena (1.37.0)
       aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-autoscaling (1.58.0)
+    aws-sdk-autoscaling (1.60.0)
       aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-cloudwatch (1.50.0)
+    aws-sdk-cloudwatch (1.51.0)
       aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-core (3.113.0)
+    aws-sdk-core (3.114.0)
       aws-eventstream (~> 1, >= 1.0.2)
       aws-partitions (~> 1, >= 1.239.0)
       aws-sigv4 (~> 1.1)
       jmespath (~> 1.0)
-    aws-sdk-ec2 (1.227.0)
+    aws-sdk-ec2 (1.234.0)
       aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
     aws-sdk-eks (1.51.0)
       aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-elasticache (1.54.0)
+    aws-sdk-elasticache (1.55.0)
       aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
     aws-sdk-kms (1.43.0)
       aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-rds (1.117.0)
+    aws-sdk-rds (1.118.0)
       aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-route53 (1.47.0)
+    aws-sdk-route53 (1.49.0)
       aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-s3 (1.91.0)
+    aws-sdk-s3 (1.93.1)
       aws-sdk-core (~> 3, >= 3.112.0)
       aws-sdk-kms (~> 1)
       aws-sigv4 (~> 1.1)
     aws-sdk-sns (1.39.0)
       aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
-    aws-sdk-ssm (1.106.0)
+    aws-sdk-ssm (1.108.0)
       aws-sdk-core (~> 3, >= 3.112.0)
       aws-sigv4 (~> 1.1)
     aws-sigv4 (1.2.3)

data/lib/movable_ink/aws.rb

@@ -103,7 +103,11 @@ module MovableInk
     end
 
     def my_region
-      @my_region ||= availability_zone.chop
+      @my_region ||= if ENV['AWS_REGION'].nil?
+        availability_zone.chop
+      else
+        ENV['AWS_REGION']
+      end
     end
 
     def datacenter(region: my_region)

data/lib/movable_ink/aws/errors.rb

@@ -3,7 +3,7 @@ module MovableInk
     module Errors
       class ServiceError < StandardError; end
       class FailedWithBackoff < StandardError; end
-      class EC2Required < StandardError; end
+      class MetadataTimeout < StandardError; end
       class NoEnvironmentTagError < StandardError; end
       class InvalidDiscoveryTypeError < StandardError; end
       class RoleNameRequiredError < StandardError; end

data/lib/movable_ink/aws/metadata.rb

@@ -3,59 +3,55 @@ require 'net/http'
 module MovableInk
   class AWS
     module Metadata
-      def http
-        @http ||= begin
+      def http(timeout_seconds: 1)
+        @http = begin
           http = Net::HTTP.new("169.254.169.254", 80)
-          http.open_timeout = 1
-          http.read_timeout = 1
+          http.open_timeout = timeout_seconds
+          http.read_timeout = timeout_seconds
           http
         end
       end
 
-      def retrieve_metadata(key)
-        request = Net::HTTP::Get.new("/latest/meta-data/#{key}")
-        request['X-aws-ec2-metadata-token'] = imds_token
-        response = http.request(request)
-        response.body
-      rescue
-        ""
+      def retrieve_metadata(key, tries: 3)
+        tries.times do |num|
+          num += 1
+          request = Net::HTTP::Get.new("/latest/meta-data/#{key}")
+          request['X-aws-ec2-metadata-token'] = imds_token
+          response = http(timeout_seconds: num * 3).request(request)
+          return response.body
+        rescue Net::OpenTimeout, Net::ReadTimeout, Errno::EHOSTDOWN
+          sleep(num * 2)
+        end
+
+        raise MovableInk::AWS::Errors::MetadataTimeout
       end
 
       def availability_zone
-        @availability_zone ||= begin
-          az = retrieve_metadata('placement/availability-zone')
-          raise(MovableInk::AWS::Errors::EC2Required) if az.empty?
-          az
-        end
+        @availability_zone ||= retrieve_metadata('placement/availability-zone')
       end
 
       def instance_id
-        @instance_id ||= begin
-          id = retrieve_metadata('instance-id')
-          raise(MovableInk::AWS::Errors::EC2Required) if id.empty?
-          id
-        end
+        @instance_id ||= retrieve_metadata('instance-id')
       end
 
       def private_ipv4
-        @ipv4 ||= begin
-          ipv4 = retrieve_metadata('local-ipv4')
-          raise(MovableInk::AWS::Errors::EC2Required) if ipv4.empty?
-          ipv4
-        end
+        @ipv4 ||= retrieve_metadata('local-ipv4')
       end
 
       private
 
-      def imds_token
-        begin
-          request = Net::HTTP::Put.new('/latest/api/token')
+      def imds_token(tries: 3)
+        tries.times do |num|
+          num += 1
+          request = Net::HTTP::Get.new('/latest/api/token')
           request['X-aws-ec2-metadata-token-ttl-seconds'] = 120
-          response = http.request(request)
-          response.body
-        rescue
-          nil
+          response = http(timeout_seconds: num * 3).request(request)
+          return response.body
+        rescue Net::OpenTimeout, Net::ReadTimeout, Errno::EHOSTDOWN
+          sleep(num * 2)
         end
+
+        raise MovableInk::AWS::Errors::MetadataTimeout
       end
     end
   end

data/lib/movable_ink/version.rb

@@ -1,5 +1,5 @@
 module MovableInk
   class AWS
-    VERSION = '2.2.1'
+    VERSION = '2.3.0'
   end
 end

data/spec/aws_spec.rb

@@ -1,17 +1,37 @@
 require_relative '../lib/movable_ink/aws'
+require 'webmock/rspec'
 
 describe MovableInk::AWS do
   context "outside EC2" do
+    before(:each) do
+      allow_any_instance_of(MovableInk::AWS).to receive(:sleep).and_return(true)
+    end
+
+    after(:each) { ENV['AWS_REGION'] = nil }
+
     it 'doesnt raise an error if instance_id is set' do
       aws = MovableInk::AWS.new(instance_id: 'i-987654321')
       expect(aws.instance_id).to eq('i-987654321')
     end
+
+    it 'doesnt raise if AWS_REGION is set' do
+      ENV['AWS_REGION'] = 'us-east-1'
+      miaws = MovableInk::AWS.new
+      expect(miaws.my_region).to eq('us-east-1')
+    end
+
+    it 'raises when AWS_REGION is not set and the metadata service is not available' do
+      miaws = MovableInk::AWS.new
+      # stub an error making a request to the metadata api
+      stub_request(:get, 'http://169.254.169.254/latest/api/token').to_raise(Net::OpenTimeout)
+      expect { miaws.my_region }.to raise_error(MovableInk::AWS::Errors::MetadataTimeout)
+    end
   end
 
   context "inside EC2" do
     it "should find the datacenter by region" do
       aws = MovableInk::AWS.new
-      expect(aws).to receive(:retrieve_metadata).with('placement/availability-zone').and_return("us-east-1a")
+      expect(aws).to receive(:availability_zone).and_return("us-east-1a")
       expect(aws.datacenter).to eq('iad')
     end
 

data/spec/ec2_spec.rb

@@ -2,12 +2,16 @@ require_relative '../lib/movable_ink/aws'
 require 'webmock/rspec'
 
 describe MovableInk::AWS::EC2 do
+  before(:each) do
+    allow_any_instance_of(MovableInk::AWS).to receive(:sleep).and_return(true)
+  end
+
   context "outside EC2" do
     it "should raise an error if trying to load mi_env outside of EC2" do
       aws = MovableInk::AWS.new
-      allow(aws).to receive(:retrieve_metadata).with('instance-id').and_return("")
-      allow(aws).to receive(:retrieve_metadata).with('placement/availability-zone').and_return("")
-      expect{ aws.mi_env }.to raise_error(MovableInk::AWS::Errors::EC2Required)
+      # stub an error making a request to the metadata api
+      stub_request(:get, 'http://169.254.169.254/latest/api/token').to_raise(Net::OpenTimeout)
+      expect{ aws.mi_env }.to raise_error(MovableInk::AWS::Errors::MetadataTimeout)
     end
 
     it "should use the provided environment" do
@@ -17,12 +21,16 @@ describe MovableInk::AWS::EC2 do
 
     it "should not find a 'me'" do
       aws = MovableInk::AWS.new
+      # stub an error making a request to the metadata api
+      stub_request(:get, 'http://169.254.169.254/latest/api/token').to_raise(Net::OpenTimeout)
       expect(aws.me).to eq(nil)
     end
   end
 
   context "inside EC2" do
-    WebMock.allow_net_connect!
+    before(:each) { WebMock.allow_net_connect! }
+    after(:each) { WebMock.disable_net_connect! }
+
     let(:aws) { MovableInk::AWS.new }
     let(:ec2) { Aws::EC2::Client.new(stub_responses: true) }
     let(:tag_data) { ec2.stub_data(:describe_tags, tags: [

data/spec/metadata_spec.rb

@@ -1,20 +1,25 @@
 require_relative '../lib/movable_ink/aws'
+require 'webmock/rspec'
 
 describe MovableInk::AWS::Metadata do
+  before(:each) do
+    allow_any_instance_of(MovableInk::AWS).to receive(:sleep).and_return(true)
+  end
+
   context 'outside ec2' do
-    it 'should raise an error if EC2 is required' do
+    it 'should raise an error if the metadata service times out' do
       aws = MovableInk::AWS.new
-      allow(aws).to receive(:retrieve_metadata).with('instance-id').and_return("")
-      allow(aws).to receive(:retrieve_metadata).with('placement/availability-zone').and_return("")
-
-      expect{ aws.instance_id }.to raise_error(MovableInk::AWS::Errors::EC2Required)
-      expect{ aws.availability_zone }.to raise_error(MovableInk::AWS::Errors::EC2Required)
+      # stub an error making a request to the metadata api
+      stub_request(:get, 'http://169.254.169.254/latest/api/token').to_raise(Net::OpenTimeout)
+      expect{ aws.instance_id }.to raise_error(MovableInk::AWS::Errors::MetadataTimeout)
+      expect{ aws.availability_zone }.to raise_error(MovableInk::AWS::Errors::MetadataTimeout)
     end
 
     it 'should raise an error if trying to load private_ipv4 outside of EC2' do
       aws = MovableInk::AWS.new
-      allow(aws).to receive(:retrieve_metadata).with('local-ipv4').and_return('')
-      expect{ aws.private_ipv4 }.to raise_error(MovableInk::AWS::Errors::EC2Required)
+      # stub an error making a request to the metadata api
+      stub_request(:get, 'http://169.254.169.254/latest/api/token').to_raise(Net::OpenTimeout)
+      expect{ aws.private_ipv4 }.to raise_error(MovableInk::AWS::Errors::MetadataTimeout)
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: MovableInkAWS
 version: !ruby/object:Gem::Version
-  version: 2.2.1
+  version: 2.3.0
 platform: ruby
 authors:
 - Matt Chesler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-03-17 00:00:00.000000000 Z
+date: 2021-04-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core
@@ -276,7 +276,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.0.3.1
 signing_key: 
 specification_version: 4
 summary: AWS Utility methods for MovableInk