engineyard-metadata 0.0.5 → 0.0.6

data/README.rdoc

@@ -11,20 +11,46 @@ To define an unchanging interface to useful metadata (passwords, IP addresses, e
 * 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].
+Here's the current method list:
+
+  EY::Metadata.present_instance_id     (only works from cloud instances)
+  EY::Metadata.present_security_group  (only works from cloud instances)
+  EY::Metadata.present_instance_role   (only works from cloud instances)
+  EY::Metadata.present_public_hostname (only works from cloud instances)
+  EY::Metadata.database_password       (only works from cloud instances)
+  EY::Metadata.database_username
+  EY::Metadata.database_name
+  EY::Metadata.database_host
+  EY::Metadata.ssh_username
+  EY::Metadata.ssh_password            (only works from cloud instances)
+  EY::Metadata.app_servers
+  EY::Metadata.db_servers
+  EY::Metadata.utilities
+  EY::Metadata.app_master
+  EY::Metadata.db_master
+  EY::Metadata.mysql_command           (only works from cloud instances)
+  EY::Metadata.mysqldump_command       (only works from cloud instances)
+  EY::Metadata.app_slaves
+  EY::Metadata.db_slaves
+  EY::Metadata.solo
+  EY::Metadata.environment_name
+  EY::Metadata.stack_name
+  EY::Metadata.repository_uri
 
 == Use
 
-=== From the inside
+See the rdoc at {the engineyard-metadata rdoc}[http://rubydoc.info/gems/engineyard-metadata].
+
+=== When you're executing this gem from INSIDE the cloud
 
 When you're executing the gem from your instances, you don't have to configure anything. Just require the gem.
 
-=== From the outside
+=== When you're executing this gem from OUTSIDE the cloud
 
-You need to provide...
+You must...
 
-* <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.
+* have <tt>~/.eyrc</tt> or set <tt>EY::Metadata.ey_cloud_token=</tt> or set <tt>ENV['EY_CLOUD_TOKEN']</tt>.
+* execute the gem from the local copy of your application's repo or set <tt>EY::Metadata.environment_name=</tt> or set <tt>ENV['EY_ENVIRONMENT_NAME']</tt>.
 
 === Where the methods are defined
 

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/engineyard-metadata.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{engineyard-metadata}
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Seamus Abshere"]

data/lib/engineyard-metadata/chef_dna.rb

@@ -40,6 +40,11 @@ module EY
       def database_name
         data['engineyard']['environment']['apps'][0]['database_name']
       end
+      
+      # The git repository that you told EngineYard to use for this application.
+      def repository_uri
+        data['engineyard']['environment']['apps'][0]['repository_name']
+      end
     
       # Public hostname where you should connect to the database.
       #

data/lib/engineyard-metadata/engine_yard_cloud_api.rb

@@ -1,5 +1,3 @@
-require 'etc'
-require 'yaml'
 require 'rest' # from nap gem
 require 'active_support'
 require 'active_support/version'
@@ -98,7 +96,7 @@ module EY
           x['public_hostname']
         end
       end
-
+      
       # The name of the EngineYard AppCloud environment.
       def environment_name
         data['name']
@@ -109,41 +107,29 @@ module EY
         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
+      # The git repository that you told EngineYard to use for this application.
+      def repository_uri
+        data['apps'][0]['repository_uri']
       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
+      def data_loaded?
+        @data.is_a? Hash
       end
       
       def data
-        return @data if @data.is_a? Hash
-        raw_json = REST.get(URL, 'X-EY-Cloud-Token' => ey_cloud_token).body
+        return @data if data_loaded?
+        raw_json = REST.get(URL, 'X-EY-Cloud-Token' => EY::Metadata.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
+        matching_environment_hshs = raw_data['environments'].select do |environment_hsh|
+          if EY::Metadata.environment_name
+            environment_hsh['name'] == EY::Metadata.environment_name
+          else
+            environment_hsh['apps'].any? { |app_hsh| app_hsh['repository_uri'] == repository_uri }
           end
         end
-        raise RuntimeError, "[engineyard-metadata gem] Couldn't find an EngineYard environment with the repository uri #{repository_uri}" unless @data.is_a? Hash
+        raise RuntimeError, "[engineyard-metadata gem] Found too many environments: #{matching_environment_hshs.map { |hsh| hsh['name'] }.join(', ')}" if matching_environment_hshs.length > 1
+        @data = matching_environment_hshs[0]
+        raise RuntimeError, "[engineyard-metadata gem] Couldn't find an EngineYard environment with the repository uri #{repository_uri}" unless data_loaded?
         @data
       end
     end

data/lib/engineyard-metadata/metadata.rb

@@ -28,6 +28,7 @@ module EY
       solo
       environment_name
       stack_name
+      repository_uri
     }
     
     # This gets raised when you can't get a particular piece of metadata from the execution environment you're in.

data/lib/engineyard-metadata/outsider.rb

@@ -1,18 +1,22 @@
+require 'etc'
+require 'yaml'
+
 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/)
+      LOCALLY_DETERMINED = %w{ environment_name repository_uri }
+      UNGETTABLE = KEYS.grep(/present/) + KEYS.grep(/password/) + KEYS.grep(/mysql/)
       
-      POSSIBLE = KEYS - IMPOSSIBLE
+      GETTABLE = KEYS - LOCALLY_DETERMINED - UNGETTABLE
       
-      IMPOSSIBLE.each do |name|
+      UNGETTABLE.each do |name|
         define_method name do
           raise CannotGetFromHere
         end
       end
       
-      POSSIBLE.each do |name|
+      GETTABLE.each do |name|
         define_method name do
           engine_yard_cloud_api.send name
         end
@@ -25,6 +29,68 @@ module EY
       def git_config_path
         File.join Dir.pwd, '.git', 'config'
       end
+      
+      def clear
+        @repository_uri = nil
+        @environment_name = nil
+        @ey_cloud_token = nil
+        @data = nil
+      end
+      
+      def environment_name=(str)
+        # clear this out in case it was inferred
+        @repository_uri = nil
+        # clear this out in case we're looking up a new environment
+        @data = nil
+        @environment_name = str
+      end
+      
+      # The name of the EngineYard AppCloud environment.
+      def environment_name
+        return @environment_name if @environment_name.is_a? String
+        @environment_name = if engine_yard_cloud_api.data_loaded?
+          # this happens when we don't get any help from the user and the environment has been found based on the repository uri
+          engine_yard_cloud_api.environment_name
+        elsif ENV['EY_ENVIRONMENT_NAME']
+          ENV['EY_ENVIRONMENT_NAME']
+        end
+      end
+      
+      def ey_cloud_token=(str)
+        # clear this out in case it was inferred
+        @repository_uri = nil
+        # clear this out in case we're looking up a new environment
+        @data = nil
+        @ey_cloud_token = str
+      end
+
+      # The secret API token to access https://cloud.engineyard.com
+      def ey_cloud_token
+        return @ey_cloud_token if @ey_cloud_token.is_a? String
+        @ey_cloud_token = if ENV['EY_CLOUD_TOKEN']
+          ENV['EY_CLOUD_TOKEN']
+        elsif File.exist? eyrc_path
+          YAML.load(File.read(eyrc_path))['ey_cloud_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.
+      #
+      # There's no setter for this because you should really use EY::Metadata.environment_name= or ENV['EY_ENVIRONMENT_NAME']
+      def repository_uri
+        return @repository_uri if @repository_uri.is_a? String
+        @repository_uri = if engine_yard_cloud_api.data_loaded?
+          engine_yard_cloud_api.repository_uri
+        elsif ENV['EY_REPOSITORY_URI']
+          ENV['EY_REPOSITORY_URI']
+        elsif File.exist? git_config_path
+          `git config --get remote.origin.url`.strip
+        else
+          raise RuntimeError, "[engineyard-metadata gem] You need to be inside a app's git repo or set ENV['EY_REPOSITORY_URI']"
+        end
+      end
 
       # An adapter that reads from the public EngineYard Cloud API (https://cloud.engineyard.com)
       def engine_yard_cloud_api

data/spec/metadata_spec.rb

@@ -56,6 +56,64 @@ shared_examples_for "all execution environments" do
   it 'gets the stack name' do
     EY::Metadata.stack_name.should == 'FAKE_STACK_NAME'
   end
+  
+  it 'gets the repository URI' do
+    EY::Metadata.repository_uri.should == 'FAKE_REPOSITORY_URI'
+  end
+end
+
+shared_examples_for "execution outside the cloud" do
+  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
 end
 
 describe 'EY::Metadata' do
@@ -70,59 +128,25 @@ describe 'EY::Metadata' 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)
+    describe "controlled with environment variables" do
+      before(:all) do
+        EY::Metadata.clear
+        ENV['EY_CLOUD_TOKEN'] = FAKE_CLOUD_TOKEN
+        ENV['EY_ENVIRONMENT_NAME'] = FAKE_ENVIRONMENT_NAME
+      end      
+      it_should_behave_like "all execution environments"
+      it_should_behave_like "execution outside the cloud"
     end
     
-    it 'cannot get the mysqldump command' do
-      lambda {
-        EY::Metadata.mysqldump_command
-      }.should raise_error(EY::Metadata::CannotGetFromHere)
+    describe "controlled with attr writers" do
+      before(:all) do
+        EY::Metadata.clear
+        EY::Metadata.ey_cloud_token = FAKE_CLOUD_TOKEN
+        EY::Metadata.environment_name = FAKE_ENVIRONMENT_NAME
+      end
+      it_should_behave_like "all execution environments"
+      it_should_behave_like "execution outside the cloud"
     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

data/spec/spec_helper.rb

@@ -9,10 +9,10 @@ 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'
+FAKE_CLOUD_TOKEN = 'FAKE_EY_CLOUD_TOKEN'
+FAKE_ENVIRONMENT_NAME = 'FAKE_ENVIRONMENT_NAME'
 
 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",

data/spec/support/dna.json

@@ -45,7 +45,7 @@
       },
       "newrelic": false,
       "https_bind_port": 443,
-      "repository_name": "APPS-0-REPOSITORY-NAME",
+      "repository_name": "FAKE_REPOSITORY_URI",
       "type": "rack",
       "migration_command": "rake db:migrate",
       "http_bind_port": 80,
@@ -124,7 +124,7 @@
           "database_name": "FAKE_APP_NAME",
           "migration_command": "rake db:migrate",
           "type": "rack",
-          "repository_name": "APPS-0-REPOSITORY_NAME",
+          "repository_name": "FAKE_REPOSITORY_URI",
           "run_deploy": false,
           "revision": "",
           "bundled": null,

data/spec/support/engine_yard_cloud_api_response.json

@@ -1,5 +1,17 @@
 {"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":"WRONG_SSH_USERNAME","stack_name":"WRONG_STACK_NAME","framework_env":"production","name":"WRONG_ENVIRONMENT_NAME","account":
+		{"name":"WRONG_ACCOUNT_NAME","id":12345
+		},"instances_count":0,"apps":
+		[
+		{"repository_uri":"FAKE_REPOSITORY_URI","name":"WRONG_APP_NAME","account":
+		{"name":"WRONG_ACCOUNT_NAME","id":12345
+		},"id":292301
+		}
+		],"id":382918,"instances":[]
+		},
 		{"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":

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: engineyard-metadata
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 19
   prerelease: false
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Seamus Abshere