ec2_userdata 1.0

data/lib/ec2_userdata.rb

@@ -0,0 +1,80 @@
+require 'net/http'
+require 'json/pure'
+
+module EC2
+  class UserData
+    def self.[](key)
+      if @userdata.nil?
+        if EC2.ec2?
+          logger.info "Running on EC2. Reading user data from http://169.254.169.254/1.0/user-data" if logger
+          @userdata = get_ec2_userdata
+        else
+          logger.info "Not running on EC2. Reading user data from #{app_root}/config/ec2_userdata.yml." if logger
+          @userdata = get_local_userdata
+        end
+      end
+
+      @userdata[key]
+    end
+    
+    private
+    def self.get_ec2_userdata
+      JSON.parse(Net::HTTP.get(URI.parse("http://169.254.169.254/1.0/user-data")))
+    end
+    
+    def self.get_local_userdata
+      if app_root
+        YAML.load_file("#{app_root}/config/ec2_userdata.yml")
+      else
+        raise "Cannot find app_root. Don't know what to do!"
+      end
+    end
+    
+    def self.logger
+      if defined?(Rails)
+        Rails.logger
+      elsif defined?(Merb)
+        Merb.logger
+      elsif defined?(LOGGER)
+        LOGGER
+      else
+        nil
+      end
+    end
+    
+    def self.app_root
+      if defined?(Rails)
+        RAILS_ROOT
+      elsif defined?(Merb)
+        Merb.root
+      elsif defined?(APP_ROOT)
+        APP_ROOT
+      else
+        nil
+      end
+    end
+  end
+
+  # Returns true if the current instance is running on the EC2 cloud
+  def self.ec2?
+    return @running_on_ec2 if @running_on_ec2
+    raise("nslookup must be in the path") if cmd_exec("which nslookup").blank?
+    @running_on_ec2 = (cmd_exec("nslookup 169.254.169.254").match(/NXDOMAIN/) || []).size < 1 
+  end
+
+  private
+  def self.cmd_exec(cmd)
+    `#{cmd}`
+  end
+end
+
+### Active Support ###
+class String
+  def blank?
+    self.strip.length == 0
+  end
+end
+
+class NilClass
+  def blank?; true; end
+end

data/test/unit/ec2_userdata_test.rb

@@ -0,0 +1,68 @@
+require 'rubygems'
+require 'redgreen'
+require 'test/unit'
+require 'mocha'
+require File.dirname(__FILE__) + '/../../lib/ec2_userdata'
+
+APP_ROOT = "File.dirname(__FILE__) + '/../.."
+
+class Ec2UserDataTest < Test::Unit::TestCase
+  def setup
+    EC2::UserData.class_eval("@userdata = nil")
+    EC2::module_eval("@running_on_ec2 = nil")
+
+  end
+  
+  def test_get_on_ec2
+    EC2.expects(:ec2?).once.returns(true)
+    Net::HTTP.expects(:get).with(URI.parse("http://169.254.169.254/1.0/user-data")).returns(ec2_json_userdata)
+    
+    assert_equal "lisa", EC2::UserData["cluster"]
+    assert_equal 11300, EC2::UserData["queue_port"]
+  end
+  
+  def test_get_on_local
+    EC2.expects(:ec2?).once.returns(false)
+    YAML.expects(:load_file).with("#{APP_ROOT}/config/ec2_userdata.yml").returns(YAML.load(local_yaml_userdata))
+    assert_equal "lisa", EC2::UserData["cluster"]
+    assert_equal 11300, EC2::UserData["queue_port"]
+  end
+  
+  def test_ec2_true
+    # Yes, on EC2
+    EC2.expects(:cmd_exec).with("which nslookup").returns("/usr/bin/nslookup")
+    EC2.expects(:cmd_exec).with("nslookup 169.254.169.254").returns(nslookup_on_ec2)
+    assert EC2.ec2?
+  end
+  
+  def test_ec2_false
+    # No, not on EC2
+    EC2.expects(:cmd_exec).with("which nslookup").returns("/usr/bin/nslookup")
+    EC2.expects(:cmd_exec).with("nslookup 169.254.169.254").returns(nslookup_on_local)
+    assert_equal false, EC2.ec2?
+  end
+
+  def test_ec2_ns_lookup_not_found
+    # nslookup not found
+    EC2.expects(:cmd_exec).with("which nslookup").returns("")
+    assert_raises(RuntimeError) { EC2.ec2? }
+  end
+
+
+  ## Helpers ##
+  def ec2_json_userdata
+    '{"queue_host":"lisa-queue.defensio.net","cluster":"lisa","queue_port":11300}'
+  end
+  
+  def local_yaml_userdata
+    "--- \nqueue_host: lisa-queue.defensio.net\nqueue_port: 11300\ncluster: lisa\n"
+  end
+  
+  def nslookup_on_ec2
+    "Server:		172.16.0.23\nAddress:	172.16.0.23#53\n\nNon-authoritative answer:\n254.169.254.169.in-addr.arpa	name = instance-data.ec2.internal.\n\nAuthoritative answers can be found from:\n"
+  end
+  
+  def nslookup_on_local
+    "Server:		192.168.1.1\nAddress:	192.168.1.1#53\n\n** server can't find 254.169.254.169.in-addr.arpa.: NXDOMAIN\n"
+  end
+end

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: ec2_userdata
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  version: "1.0"
+platform: ruby
+authors: 
+- Carl Mercier
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-26 00:00:00 -04:00
+default_executable: 
+dependencies: []
+
+description: A simple Ruby library that reads UserData on EC2 with graceful fallback when not running on EC2
+email: carl@carlmercier.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/ec2_userdata.rb
+- test/unit/ec2_userdata_test.rb
+has_rdoc: true
+homepage: http://carlmercier.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A simple Ruby library that reads UserData on EC2 with graceful fallback when not running on EC2
+test_files: []
+