breeze 0.0.3 → 0.0.4

data/.gitignore

@@ -4,3 +4,4 @@ pkg/*
 .bundle
 Gemfile.lock
 /Thorfile
+tmp/

data/breeze.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
   s.authors     = ["Markus Bengts"]
   s.email       = ["markus.bengts@gmail.com"]
   s.homepage    = "https://github.com/markus/breeze"
-  s.summary     = %q{Thor tasks to manage AWS cloud computing resorces and deployments}
+  s.summary     = %q{Thor tasks to manage cloud computing resources and deployments}
   s.description = <<-END_DESCRIPTION
 Breeze makes it easy to automate server installation and configuration. It provides
 example scripts and configuration files that you can modify and keep in your revision
@@ -25,4 +25,6 @@ END_DESCRIPTION
 
   s.add_dependency('thor')
   s.add_dependency('fog', '>= 0.7')
+  s.add_development_dependency "cucumber"
+  s.add_development_dependency "aruba"
 end

data/features/erb_conf.feature

@@ -0,0 +1,76 @@
+Feature: ERb Configuration
+  
+  Server configuration files can be transformed from ERb templates
+  in config/breeze/configs and deployed to any path on the server.
+  This allows us to keep configuration files under revision control
+  and to deploy the same configuration to multiple servers.
+  
+  Scenario: Transform and deploy a configuration file
+    Given a file named "config/breeze/configs/test" with:
+    """
+    <%
+      @path = 'test.conf'
+      @perms = 0600
+      @post = 'ls -l test.conf'
+    %>
+    http {
+      root <%= CONFIGURATION[:app_path] %>/public
+    }
+    """
+    When I run `thor configuration:deploy_to_localhost`
+    Then the file "test.conf" should contain exactly:
+    """
+    
+    http {
+      root /srv/YOUR-APP/public
+    }
+    """
+    And the output should contain "-rw-------"
+  
+  Scenario: Read and write using custom commands
+    Given a file named "config/breeze/configs/test" with:
+    """
+    <%
+      @read_cmd = 'echo "previous content"'
+      @write_cmd = 'cat'
+    %>
+    new content
+    """
+    When I run `thor configuration:deploy_to_localhost`
+    Then the output should contain "new content"
+  
+  Scenario: Define transformation order with file names
+    Given a file named "config/breeze/configs/a_file" with:
+    """
+    <%
+      @path = 'ab_test'
+      @perms = 0700
+    %>
+    this file is transformed first and then backed up
+    """
+    And a file named "config/breeze/configs/b_file" with:
+    """
+    <%
+      @path = 'ab_test'
+      @perms = 0700
+      @post = 'ls -l ab_test.backup'
+    %>
+    this overwrites the first ab_test
+    """
+    When I run `thor configuration:deploy_to_localhost`
+    Then the file "ab_test" should contain "this overwrites the first ab_test"
+    And the file "ab_test.backup" should contain "transformed first and then backed up"
+    And the output should contain "-rwx------"
+  
+  Scenario: Transform and deploy only one file
+    Given a file named "config/breeze/configs/a_file" with:
+    """
+    <% @path = 'a_file' %> this is a
+    """
+    And a file named "config/breeze/configs/b_file" with:
+    """
+    <% @path = 'b_file' %> this is b
+    """
+    When I run `thor configuration:deploy_to_localhost config/breeze/configs/b*`
+    Then a file named "b_file" should exist
+    And a file named "a_file" should not exist

data/features/support/env.rb

@@ -0,0 +1,33 @@
+require 'aruba/cucumber'
+
+# We need a clean test app template that can be cloned into
+# tmp/aruba for each scenario.
+template_dir = File.expand_path('tmp/test_app_template')
+
+# Create the test app with `breeze init`.
+system <<-END_SCRIPT
+rm -rf #{template_dir}
+mkdir -p #{template_dir}
+cd #{template_dir}
+bundle exec ../../bin/breeze init > /dev/null
+END_SCRIPT
+
+# Remove all configuration file templates because they may contain absolute paths
+# and commands that make changes to the local system.
+system("rm -rf #{template_dir}/config/breeze/configs/*")
+
+# Use the current source insted of the installed gem.
+thorfile_path = File.join(template_dir, 'Thorfile')
+thorfile_content = File.read(thorfile_path)
+expected_require = "require 'breeze'"
+wanted_require = "require 'bundler'; Bundler.setup; require 'breeze'"
+raise "Cannot find #{expected_require} in #{thorfile_path}" unless thorfile_content.include?(expected_require)
+File.open(thorfile_path, 'w') { |f| f.puts(thorfile_content.sub(expected_require, wanted_require)) }
+
+# Use Fog.mock!
+system("echo 'Fog.mock!' >> #{thorfile_path}")
+
+# Clone the test app for each scenario.
+Before do
+  system("cp -r #{template_dir} tmp/aruba")
+end

data/lib/breeze.rb

@@ -1,6 +1,6 @@
 module Breeze
 
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
   autoload :Veur, 'breeze/veur'
 
 end

data/lib/breeze/fog_extensions/aws.rb

@@ -11,6 +11,7 @@ module Fog
       end
 
       def display_name
+        return "#{state}:#{name}" if name and state != 'running'
         name || public_ip_address || "#{state} #{flavor_id} #{id}"
       end
 
@@ -55,6 +56,10 @@ module Fog
     end
     class Compute::Image
 
+      def display_name
+        name or location
+      end
+
       def full_type
         "#{type}, #{architecture}, #{root_device_type}"
       end

data/lib/breeze/tasks/app.rb

@@ -17,9 +17,12 @@ module Breeze
       end
       server = create_server
       server.breeze_data(:name => public_server_name, :db => db_server_name)
-      thor("server:address:create #{server.id}") if options[:elastic_ip]
-      thor("dns:record:create #{zone_id(public_server_name)} #{public_server_name}. A #{ip(server)} #{options[:dns_ttl]}")
+      if options[:elastic_ip]
+        thor("server:address:create #{server.id}")
+        server.reload until server.addresses.first
+      end
       deploy_command([server], public_server_name, db_server_name, options[:deploy_branch]) if options[:deploy_branch]
+      thor("dns:record:create #{zone_id(public_server_name)} #{public_server_name}. A #{ip(server)} #{options[:dns_ttl]}")
     end
 
     desc 'stop PUBLIC_SERVER_NAME', 'Destroy web server and db'
@@ -55,7 +58,7 @@ module Breeze
       new_server = create_server
       new_server.breeze_data(:name => public_server_name, :db => db_server_name)
       deploy_command([new_server], public_server_name, db_server_name, branch)
-      puts("The new server should soon be available at #{ip(new_server)}.")
+      puts("The new server should soon be available at: #{ip(new_server)}")
       if ask("Ready to continue and move the elastic_ip for #{public_server_name} to the new server? [YES/rollback] >") =~ /r|n/i
         new_server.destroy
       else
@@ -153,6 +156,10 @@ module Breeze
       super(task + (options[:force] ? ' --force' : ''))
     end
 
+    def log_in_to(server)
+      system("#{CONFIGURATION[:ssh][:ssh_command]} #{CONFIGURATION[:ssh][:ssh_user]}@#{server}")
+    end
+
     # Don't know how to include or inherit thor tasks and descriptions.
     # These may be included in Staging and Production.
     def self.inherited(c)
@@ -173,6 +180,10 @@ module Breeze
       def enable
         thor("app:enable \#{PUBLIC_SERVER_NAME}")
       end
+      desc 'ssh', 'Log in with ssh'
+      def ssh
+        log_in_to(PUBLIC_SERVER_NAME)
+      end
       END_TASKS
     end
 

data/lib/breeze/tasks/configuration.rb

@@ -9,11 +9,11 @@ module Breeze
   # See https://github.com/wr0ngway/rubber/wiki/Configuration
   class Configuration < Veur
 
-    desc 'deploy_to_localhost',
+    desc 'deploy_to_localhost [FILE]',
       'Transform and deploy server configuration files to the local file system based on ERB templates in config/server'
     method_option :force, :default => false, :desc => 'Overwrite and execute @post commands even if files would not change'
-    def deploy_to_localhost
-      Dir['config/breeze/configs/**/*'].each do |path|
+    def deploy_to_localhost(file_pattern='config/breeze/configs/**/*')
+      Dir[file_pattern].sort.each do |path|
         transform_and_deploy(path, options[:force]) unless File.directory?(path)
       end
     end

data/lib/breeze/tasks/describe.rb

@@ -19,7 +19,7 @@ module Breeze
       report 'MACHINE IMAGES',
         ['Name or Location', 'Image ID', 'Owner', 'Image Type', 'Public'],
         fog.images.all('Owner' => Breeze::CONFIGURATION[:image_owner]).map{ |i|
-          [i.name||i.location, i.id, i.owner_id, i.full_type, i.is_public]
+          [i.display_name, i.id, i.owner_id, i.full_type, i.is_public]
         }
     end
 

data/lib/breeze/tasks/server.rb

@@ -14,12 +14,14 @@ module Breeze
       create_server(options)
     end
 
-    desc 'destroy INSTANCE_ID', 'Terminate a running (or stopped) server instance'
+    desc 'destroy INSTANCE_ID [...]', 'Terminate a running (or stopped) server instance'
     method_options :force => false
-    def destroy(instance_id)
-      server = fog.servers.get(instance_id)
-      if force_or_accept?("Terminate server #{server.display_name}?")
-        server.destroy
+    def destroy(*instance_ids)
+      instance_ids.each do |instance_id|
+        server = fog.servers.get(instance_id)
+        if force_or_accept?("Terminate server #{server.display_name}?")
+          server.destroy
+        end
       end
     end
 
@@ -34,31 +36,45 @@ module Breeze
       return server
     end
 
-    def wait_until_host_is_available(host)
+    # Can take a host name or an ip address. Resolves the host name
+    # and returns the ip address if get_ip is passed in as true.
+    def wait_until_host_is_available(host, get_ip=false)
       if Resolv.getaddresses(host).empty?
         print("Waiting for #{host} to resolve")
         wait_until('ready!') { Resolv.getaddresses(host).any? }
       end
-      return true if remote_is_available?(host)
-      print("Waiting for #{host} to accept connections")
-      wait_until('ready!') { remote_is_available?(host) }
+      host = Resolv.getaddresses(host).first if get_ip
+      unless remote_is_available?(host)
+        print("Waiting for #{host} to accept connections")
+        wait_until('ready!') { remote_is_available?(host) }
+      end
+      return host
     end
 
     def remote_is_available?(host)
-      execute(:remote_available?, :host => host)
+      execute("%{ssh_command} -q %{ssh_user}@%{host} exit", :host => host)
     end
 
+    # Execute a command on the remote host. Args is a hash that must include :host.
     def remote(command, args)
       args[:command] = command
-      execute(:remote_command, args)
+      execute("%{ssh_command} %{ssh_user}@%{host} '%{command}'", args)
     end
 
     def upload(file_pattern, args)
       args[:file_pattern] = file_pattern
-      execute(:upload_command, args)
+      args[:remote_path] ||= './'
+      execute('rsync -e "%{ssh_command}" -v %{file_pattern} %{ssh_user}@%{host}:%{remote_path}', args)
+    end
+
+    def download(remote_path, args)
+      args[:remote_path] = remote_path
+      args[:local_path] ||= './'
+      execute('rsync -e "%{ssh_command}" -v %{ssh_user}@%{host}:%{remote_path} %{local_path}', args)
     end
 
     def execute(command, args)
+      args = CONFIGURATION[:ssh].merge(args)
       command = CONFIGURATION[command] if command.is_a?(Symbol)
     #   system(command % args)
     # rescue ArgumentError # for ruby 1.8 compatibility

data/lib/breeze/tasks/server/image.rb

@@ -28,5 +28,16 @@ module Breeze
       puts("NOTICE: it may take a while before the new image shows up in describe:images")
     end
 
+    desc 'destroy IMAGE_ID [...]', 'Deregister the image and destroy the related volume snapshot'
+    method_options :force => false
+    def destroy(*image_ids)
+      image_ids.each do |image_id|
+        image = fog.images.get(image_id)
+        if force_or_accept?("Destroy image #{image.display_name}?")
+          image.deregister(true)
+        end
+      end
+    end
+
   end
 end

data/lib/templates/Thorfile

@@ -13,12 +13,9 @@ Breeze::CONFIGURATION = {
     :aws_secret_access_key => 'YOUR-SECTET-ACCESS-KEY'
   },
 
-  # Remote and upload commands are required in order to create a server image or deploy
-  # an application. Arguments marked with %{} are automatically replaced when the
-  # commands are used. Use "ssh -i /path/to/key" if not using your default ssh key.
-  :remote_available? => 'ssh -q ubuntu@%{host} exit',
-  :remote_command => "ssh ubuntu@%{host} '%{command}'",
-  :upload_command => 'rsync -v %{file_pattern} ubuntu@%{host}:%{remote_path}',
+  # ssh_command and ssh_user are required in order to create a server image or deploy
+  # an application. Use "ssh -i /path/to/key" if not using your default ssh key.
+  :ssh => {:ssh_command => "ssh -o 'UserKnownHostsFile /dev/null'", :ssh_user => 'ubuntu'},
 
   # :rollback_window specifies the number of minutes to keep old instances running after new ones
   # have been deployed. Rollback is no longer possible when the old instances have been destroyed.
@@ -91,7 +88,7 @@ class Breeze::App
 end
 
 # Define staging:start etc. below. The constants are also needed by
-# inherited tasks: deploy, rollback, enable and disable.
+# inherited tasks: deploy, rollback, enable, disable and ssh.
 
 class Staging < Breeze::App
 

data/lib/templates/profiles/rails_and_image_magick/configs/database.yml

@@ -3,7 +3,7 @@
   @owner = 'rails'
   @group = 'rails'
   @perms = 0640
-  @post = 'rake db:migrate RAILS_ENV=production'
+  @post = "sudo -u #{@owner} rake db:migrate RAILS_ENV=production"
 
   conf = CONFIGURATION[:default_db_options]
 %>

data/lib/templates/profiles/rails_and_image_magick/scripts/install_cust.sh

@@ -21,4 +21,5 @@ extract_and_install $IMAGE_MAGICK_PACKAGE "$IMAGE_MAGICK_OPTIONS"
 cat >> $HOME/.profile <<END_PROFILE
 # export RAILS_ENV=production
 # export EDITOR=vi
+# alias rails='sudo -E -u rails ./script/rails'
 END_PROFILE

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - Markus Bengts
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-03-23 00:00:00 +01:00
+date: 2011-04-19 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -44,6 +44,32 @@ dependencies:
         version: "0.7"
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: aruba
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
 description: |
   Breeze makes it easy to automate server installation and configuration. It provides
   example scripts and configuration files that you can modify and keep in your revision
@@ -65,6 +91,8 @@ files:
 - Rakefile
 - bin/breeze
 - breeze.gemspec
+- features/erb_conf.feature
+- features/support/env.rb
 - lib/breeze.rb
 - lib/breeze/fog_extensions.rb
 - lib/breeze/fog_extensions/aws.rb
@@ -128,6 +156,7 @@ rubyforge_project: breeze
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Thor tasks to manage AWS cloud computing resorces and deployments
-test_files: []
-
+summary: Thor tasks to manage cloud computing resources and deployments
+test_files: 
+- features/erb_conf.feature
+- features/support/env.rb