engineyard-metadata 0.1.2 → 0.2.0

data/lib/engineyard-metadata/insider.rb

@@ -1,5 +1,5 @@
 module EY
-  module Metadata
+  class Metadata
     # This gets pulled in when you're running directly on a cloud instance.
     module Insider
       DELEGATED_TO_AMAZON_EC2_API = %w{
@@ -7,7 +7,7 @@ module EY
         present_security_group
       }
     
-      DELEGATED_TO_CHEF_DNA = KEYS - DELEGATED_TO_AMAZON_EC2_API
+      DELEGATED_TO_CHEF_DNA = METHODS - DELEGATED_TO_AMAZON_EC2_API
 
       DELEGATED_TO_AMAZON_EC2_API.each do |name|
         define_method name do
@@ -20,12 +20,7 @@ module EY
           chef_dna.send name
         end
       end
-      
-      def clear
-        @chef_dna = nil
-        @amazon_ec2_api = nil
-      end
-      
+            
       # You can't get the list of environment names while you're on the instances themselves.
       def environment_names
         raise CannotGetFromHere
@@ -40,6 +35,17 @@ module EY
       def amazon_ec2_api
         @amazon_ec2_api ||= AmazonEc2Api.new
       end
+      
+      def app_name
+        return @app_name if @app_name.is_a? String
+        if ENV['EY_APP_NAME']
+          @app_name = ENV['EY_APP_NAME']
+        elsif Dir.pwd =~ %r{/data/([^/]+)/current} or Dir.pwd =~ %r{/data/([^/]+)/releases}
+          @app_name = $1
+        end
+        raise RuntimeError, "[engineyard-metadata gem] Please set EY.metadata.app_name= or set ENV['EY_APP_NAME']" unless @app_name.to_s.strip.length > 0
+        @app_name
+      end
     end
   end
 end

data/lib/engineyard-metadata/metadata.rb

@@ -1,11 +1,17 @@
+require 'singleton'
+
 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
-    KEYS = %w{
+  class Metadata
+    include Singleton
+    
+    attr_writer :app_name
+    
+    METHODS = %w{
       app_master
       app_name
       app_servers
@@ -34,7 +40,17 @@ module EY
       ssh_username
       stack_name
       utilities
-    } unless defined?(KEYS)
+    } unless defined?(METHODS)
+    
+    # The path to the current deploy on app servers.
+    def current_path
+      "/data/#{app_name}/current"
+    end
+    
+    # The path to the shared directory on app servers.
+    def shared_path
+      "/data/#{app_name}/shared"
+    end
     
     # This gets raised when you can't get a particular piece of metadata from the execution environment you're in.
     class CannotGetFromHere < RuntimeError
@@ -48,13 +64,14 @@ module EY
     autoload :AmazonEc2Api, 'engineyard-metadata/amazon_ec2_api'
     autoload :EngineYardCloudApi, 'engineyard-metadata/engine_yard_cloud_api'
     
-    def self.reload
+    def reload
       if File.directory? '/var/log/engineyard'
-        extend Insider
+        Metadata.send :include, Insider
       else
-        extend Outsider
+        Metadata.send :include, Outsider
       end
     end
-    reload
   end
 end
+
+EY.metadata.reload

data/lib/engineyard-metadata/outsider.rb

@@ -2,13 +2,12 @@ require 'etc'
 require 'yaml'
 
 module EY
-  module Metadata
+  class Metadata
     # This gets pulled in when you're running from your developer machine (i.e., not on a cloud instance).
     module Outsider
-      LOCALLY_DETERMINED = %w{ environment_name repository_uri }
-      UNGETTABLE = KEYS.grep(/present/) + KEYS.grep(/password/) + KEYS.grep(/mysql/)
+      UNGETTABLE = METHODS.grep(/present/) + METHODS.grep(/password/) + METHODS.grep(/mysql/)
       
-      GETTABLE = KEYS - LOCALLY_DETERMINED - UNGETTABLE
+      GETTABLE = METHODS - UNGETTABLE - %w{ environment_name }
       
       UNGETTABLE.each do |name|
         define_method name do
@@ -26,79 +25,64 @@ module EY
         File.join File.expand_path("~#{Etc.getpwuid.name}"), '.eyrc'
       end
       
-      def git_config_path
-        File.join Dir.pwd, '.git', 'config'
+      def preset_app_name?
+        @app_name.is_a?(String) or ENV['EY_APP_NAME']
       end
       
-      def clear
-        @repository_uri = nil
-        @environment_name = nil
-        @ey_cloud_token = nil
-        @engine_yard_cloud_api = nil
+      def app_name
+        return @app_name if @app_name.is_a?(String)
+        if ENV['EY_APP_NAME']
+          @app_name = ENV['EY_APP_NAME']
+        elsif engine_yard_cloud_api.possible_to_detect_app_from_environment_name?
+          @app_name = engine_yard_cloud_api.app_name
+        elsif engine_yard_cloud_api.possible_to_detect_app_from_git_config?
+          @app_name = engine_yard_cloud_api.app_name
+        end
+        @app_name
       end
       
+      def preset_environment_name?
+        @environment_name.is_a?(String) or ENV['EY_ENVIRONMENT_NAME']
+      end
+
+      # Sets the environment you want, in case it can't be detected from ENV['EY_ENVIRONMENT_NAME'] or .git/config
       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
-        @engine_yard_cloud_api = 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']
+        if ENV['EY_ENVIRONMENT_NAME']
+          @environment_name = ENV['EY_ENVIRONMENT_NAME']
+        elsif engine_yard_cloud_api.possible_to_detect_environment_from_git_config?
+          @environment_name = engine_yard_cloud_api.environment_name
         end
-        raise RuntimeError, "[engineyard-metadata gem] You need to run this from the application repo, set EY::Metadata.environment_name= or set ENV['EY_ENVIRONMENT_NAME']" unless @environment_name.to_s.strip.length > 0
+        raise RuntimeError, "[engineyard-metadata gem] You need to run this from the application repo, set EY.metadata.environment_name= or set ENV['EY_ENVIRONMENT_NAME']" unless @environment_name.to_s.strip.length > 0
         @environment_name
       end
       
+      # Sets the (secret) cloud token, in case it's not in ENV['EY_CLOUD_TOKEN'] or ~/.eyrc
       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
-        @engine_yard_cloud_api = nil
+        @engine_yard_cloud_api = nil # because it depends on cloud token
         @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']
+        if ENV['EY_CLOUD_TOKEN']
+          @ey_cloud_token = ENV['EY_CLOUD_TOKEN']
         elsif File.exist? eyrc_path
-          YAML.load(File.read(eyrc_path))['api_token']
+          @ey_cloud_token = YAML.load(File.read(eyrc_path))['api_token']
         end
-        raise RuntimeError, "[engineyard-metadata gem] You need to have #{eyrc_path}, set EY::Metadata.ey_cloud_token= or set ENV['EY_CLOUD_TOKEN']" unless @ey_cloud_token.to_s.strip.length > 0
+        raise RuntimeError, "[engineyard-metadata gem] You need to have #{eyrc_path}, set EY.metadata.ey_cloud_token= or set ENV['EY_CLOUD_TOKEN']" unless @ey_cloud_token.to_s.strip.length > 0
         @ey_cloud_token
       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 = File.read git_config_path
-          git_config =~ /^\[remote.*?\burl = (.*?)\n/m
-          $1
-        end
-        raise RuntimeError, "[engineyard-metadata gem] Please set EY::Metadata.environment_name= or set ENV['EY_ENVIRONMENT_NAME']" unless @repository_uri.to_s.strip.length > 0
-        @repository_uri
-      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
+        @engine_yard_cloud_api ||= EngineYardCloudApi.new ey_cloud_token
       end
     end
   end

data/lib/engineyard-metadata/ssh_alias_helper.rb

@@ -1,5 +1,5 @@
 module EY
-  module Metadata
+  class Metadata
     module SshAliasHelper
       # Aliases like 'my_env-app_master' or 'my_env-utilities-5' that go in .ssh/config
       #

data/spec/metadata_spec.rb

@@ -2,181 +2,177 @@ require 'spec_helper'
 
 shared_examples_for "it does in all execution environments" do
   it 'get the database username' do
-    EY::Metadata.database_username.should == 'FAKE_SSH_USERNAME'
+    EY.metadata.database_username.should == 'deploy'
   end
 
   it 'get the database name' do
-    EY::Metadata.database_name.should == 'FAKE_APP_NAME'
+    EY.metadata.database_name.should == 'cm1_certified_blue'
   end
 
   it 'get the database host' do
-    EY::Metadata.database_host.should == 'FAKE_DB_MASTER_PUBLIC_HOSTNAME'
+    EY.metadata.database_host.should == 'ec2-67-202-19-255.compute-1.amazonaws.com'
   end
 
   it 'get the ssh username' do
-    EY::Metadata.ssh_username.should == 'FAKE_SSH_USERNAME'
+    EY.metadata.ssh_username.should == 'deploy'
   end
   
   it 'get the app server hostnames' do
-    EY::Metadata.app_servers.should == [ 'app_1.compute-1.amazonaws.com' , 'app_master.compute-1.amazonaws.com' ]
+    EY.metadata.app_servers.should == ["ec2-174-129-212-130.compute-1.amazonaws.com"]
   end
 
   it 'get the db server hostnames' do
-    EY::Metadata.db_servers.should == [ 'FAKE_DB_MASTER_PUBLIC_HOSTNAME', 'db_slave_1.compute-1.amazonaws.com' ]
+    EY.metadata.db_servers.should == ["ec2-67-202-19-255.compute-1.amazonaws.com"]
   end
 
   it 'get the utilities hostnames' do
-    EY::Metadata.utilities.should == [ 'FAKE_UTIL_1_PUBLIC_HOSTNAME' ]
+    EY.metadata.utilities.should == []
   end
 
   it 'get the app master hostname' do
-    EY::Metadata.app_master.should == 'app_master.compute-1.amazonaws.com'
+    EY.metadata.app_master.should == 'ec2-174-129-212-130.compute-1.amazonaws.com'
   end
 
   it 'get the db master hostname' do
-    EY::Metadata.db_master.should == 'FAKE_DB_MASTER_PUBLIC_HOSTNAME'
+    EY.metadata.db_master.should == 'ec2-67-202-19-255.compute-1.amazonaws.com'
   end
 
   it 'get the db slave hostnames' do
-    EY::Metadata.db_slaves.should == [ 'db_slave_1.compute-1.amazonaws.com' ]
+    EY.metadata.db_slaves.should == []
   end
 
   it 'get the app slave hostnames' do
-    EY::Metadata.app_slaves.should == [ 'app_1.compute-1.amazonaws.com' ]
+    EY.metadata.app_slaves.should == []
   end
 
   it 'get the solo hostname' do
-    EY::Metadata.solo.should == nil
+    EY.metadata.solo.should == nil
   end
 
   it 'get the environment name' do
-    EY::Metadata.environment_name.should == 'FAKE_ENVIRONMENT_NAME'
+    EY.metadata.environment_name.should == 'cm1_production_blue'
   end
   
   it 'get the stack name' do
-    EY::Metadata.stack_name.should == 'FAKE_STACK_NAME'
+    EY.metadata.stack_name.should == 'nginx_unicorn'
   end
   
   it 'get the repository URI' do
-    EY::Metadata.repository_uri.should == 'FAKE_REPOSITORY_URI'
+    EY.metadata.repository_uri.should == 'git@github.com:brighterplanet/cm1.git'
   end
   
   it 'gets the app name' do
-    EY::Metadata.app_name.should == 'FAKE_APP_NAME'
+    EY.metadata.app_name.should == 'cm1_certified_blue'
   end
   
   it 'gets the current path' do
-    EY::Metadata.current_path.should == '/data/FAKE_APP_NAME/current'
+    EY.metadata.current_path.should == '/data/cm1_certified_blue/current'
   end
   
   it 'gets the shared path' do
-    EY::Metadata.shared_path.should == '/data/FAKE_APP_NAME/shared'
+    EY.metadata.shared_path.should == '/data/cm1_certified_blue/shared'
   end
   
   it 'gets helpful ssh aliases' do
-    EY::Metadata.ssh_aliases.should =~ /Host FAKE_ENVIRONMENT_NAME-app_master\n  Hostname app_master.compute-1.amazonaws.com/
+    EY.metadata.ssh_aliases.should =~ /Host cm1_production_blue-app_master\n  Hostname ec2-174-129-212-130.compute-1.amazonaws.com/
   end
 end
 
 shared_examples_for "it's executing outside the cloud" do
   it 'gets the list of all environment names' do
-    EY::Metadata.environment_names.should == [ 'WRONG_ENVIRONMENT_NAME', 'FAKE_ENVIRONMENT_NAME' ]
+    EY.metadata.environment_names.should == ["app1_production", "wlpf1_production", "data1_production", "cm1_production_red", "cm1_production_blue"]
   end
 
   it 'not get the present instance ID' do
     lambda {
-      EY::Metadata.present_instance_id
+      EY.metadata.present_instance_id
     }.should raise_error(EY::Metadata::CannotGetFromHere)
   end
 
   it 'not get the present instance role (as a string)' do
     lambda {
-      EY::Metadata.present_instance_role
+      EY.metadata.present_instance_role
     }.should raise_error(EY::Metadata::CannotGetFromHere)
   end
   
   it 'not get the present public hostname' do
     lambda {
-      EY::Metadata.present_public_hostname
+      EY.metadata.present_public_hostname
     }.should raise_error(EY::Metadata::CannotGetFromHere)
   end
   
   it 'not get the present security group' do
     lambda {
-      EY::Metadata.present_security_group
+      EY.metadata.present_security_group
     }.should raise_error(EY::Metadata::CannotGetFromHere)
   end
 
   it 'not get the database password' do
     lambda {
-      EY::Metadata.database_password
+      EY.metadata.database_password
     }.should raise_error(EY::Metadata::CannotGetFromHere)
   end
 
   it 'not get the ssh password' do
     lambda {
-      EY::Metadata.ssh_password
+      EY.metadata.ssh_password
     }.should raise_error(EY::Metadata::CannotGetFromHere)
   end
   
   it 'not get the mysql command' do
     lambda {
-      EY::Metadata.mysql_command
+      EY.metadata.mysql_command
     }.should raise_error(EY::Metadata::CannotGetFromHere)
   end
   
   it 'not get the mysqldump command' do
     lambda {
-      EY::Metadata.mysqldump_command
+      EY.metadata.mysqldump_command
     }.should raise_error(EY::Metadata::CannotGetFromHere)
   end
-  
-  it 'get the raw EngineYard Cloud API data' do
-    EY::Metadata.engine_yard_cloud_api.data.should be_a(Hash)
-  end
 end
 
 shared_examples_for "it's executing inside the cloud" do
   it 'not get the list of all environment names' do
     lambda {
-      EY::Metadata.environment_names
+      EY.metadata.environment_names
     }.should raise_error(EY::Metadata::CannotGetFromHere)
   end
   
   it 'get the present instance ID' do
-    EY::Metadata.present_instance_id.should == PRESENT_INSTANCE_ID
+    EY.metadata.present_instance_id.should == FAKE_INSTANCE_ID
   end
 
   it 'get the present instance role (as a string)' do
-    EY::Metadata.present_instance_role.should == 'app_master'
+    EY.metadata.present_instance_role.should == 'app_master'
   end
 
   it 'get the present public hostname' do
-    EY::Metadata.present_public_hostname.should == PRESENT_PUBLIC_HOSTNAME
+    EY.metadata.present_public_hostname.should == 'ec2-174-129-212-130.compute-1.amazonaws.com'
   end
 
   it 'get the present security group' do
-    EY::Metadata.present_security_group.should == PRESENT_SECURITY_GROUP
+    EY.metadata.present_security_group.should == FAKE_SECURITY_GROUP
   end
   
   it 'get the database password' do
-    EY::Metadata.database_password.should == 'USERS-0-PASSWORD'
+    EY.metadata.database_password.should == 'USERS-0-PASSWORD'
   end
   
   it 'get the ssh password' do
-    EY::Metadata.ssh_password.should == 'SSH-PASSWORD'
+    EY.metadata.ssh_password.should == 'USERS-0-PASSWORD'
   end
   
   it 'get 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}
+    EY.metadata.mysql_command.should =~ %r{mysql -h ec2-67-202-19-255.compute-1.amazonaws.com -u deploy -pUSERS-0-PASSWORD cm1_certified_blue}
   end
 
   it 'get 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}
+    EY.metadata.mysqldump_command.should =~ %r{mysqldump -h ec2-67-202-19-255.compute-1.amazonaws.com -u deploy -pUSERS-0-PASSWORD cm1_certified_blue}
   end
 end
 
-describe 'EY::Metadata' do
+describe 'EY.metadata' do
   after do
     stop_pretending
   end
@@ -184,7 +180,8 @@ describe 'EY::Metadata' do
   describe "being executed on an EngineYard AppCloud (i.e. Amazon EC2) instance" do
     before do
       pretend_we_are_on_an_engineyard_appcloud_ec2_instance
-      EY::Metadata.reload
+      EY.metadata.reload
+      EY.metadata.app_name = 'cm1_certified_blue'
     end
     it_should_behave_like "it does in all execution environments"
     it_should_behave_like "it's executing inside the cloud"
@@ -193,34 +190,41 @@ describe 'EY::Metadata' do
   describe "being executed from a developer/administrator's local machine" do
     before do
       pretend_we_are_on_a_developer_machine
-      EY::Metadata.reload
-      EY::Metadata.clear
+      EY.metadata.reload
+      EY.metadata.instance_variables.each do |ivar_name|
+        EY.metadata.instance_variable_set ivar_name, nil
+      end
       ENV.delete 'EY_CLOUD_TOKEN'
       ENV.delete 'EY_ENVIRONMENT_NAME'
+      ENV.delete 'EY_APP_NAME'
+      EY.metadata.app_name = 'cm1_certified_blue'
     end
     describe "controlled with environment variables" do
       before do
+        EY.metadata.instance_variables.each do |ivar_name|
+          EY.metadata.instance_variable_set ivar_name, nil
+        end
         ENV['EY_CLOUD_TOKEN'] = FAKE_CLOUD_TOKEN + 'aaa'
-        ENV['EY_ENVIRONMENT_NAME'] = FAKE_ENVIRONMENT_NAME
-        EY::Metadata.ey_cloud_token.should == FAKE_CLOUD_TOKEN + 'aaa' # sanity check
+        ENV['EY_APP_NAME'] = 'cm1_certified_blue'
+        EY.metadata.ey_cloud_token.should == FAKE_CLOUD_TOKEN + 'aaa' # sanity check
       end
       it_should_behave_like "it does in all execution environments"
       it_should_behave_like "it's executing outside the cloud"
     end
     describe "controlled with attr writers" do
       before do
-        EY::Metadata.ey_cloud_token = FAKE_CLOUD_TOKEN + 'bbb'
-        EY::Metadata.environment_name = FAKE_ENVIRONMENT_NAME
-        EY::Metadata.ey_cloud_token.should == FAKE_CLOUD_TOKEN + 'bbb' # sanity check
+        EY.metadata.ey_cloud_token = FAKE_CLOUD_TOKEN + 'bbb'
+        EY.metadata.app_name = 'cm1_certified_blue'
+        EY.metadata.ey_cloud_token.should == FAKE_CLOUD_TOKEN + 'bbb' # sanity check
       end
       it_should_behave_like "it does in all execution environments"
       it_should_behave_like "it's executing outside the cloud"
     end
     describe "depending on .eyrc" do
       before do
-        File.open(EY::Metadata.eyrc_path, 'w') { |f| f.write({'api_token' => FAKE_CLOUD_TOKEN + 'ccc'}.to_yaml) }
-        EY::Metadata.environment_name = FAKE_ENVIRONMENT_NAME
-        EY::Metadata.ey_cloud_token.should == FAKE_CLOUD_TOKEN + 'ccc' # sanity check
+        File.open(EY.metadata.eyrc_path, 'w') { |f| f.write({'api_token' => FAKE_CLOUD_TOKEN + 'ccc'}.to_yaml) }
+        EY.metadata.environment_name = 'cm1_production_blue'
+        EY.metadata.ey_cloud_token.should == FAKE_CLOUD_TOKEN + 'ccc' # sanity check
       end
       it_should_behave_like "it does in all execution environments"
       it_should_behave_like "it's executing outside the cloud"