kitchen-ec2 0.9.0 → 0.9.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b12924746e2f87674fd4988de55bce1d30507be4
-  data.tar.gz: 7fbbd13c4e9810f0aad3d15bff357291cd808695
+  metadata.gz: 63b191e76f8a9ca14b90f8fbccbdfd1ce3f331b6
+  data.tar.gz: 852a2dc5b108ecb0cef3f27c65162e9716e938c3
 SHA512:
-  metadata.gz: 67561dd868c1a2e8664f99791b62c237b9dc698ed17d587c0f10ce83ad61713a166742d7b50679d93423acf23f5fbecd55e20eaf8d68f3519106af1ecc5d21b7
-  data.tar.gz: db02d3bd6413b7a35e6a843ebced5eba8e54c939462966aee92b87881907e81ad314c4df6839633b912c3b33ad60777fa6cc9ce44864a729b27aec749eb37745
+  metadata.gz: 1e9ac692d5b4d8f9b60633f5eb890bc70efb773fe4980e2478e6743b8dfbba2b7ac713f428f0bc5875da292ea8f6efc62dd4108fce061621d212d12b41be7971
+  data.tar.gz: 827a0183547e2c3f24202711edf9a14b4f17663e677a13915230896076cb08b1cc065107c1ee42dbe3bf395b6715aaa9cab6928bdd245ac3201db19cac4c10eb

data/.rubocop.yml

@@ -7,3 +7,9 @@ Style/Next:
 
 Style/DoubleNegation:
   Enabled: false
+
+Metrics/CyclomaticComplexity:
+  Max: 30
+
+Metrics/PerceivedComplexity:
+  Max: 30

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 0.9.1 / 2015-05-21
+
+### Bug Fixes
+
+* Pull Request [#124][]: AWS SDK V2 returns `instance.public_dns_name` as empty string instead of nil, and we were only checking for nil.  Caused timeouts trying to connect. ([@tyler-ball][])
+    * Fixed regression: Adding back `interface` config value that I accidently removed, code is now in line with README.
+* Pull Request [#125][]: When specifying `associate_public_ip` we must send the subnet (if provided) in the `network_interfaces` section of the payload instead of the main section. ([@tyler-ball][])
+    * Fixed regression: Accidently renamed config `associate_public_ip` to `associate_public_ip_address`, reverting.
+    * Fixed regression: Accidently renamed config `iam_profile_name` to `iam_instance_profile`, reverting.
+
+### New Features
+
+### Improvements
+
 ## 0.9.0 / 2015-05-18
 
 ### Bug Fixes
@@ -110,6 +124,8 @@
 [#107]: https://github.com/test-kitchen/kitchen-ec2/issues/107
 [#110]: https://github.com/test-kitchen/kitchen-ec2/issues/110
 [#112]: https://github.com/test-kitchen/kitchen-ec2/issues/112
+[#124]: https://github.com/test-kitchen/kitchen-ec2/issues/124
+[#125]: https://github.com/test-kitchen/kitchen-ec2/issues/125
 [@Atalanta]: https://github.com/Atalanta
 [@Igorshp]: https://github.com/Igorshp
 [@JamesAwesome]: https://github.com/JamesAwesome
@@ -136,4 +152,4 @@
 [@someara]: https://github.com/someara
 [@spheromak]: https://github.com/spheromak
 [@tiwilliam]: https://github.com/tiwilliam
-[@tyler-ball]: https://github.com/tyler-ball
+[@tyler-ball]: https://github.com/tyler-ball

data/lib/kitchen/driver/aws/instance_generator.rb

@@ -55,15 +55,20 @@ module Kitchen
           i[:block_device_mappings] = block_device_mappings unless block_device_mappings.empty?
           i[:security_group_ids] = config[:security_group_ids] if config[:security_group_ids]
           i[:user_data] = prepared_user_data if prepared_user_data
-          if config[:iam_instance_profile]
+          if config[:iam_profile_name]
             i[:iam_instance_profile] = { :name => config[:iam_profile_name] }
           end
-          if !config.fetch(:associate_public_ip_address, nil).nil?
+          if !config.fetch(:associate_public_ip, nil).nil?
             i[:network_interfaces] =
               [{
                 :device_index => 0,
-                :associate_public_ip_address => config[:associate_public_ip_address]
+                :associate_public_ip_address => config[:associate_public_ip]
               }]
+            # If specifying `:network_interfaces` in the request, you must specify the
+            # subnet_id in the network_interfaces block and not at the top level
+            if config[:subnet_id]
+              i[:network_interfaces][0][:subnet_id] = i.delete(:subnet_id)
+            end
           end
           i
         end

data/lib/kitchen/driver/ec2.rb

@@ -20,9 +20,10 @@ require "benchmark"
 require "json"
 require "aws"
 require "kitchen"
-require "kitchen/driver/ec2_version"
+require_relative "ec2_version"
 require_relative "aws/client"
 require_relative "aws/instance_generator"
+require "aws-sdk-core/waiters/errors"
 
 module Kitchen
 
@@ -60,6 +61,7 @@ module Kitchen
       end
       default_config :username,            nil
       default_config :associate_public_ip, nil
+      default_config :interface,           nil
 
       required_config :aws_ssh_key_id
       required_config :image_id
@@ -194,14 +196,21 @@ module Kitchen
           t = config[:retryable_tries] * config[:retryable_sleep]
           info "Waited #{c}/#{t}s for instance <#{state[:server_id]}> to become ready."
         end
-        server = server.wait_until(
-          :max_attempts => config[:retryable_tries],
-          :delay => config[:retryable_sleep],
-          :before_attempt => wait_log
-        ) do |s|
-          hostname = hostname(s)
-          # Euca instances often report ready before they have an IP
-          s.state.name == "running" && !hostname.nil? && hostname != "0.0.0.0"
+        begin
+          server = server.wait_until(
+            :max_attempts => config[:retryable_tries],
+            :delay => config[:retryable_sleep],
+            :before_attempt => wait_log
+          ) do |s|
+            hostname = hostname(s, config[:interface])
+            # Euca instances often report ready before they have an IP
+            s.exists? && s.state.name == "running" && !hostname.nil? && hostname != "0.0.0.0"
+          end
+        rescue ::Aws::Waiters::Errors::WaiterFailed
+          error("Ran out of time waiting for the server with id [#{state[:server_id]}]" \
+            " to become ready, attempting to destroy it")
+          destroy(state)
+          raise
         end
 
         info("EC2 instance <#{state[:server_id]}> ready.")
@@ -217,7 +226,7 @@ module Kitchen
         server = ec2.get_instance(state[:server_id])
         unless server.nil?
           instance.transport.connection(state).close
-          server.terminate unless server.nil?
+          server.terminate
         end
         if state[:spot_request_id]
           debug("Deleting spot request <#{state[:server_id]}>")
@@ -235,8 +244,6 @@ module Kitchen
         region && region[instance.platform.name]
       end
 
-      private
-
       def ec2
         @ec2 ||= Aws::Client.new(
           config[:region],
@@ -354,6 +361,8 @@ module Kitchen
           potential_hostname = nil
           INTERFACE_TYPES.values.each do |type|
             potential_hostname ||= server.send(type)
+            # AWS returns an empty string if the dns name isn't populated yet
+            potential_hostname = nil if potential_hostname == ""
           end
           potential_hostname
         end

data/lib/kitchen/driver/ec2_version.rb

@@ -21,6 +21,6 @@ module Kitchen
   module Driver
 
     # Version string for EC2 Test Kitchen driver
-    EC2_VERSION = "0.9.0"
+    EC2_VERSION = "0.9.1"
   end
 end

data/spec/kitchen/driver/ec2/instance_generator_spec.rb

@@ -244,6 +244,47 @@ describe Kitchen::Driver::Aws::InstanceGenerator do
       end
     end
 
+    context "when subnet_id is provided" do
+      let(:config) do
+        {
+          :subnet_id => "s-456"
+        }
+      end
+
+      it "adds a network_interfaces block" do
+        expect(generator.ec2_instance_data).to eq(
+          :placement => { :availability_zone => nil },
+          :instance_type => nil,
+          :ebs_optimized => nil,
+          :image_id => nil,
+          :key_name => nil,
+          :subnet_id => "s-456",
+          :private_ip_address => nil
+        )
+      end
+    end
+
+    context "when associate_public_ip is provided" do
+      let(:config) do
+        {
+          :associate_public_ip => true
+        }
+      end
+
+      it "adds a network_interfaces block" do
+        expect(generator.ec2_instance_data).to eq(
+          :placement => { :availability_zone => nil },
+          :instance_type => nil,
+          :ebs_optimized => nil,
+          :image_id => nil,
+          :key_name => nil,
+          :subnet_id => nil,
+          :private_ip_address => nil,
+          :network_interfaces => [{ :device_index => 0, :associate_public_ip_address => true }]
+        )
+      end
+    end
+
     context "when provided the maximum config" do
       let(:config) do
         {
@@ -266,8 +307,8 @@ describe Kitchen::Driver::Aws::InstanceGenerator do
           ],
           :security_group_ids => ["sg-789"],
           :user_data => "foo",
-          :iam_instance_profile => "iam-123",
-          :associate_public_ip_address => true
+          :iam_profile_name => "iam-123",
+          :associate_public_ip => true
         }
       end
 
@@ -278,7 +319,6 @@ describe Kitchen::Driver::Aws::InstanceGenerator do
           :ebs_optimized => true,
           :image_id => "ami-123",
           :key_name => "key",
-          :subnet_id => "s-456",
           :private_ip_address => "0.0.0.0",
           :block_device_mappings => [
             {
@@ -292,8 +332,12 @@ describe Kitchen::Driver::Aws::InstanceGenerator do
               :virtual_name => "test"
             }
           ],
-          :iam_instance_profile => { :name => nil },
-          :network_interfaces => [{ :device_index => 0, :associate_public_ip_address => true }],
+          :iam_instance_profile => { :name => "iam-123" },
+          :network_interfaces => [{
+            :device_index => 0,
+            :associate_public_ip_address => true,
+            :subnet_id => "s-456"
+          }],
           :security_group_ids => ["sg-789"],
           :user_data => "foo"
         )

data/spec/kitchen/driver/ec2_spec.rb

@@ -71,7 +71,7 @@ describe Kitchen::Driver::Ec2 do
     end
   end
 
-  describe "finalize_config!" do
+  describe "#finalize_config!" do
     it "defaults the availability zone if not provided" do
       expect(config[:availability_zone]).to eq(nil)
       driver.finalize_config!(instance)
@@ -79,4 +79,84 @@ describe Kitchen::Driver::Ec2 do
     end
   end
 
+  describe "#hostname" do
+    let(:public_dns_name) { nil }
+    let(:public_ip_address) { nil }
+    let(:private_ip_address) { nil }
+    let(:server) {
+      double("server",
+        :public_dns_name => public_dns_name,
+        :public_ip_address => public_ip_address,
+        :private_ip_address => private_ip_address
+      )
+    }
+
+    it "returns nil if all sources are nil" do
+      expect(driver.hostname(server)).to eq(nil)
+    end
+
+    it "raises an error if provided an unknown interface" do
+      expect { driver.hostname(server, "foobar") }.to raise_error(Kitchen::UserError)
+    end
+
+    shared_examples "an interface type provided" do
+      it "returns public_dns_name when requested" do
+        expect(driver.hostname(server, "dns")).to eq(public_dns_name)
+      end
+      it "returns public_ip_address when requested" do
+        expect(driver.hostname(server, "public")).to eq(public_ip_address)
+      end
+      it "returns private_ip_address when requested" do
+        expect(driver.hostname(server, "private")).to eq(private_ip_address)
+      end
+    end
+
+    context "private_ip_address is populated" do
+      let(:private_ip_address) { "10.0.0.1" }
+
+      it "returns the private_ip_address" do
+        expect(driver.hostname(server)).to eq(private_ip_address)
+      end
+
+      include_examples "an interface type provided"
+    end
+
+    context "public_ip_address is populated" do
+      let(:private_ip_address) { "10.0.0.1" }
+      let(:public_ip_address) { "127.0.0.1" }
+
+      it "returns the public_ip_address" do
+        expect(driver.hostname(server)).to eq(public_ip_address)
+      end
+
+      include_examples "an interface type provided"
+    end
+
+    context "public_dns_name is populated" do
+      let(:private_ip_address) { "10.0.0.1" }
+      let(:public_ip_address) { "127.0.0.1" }
+      let(:public_dns_name) { "public_dns_name" }
+
+      it "returns the public_dns_name" do
+        expect(driver.hostname(server)).to eq(public_dns_name)
+      end
+
+      include_examples "an interface type provided"
+    end
+
+    context "public_dns_name returns as empty string" do
+      let(:public_dns_name) { "" }
+      it "returns nil" do
+        expect(driver.hostname(server)).to eq(nil)
+      end
+
+      context "and private_ip_address is populated" do
+        let(:private_ip_address) { "10.0.0.1" }
+        it "returns the private_ip_address" do
+          expect(driver.hostname(server)).to eq(private_ip_address)
+        end
+      end
+    end
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kitchen-ec2
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.9.1
 platform: ruby
 authors:
 - Fletcher Nichol
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-19 00:00:00.000000000 Z
+date: 2015-05-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: test-kitchen