engineyard-metadata 0.0.4 → 0.0.5

data/README.rdoc

@@ -1,23 +1,34 @@
 = engineyard-metadata
 
-Pulls metadata from EC2 and EngineYard so that your EngineYard Cloud instances know about each other.
+Presents a simple, unchanging interface to get metadata about your EngineYard AppCloud instances running on Amazon EC2.
 
 == Purpose
 
-To define an unchanging interface to useful metadata (passwords, IP addresses, etc.) that is otherwise buried deep inside EngineYard's chef config files and EC2 API calls.
+To define an unchanging interface to useful metadata (passwords, IP addresses, etc.) that is otherwise buried deep inside EngineYard's chef config files and various API calls.
 
 == Examples
 
 * Get a dynamically updated list of all running app servers so that you can pool memcached over all of them. (<tt>EY::Metadata.app_servers</tt>)
 * Get the current database password so that you can write a script that connects to it. (<tt>EY::Metadata.database_password</tt>)
 
+Get the full method list in {the engineyard-metadata rdoc}[http://rdoc.info/github/seamusabshere/engineyard-metadata].
+
 == Use
 
-Get the full method list in {the engineyard-metadata rdoc}[http://rdoc.info/github/seamusabshere/engineyard-metadata].
+=== From the inside
+
+When you're executing the gem from your instances, you don't have to configure anything. Just require the gem.
+
+=== From the outside
+
+You need to provide...
+
+* <tt>ENV['EY_CLOUD_TOKEN']</tt> or have <tt>~/.eyrc</tt>
+* <tt>ENV['REPOSITORY_URI']</tt> or execute the gem from the local copy of your application's repo.
 
-Metadata getters are defined directly on <tt>EY::Metadata</tt>. Even if EngineYard changes the structure of the config files or Amazon EC2's API changes, these methods will stay the same.
+=== Where the methods are defined
 
-This only runs on EngineYard AppCloud instances (running on Amazon EC2).
+Metadata getters are defined directly on <tt>EY::Metadata</tt> (which in turn delegates out to various adapters). Even if EngineYard changes the structure of the config files or Amazon EC2's API changes, these methods will stay the same.
 
   [...]
   >> require 'rubygems'
@@ -26,8 +37,6 @@ This only runs on EngineYard AppCloud instances (running on Amazon EC2).
   [...]
   >> EY::Metadata.database_host
   => "external_db_master.compute-1.amazonaws.com"
-  >> EY::Metadata.database_password
-  => "foobarfoo"
   >> EY::Metadata.app_servers
   => [ 'app_1.compute-1.amazonaws.com' , 'app_master.compute-1.amazonaws.com' ]
   >> EY::Metadata.db_servers

data/Rakefile

@@ -11,6 +11,7 @@ begin
     gem.homepage = "http://github.com/seamusabshere/engineyard-metadata"
     gem.authors = ["Seamus Abshere"]
     gem.add_dependency 'activesupport', '>=2.3.4'
+    gem.add_dependency 'nap', '>=0.4'
     gem.add_development_dependency "fakeweb"
     gem.add_development_dependency "fakefs"
     gem.add_development_dependency "rspec", "~>1"

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/engineyard-metadata.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{engineyard-metadata}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Seamus Abshere"]
-  s.date = %q{2010-10-11}
+  s.date = %q{2010-10-14}
   s.description = %q{Pulls metadata from EC2 and EngineYard so that your EngineYard AppCloud (Amazon EC2) instances know about each other.}
   s.email = %q{seamus@abshere.net}
   s.extra_rdoc_files = [
@@ -27,10 +27,14 @@ Gem::Specification.new do |s|
      "lib/engineyard-metadata.rb",
      "lib/engineyard-metadata/amazon_ec2_api.rb",
      "lib/engineyard-metadata/chef_dna.rb",
+     "lib/engineyard-metadata/engine_yard_cloud_api.rb",
+     "lib/engineyard-metadata/insider.rb",
      "lib/engineyard-metadata/metadata.rb",
+     "lib/engineyard-metadata/outsider.rb",
      "spec/metadata_spec.rb",
      "spec/spec_helper.rb",
-     "spec/support/dna.json"
+     "spec/support/dna.json",
+     "spec/support/engine_yard_cloud_api_response.json"
   ]
   s.homepage = %q{http://github.com/seamusabshere/engineyard-metadata}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -48,17 +52,20 @@ Gem::Specification.new do |s|
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<activesupport>, [">= 2.3.4"])
+      s.add_runtime_dependency(%q<nap>, [">= 0.4"])
       s.add_development_dependency(%q<fakeweb>, [">= 0"])
       s.add_development_dependency(%q<fakefs>, [">= 0"])
       s.add_development_dependency(%q<rspec>, ["~> 1"])
     else
       s.add_dependency(%q<activesupport>, [">= 2.3.4"])
+      s.add_dependency(%q<nap>, [">= 0.4"])
       s.add_dependency(%q<fakeweb>, [">= 0"])
       s.add_dependency(%q<fakefs>, [">= 0"])
       s.add_dependency(%q<rspec>, ["~> 1"])
     end
   else
     s.add_dependency(%q<activesupport>, [">= 2.3.4"])
+    s.add_dependency(%q<nap>, [">= 0.4"])
     s.add_dependency(%q<fakeweb>, [">= 0"])
     s.add_dependency(%q<fakefs>, [">= 0"])
     s.add_dependency(%q<rspec>, ["~> 1"])

data/lib/engineyard-metadata/amazon_ec2_api.rb

@@ -2,6 +2,7 @@ require 'open-uri'
 
 module EY
   module Metadata
+    # An adapter that reads from Amazon EC2's metadata web service, which is only available from cloud instances.
     class AmazonEc2Api
       # The present instance's Amazon Ec2 instance id.
       def present_instance_id

data/lib/engineyard-metadata/chef_dna.rb

@@ -8,89 +8,90 @@ end if ActiveSupport::VERSION::MAJOR == 3
 
 module EY
   module Metadata
+    # An adapter that reads from /etc/chef/dna.json, which is only available on cloud instances.
     class ChefDna
       PATH = '/etc/chef/dna.json'
-      MYSQL_BIN = '/usr/bin/mysql'
-      MYSQLDUMP_BIN = '/usr/bin/mysqldump'
-      
+
       def data # :nodoc:
         @data ||= ActiveSupport::JSON.decode File.read(PATH)
       end
-    
+  
       # The present instance's role
       def present_instance_role
         data['instance_role']
       end
-      
+    
       # The present instance's public hostname.
       def present_public_hostname
         data['engineyard']['environment']['instances'].detect { |i| i['id'] == EY::Metadata.present_instance_id }['public_hostname']
       end
-    
+  
       # Currently the same as the SSH password.
       def database_password
         data['users'][0]['password']
       end
-      
+    
       # Currently the same as the SSH username.
       def database_username
         data['users'][0]['username']
       end
-      
+    
       # For newly deployed applications, equal to the application name.
       def database_name
         data['engineyard']['environment']['apps'][0]['database_name']
       end
-      
+    
       # Public hostname where you should connect to the database.
       #
       # Currently the db master public hostname.
       def database_host
-        data['db_host']
+        db_master
       end
-    
+  
       # SSH username.
       def ssh_username
         data['engineyard']['environment']['ssh_username']
       end
-      
+    
       # SSH password.
       def ssh_password
         data['engineyard']['environment']['ssh_password']
       end
-    
+  
       # The public hostnames of all the app servers.
       #
       # If you're on a solo app, it counts the solo as an app server.
       def app_servers
         data['engineyard']['environment']['instances'].select { |i| %w{ app_master app solo }.include? i['role'] }.map { |i| i['public_hostname'] }.sort
       end
-      
+    
       # The public hostnames of all the app slaves.
       def app_slaves
         data['engineyard']['environment']['instances'].select { |i| %w{ app }.include? i['role'] }.map { |i| i['public_hostname'] }.sort
       end
-    
+  
       # The public hostnames of all the db servers.
       #
       # If you're on a solo app, it counts the solo as a db server.
       def db_servers
         data['engineyard']['environment']['instances'].select { |i| %w{ db_master db_slave solo }.include? i['role'] }.map { |i| i['public_hostname'] }.sort
       end
-    
+  
       # The public hostnames of all the db slaves.
       def db_slaves
         data['engineyard']['environment']['instances'].select { |i| %w{ db_slave }.include? i['role'] }.map { |i| i['public_hostname'] }.sort
       end
-    
+  
       # The public hostnames of all the utility servers.
       #
       # If you're on a solo app, it counts the solo as a utility.
       def utilities
         data['engineyard']['environment']['instances'].select { |i| %w{ util solo }.include? i['role'] }.map { |i| i['public_hostname'] }.sort
       end
-    
+  
       # The public hostname of the app_master.
+      #
+      # If you're on a solo app, it counts the solo as the app_master.
       def app_master
         if x = data['engineyard']['environment']['instances'].detect { |i| i['role'] == 'app_master' }
           x['public_hostname']
@@ -98,8 +99,10 @@ module EY
           solo
         end
       end
-    
-      # The public hostname of the db_master,
+  
+      # The public hostname of the db_master.
+      #
+      # If you're on a solo app, it counts the solo as the app_master.
       def db_master
         if x = data['engineyard']['environment']['instances'].detect { |i| i['role'] == 'db_master' }
           x['public_hostname']
@@ -107,28 +110,33 @@ module EY
           solo
         end
       end
-      
+    
       # The public hostname of the solo.
       def solo
         if x = data['engineyard']['environment']['instances'].detect { |i| i['role'] == 'solo' }
           x['public_hostname']
         end
       end
-      
+
       # The shell command for mysql, including username, password, hostname and database
       def mysql_command
-        "#{MYSQL_BIN} -h #{database_host} -u #{database_username} -p#{database_password} #{database_name}"
+        "/usr/bin/mysql -h #{database_host} -u #{database_username} -p#{database_password} #{database_name}"
       end
 
       # The shell command for mysql, including username, password, hostname and database
       def mysqldump_command
-        "#{MYSQLDUMP_BIN} -h #{database_host} -u #{database_username} -p#{database_password} #{database_name}"
+        "/usr/bin/mysqldump -h #{database_host} -u #{database_username} -p#{database_password} #{database_name}"
       end
-      
+    
       # The name of the EngineYard AppCloud environment.
       def environment_name
         data['environment']['name']
       end
+      
+      # The stack in use, like nginx_passenger.
+      def stack_name
+        data['engineyard']['environment']['stack_name']
+      end
     end
   end
 end

data/lib/engineyard-metadata/engine_yard_cloud_api.rb

@@ -0,0 +1,151 @@
+require 'etc'
+require 'yaml'
+require 'rest' # from nap gem
+require 'active_support'
+require 'active_support/version'
+%w{
+  active_support/json
+}.each do |active_support_3_requirement|
+  require active_support_3_requirement
+end if ActiveSupport::VERSION::MAJOR == 3
+
+module EY
+  module Metadata
+    # An adapter that reads from the public EngineYard Cloud API (https://cloud.engineyard.com). Available from anywhere.
+    #
+    # See README for what environment variables and/or files you need to have in place for this to work.
+    class EngineYardCloudApi
+      URL = 'https://cloud.engineyard.com/api/v2/environments'
+      
+      # Currently the same as the SSH username.
+      def database_username
+        data['ssh_username']
+      end
+      
+      # The username for connecting by SSH.
+      def ssh_username
+        data['ssh_username']
+      end
+      
+      # Currently the same as the app name, at least for recently-created environments.
+      #
+      # It used to be named after the environment.
+      def database_name
+        data['apps'][0]['name']
+      end
+      
+      # The hostname of the database host.
+      def database_host
+        db_master
+      end
+
+      # The public hostname of the db_master.
+      #
+      # If you're on a solo app, it counts the solo as the app_master.
+      def db_master
+        if x = data['instances'].detect { |i| i['role'] == 'db_master' }
+          x['public_hostname']
+        else
+          solo
+        end
+      end
+      
+      # The public hostnames of all the app servers.
+      #
+      # If you're on a solo app, it counts the solo as an app server.
+      def app_servers
+        data['instances'].select { |i| %w{ app_master app solo }.include? i['role'] }.map { |i| i['public_hostname'] }.sort
+      end
+      
+      # The public hostnames of all the db servers.
+      #
+      # If you're on a solo app, it counts the solo as a db server.
+      def db_servers
+        data['instances'].select { |i| %w{ db_master db_slave solo }.include? i['role'] }.map { |i| i['public_hostname'] }.sort
+      end
+      
+      # The public hostnames of all the utility servers.
+      #
+      # If you're on a solo app, it counts the solo as a utility.
+      def utilities
+        data['instances'].select { |i| %w{ util solo }.include? i['role'] }.map { |i| i['public_hostname'] }.sort
+      end
+      
+      # The public hostnames of all the app slaves.
+      def app_slaves
+        data['instances'].select { |i| %w{ app }.include? i['role'] }.map { |i| i['public_hostname'] }.sort
+      end
+  
+      # The public hostnames of all the db slaves.
+      def db_slaves
+        data['instances'].select { |i| %w{ db_slave }.include? i['role'] }.map { |i| i['public_hostname'] }.sort
+      end
+      
+      # The public hostname of the app_master.
+      #
+      # If you're on a solo app, it counts the solo as the app_master.
+      def app_master
+        if x = data['instances'].detect { |i| i['role'] == 'app_master' }
+          x['public_hostname']
+        else
+          solo
+        end
+      end
+
+      # The public hostname of the solo.
+      def solo
+        if x = data['instances'].detect { |i| i['role'] == 'solo' }
+          x['public_hostname']
+        end
+      end
+
+      # The name of the EngineYard AppCloud environment.
+      def environment_name
+        data['name']
+      end
+      
+      # The stack in use, like nginx_passenger.
+      def stack_name
+        data['stack_name']
+      end
+      
+      # The secret API token to access https://cloud.engineyard.com
+      def ey_cloud_token
+        @ey_cloud_token ||= if ENV['EY_CLOUD_TOKEN'].to_s.strip.length > 0
+          ENV['EY_CLOUD_TOKEN']
+        elsif File.exist? EY::Metadata.eyrc_path
+          YAML.load(File.read(EY::Metadata.eyrc_path))['api_token']
+        else
+          raise RuntimeError, "[engineyard-metadata gem] You need to download #{eyrc_path} or set ENV['EY_CLOUD_TOKEN']"
+        end
+      end
+      
+      # The URL that EngineYard has on file for your application.
+      def repository_uri
+        @repository_uri ||= if ENV['REPOSITORY_URI'].to_s.strip.length > 0
+          ENV['REPOSITORY_URI']
+        elsif File.exist? EY::Metadata.git_config_path
+          `git config --get remote.origin.url`
+        else
+          raise RuntimeError, "[engineyard-metadata gem] You need to be inside a app's git repo or set ENV['REPOSITORY_URI']"
+        end
+      end
+      
+      def data
+        return @data if @data.is_a? Hash
+        raw_json = REST.get(URL, 'X-EY-Cloud-Token' => ey_cloud_token).body
+        raw_data = ActiveSupport::JSON.decode raw_json
+        catch :found_environment_by_repository_uri do
+          raw_data['environments'].each do |environment_hsh|
+            if environment_hsh['apps'].any? { |app_hsh| app_hsh['repository_uri'] == repository_uri }
+              @data = environment_hsh
+              throw :found_environment_by_repository_uri
+            end
+          end
+        end
+        raise RuntimeError, "[engineyard-metadata gem] Couldn't find an EngineYard environment with the repository uri #{repository_uri}" unless @data.is_a? Hash
+        @data
+      end
+    end
+  end
+end

data/lib/engineyard-metadata/insider.rb

@@ -0,0 +1,35 @@
+module EY
+  module Metadata
+    # This gets pulled in when you're running directly on a cloud instance.
+    module Insider
+      DELEGATED_TO_AMAZON_EC2_API = %w{
+        present_instance_id
+        present_security_group
+      }
+    
+      DELEGATED_TO_CHEF_DNA = KEYS - DELEGATED_TO_AMAZON_EC2_API
+
+      DELEGATED_TO_AMAZON_EC2_API.each do |name|
+        define_method name do
+          amazon_ec2_api.send name
+        end
+      end
+
+      DELEGATED_TO_CHEF_DNA.each do |name|
+        define_method name do
+          chef_dna.send name
+        end
+      end
+      
+      # An adapter that reads from the EngineYard AppCloud /etc/chef/dna.json file.
+      def chef_dna
+        @chef_dna ||= ChefDna.new
+      end
+
+      # An adapter that reads from Amazon's EC2 API.
+      def amazon_ec2_api
+        @amazon_ec2_api ||= AmazonEc2Api.new
+      end
+    end
+  end
+end

data/lib/engineyard-metadata/metadata.rb

@@ -1,11 +1,13 @@
 module EY
+  # All methods are defined on this module. For example, you're supposed to say
+  #
+  #   EY::Metadata.database_username
+  #
+  # instead of trying to call it from a particular adapter.
   module Metadata
-    DELEGATED_TO_AMAZON_EC2_API = %w{
+    KEYS = %w{
       present_instance_id
       present_security_group
-    }
-        
-    DELEGATED_TO_CHEF_DNA = %w{
       present_instance_role
       present_public_hostname
       database_password
@@ -25,33 +27,24 @@ module EY
       db_slaves
       solo
       environment_name
+      stack_name
     }
     
-    DELEGATED_TO_AMAZON_EC2_API.each do |name|
-      EY::Metadata.send :define_method, name do
-        amazon_ec2_api.send name
-      end
-    end
-    
-    DELEGATED_TO_CHEF_DNA.each do |name|
-      EY::Metadata.send :define_method, name do
-        chef_dna.send name
-      end
+    # This gets raised when you can't get a particular piece of metadata from the execution environment you're in.
+    class CannotGetFromHere < RuntimeError
     end
-
-    extend self
     
+    autoload :Insider, 'engineyard-metadata/insider'
+    autoload :Outsider, 'engineyard-metadata/outsider'
     autoload :ChefDna, 'engineyard-metadata/chef_dna'
     autoload :AmazonEc2Api, 'engineyard-metadata/amazon_ec2_api'
+    autoload :EngineYardCloudApi, 'engineyard-metadata/engine_yard_cloud_api'
     
-    # An adapter that reads from the EngineYard AppCloud /etc/chef/dna.json file.
-    def chef_dna
-      @chef_dna ||= EY::Metadata::ChefDna.new
-    end
-    
-    # An adapter that reads from Amazon's EC2 API.
-    def amazon_ec2_api
-      @amazon_ec2_api ||= EY::Metadata::AmazonEc2Api.new
+    # this is a pretty sloppy way of detecting whether we're on ec2
+    if File.exist? '/etc/chef/dna.json'
+      extend Insider
+    else
+      extend Outsider
     end
   end
 end

data/lib/engineyard-metadata/outsider.rb

@@ -0,0 +1,35 @@
+module EY
+  module Metadata
+    # This gets pulled in when you're running from your developer machine (i.e., not on a cloud instance).
+    module Outsider
+      IMPOSSIBLE = KEYS.grep(/present/) + KEYS.grep(/password/) + KEYS.grep(/mysql/)
+      
+      POSSIBLE = KEYS - IMPOSSIBLE
+      
+      IMPOSSIBLE.each do |name|
+        define_method name do
+          raise CannotGetFromHere
+        end
+      end
+      
+      POSSIBLE.each do |name|
+        define_method name do
+          engine_yard_cloud_api.send name
+        end
+      end
+      
+      def eyrc_path
+        File.join File.expand_path("~#{Etc.getpwuid.name}"), '.eyrc'
+      end
+      
+      def git_config_path
+        File.join Dir.pwd, '.git', 'config'
+      end
+
+      # An adapter that reads from the public EngineYard Cloud API (https://cloud.engineyard.com)
+      def engine_yard_cloud_api
+        @engine_yard_cloud_api ||= EngineYardCloudApi.new
+      end
+    end
+  end
+end

data/spec/metadata_spec.rb

@@ -1,80 +1,42 @@
 require 'spec_helper'
 
-describe EY do
-  it 'has a FakeFS dna.json' do
-    File.exist?('/etc/chef/dna.json').should == true
-  end
-end
-
-describe EY::Metadata do
-  it 'gets the present instance ID' do
-    EY::Metadata.present_instance_id.should == PRESENT_INSTANCE_ID
-  end
-  
-  it 'gets the present instance role (as a string)' do
-    EY::Metadata.present_instance_role.should == 'app_master'
-  end
-  
-  it 'gets the present public hostname' do
-    EY::Metadata.present_public_hostname.should == PRESENT_PUBLIC_HOSTNAME
-  end
-  
-  it 'gets the present security group' do
-    EY::Metadata.present_security_group.should == PRESENT_SECURITY_GROUP
-  end
-  
-  it 'gets the database password' do
-    EY::Metadata.database_password.should == 'USERS-0-PASSWORD'
-  end
-  
+shared_examples_for "all execution environments" do
   it 'gets the database username' do
-    EY::Metadata.database_username.should == 'USERS-0-USERNAME'
+    EY::Metadata.database_username.should == 'FAKE_SSH_USERNAME'
   end
 
   it 'gets the database name' do
-    EY::Metadata.database_name.should == 'APPS-0-DATABASE_NAME'
+    EY::Metadata.database_name.should == 'FAKE_APP_NAME'
   end
 
   it 'gets the database host' do
-    EY::Metadata.database_host.should == 'external_db_master.compute-1.amazonaws.com'
+    EY::Metadata.database_host.should == 'FAKE_DB_MASTER_PUBLIC_HOSTNAME'
   end
-  
+
   it 'gets the ssh username' do
-    EY::Metadata.ssh_username.should == 'SSH-USERNAME'
-  end
-  
-  it 'gets the ssh password' do
-    EY::Metadata.ssh_password.should == 'SSH-PASSWORD'
+    EY::Metadata.ssh_username.should == 'FAKE_SSH_USERNAME'
   end
   
   it 'gets the app server hostnames' do
     EY::Metadata.app_servers.should == [ 'app_1.compute-1.amazonaws.com' , 'app_master.compute-1.amazonaws.com' ]
   end
-  
+
   it 'gets the db server hostnames' do
-    EY::Metadata.db_servers.should == [ 'db_master.compute-1.amazonaws.com', 'db_slave_1.compute-1.amazonaws.com' ]
+    EY::Metadata.db_servers.should == [ 'FAKE_DB_MASTER_PUBLIC_HOSTNAME', 'db_slave_1.compute-1.amazonaws.com' ]
   end
-  
+
   it 'gets the utilities hostnames' do
-    EY::Metadata.utilities.should == [ 'util_1.compute-1.amazonaws.com' ]
+    EY::Metadata.utilities.should == [ 'FAKE_UTIL_1_PUBLIC_HOSTNAME' ]
   end
 
   it 'gets the app master hostname' do
     EY::Metadata.app_master.should == 'app_master.compute-1.amazonaws.com'
   end
-  
+
   it 'gets the db master hostname' do
-    EY::Metadata.db_master.should == 'db_master.compute-1.amazonaws.com'
+    EY::Metadata.db_master.should == 'FAKE_DB_MASTER_PUBLIC_HOSTNAME'
   end
-  
-  it 'gets the mysql command' do
-    EY::Metadata.mysql_command.should == '/usr/bin/mysql -h external_db_master.compute-1.amazonaws.com -u USERS-0-USERNAME -pUSERS-0-PASSWORD APPS-0-DATABASE_NAME'
-  end
-  
-  it 'gets the mysqldump command' do
-    EY::Metadata.mysqldump_command.should == '/usr/bin/mysqldump -h external_db_master.compute-1.amazonaws.com -u USERS-0-USERNAME -pUSERS-0-PASSWORD APPS-0-DATABASE_NAME'
-  end
-  
+
   it 'gets the db slave hostnames' do
     EY::Metadata.db_slaves.should == [ 'db_slave_1.compute-1.amazonaws.com' ]
   end
@@ -82,12 +44,134 @@ describe EY::Metadata do
   it 'gets the app slave hostnames' do
     EY::Metadata.app_slaves.should == [ 'app_1.compute-1.amazonaws.com' ]
   end
-  
+
   it 'gets the solo hostname' do
     EY::Metadata.solo.should == nil
   end
-  
+
   it 'gets the environment name' do
-    EY::Metadata.environment_name.should == 'APP-NAME_production'
+    EY::Metadata.environment_name.should == 'FAKE_ENVIRONMENT_NAME'
+  end
+  
+  it 'gets the stack name' do
+    EY::Metadata.stack_name.should == 'FAKE_STACK_NAME'
+  end
+end
+
+describe 'EY::Metadata' do
+  describe "being executed from a developer/administrator's local machine" do
+    before(:all) do
+      pretend_we_are_on_a_developer_machine
+      # forcibly reload metadata.rb, so that it can extend itself based on its execution environment
+      load File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'engineyard-metadata', 'metadata.rb'))
+    end
+
+    after(:all) do
+      stop_pretending
+    end
+    
+    it 'cannot get the present instance ID' do
+      lambda {
+        EY::Metadata.present_instance_id
+      }.should raise_error(EY::Metadata::CannotGetFromHere)
+    end
+
+    it 'cannot get the present instance role (as a string)' do
+      lambda {
+        EY::Metadata.present_instance_role
+      }.should raise_error(EY::Metadata::CannotGetFromHere)
+    end
+    
+    it 'cannot get the present public hostname' do
+      lambda {
+        EY::Metadata.present_public_hostname
+      }.should raise_error(EY::Metadata::CannotGetFromHere)
+    end
+    
+    it 'cannot get the present security group' do
+      lambda {
+        EY::Metadata.present_security_group
+      }.should raise_error(EY::Metadata::CannotGetFromHere)
+    end
+
+    it 'cannot get the database password' do
+      lambda {
+        EY::Metadata.database_password
+      }.should raise_error(EY::Metadata::CannotGetFromHere)
+    end
+
+    it 'cannot get the ssh password' do
+      lambda {
+        EY::Metadata.ssh_password
+      }.should raise_error(EY::Metadata::CannotGetFromHere)
+    end
+    
+    it 'cannot get the mysql command' do
+      lambda {
+        EY::Metadata.mysql_command
+      }.should raise_error(EY::Metadata::CannotGetFromHere)
+    end
+    
+    it 'cannot get the mysqldump command' do
+      lambda {
+        EY::Metadata.mysqldump_command
+      }.should raise_error(EY::Metadata::CannotGetFromHere)
+    end
+    
+    it 'gets the raw EngineYard Cloud API data' do
+      EY::Metadata.engine_yard_cloud_api.data.should be_a(Hash)
+    end
+
+    it_should_behave_like "all execution environments"
+  end
+  
+  describe "being executed on an EngineYard AppCloud (i.e. Amazon EC2) instance" do
+    before(:all) do
+      pretend_we_are_on_an_engineyard_appcloud_ec2_instance
+        # forcibly reload metadata.rb, so that it can extend itself based on its execution environment
+      load File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib', 'engineyard-metadata', 'metadata.rb'))
+    end
+    
+    after(:all) do
+      stop_pretending
+    end
+    
+    it_should_behave_like "all execution environments"
+    
+    it 'has a FakeFS dna.json' do
+      File.exist?('/etc/chef/dna.json').should == true
+    end
+    
+    it 'gets the present instance ID' do
+      EY::Metadata.present_instance_id.should == PRESENT_INSTANCE_ID
+    end
+
+    it 'gets the present instance role (as a string)' do
+      EY::Metadata.present_instance_role.should == 'app_master'
+    end
+
+    it 'gets the present public hostname' do
+      EY::Metadata.present_public_hostname.should == PRESENT_PUBLIC_HOSTNAME
+    end
+
+    it 'gets the present security group' do
+      EY::Metadata.present_security_group.should == PRESENT_SECURITY_GROUP
+    end
+    
+    it 'gets the database password' do
+      EY::Metadata.database_password.should == 'USERS-0-PASSWORD'
+    end
+    
+    it 'gets the ssh password' do
+      EY::Metadata.ssh_password.should == 'SSH-PASSWORD'
+    end
+    
+    it 'gets the mysql command' do
+      EY::Metadata.mysql_command.should =~ %r{mysql -h FAKE_DB_MASTER_PUBLIC_HOSTNAME -u FAKE_SSH_USERNAME -pUSERS-0-PASSWORD FAKE_APP_NAME}
+    end
+
+    it 'gets the mysqldump command' do
+      EY::Metadata.mysqldump_command.should =~ %r{mysqldump -h FAKE_DB_MASTER_PUBLIC_HOSTNAME -u FAKE_SSH_USERNAME -pUSERS-0-PASSWORD FAKE_APP_NAME}
+    end
   end
 end

data/spec/spec_helper.rb

@@ -3,38 +3,51 @@ require 'spec'
 # require 'ruby-debug'
 # assumes active-support 3
 require 'active_support/json/encoding'
+require 'fakeweb'
+require 'fakefs/safe'
 
 PRESENT_PUBLIC_HOSTNAME = 'app_master.compute-1.amazonaws.com'
 PRESENT_SECURITY_GROUP = 'ey-data1_production-1-2-3'
 PRESENT_INSTANCE_ID = 'i-deadbeef'
+REPOSITORY_URI = 'FAKE_REPOSITORY_URI'
 
-require 'fakeweb'
-FakeWeb.allow_net_connect = false
-# fake call to amazon ec2 api to get present security group
-FakeWeb.register_uri  :get,
-                      "http://169.254.169.254/latest/meta-data/security-groups",
-                      :status => ["200", "OK"],
-                      :body => PRESENT_SECURITY_GROUP
+def pretend_we_are_on_a_developer_machine
+  ENV['REPOSITORY_URI'] = REPOSITORY_URI
+  FakeWeb.allow_net_connect = false
+  FakeWeb.register_uri  :get,
+                        "https://cloud.engineyard.com/api/v2/environments",
+                        :status => ["200", "OK"],
+                        :body => File.read(File.join(File.dirname(__FILE__), 'support', 'engine_yard_cloud_api_response.json'))
+  # FakeFS.activate!
+end
 
-# fake call to amazon ec2 api to get present instance id
-FakeWeb.register_uri  :get,
-                      "http://169.254.169.254/latest/meta-data/instance-id",
-                      :status => ["200", "OK"],
-                      :body => PRESENT_INSTANCE_ID
 
-dna_json = File.read File.join(File.dirname(__FILE__), 'support', 'dna.json')
-require 'fakefs'
-FileUtils.mkdir_p '/etc/chef'
-File.open '/etc/chef/dna.json', 'w' do |f|
-  f.write dna_json
-end
+def pretend_we_are_on_an_engineyard_appcloud_ec2_instance
+  FakeWeb.allow_net_connect = false
+  # fake call to amazon ec2 api to get present security group
+  FakeWeb.register_uri  :get,
+                        "http://169.254.169.254/latest/meta-data/security-groups",
+                        :status => ["200", "OK"],
+                        :body => PRESENT_SECURITY_GROUP
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'engineyard-metadata'
+  # fake call to amazon ec2 api to get present instance id
+  FakeWeb.register_uri  :get,
+                        "http://169.254.169.254/latest/meta-data/instance-id",
+                        :status => ["200", "OK"],
+                        :body => PRESENT_INSTANCE_ID
 
-# Spec::Runner.configure do |config|
-#   config.before(:all) do
-#     
-#   end
-# end
+  # first read a file from the real file system...
+  dna_json = File.read File.join(File.dirname(__FILE__), 'support', 'dna.json')
+  # ... then turn on the fakefs
+  FakeFS.activate!
+  FileUtils.mkdir_p '/etc/chef'
+  File.open '/etc/chef/dna.json', 'w' do |f|
+    f.write dna_json
+  end
+end
+
+def stop_pretending
+  FakeFS.deactivate!
+  FakeWeb.clean_registry
+  FakeWeb.allow_net_connect = true
+end

data/spec/support/dna.json

@@ -15,7 +15,7 @@
   "internal_ssh_private_key": "-----BEGIN RSA PRIVATE KEY-----\nPRIVATE-KEY\n-----END RSA PRIVATE KEY-----\n",
   "utility_instances": [
     {
-      "name": "APP-NAME_production_util_1",
+      "name": "FAKE_ENVIRONMENT_NAME_util_1",
       "hostname": "internal_util_1.compute-1.internal"
     }
   ],
@@ -77,7 +77,7 @@
       "vhosts": [
         {
           "name": "_",
-          "role": "APP-NAME_production"
+          "role": "FAKE_ENVIRONMENT_NAME"
         }
       ]
     }
@@ -86,15 +86,15 @@
   "users": [
     {
       "gid": "1000",
-      "username": "USERS-0-USERNAME",
+      "username": "FAKE_SSH_USERNAME",
       "uid": "1000",
       "comment": "",
       "password": "USERS-0-PASSWORD"
     }
   ],
   "environment": {
-    "name": "APP-NAME_production",
-    "stack": "nginx_passenger",
+    "name": "FAKE_ENVIRONMENT_NAME",
+    "stack": "FAKE_STACK_NAME",
     "framework_env": "production"
   },
   "master_app_server": {
@@ -107,7 +107,7 @@
       "name": "dev-libs/oniguruma"
     }
   ],
-  "db_host": "external_db_master.compute-1.amazonaws.com",
+  "db_host": "FAKE_DB_HOST",
   "haproxy": {
     "username": "HAPROXY-USERNAME",
     "password": "HAPROXY-PASSWORD"
@@ -116,12 +116,12 @@
     "environment": {
       "apps": [
         {
-          "name": "APP-NAME",
+          "name": "FAKE_APP_NAME",
           "newrelic": false,
           "components": [
 
           ],
-          "database_name": "APPS-0-DATABASE_NAME",
+          "database_name": "FAKE_APP_NAME",
           "migration_command": "rake db:migrate",
           "type": "rack",
           "repository_name": "APPS-0-REPOSITORY_NAME",
@@ -153,7 +153,7 @@
         }
       ],
       "aws_secret_key": "AWS-SECRET-KEY",
-      "name": "APP-NAME_production",
+      "name": "FAKE_ENVIRONMENT_NAME",
       "ssh_keys": [
 		    "ssh-rsa AAAAB3NzaC1yc2EAAAAB key-a",
 		    "ssh-rsa AAAAB3NzaC1yc2EAAAAB key-b",
@@ -192,7 +192,7 @@
         },
         {
           "name": null,
-          "public_hostname": "db_master.compute-1.amazonaws.com",
+          "public_hostname": "FAKE_DB_MASTER_PUBLIC_HOSTNAME",
           "components": [
             {
               "key": "ssmtp"
@@ -222,7 +222,7 @@
         },
         {
           "name": "foobarfoo",
-          "public_hostname": "util_1.compute-1.amazonaws.com",
+          "public_hostname": "FAKE_UTIL_1_PUBLIC_HOSTNAME",
           "components": [
             {
               "key": "ssmtp"
@@ -242,7 +242,7 @@
       "backup_interval": 24,
       "admin_ssh_key": "ssh-rsa AAAAB3NzaC1 ey-cloud-production\n",
       "internal_ssh_public_key": "ssh-rsa AAAAB3NzaC1yc2EAAAAB \n",
-      "ssh_username": "SSH-USERNAME",
+      "ssh_username": "FAKE_SSH_USERNAME",
       "internal_ssh_private_key": "-----BEGIN RSA PRIVATE KEY-----\nINTERNAL-SSH-PRIVATE-KEY\n-----END RSA PRIVATE KEY-----\n",
       "mailserver": "smtp.engineyard.com",
       "components": [
@@ -255,7 +255,7 @@
 
       ],
       "backup_window": 10,
-      "stack_name": "nginx_passenger",
+      "stack_name": "FAKE_STACK_NAME",
       "alert_email": "ALERT-EMAIL",
       "ssh_password": "SSH-PASSWORD",
       "db_stack_name": "mysql",

data/spec/support/engine_yard_cloud_api_response.json

@@ -0,0 +1,28 @@
+{"environments":
+	[
+		{"app_master":
+		{"public_hostname":"app_master.compute-1.amazonaws.com","name":null,"status":"running","amazon_id":"i-aaaaaaaa","role":"app_master","id":11111
+		},"ssh_username":"FAKE_SSH_USERNAME","stack_name":"FAKE_STACK_NAME","framework_env":"production","name":"FAKE_ENVIRONMENT_NAME","account":
+		{"name":"FAKE_ACCOUNT_NAME","id":12345
+		},"instances_count":5,"apps":
+		[
+		{"repository_uri":"FAKE_REPOSITORY_URI","name":"FAKE_APP_NAME","account":
+		{"name":"FAKE_ACCOUNT_NAME","id":12345
+		},"id":292301
+		}
+		],"id":382918,"instances":
+		[
+		{"public_hostname":"app_master.compute-1.amazonaws.com","name":null,"status":"running","amazon_id":"i-aaaaaaaa","role":"app_master","id":11111
+		},
+		{"public_hostname":"app_1.compute-1.amazonaws.com","name":null,"status":"running","amazon_id":"i-bbbbbbbb","role":"app","id":22222
+		},
+		{"public_hostname":"FAKE_DB_MASTER_PUBLIC_HOSTNAME","name":null,"status":"running","amazon_id":"i-cccccccc","role":"db_master","id":33333
+		},
+		{"public_hostname":"db_slave_1.compute-1.amazonaws.com","name":null,"status":"running","amazon_id":"i-cccccccc","role":"db_slave","id":44444
+		},
+		{"public_hostname":"FAKE_UTIL_1_PUBLIC_HOSTNAME","name":"data1_production_util1","status":"running","amazon_id":"i-dddddddd","role":"util","id":55555
+		}
+		]
+		}
+	]
+}

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: engineyard-metadata
 version: !ruby/object:Gem::Version 
-  hash: 23
+  hash: 21
   prerelease: false
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Seamus Abshere
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-11 00:00:00 -05:00
+date: 2010-10-14 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -35,7 +35,7 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: fakeweb
+  name: nap
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -45,11 +45,12 @@ dependencies:
         hash: 3
         segments: 
         - 0
-        version: "0"
-  type: :development
+        - 4
+        version: "0.4"
+  type: :runtime
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: fakefs
+  name: fakeweb
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -63,9 +64,23 @@ dependencies:
   type: :development
   version_requirements: *id003
 - !ruby/object:Gem::Dependency 
-  name: rspec
+  name: fakefs
   prerelease: false
   requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -75,7 +90,7 @@ dependencies:
         - 1
         version: "1"
   type: :development
-  version_requirements: *id004
+  version_requirements: *id005
 description: Pulls metadata from EC2 and EngineYard so that your EngineYard AppCloud (Amazon EC2) instances know about each other.
 email: seamus@abshere.net
 executables: []
@@ -96,10 +111,14 @@ files:
 - lib/engineyard-metadata.rb
 - lib/engineyard-metadata/amazon_ec2_api.rb
 - lib/engineyard-metadata/chef_dna.rb
+- lib/engineyard-metadata/engine_yard_cloud_api.rb
+- lib/engineyard-metadata/insider.rb
 - lib/engineyard-metadata/metadata.rb
+- lib/engineyard-metadata/outsider.rb
 - spec/metadata_spec.rb
 - spec/spec_helper.rb
 - spec/support/dna.json
+- spec/support/engine_yard_cloud_api_response.json
 has_rdoc: true
 homepage: http://github.com/seamusabshere/engineyard-metadata
 licenses: []