engineyard-metadata 0.1.1 → 0.1.2

data/README.rdoc

@@ -13,29 +13,33 @@ To define an unchanging interface to useful metadata (passwords, IP addresses, e
 
 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
+	EY::Metadata.app_master
+	EY::Metadata.app_name
+	EY::Metadata.app_servers
+	EY::Metadata.app_slaves
+	EY::Metadata.current_path
+	EY::Metadata.database_host
+	EY::Metadata.database_name
+	EY::Metadata.database_password       (only works from cloud instances)
+	EY::Metadata.database_username
+	EY::Metadata.db_master
+	EY::Metadata.db_servers
+	EY::Metadata.db_slaves
+	EY::Metadata.environment_name
+	EY::Metadata.mysql_command           (only works from cloud instances)
+	EY::Metadata.mysqldump_command       (only works from cloud instances)
+	EY::Metadata.present_instance_id     (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.present_security_group  (only works from cloud instances)
+	EY::Metadata.repository_uri
+	EY::Metadata.shared_path
+	EY::Metadata.solo
+	EY::Metadata.ssh_aliases
+	EY::Metadata.ssh_password            (only works from cloud instances)
+	EY::Metadata.ssh_username
+	EY::Metadata.stack_name
+	EY::Metadata.utilities
 
 == Use
 
@@ -69,8 +73,24 @@ Metadata getters are defined directly on <tt>EY::Metadata</tt> (which in turn de
   => [ 'db_master.compute-1.amazonaws.com', 'db_slave_1.compute-1.amazonaws.com' ]
   [...and many more...]
 
+== SSH alias helper
+
+You can put the output of <tt>ey_ssh_aliases</tt> into <tt>~/.ssh/config</tt>:
+
+	$ EY_ENVIRONMENT_NAME=my_env ey_ssh_aliases 
+	Host my_env-app_master
+	  Hostname ec2-11-11-111-11.compute-1.amazonaws.com
+	  User deploy
+	  StrictHostKeyChecking no
+
+	Host my_env-db_master
+	  Hostname ec2-111-11-11-11.compute-1.amazonaws.com
+	  User deploy
+	  StrictHostKeyChecking no
+
 == Known issues
 
+* Doesn't work with multiple apps per environment.
 * It's not always clear what environment you're running in. For example, you say <tt>EY::Metadata.something</tt> and you're just supposed to know what environment you're in. You can use <tt>.environment_name=</tt>, but you might not remember.
 * There are no factory methods. If we fully fleshed this out, it might be like <tt>my_env = EY::Environment.find('my_env')</tt> and <tt>my_app_master = my_env.app_master</tt>. Not sure that complexity would add a lot of value.
 

data/Rakefile

@@ -15,6 +15,7 @@ begin
     gem.add_development_dependency "fakeweb"
     gem.add_development_dependency "fakefs"
     gem.add_development_dependency "rspec", "~>2"
+    gem.executables = ['ey_ssh_aliases']
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/bin/ey_ssh_aliases

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+unless RUBY_VERSION >= '1.9'
+	require 'rubygems'
+end
+require 'engineyard-metadata'
+puts EY::Metadata.ssh_aliases

data/engineyard-metadata.gemspec

@@ -5,13 +5,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{engineyard-metadata}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Seamus Abshere"]
-  s.date = %q{2010-10-18}
+  s.date = %q{2010-10-21}
+  s.default_executable = %q{ey_ssh_aliases}
   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.executables = ["ey_ssh_aliases"]
   s.extra_rdoc_files = [
     "LICENSE",
      "README.rdoc"
@@ -23,6 +25,7 @@ Gem::Specification.new do |s|
      "README.rdoc",
      "Rakefile",
      "VERSION",
+     "bin/ey_ssh_aliases",
      "engineyard-metadata.gemspec",
      "lib/engineyard-metadata.rb",
      "lib/engineyard-metadata/amazon_ec2_api.rb",
@@ -31,6 +34,7 @@ Gem::Specification.new do |s|
      "lib/engineyard-metadata/insider.rb",
      "lib/engineyard-metadata/metadata.rb",
      "lib/engineyard-metadata/outsider.rb",
+     "lib/engineyard-metadata/ssh_alias_helper.rb",
      "spec/metadata_spec.rb",
      "spec/spec_helper.rb",
      "spec/support/dna.json",

data/lib/engineyard-metadata/chef_dna.rb

@@ -12,6 +12,8 @@ module EY
     class ChefDna
       PATH = '/etc/chef/dna.json'
 
+      include SshAliasHelper
+
       def data # :nodoc:
         @data ||= ActiveSupport::JSON.decode File.read(PATH)
       end
@@ -45,7 +47,24 @@ module EY
       def repository_uri
         data['engineyard']['environment']['apps'][0]['repository_name']
       end
-    
+      
+      # The name of the single app that runs in this environment.
+      #
+      # Warning: this gem currently doesn't support multiple apps per environment.
+      def app_name
+        data['engineyard']['environment']['apps'][0]['name']
+      end
+      
+      # 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
+
       # Public hostname where you should connect to the database.
       #
       # Currently the db master public hostname.

data/lib/engineyard-metadata/engine_yard_cloud_api.rb

@@ -16,6 +16,8 @@ module EY
     class EngineYardCloudApi
       URL = 'https://cloud.engineyard.com/api/v2/environments'
       
+      include SshAliasHelper
+      
       # Currently the same as the SSH username.
       def database_username
         data['ssh_username']
@@ -28,9 +30,9 @@ module EY
       
       # Currently the same as the app name, at least for recently-created environments.
       #
-      # It used to be named after the environment.
+      # This is less reliable that the answer you would get running from an instance, because databases used to be named after environments.
       def database_name
-        data['apps'][0]['name']
+        app_name
       end
       
       # The hostname of the database host.
@@ -118,6 +120,23 @@ module EY
         environments.map { |environment| environment['name'] }
       end
       
+      # The name of the single app that runs in this environment.
+      #
+      # Warning: this gem currently doesn't support multiple apps per environment.
+      def app_name
+        data['apps'][0]['name']
+      end
+      
+      # 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
+      
       # Used internally to determine whether we've decoded the API response yet.
       def data_loaded?
         defined?(@data) and @data.is_a? Hash

data/lib/engineyard-metadata/metadata.rb

@@ -6,36 +6,42 @@ module EY
   # instead of trying to call it from a particular adapter.
   module Metadata
     KEYS = %w{
-      present_instance_id
-      present_security_group
-      present_instance_role
-      present_public_hostname
+      app_master
+      app_name
+      app_servers
+      app_slaves
+      current_path
+      database_host
+      database_name
       database_password
       database_username
-      database_name
-      database_host
-      ssh_username
-      ssh_password
-      app_servers
-      db_servers
-      utilities
-      app_master
       db_master
+      db_servers
+      db_slaves
+      environment_name
+      environment_names
       mysql_command
       mysqldump_command
-      app_slaves
-      db_slaves
+      present_instance_id
+      present_instance_role
+      present_public_hostname
+      present_security_group
+      repository_uri
+      shared_path
       solo
-      environment_name
+      ssh_aliases
+      ssh_password
+      ssh_username
       stack_name
-      repository_uri
-      environment_names
+      utilities
     } unless defined?(KEYS)
     
     # This gets raised when you can't get a particular piece of metadata from the execution environment you're in.
     class CannotGetFromHere < RuntimeError
     end
     
+    autoload :SshAliasHelper, 'engineyard-metadata/ssh_alias_helper'
+
     autoload :Insider, 'engineyard-metadata/insider'
     autoload :Outsider, 'engineyard-metadata/outsider'
     autoload :ChefDna, 'engineyard-metadata/chef_dna'

data/lib/engineyard-metadata/ssh_alias_helper.rb

@@ -0,0 +1,36 @@
+module EY
+  module Metadata
+    module SshAliasHelper
+      # Aliases like 'my_env-app_master' or 'my_env-utilities-5' that go in .ssh/config
+      #
+      # For example:
+      #   Host my_env-app_master
+      #     Hostname ec2-111-111-111-111.compute-1.amazonaws.com
+      #     User deploy
+      #     StrictHostKeyChecking no
+      def ssh_aliases
+        counter = Hash.new 0
+        %w{ app_master db_master db_slaves app_slaves utilities }.map do |role_group|
+          send(role_group).map do |public_hostname|
+            ssh_alias counter, role_group, public_hostname
+          end
+        end.flatten.join("\n")
+      end
+      
+      # Used internally to generate a single ssh alias.
+      def ssh_alias(counter, role_group, public_hostname)
+        id = case role_group
+        when 'db_slaves', 'app_slaves', 'utilities'
+          "#{role_group}-#{counter[role_group] += 1}"
+        else
+          role_group
+        end
+        %{Host #{environment_name}-#{id}
+  Hostname #{public_hostname}
+  User #{ssh_username}
+  StrictHostKeyChecking no
+}        
+      end
+    end
+  end
+end

data/spec/metadata_spec.rb

@@ -60,6 +60,22 @@ shared_examples_for "it does in all execution environments" do
   it 'get the repository URI' do
     EY::Metadata.repository_uri.should == 'FAKE_REPOSITORY_URI'
   end
+  
+  it 'gets the app name' do
+    EY::Metadata.app_name.should == 'FAKE_APP_NAME'
+  end
+  
+  it 'gets the current path' do
+    EY::Metadata.current_path.should == '/data/FAKE_APP_NAME/current'
+  end
+  
+  it 'gets the shared path' do
+    EY::Metadata.shared_path.should == '/data/FAKE_APP_NAME/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/
+  end
 end
 
 shared_examples_for "it's executing outside the cloud" do

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: engineyard-metadata
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Seamus Abshere
@@ -15,8 +15,8 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-18 00:00:00 -05:00
-default_executable: 
+date: 2010-10-21 00:00:00 -05:00
+default_executable: ey_ssh_aliases
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: activesupport
@@ -93,8 +93,8 @@ dependencies:
   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: []
-
+executables: 
+- ey_ssh_aliases
 extensions: []
 
 extra_rdoc_files: 
@@ -107,6 +107,7 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- bin/ey_ssh_aliases
 - engineyard-metadata.gemspec
 - lib/engineyard-metadata.rb
 - lib/engineyard-metadata/amazon_ec2_api.rb
@@ -115,6 +116,7 @@ files:
 - lib/engineyard-metadata/insider.rb
 - lib/engineyard-metadata/metadata.rb
 - lib/engineyard-metadata/outsider.rb
+- lib/engineyard-metadata/ssh_alias_helper.rb
 - spec/metadata_spec.rb
 - spec/spec_helper.rb
 - spec/support/dna.json