ec2-metadata 0.1.0 → 0.2.0

data/lib/ec2_metadata/dummy.yml

@@ -0,0 +1,34 @@
+--- 
+meta-data: 
+  ami-id: ami-6966372c
+  ami-launch-index: "0"
+  ami-manifest-path: akm2000-us-west-1/dev-20100406-01.manifest.xml
+  ancestor-ami-ids: ami-c32e7f86
+  instance-id: i-3de0f678
+  instance-type: m1.small
+  instance-action: none
+  security-groups: |-
+    ruby-dev
+    default
+  hostname: ip-10-160-115-246.us-west-1.compute.internal
+  public-hostname: ec2-204-236-178-101.us-west-1.compute.amazonaws.com
+  public-ipv4: 204.236.178.101
+  local-hostname: ip-10-160-115-246.us-west-1.compute.internal
+  local-ipv4: 10.160.115.246
+  kernel-id: aki-773c6d32
+  ramdisk-id: ari-c12e7f84
+  reservation-id: r-b76769f2
+  block-device-mapping: 
+    root: /dev/sda1
+    ami: sda1
+    swap: sda3
+    ephemeral0: sda2
+  public-keys: 
+    "0": 
+      west-dev01: 
+        openssh-key: |
+          ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQC3on58pV0jEdOukPJMi3zaI90Vg5n+vTaWVNBC2pDfaFX5yVIwcT/LQn9CqvcFsayvRaLfrVT8+wz7BnvQwldUAoIC5wCb5MXhhdr+3dk3ey/t8t3rS0lO6pxYc1jchkH23C/RQz+gOzFDuuzxX4zngRRkajYt1hKEVOPLVv9tqBawalCF0d3iALu/XBguj6fUogaqHgNgZZpZXTXDyfmLtWnXErB0/hqmuV6iIXjclB+K94lZCcJaOQSm/+9C6R0jCKwJNteJInvD553IzyTzBgc5Os3ukNuYv+Ub6aP717ikmI5fa5P0pBL+684kkPKvpGoADJveACoL1+uKpk0j west-dev01
+
+  placement: 
+    availability-zone: us-west-1b
+user-data: 

data/lib/ec2_metadata/http_client.rb

@@ -0,0 +1,29 @@
+require 'ec2_metadata'
+
+module Ec2Metadata
+  module HttpClient
+    def self.extended(obj)
+      obj.open_timeout_sec ||= DEFAULT_OPEN_TIMEOUT
+      obj.read_timeout_sec ||= DEFAULT_READ_TIMEOUT
+    end
+
+    DEFAULT_OPEN_TIMEOUT = 5
+    DEFAULT_READ_TIMEOUT = 10
+
+    attr_accessor :open_timeout_sec
+    attr_accessor :read_timeout_sec
+    
+    def get(path)
+      logging("Ec2Metadata.get(#{path.inspect})") do
+        http = Net::HTTP.new(DEFAULT_HOST)
+        http.open_timeout = self.open_timeout_sec
+        http.read_timeout = self.read_timeout_sec
+        http.start do |http|
+          res = http.get(path)
+          res.is_a?(Net::HTTPSuccess) ? res.body : nil
+        end
+      end
+    end
+
+  end
+end

data/lib/hash_key_orderable.rb

@@ -0,0 +1,23 @@
+module HashKeyOrderable
+  attr_accessor :key_order
+  
+  def each_with_key_order(&block)
+    if @key_order.nil? || @key_order.empty?
+      each_without_key_order(&block)
+      return self
+    end
+    unexist_keys = @key_order - self.keys
+    actual_order = (@key_order - unexist_keys) | self.keys
+    actual_order.each do |key|
+      yield(key, self[key])
+    end
+    self
+  end
+
+  def self.extended(obj)
+    obj.instance_eval do
+      alias :each_without_key_order :each
+      alias :each :each_with_key_order
+    end
+  end
+end

data/spec/ec2_metadata/base_spec.rb

@@ -8,13 +8,13 @@ describe Ec2Metadata::Base do
       describe revision do
         before do
           @meta_data = Ec2Metadata::Base.new("/#{revision}/meta-data/")
-          Net::HTTP.should_receive(:get).with("169.254.169.254", "/#{revision}/meta-data/").once.
+          Ec2Metadata.should_receive(:get).with("/#{revision}/meta-data/").once.
             and_return(ALL_ATTR_KEYS.join("\n"))
         end
 
         SIMPLE_ATTR_KEYS.each do |attr_key|
           it "(#{attr_key.gsub(/-/, '_').inspect}) should return #{attr_key}" do
-            Net::HTTP.should_receive(:get).with("169.254.169.254", "/#{revision}/meta-data/#{attr_key}").once.
+            Ec2Metadata.should_receive(:get).with("/#{revision}/meta-data/#{attr_key}").once.
               and_return("#{revision}_#{attr_key}")
             @meta_data[attr_key].should == "#{revision}_#{attr_key}"
             @meta_data[attr_key.to_sym].should == "#{revision}_#{attr_key}"
@@ -22,38 +22,39 @@ describe Ec2Metadata::Base do
         end
 
         it "('placement') should return object like Hash" do
-          Net::HTTP.should_receive(:get).with("169.254.169.254", "/#{revision}/meta-data/placement/").and_return("availability-zone")
+          Ec2Metadata.should_receive(:get).with("/#{revision}/meta-data/placement/").and_return("availability-zone")
           obj = @meta_data[:placement]
           obj.child_keys.should == ["availability-zone"]
-          Net::HTTP.should_receive(:get).with("169.254.169.254", "/#{revision}/meta-data/placement/availability-zone").and_return("us-east-1a")
+          Ec2Metadata.should_receive(:get).with("/#{revision}/meta-data/placement/availability-zone").and_return("us-east-1a")
           obj[:availability_zone].should == "us-east-1a"
         end
 
         it "('block_device_mapping') should return object like Hash" do
-          Net::HTTP.should_receive(:get).with("169.254.169.254", "/#{revision}/meta-data/block-device-mapping/").and_return(["ami", "ephemeral0", "root", "swap"].join("\n"))
+          Ec2Metadata.should_receive(:get).with("/#{revision}/meta-data/block-device-mapping/").and_return(["ami", "ephemeral0", "root", "swap"].join("\n"))
           obj = @meta_data[:block_device_mapping]
           obj.child_keys.should == ["ami", "ephemeral0", "root", "swap"]
-          Net::HTTP.should_receive(:get).with("169.254.169.254", "/#{revision}/meta-data/block-device-mapping/ami").and_return("sda1")
+          Ec2Metadata.should_receive(:get).with("/#{revision}/meta-data/block-device-mapping/ami").and_return("sda1")
           obj[:ami].should == "sda1"
-          Net::HTTP.should_receive(:get).with("169.254.169.254", "/#{revision}/meta-data/block-device-mapping/ephemeral0").and_return("sda2")
+          Ec2Metadata.should_receive(:get).with("/#{revision}/meta-data/block-device-mapping/ephemeral0").and_return("sda2")
           obj[:ephemeral0].should == "sda2"
-          Net::HTTP.should_receive(:get).with("169.254.169.254", "/#{revision}/meta-data/block-device-mapping/root").and_return("/dev/sda1")
+          Ec2Metadata.should_receive(:get).with("/#{revision}/meta-data/block-device-mapping/root").and_return("/dev/sda1")
           obj[:root].should == "/dev/sda1"
-          Net::HTTP.should_receive(:get).with("169.254.169.254", "/#{revision}/meta-data/block-device-mapping/swap").and_return("sda3")
+          Ec2Metadata.should_receive(:get).with("/#{revision}/meta-data/block-device-mapping/swap").and_return("sda3")
           obj[:swap].should == "sda3"
         end
 
         it "('public_keys') should return object like Hash" do
-          Net::HTTP.should_receive(:get).with("169.254.169.254", "/#{revision}/meta-data/public-keys/").and_return("0=keypair0")
+          Ec2Metadata.should_receive(:get).with("/#{revision}/meta-data/public-keys/").and_return("0=keypair0")
           obj = @meta_data[:public_keys]
           obj.child_keys.should == ["0"]
           obj.class.should == Ec2Metadata::Base
           key0 = obj["0"]
-          key0.to_s.should == "keypair0"
-          Net::HTTP.should_receive(:get).with("169.254.169.254", "/#{revision}/meta-data/public-keys/0/").and_return("openssh-key")
-          key0.child_keys.should == ["openssh-key"]
-          Net::HTTP.should_receive(:get).with("169.254.169.254", "/#{revision}/meta-data/public-keys/0/openssh-key").and_return("ssh-rsa 1234567890")
-          key0[:openssh_key].should == "ssh-rsa 1234567890"
+          key0.child_keys.should == ["keypair0"]
+          key0name = key0["keypair0"]
+          Ec2Metadata.should_receive(:get).with("/#{revision}/meta-data/public-keys/0/").and_return("openssh-key")
+          key0name.child_keys.should == ["openssh-key"]
+          Ec2Metadata.should_receive(:get).with("/#{revision}/meta-data/public-keys/0/openssh-key").and_return("ssh-rsa 1234567890")
+          key0name[:openssh_key].should == "ssh-rsa 1234567890"
         end
 
       end

data/spec/ec2_metadata/command_spec.rb

@@ -0,0 +1,101 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '../spec_helper'))
+
+describe Ec2Metadata::Root do
+
+  before do
+    Ec2Metadata.clear_instance
+  end
+
+  describe :show do
+    describe "valid" do
+      it "should puts sorted data" do
+        revisions = %w(1.0 2009-04-04 latest)
+        data_types = %w(user-data meta-data)
+        attrs = %w(ami-id hostname instance-id local-hostname local-ipv4 public-hostname public-ipv4)
+        Ec2Metadata.should_receive(:get).with("/").once.and_return(revisions.join("\n"))
+        Ec2Metadata.should_receive(:get).with("/latest/").once.and_return(data_types.join("\n"))
+        Ec2Metadata.should_receive(:get).with("/latest/user-data").once.and_return((1..3).map{|n| "user-data-line#{n}"}.join("\n"))
+        Ec2Metadata.should_receive(:get).with("/latest/meta-data/").once.and_return(attrs.join("\n"))
+        Ec2Metadata.should_receive(:get).with("/latest/meta-data/ami-id").once.and_return('ami-abcdef01')
+        Ec2Metadata.should_receive(:get).with("/latest/meta-data/instance-id").once.and_return('i-12345678')
+        Ec2Metadata.should_receive(:get).with("/latest/meta-data/public-hostname").once.and_return('ec2-75-101-241-136.compute-1.amazonaws.com')
+        Ec2Metadata.should_receive(:get).with("/latest/meta-data/local-hostname").once.and_return('ip-10-123-123-123')
+        Ec2Metadata.should_receive(:get).with("/latest/meta-data/hostname").once.and_return('ip-10-123-123-123')
+        Ec2Metadata.should_receive(:get).with("/latest/meta-data/local-ipv4").once.and_return('10.123.123.123')
+        Ec2Metadata.should_receive(:get).with("/latest/meta-data/public-ipv4").once.and_return('75.101.241.136')
+        result = <<EOS
+--- 
+meta-data: 
+  ami-id: ami-abcdef01
+  instance-id: i-12345678
+  hostname: ip-10-123-123-123
+  public-hostname: ec2-75-101-241-136.compute-1.amazonaws.com
+  public-ipv4: 75.101.241.136
+  local-hostname: ip-10-123-123-123
+  local-ipv4: 10.123.123.123
+user-data: |-
+  user-data-line1
+  user-data-line2
+  user-data-line3
+EOS
+        Ec2Metadata::Command.should_receive(:puts).with(result)
+        Ec2Metadata::Command.show
+      end
+
+      it "should display message which means 'dummy data is used'" do
+        Ec2Metadata.from_hash({
+          'user-data' => "user-data-line1\nuser-data-line2\nuser-data-line3",
+          'meta-data' => {
+            'ami-id' => 'ami-abcdef01',
+            'instance-id' => 'i-12345678',
+            'public-hostname' => "ec2-75-101-241-136.compute-1.amazonaws.com",
+            'local-hostname' => "ip-10-123-123-123",
+            'hostname' => "ip-10-123-123-123",
+            'local-ipv4' => "10.123.123.123",
+            'public-ipv4' => "75.101.241.136",
+            # 'public_keys' => [{'openssh-key' => "ssh-rsa 1234567890"}]
+          }
+        })
+        Ec2Metadata::Dummy.instance_variable_set(:@loaded_yaml_path, '/path/to/ec2_metadata.yml')
+        result = <<EOS
+--- 
+meta-data: 
+  ami-id: ami-abcdef01
+  instance-id: i-12345678
+  hostname: ip-10-123-123-123
+  public-hostname: ec2-75-101-241-136.compute-1.amazonaws.com
+  public-ipv4: 75.101.241.136
+  local-hostname: ip-10-123-123-123
+  local-ipv4: 10.123.123.123
+user-data: |-
+  user-data-line1
+  user-data-line2
+  user-data-line3
+EOS
+        Ec2Metadata::Command.should_receive(:puts).with(result).once
+        Ec2Metadata::Command.should_receive(:puts).with("Actually these data is based on a DUMMY yaml file: /path/to/ec2_metadata.yml").once
+        Ec2Metadata::Command.show
+      end
+    end
+
+    it "should raise ArgumentError for invalid api version" do
+      revisions = %w(1.0 2009-04-04 latest)
+      Ec2Metadata.should_receive(:get).with("/").once.and_return(revisions.join("\n"))
+      lambda{ 
+        Ec2Metadata::Command.show("invalid api version")
+      }.should raise_error(ArgumentError)
+    end
+
+  end
+
+  describe :show_api_versions do
+    it "default" do
+      revisions = %w(1.0 2009-04-04 latest)
+      Ec2Metadata.should_receive(:get).with("/").once.and_return(revisions.join("\n"))
+      Ec2Metadata::Command.should_receive(:puts).with(revisions)
+      Ec2Metadata::Command.show_api_versions
+    end
+
+  end
+  
+end

data/spec/ec2_metadata/dummy_spec.rb

@@ -0,0 +1,92 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '../spec_helper'))
+
+describe Ec2Metadata::Dummy do
+  after(:all) do
+    Ec2Metadata::Dummy.instance_variable_set(:@loaded_yaml_path, nil)
+  end
+
+  describe :yaml_paths do
+    it "default" do
+      ENV.should_receive(:[]).with("EC2_METADATA_DUMMY_YAML").once.and_return(nil)
+      original_constants = Module.constants
+      Module.should_receive(:constants).once.and_return(original_constants - %w(RAILS_ROOT))
+      Ec2Metadata::Dummy.yaml_paths.should == [
+        './config/ec2_metadata.yml',
+        './ec2_metadata.yml',
+        '~/ec2_metadata.yml',
+        '/etc/ec2_metadata.yml'
+      ]
+    end
+
+    it "with rails" do
+      ENV.should_receive(:[]).with("EC2_METADATA_DUMMY_YAML").once.and_return(nil)
+      original_constants = Module.constants
+      Module.should_receive(:constants).once.and_return(original_constants + %w(RAILS_ROOT))
+      Module.should_receive(:const_get).with("RAILS_ROOT").once.and_return("/path/to/rails/project")
+      Ec2Metadata::Dummy.yaml_paths.should == [
+        '/path/to/rails/project/config/ec2_metadata.yml',
+        './config/ec2_metadata.yml',
+        './ec2_metadata.yml',
+        '~/ec2_metadata.yml',
+        '/etc/ec2_metadata.yml'
+      ]
+    end
+
+    it "with specified_path" do
+      ENV.should_receive(:[]).with("EC2_METADATA_DUMMY_YAML").once.and_return("/path/to/dummy/yaml")
+      original_constants = Module.constants
+      Module.should_receive(:constants).once.and_return(original_constants - %w(RAILS_ROOT))
+      Ec2Metadata::Dummy.yaml_paths.should == [
+        '/path/to/dummy/yaml',
+        './config/ec2_metadata.yml',
+        './ec2_metadata.yml',
+        '~/ec2_metadata.yml',
+        '/etc/ec2_metadata.yml'
+      ]
+    end
+  end
+
+  describe :search_and_load_yaml do
+    it "should load_yaml if yaml exists" do
+      yaml_path = "/path/to/ec2_metadata.yml"
+      Ec2Metadata::Dummy.should_receive(:yaml_paths).once.and_return([yaml_path])
+      Dir.should_receive(:glob).with([yaml_path]).and_return([yaml_path])
+      Ec2Metadata::Dummy.should_receive(:load_yaml).with(yaml_path).once
+      Ec2Metadata::Dummy.search_and_load_yaml
+    end
+
+    it "shouldn't load_yaml unless yaml exists" do
+      yaml_path = "/path/to/ec2_metadata.yml"
+      Ec2Metadata::Dummy.should_receive(:yaml_paths).once.and_return([yaml_path])
+      Dir.should_receive(:glob).with([yaml_path]).and_return([])
+      Ec2Metadata::Dummy.should_not_receive(:load_yaml)
+      Ec2Metadata::Dummy.search_and_load_yaml
+    end
+  end
+
+  describe :load_yaml do
+    require 'yaml'
+    require 'erb'
+    
+    it "should load by from_hash" do
+      yaml = {
+        'user-data' => "user-data-line1\nuser-data-line2\nuser-data-line3",
+        'meta-data' => {
+          'ami-id' => 'ami-abcdef01',
+          'instance-id' => 'i-12345678',
+          'public-hostname' => "ec2-75-101-241-136.compute-1.amazonaws.com",
+          'local-hostname' => "ip-10-123-123-123",
+          'hostname' => "ip-10-123-123-123",
+          'local-ipv4' => "10.123.123.123",
+          'public-ipv4' => "75.101.241.136"
+        }
+      }
+      yaml_path = "/path/to/ec2_metadata.yml"
+      IO.should_receive(:read).with(yaml_path).and_return(YAML.dump(yaml))
+      Ec2Metadata.should_receive(:from_hash).with(yaml)
+      Ec2Metadata::Dummy.load_yaml(yaml_path)
+      Ec2Metadata::Dummy.loaded_yaml_path.should == yaml_path
+    end
+  end
+  
+end

data/spec/ec2_metadata/http_client_spec.rb

@@ -0,0 +1,34 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '../spec_helper'))
+
+describe Ec2Metadata::HttpClient do
+
+  describe :get do
+    it "should return body for Net::HTTPSuccess" do
+      mock_http = mock(:http)
+      mock_res = mock(:http_res)
+      Net::HTTP.should_receive(:new).with("169.254.169.254").and_return(mock_http)
+      mock_http.should_receive(:open_timeout=).with(5)
+      mock_http.should_receive(:read_timeout=).with(10)
+      mock_http.should_receive(:start).and_yield(mock_http)
+      mock_http.should_receive(:get).with("/path1").and_return(mock_res)
+      mock_res.should_receive(:is_a?).with(Net::HTTPSuccess).and_return(true)
+      mock_res.should_receive(:body).and_return("HTTP Success Response Body1")
+      Ec2Metadata.get("/path1").should == "HTTP Success Response Body1"
+    end
+    
+    it "should return nil not for Net::HTTPSuccess" do
+      mock_http = mock(:http)
+      mock_res = mock(:http_res)
+      Net::HTTP.should_receive(:new).with("169.254.169.254").and_return(mock_http)
+      mock_http.should_receive(:open_timeout=).with(5)
+      mock_http.should_receive(:read_timeout=).with(10)
+      mock_http.should_receive(:start).and_yield(mock_http)
+      mock_http.should_receive(:get).with("/path1").and_return(mock_res)
+      mock_res.should_receive(:is_a?).with(Net::HTTPSuccess).and_return(false)
+      mock_res.should_not_receive(:body) # .and_return("404 not found")
+      Ec2Metadata.get("/path1").should == nil
+    end
+    
+  end
+  
+end

data/spec/ec2_metadata/revision_spec.rb

@@ -8,7 +8,7 @@ describe Ec2Metadata::Root do
       describe revision do
         before do
           @rev_obj = Ec2Metadata::Revision.new("/#{revision}/")
-          Net::HTTP.should_receive(:get).with("169.254.169.254", "/#{revision}/").once.
+          Ec2Metadata.should_receive(:get).with("/#{revision}/").once.
             and_return(DATA_TYPES.join("\n"))
         end
 
@@ -18,7 +18,7 @@ describe Ec2Metadata::Root do
         end
 
         it "should return Ec2Metadata::Base for user_data" do
-          Net::HTTP.should_receive(:get).with("169.254.169.254", "/#{revision}/user-data").once.
+          Ec2Metadata.should_receive(:get).with("/#{revision}/user-data").once.
             and_return("#{revision}-user_data")
           user_data = @rev_obj[:user_data]
           user_data.should == "#{revision}-user_data"

data/spec/ec2_metadata/root_spec.rb

@@ -9,7 +9,7 @@ describe Ec2Metadata::Root do
 
     REVISIONS.each do |rev|
       it "should return Revision for #{rev}" do
-        Net::HTTP.should_receive(:get).with("169.254.169.254", "/").once.
+        Ec2Metadata.should_receive(:get).with("/").once.
           and_return(REVISIONS.join("\n"))
         revision = @root[rev]
         revision.class.should == Ec2Metadata::Revision
@@ -17,22 +17,22 @@ describe Ec2Metadata::Root do
     end
 
     it "should return latest DataType for user-data" do
-      Net::HTTP.should_receive(:get).with("169.254.169.254", "/").once.
+      Ec2Metadata.should_receive(:get).with("/").once.
         and_return(REVISIONS.join("\n"))
-      Net::HTTP.should_receive(:get).with("169.254.169.254", "/latest/").once.
+      Ec2Metadata.should_receive(:get).with("/latest/").once.
         and_return(DATA_TYPES.join("\n"))
-      Net::HTTP.should_receive(:get).with("169.254.169.254", "/latest/user-data").once.
+      Ec2Metadata.should_receive(:get).with("/latest/user-data").once.
         and_return("test-user-data1")
       obj = @root['user-data']
       obj.should == "test-user-data1"
     end
 
     it "should return latest DataType for meta-data" do
-      Net::HTTP.should_receive(:get).with("169.254.169.254", "/").once.
+      Ec2Metadata.should_receive(:get).with("/").once.
         and_return(REVISIONS.join("\n"))
-      Net::HTTP.should_receive(:get).with("169.254.169.254", "/latest/").once.
+      Ec2Metadata.should_receive(:get).with("/latest/").once.
         and_return(DATA_TYPES.join("\n"))
-      Net::HTTP.should_not_receive(:get).with("169.254.169.254", "/latest/meta-data/")
+      Ec2Metadata.should_not_receive(:get).with("/latest/meta-data/")
       obj = @root['meta-data']
       obj.class.should == Ec2Metadata::Base
     end