amazon-instance 0.0.2

data/LICENSE

@@ -0,0 +1,23 @@
+New BSD Licence
+
+Copyright (c) 2010, Alfonso Jimenez All rights reserved.
+
+Authors: Alfonso Jimenez
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that
+the following conditions are met:
+
+    * Redistributions of source code must retain the above copyright notice, this list of conditions and the
+      following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and
+      the following disclaimer in the documentation and/or other materials provided with the distribution.
+    * Neither the name of the Xurrency nor the names of its contributors may be used to endorse or promote
+      products derived from this software without specific prior written permission. 
+
+THIS SOFTWARE IS PROVIDED BY ALFONSO JIMENEZ ''AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
+NO EVENT SHALL WEBLOGS SL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 

data/README.textile

@@ -0,0 +1,84 @@
+h1. amazon-instance
+
+amazon-instance is a tool for creating new Amazon EC2 instances. It allows you to organize your instances
+by projects and environments.
+
+h2. Installation
+
+<pre><code>gem install amazon-instance</code></pre>
+
+h2. Configuration
+
+The configuration directory has got the following structure:
+
+<pre><code>
+  config/
+    general.yml
+    projects/
+      example.yml
+      example2.yml
+      ..
+    on-boot/
+      script.sh
+      script2.sh
+      ..
+</code></pre>
+
+@general.yml@
+
+This file includes the basic configuration.
+
+<pre><code>
+access_key_id: YOUR_ACCESS_KEY
+secret_key_id: YOUR_SECRET_KEY
+ec2_zone_url:  https://eu-west-1.ec2.amazonaws.com
+</code></pre>
+
+@projects/@
+
+Each file defines a particular project. Instance options such as AMI id, type, ... should be provided here.
+This files are organized by environments. For example, if we want to setup a project called "my-personal-site"
+with two environments (development and production), we could do something like this:
+
+@my-personal-site.yml@
+<pre><code>development:
+  :key_name:          mykeys
+  :availability_zone: eu-west-1a
+  :instance_type:     m1.small
+  :security_group:    my-project-development-web
+  :image_id:          ami-52794c26
+  :on_boot:           script.sh
+    
+production:
+  :key_name:          mykeys
+  :availability_zone: eu-west-1a
+  :instance_type:     m1.small
+  :security_group:    my-project-production-web
+  :image_id:          ami-52794c26
+  :on_boot:           script.sh
+</code></pre>
+    
+Notice that we are saying that we want to run script.sh once the instance is created. This script should be
+placed into the on-boot directory.
+
+h2. Usage
+
+You can launch new Amazon EC2 instances by using the command @amazon-instance@
+
+<pre><code>
+alfonso@alexandra:~$ amazon-instance -h
+Options:
+  --environment, -e <s>:   Environment (Required)
+      --project, -p <s>:   Project (Required)
+   --config-dir, -c <s>:   Config directory (optional)
+            --quiet, -q:   Quiet mode (optional)
+             --help, -h:   Show this message
+</code></pre> 
+
+For example:
+
+<pre><code>alfonso@alexandra:~$ amazon-instance -p my-project -e development</pre></code>
+
+h2. License
+
+See LICENSE for details

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'rspec'
+
+gem 'rspec', '>= 2.0.0.beta.20'
+gem 'rspec-expectations'
+
+require 'rspec/core/rake_task'
+
+desc 'Test invalid instance'
+  RSpec::Core::RakeTask.new do |t|
+end
+
+task :default => :spec

data/bin/amazon-instance

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems' 
+require 'trollop'
+require 'amazon-instance'
+
+class LaunchAmazon
+  def run
+    options = Trollop::options do
+      opt :environment, 'Environment', :short => '-e',:type => String, :required => true
+      opt :project, 'Project Name', :short => '-p', :type => String, :required => true
+      opt :config_dir, 'Config directory', :short => '-c', :type => String, :default => File.join(File.dirname(__FILE__), '../config')
+      opt :quiet, 'Quiet mode', :short => '-q', :default => true
+    end
+
+    begin
+      instance = AmazonInstance.new(options.environment,
+                                    options.project,
+                                    options.config_dir+'/',
+                                    options.quiet)
+      instance.launch
+    rescue Exception => e
+      puts "\e[31m[error] #{e.message}\e[0m"
+    end
+  end
+end
+
+# Run the application
+app = LaunchAmazon.new
+app.run

data/config/general.yml

@@ -0,0 +1,3 @@
+access_key_id: YOUR_ACCESS_KEY
+secret_key_id: YOUR_SECRET_KEY
+ec2_zone_url:  https://eu-west-1.ec2.amazonaws.com

data/config/on-boot/script.sh

@@ -0,0 +1,3 @@
+#!/bin/sh -x
+
+#This script is being executed on the instance when booting first time

data/config/projects/example.yml

@@ -0,0 +1,31 @@
+dev:
+  :key_name:          mykeys
+  :availability_zone: eu-west-1a
+  :instance_type:     m1.small
+  :security_group:    example-dev-web
+  :image_id:          ami-52794c26
+  :on_boot:           script.sh
+
+test:
+  :key_name:          mykeys
+  :availability_zone: eu-west-1a
+  :instance_type:     m1.small
+  :security_group:    example-test-web
+  :image_id:          ami-52794c26
+  :on_boot:           script.sh
+
+qa:
+  :key_name:          mykeys
+  :availability_zone: eu-west-1a
+  :instance_type:     m1.small
+  :security_group:    example-qa-web
+  :image_id:          ami-52794c26
+  :on_boot:           script.sh
+
+prod:
+  :key_name:          mykeys
+  :availability_zone: eu-west-1a
+  :instance_type:     c1.medium
+  :security_group:    example-prod-web
+  :image_id:          ami-52794c26
+  :on_boot:           script.sh

data/lib/amazon-instance.rb

@@ -0,0 +1,60 @@
+require 'rubygems'
+
+require File.dirname(__FILE__)+'/amazon-instance/project'
+require File.dirname(__FILE__)+'/amazon-instance/amazon-ec2'
+  
+class AmazonInstance
+  attr_accessor :config
+  attr_accessor :config_dir
+  attr_accessor :environment
+  attr_accessor :project
+  attr_accessor :verbose
+  
+  def initialize(environment, project, config_dir, verbose=false)
+    @config = load_general_config(config_dir)
+    
+    @config_dir = config_dir
+    @environment = environment
+    @verbose = verbose
+    
+    @project = Project::load(project, environment, config_dir)
+  end
+  
+  def launch(ec2=nil)
+    ec2 = AmazonEC2.new(@config['access_key_id'],
+                        @config['secret_key_id'],
+                        URI.parse(@config['ec2_zone_url']).host) if ec2.nil?
+
+    group = @project[:security_group]
+    
+    raise 'Invalid security group: '+group unless ec2.valid_group?(group)
+
+    print_message('Creating instance') if @verbose
+    host = ec2.launch_instance(@environment, @project, @config_dir)
+    print_message('Instance created', :ok) if @verbose
+
+    # Wait till ssh port is open
+    print_message('Checking SSH port') if @verbose
+    ec2.sleep_till_ssh_is_open(host)
+    print_message('SSH port open: '+host, :ok) if @verbose
+    
+    host
+  end
+
+  private
+  def load_general_config(config_dir)
+    config = nil
+
+    File.open(config_dir+'general.yml') do |content|
+      config = YAML::load(content.read)
+    end
+    
+    config
+  end
+  
+  def print_message(message, level=:info)
+    colours = {:info => 33, :error => 31, :ok => 32}
+    
+    puts "\e[#{colours[level]}m[#{level.to_s}] #{message}\e[0m"
+  end
+end

data/lib/amazon-instance/amazon-ec2.rb

@@ -0,0 +1,72 @@
+require 'AWS'
+require 'socket'
+require 'timeout'
+
+class AmazonEC2
+  def initialize(access_key, secret_key, server)
+    @ec2 = AWS::EC2::Base.new(:access_key_id     => access_key,
+                              :secret_access_key => secret_key,
+                              :server            => server)
+  end
+  
+  def launch_instance(environment, config, config_dir) 
+    config[:base64_encoded] = true
+    
+    if !config[:on_boot].nil?
+      File.open(config_dir+'on-boot/'+config[:on_boot]) do |content|
+        config[:user_data] = content.read.gsub!('{environment}', environment)
+      end
+    end
+
+    instance = @ec2.run_instances(config.to_hash)
+    
+    instanceId = instance['instancesSet']['item'].first['instanceId']
+
+    host_by_instance(instanceId)
+  end
+  
+  def valid_group?(group_name)
+    valid_group = false
+    
+    @ec2.describe_security_groups['securityGroupInfo']['item'].each do |group|
+      valid_group = true if group['groupName'] == group_name
+    end
+
+    valid_group
+  end
+
+  def host_by_instance(instance_id)
+    host = nil
+
+    while host == nil do
+      instances = @ec2.describe_instances({:instance_id => instance_id})
+      host = instances['reservationSet']['item'].first['instancesSet']['item'].first['dnsName']
+      sleep 2
+    end
+    
+    host
+  end
+  
+  def sleep_till_ssh_is_open(host)
+    while ssh_open?(host) do
+      sleep(3)
+    end
+  end
+  
+  def ssh_open?(host)
+    begin
+      Timeout::timeout(1) do
+        begin
+          s = TCPSocket.new(host, 22)
+          s.close
+          return true
+        rescue Errno::ECONNREFUSED, Errno::EHOSTUNREACH
+          return false
+        end
+      end
+    rescue Timeout::Error
+    end
+
+    return false
+  end
+end

data/lib/amazon-instance/project.rb

@@ -0,0 +1,28 @@
+class Project
+  def self.load(name, environment, config_dir)
+    config = nil
+    filename = config_dir+'projects/'+name+'.yml'
+
+    if File.exist?(filename)
+      File.open(filename) do |content|
+        config_environments = YAML::load(content)
+        
+        if !config_environments[environment].nil?
+          config = config_environments[environment]
+        else
+          raise 'Invalid environment name: '+environment
+        end
+      end
+    else
+      raise 'File: '+name+'.yml does not exist'
+    end
+    
+    config
+  end
+  
+  def self.list_available_projects(config_dir)
+    Dir.foreach(pathname) do |file|
+      puts file
+    end
+  end
+end

data/spec/amazon_instance_spec.rb

@@ -0,0 +1,49 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'rubygems'
+require 'amazon-instance'
+
+describe 'AmazonInstance' do
+  before :all do
+    @config_dir = File.join(File.dirname(__FILE__), 'fixtures/')
+    @project_name = 'example'
+  end
+  
+  context 'When an instance is created' do
+    it 'with a valid environment name' do
+      instance = AmazonInstance.new('test', @project_name, @config_dir)
+      instance.environment.should == 'test'
+      
+      instance = AmazonInstance.new('qa', @project_name, @config_dir)
+      instance.environment.should == 'qa'
+      
+      instance = AmazonInstance.new('prod', @project_name, @config_dir)
+      instance.environment.should == 'prod'
+      
+      instance = AmazonInstance.new('dev', @project_name, @config_dir)
+      instance.environment.should == 'dev'
+    end
+    
+    it 'with an invalid environment name should raise an exception' do
+      expect {AmazonInstance.new('xxx', @project_name, @config_dir)}.to raise_error('Invalid environment name: xxx')
+      expect {AmazonInstance.new('yyy',@project_name, @config_dir)}.to raise_error('Invalid environment name: yyy')
+    end
+    
+    it 'with an invalid project name should raise an exception' do
+      expect {AmazonInstance.new('dev', 'invalid_config', @config_dir)}.to raise_error('File: invalid_config.yml does not exist')
+    end
+  end
+  
+  context 'When launching an instance' do
+    it 'should return the instance host' do
+      ec2 = mock('AmazonEC2')
+      ec2.should_receive(:valid_group?).with(any_args()).and_return(true)
+      ec2.should_receive(:launch_instance).with(any_args()).and_return('amazon-host.com')
+      ec2.should_receive(:sleep_till_ssh_is_open).with(any_args()).and_return(true)
+      
+      instance = AmazonInstance.new('test', @project_name, @config_dir)
+      instance.launch(ec2).should == 'amazon-host.com'
+    end
+  end
+end

data/spec/fixtures/general.yml

@@ -0,0 +1,3 @@
+access_key_id: YOUR_ACCESS_KEY
+secret_key_id: YOUR_SECRET_KEY
+ec2_zone_url:  https://eu-west-1.ec2.amazonaws.com

data/spec/fixtures/on-boot/script.sh

@@ -0,0 +1,3 @@
+#!/bin/sh -x
+
+#This script is being executed on the instance when booting first time

data/spec/fixtures/projects/example.yml

@@ -0,0 +1,31 @@
+dev:
+  :key_name:          mykeys
+  :availability_zone: eu-west-1a
+  :instance_type:     m1.small
+  :security_group:    example-dev-web
+  :image_id:          ami-52794c26
+  :on_boot:           script.sh
+
+test:
+  :key_name:          mykeys
+  :availability_zone: eu-west-1a
+  :instance_type:     m1.small
+  :security_group:    example-test-web
+  :image_id:          ami-52794c26
+  :on_boot:           script.sh
+
+qa:
+  :key_name:          mykeys
+  :availability_zone: eu-west-1a
+  :instance_type:     m1.small
+  :security_group:    example-qa-web
+  :image_id:          ami-52794c26
+  :on_boot:           script.sh
+
+prod:
+  :key_name:          mykeys
+  :availability_zone: eu-west-1a
+  :instance_type:     c1.medium
+  :security_group:    example-prod-web
+  :image_id:          ami-52794c26
+  :on_boot:           script.sh

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification 
+name: amazon-instance
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 2
+  version: 0.0.2
+platform: ruby
+authors: 
+- Alfonso Jimenez
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-16 00:00:00 +02:00
+default_executable: amazon-instance
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: amazon-ec2
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 37
+        segments: 
+        - 0
+        - 9
+        - 15
+        version: 0.9.15
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 62196427
+        segments: 
+        - 2
+        - 0
+        - 0
+        - beta
+        - 20
+        version: 2.0.0.beta.20
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: trollop
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 83
+        segments: 
+        - 1
+        - 16
+        - 2
+        version: 1.16.2
+  type: :runtime
+  version_requirements: *id003
+description: A tool for creating new Amazon EC2 instances. It allows you to organize your instances by projects and environments.
+email: yo@alfonsojimenez.com
+executables: 
+- amazon-instance
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+files: 
+- LICENSE
+- README.textile
+- Rakefile
+- lib/amazon-instance/amazon-ec2.rb
+- lib/amazon-instance/project.rb
+- lib/amazon-instance.rb
+- bin/amazon-instance
+- spec/amazon_instance_spec.rb
+- spec/fixtures/general.yml
+- spec/fixtures/projects/example.yml
+- spec/fixtures/on-boot/script.sh
+- config/general.yml
+- config/projects/example.yml
+- config/on-boot/script.sh
+has_rdoc: true
+homepage: http://github.com/alfonsojimenez/amazon-instance
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A tool for creating new Amazon EC2 instances
+test_files: 
+- spec/amazon_instance_spec.rb