foreplay 0.0.2 → 0.0.3

data/README.md

@@ -103,8 +103,12 @@ end
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+1.  Fork it
+1.  Create your feature branch (`git checkout -b my-new-feature`)
+1.  Commit your changes (`git commit -am 'Add some feature'`)
+1.  Push to the branch (`git push origin my-new-feature`)
+1.  Create new Pull Request
+
+## Acknowledgements
+
+1.  Thanks to Ryan Bigg for the guide to making your first gem https://github.com/radar/guides/blob/master/gem-development.md

data/features/deploy.feature

@@ -91,6 +91,6 @@ Feature: deploy
   Scenario: deploy
     When I run `foreplay setup -r git@github.com:Xenapto/foreplay.git -s web.example.com --password "top-secret"`
       And I run `foreplay deploy production`
-    Then the output should contain "Deploying aruba to web.example.com in the web role on the production environment"
+    Then the output should contain "Deploying aruba to web.example.com for the web role in the production environment"
       And the output should contain "Connecting to web.example.com"
       And the output should contain "There was a problem starting an ssh session on web.example.com"

data/lib/foreplay/deploy.rb

@@ -1,6 +1,7 @@
 require 'thor/group'
 require 'yaml'
 require 'net/ssh'
+require 'net/ssh/shell'
 require 'active_support/inflector'
 require 'active_support/core_ext/object'
 require 'active_support/core_ext/hash'
@@ -15,7 +16,8 @@ module Foreplay
     argument :environment,  :type => :string, :required => true
     argument :filters,      :type => :hash,   :required => false
 
-    DEFAULTS_KEY = 'defaults'
+    DEFAULTS_KEY  = 'defaults'
+    INDENT        = ' ' * 4
 
     def parse
       # Explain what we're going to do
@@ -73,7 +75,7 @@ module Foreplay
       servers     = instructions[:servers]
       preposition = mode == :deploy ? 'to' : 'for'
 
-      puts "#{mode.capitalize}ing #{instructions[:name].yellow} #{preposition} #{servers.join(', ').yellow} in the #{instructions[:role].dup.yellow} role on the #{environment.dup.yellow} environment..." if servers.length > 1
+      puts "#{mode.capitalize}ing #{instructions[:name].yellow} #{preposition} #{servers.join(', ').yellow} for the #{instructions[:role].dup.yellow} role in the #{environment.dup.yellow} environment..." if servers.length > 1
       servers.each { |server| deploy_to_server server, instructions }
     end
 
@@ -88,7 +90,7 @@ module Foreplay
 
       instructions[:server] = server
 
-      puts "#{mode.capitalize}ing #{name.yellow} #{preposition} #{server.yellow} in the #{role.dup.yellow} role on the #{environment.dup.yellow} environment"
+      puts "#{mode.capitalize}ing #{name.yellow} #{preposition} #{server.yellow} for the #{role.dup.yellow} role in the #{environment.dup.yellow} environment"
 
       # Substitute variables in the path
       path.gsub! '%u', user
@@ -98,7 +100,7 @@ module Foreplay
       steps = [ { :command => 'mkdir -p .foreplay && touch .foreplay/current_port && cat .foreplay/current_port', :silent => true } ]
 
       current_port_string = execute_on_server(steps, instructions).strip!
-      puts current_port_string.blank? ? '    No instance is currently deployed' : "    Current instance is using port #{current_port_string}"
+      puts current_port_string.blank? ? "#{INDENT}No instance is currently deployed" : "#{INDENT}Current instance is using port #{current_port_string}"
 
       current_port = current_port_string.to_i
 
@@ -129,6 +131,8 @@ module Foreplay
           :commentary   => 'Trusting the .rvmrc file for the new instance' },
         { :command      => "cd #{current_port}",
           :commentary   => 'Configuring the new instance' },
+        { :command      => 'mkdir -p config',
+          :commentary   => "Making sure the config directory exists" },
         { :key          => :env,
           :delimiter    => '=',
           :prefix       => '.',
@@ -144,29 +148,31 @@ module Foreplay
           :before       => '  ',
           :header       => "#{environment}:",
           :path         => 'config/' },
-        { :command      => "bundle install",
+        { :command      => 'bundle install',
           :commentary   => 'Using bundler to install the required gems' },
-        { :command      => "sudo ln -f `which foreman` /usr/bin/foreman",
+        { :command      => 'sudo ln -f `which foreman` /usr/bin/foreman',
           :commentary   => 'Setting the current version of foreman to be the default' },
-        { :command      => "sudo foreman export upstart /etc/init",
+        { :command      => 'sudo foreman export upstart /etc/init',
           :commentary   => "Converting #{current_service} to an upstart service" },
         { :command      => "sudo start #{current_service} || sudo restart #{current_service}",
           :commentary   => 'Starting the service',
           :ignore_error => true },
         { :command      => 'sleep 60',
           :commentary   => 'Waiting 60s to give service time to start' },
-        { :command      => "sudo iptables -t nat -A PREROUTING -p tcp --dport 80 -j REDIRECT --to-port #{current_port.to_i + 100}",
+        { :command      => "sudo iptables -t nat -A PREROUTING -p tcp --dport 80 -j REDIRECT --to-port #{current_port}",
           :commentary   => "Adding firewall rule to direct incoming traffic on port 80 to port #{current_port}" },
-        { :command      => "sudo iptables -t nat -D PREROUTING -p tcp --dport 80 -j REDIRECT --to-port #{former_port.to_i + 100}",
-          :commentary   => "Removing previous firewall directing traffic to port #{former_port}",
+        { :command      => "sudo iptables -t nat -D PREROUTING -p tcp --dport 80 -j REDIRECT --to-port #{former_port}",
+          :commentary   => "Removing previous firewall rule directing traffic to port #{former_port}",
           :ignore_error => true },
-        { :command      => "sudo iptables-save > /etc/iptables/rules.v4",
-          :commentary   => "Saving iptables rules to /etc/iptables/rules.v4" },
-        { :command      => "sudo iptables-save > /etc/iptables.up.rules",
-          :commentary   => "Saving iptables rules to /etc/iptables.up.rules" },
-        { :command      => "sudo iptables-save -c | egrep REDIRECT --color=never",
+        { :command      => 'sudo iptables-save > /etc/iptables/rules.v4',
+          :commentary   => 'Attempting to save firewall rules to /etc/iptables/rules.v4',
+          :ignore_error => true },
+        { :command      => 'sudo iptables-save > /etc/iptables.up.rules',
+          :commentary   => 'Attempting to save firewall rules to /etc/iptables.up.rules',
+          :ignore_error => true },
+        { :command      => 'sudo iptables-save -c | egrep REDIRECT --color=never',
           :ignore_error => true,
-          :commentary   => "Current firewall NAT configuration:" },
+          :commentary   => 'Current firewall NAT configuration:' },
         { :command      => "sudo stop #{former_service} || echo 'No previous instance running'",
           :commentary   => 'Stopping the previous instance',
           :ignore_error => true },
@@ -192,10 +198,10 @@ module Foreplay
         if private_key.blank?
           terminate('No authentication methods supplied. You must supply a private key, key file or password in the configuration file') if keyfile.blank?
           # Get the key from the key file
-          puts "    Using private key from #{keyfile}"
+          puts "#{INDENT}Using private key from #{keyfile}"
           private_key = File.read keyfile
         else
-          puts "    Using private key from the configuration file"
+          puts "#{INDENT}Using private key from the configuration file"
         end
 
         options[:key_data] = [private_key]
@@ -208,12 +214,12 @@ module Foreplay
       output = ''
 
       if mode == :deploy
-        puts "    Connecting to #{server}"
+        puts "#{INDENT}Connecting to #{server}"
 
         # SSH connection
         begin
           Net::SSH.start(server, user, options) do |session|
-            puts "    Successfully connected to #{server}"
+            puts "#{INDENT}Successfully connected to #{server}"
 
             session.shell do |sh|
               steps.each do |step|
@@ -234,7 +240,7 @@ module Foreplay
                   sh.wait!
 
                   if step[:ignore_error] == true || process.exit_status == 0
-                    print output.gsub!(/^/, "        ") unless step[:silent] == true
+                    print output.gsub!(/^/, INDENT * 2) unless step[:silent] == true || output.blank?
                   else
                     terminate(output)
                   end
@@ -250,7 +256,7 @@ module Foreplay
         steps.each do |step|
           commands = build_commands step, instructions
 
-          commands.each { |command| puts "        #{command}" unless step[:silent] }
+          commands.each { |command| puts "#{INDENT * 2}#{command}" unless step[:silent] }
         end
       end
 
@@ -258,7 +264,7 @@ module Foreplay
     end
 
     def build_commands step, instructions
-      puts "    #{(step[:commentary] || step[:command]).yellow}" unless step[:silent] == true
+      puts "#{INDENT}#{(step[:commentary] || step[:command]).yellow}" unless step[:silent] == true
 
       # Each step can be (1) a command or (2) a series of values to add to a file
       if step.has_key? :key

data/lib/foreplay/version.rb

@@ -1,3 +1,3 @@
 module Foreplay
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/lib/foreplay/deploy_spec.rb

@@ -54,50 +54,10 @@ describe Foreplay::Deploy do
     expect { Foreplay::Deploy.start([:deploy, 'production', '']) }.to raise_error(RuntimeError, /.*There was a problem starting an ssh session on web.example.com*/)
   end
 
-	it "should check the config" do
-    output = <<OUTPUT
-Checking \e[0;33;49mproduction\e[0m environment, all roles, all servers
-Checking \e[0;33;49mforeplay\e[0m for \e[0;33;49mweb.example.com\e[0m in the \e[0;33;49mweb\e[0m role on the \e[0;33;49mproduction\e[0m environment
-    No instance is currently deployed
-    \e[0;33;49mSetting the port for the new instance to 50000\e[0m
-        echo 50000 > .foreplay/current_port
-    \e[0;33;49mCloning repository git@github.com:Xenapto/foreplay.git\e[0m
-        mkdir -p apps/foreplay && cd apps/foreplay && rm -rf 50000 && git clone git@github.com:Xenapto/foreplay.git 50000
-    \e[0;33;49mTrusting the .rvmrc file for the new instance\e[0m
-        rvm rvmrc trust 50000
-    \e[0;33;49mConfiguring the new instance\e[0m
-        cd 50000
-    \e[0;33;49mBuilding .env\e[0m
-    \e[0;33;49mBuilding .foreman\e[0m
-    \e[0;33;49mBuilding config/database.yml\e[0m
-    \e[0;33;49mUsing bundler to install the required gems\e[0m
-        bundle install
-    \e[0;33;49mSetting the current version of foreman to be the default\e[0m
-        sudo ln -f `which foreman` /usr/bin/foreman
-    \e[0;33;49mConverting foreplay-50000 to an upstart service\e[0m
-        sudo foreman export upstart /etc/init
-    \e[0;33;49mStarting the service\e[0m
-        sudo start foreplay-50000 || sudo restart foreplay-50000
-    \e[0;33;49mWaiting 60s to give service time to start\e[0m
-        sleep 60
-    \e[0;33;49mAdding firewall rule to direct incoming traffic on port 80 to port 50000\e[0m
-        sudo iptables -t nat -A PREROUTING -p tcp --dport 80 -j REDIRECT --to-port 50100
-    \e[0;33;49mRemoving previous firewall directing traffic to port 51000\e[0m
-        sudo iptables -t nat -D PREROUTING -p tcp --dport 80 -j REDIRECT --to-port 51100
-    \e[0;33;49mSaving iptables rules to /etc/iptables/rules.v4\e[0m
-        sudo iptables-save > /etc/iptables/rules.v4
-    \e[0;33;49mSaving iptables rules to /etc/iptables.up.rules\e[0m
-        sudo iptables-save > /etc/iptables.up.rules
-    \e[0;33;49mCurrent firewall NAT configuration:\e[0m
-        sudo iptables-save -c | egrep REDIRECT --color=never
-    \e[0;33;49mStopping the previous instance\e[0m
-        sudo stop foreplay-51000 || echo 'No previous instance running'
-Deployment configuration check was successful
-OUTPUT
-
-    output.split("\n").reverse.each { |line| $stdout.should_receive(:puts).with(line) }
-		Foreplay::Deploy.start [:check, 'production', '']
-	end
+  it "should check the config" do
+    $stdout.should_receive(:puts).at_least(:once)
+    Foreplay::Deploy.start [:check, 'production', '']
+  end
 
   it "should deploy to the environment" do
     Net::SSH.should_receive(:start).with('web.example.com', 'fred', { :verbose => :warn, :password => 'trollope' }).and_yield(session)
@@ -126,8 +86,8 @@ OUTPUT
       'sudo foreman export upstart /etc/init',
       'sudo start foreplay-50000 || sudo restart foreplay-50000',
       'sleep 60',
-      'sudo iptables -t nat -A PREROUTING -p tcp --dport 80 -j REDIRECT --to-port 50100',
-      'sudo iptables -t nat -D PREROUTING -p tcp --dport 80 -j REDIRECT --to-port 51100',
+      'sudo iptables -t nat -A PREROUTING -p tcp --dport 80 -j REDIRECT --to-port 50000',
+      'sudo iptables -t nat -D PREROUTING -p tcp --dport 80 -j REDIRECT --to-port 51000',
       'sudo iptables-save > /etc/iptables/rules.v4',
       'sudo iptables-save > /etc/iptables.up.rules',
       'sudo iptables-save -c | egrep REDIRECT --color=never',

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: foreplay
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-09 00:00:00.000000000 Z
+date: 2013-11-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -224,7 +224,6 @@ files:
 - features/support/env.rb
 - foreplay.gemspec
 - foreplay.rake
-- foreplay.rb
 - lib/foreplay.rb
 - lib/foreplay/cli.rb
 - lib/foreplay/deploy.rb
@@ -251,7 +250,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -981112274767649738
+      hash: -3290811328696495946
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -260,7 +259,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -981112274767649738
+      hash: -3290811328696495946
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25

data/foreplay.rb

@@ -1,246 +0,0 @@
-# encoding: utf-8
-require 'yaml'
-require 'net/ssh'
-
-class Foreplay
-  class << self
-    def push check_only = false
-      environment = ENV['ENV']
-      config_file = "#{Rails.root}/config/foreplay.yml"
-      config_all  = YAML.load(File.read(config_file))
-
-      # This environment
-      raise RuntimeError, "No deployment environment defined. Set the ENV environment variable." if environment.blank?
-      raise RuntimeError, "No deployment configuration defined for #{environment} environment. Check #{config_file}" unless config_all.has_key? environment
-      config = config_all[environment]
-
-      # Establish defaults
-      # First the default defaults
-      defaults = {
-        'name'        => Rails.application.class.parent_name.underscore,
-        'environment' => environment,
-        'env'         => { 'RAILS_ENV' => environment }
-      }
-
-      defaults = deep_merge_with_arrays(defaults, config_all['defaults'])  if config_all.has_key? 'defaults'  # Then the global defaults
-      defaults = deep_merge_with_arrays(defaults, config['defaults'])      if config.has_key? 'defaults'      # Then the defaults for this environment
-
-      config.each do |role, additional_instructions|
-        next if role == 'defaults' # 'defaults' is not a role
-        next unless ENV['ROLE'].blank? || ENV['ROLE'] == role # Only deploy to the role we've specified (or all roles if none is specified)
-
-        instructions        = deep_merge_with_arrays(defaults, additional_instructions).symbolize_keys
-        instructions[:role] = role
-        required_keys       = [:name, :environment, :role, :servers, :path, :repository]
-
-        required_keys.each { |key| raise RuntimeError, "Required key #{key} not found in instructions for #{environment} environment. Check #{config_file}" unless instructions.has_key? key }
-
-        deploy_role instructions unless check_only
-      end
-
-      puts check_only ? 'Deployment configuration check was successful' : 'Finished deployment'
-    end
-
-    def deploy_role instructions
-      servers = instructions[:servers]
-      puts "Deploying #{instructions[:name]} to #{servers.join(', ')} for the #{instructions[:role]} role in the #{instructions[:environment]} environment..." if servers.length > 1
-      servers.each { |server| deploy_to_server server, instructions }
-    end
-
-    def deploy_to_server server, instructions
-      name        = instructions[:name]
-      environment = instructions[:environment]
-      role        = instructions[:role]
-      path        = instructions[:path]
-      repository  = instructions[:repository]
-      user        = instructions[:user]
-
-      instructions[:server] = server
-
-      puts "Deploying #{name} to #{server} for the #{role} role in the #{environment} environment"
-
-      # Substitute variables in the path
-      path.sub! '%u', user
-      path.sub! '%a', name
-
-      # Find out which port we're currently running on
-      steps = [ { :command => 'mkdir -p .foreplay && touch .foreplay/current_port && cat .foreplay/current_port', :silent => true } ]
-
-      current_port = execute_on_server(steps, instructions).strip!
-      puts "Current instance is using port #{current_port}"
-
-      # Switch ports
-      if current_port == '50000'
-        current_port  = '51000'
-        former_port   = '50000'
-      else
-        current_port  = '50000'
-        former_port   = '51000'
-      end
-
-      # Contents of .foreman file
-      current_service = '%s-%s' % [name, current_port]
-      former_service  = '%s-%s' % [name, former_port]
-
-      instructions[:foreman]['app']   = current_service
-      instructions[:foreman]['port']  = current_port
-      instructions[:foreman]['user']  = user
-
-      # Commands to execute on remote server
-      steps = [
-        { :command      => "echo #{current_port} > .foreplay/current_port" },
-        { :command      => "mkdir -p #{path} && cd #{path} && rm -rf #{current_port} && git clone #{repository} #{current_port}",
-          :commentary   => "Cloning repository #{repository}" },
-        { :command      => "rvm rvmrc trust #{current_port}" },
-        { :command      => "cd #{current_port}" },
-        { :key          => :env,
-          :delimiter    => '=',
-          :prefix       => '.',
-          :commentary   => 'Building .env' },
-        { :key          => :foreman,
-          :delimiter    => ': ',
-          :prefix       => '.',
-          :commentary   => 'Building .foreman' },
-        { :key          => :database,
-          :delimiter    => ': ',
-          :suffix       => '.yml',
-          :commentary   => 'Building config/database.yml',
-          :before       => '  ',
-          :header       => "#{environment}:", 
-          :path         => 'config/' },
-        { :command      => "bundle install" },
-        { :command      => "sudo ln -f `which foreman` /usr/bin/foreman" },
-        { :command      => "sudo foreman export upstart /etc/init" },
-        { :command      => "sudo start #{current_service} || sudo restart #{current_service}",
-          :ignore_error => true },
-        { :command      => 'sleep 60',
-          :commentary   => 'Waiting 60s to give service time to start' },
-        { :command      => "sudo iptables -t nat -A PREROUTING -p tcp --dport 80 -j REDIRECT --to-port #{current_port.to_i + 100}",
-          :commentary   => "Adding firewall rule to direct incoming traffic on port 80 to port #{current_port}" },
-        { :command      => "sudo iptables -t nat -D PREROUTING -p tcp --dport 80 -j REDIRECT --to-port #{former_port.to_i + 100}",
-          :commentary   => "Removing previous firewall directing traffic to port #{former_port}",
-          :ignore_error => true },
-        { :command      => "sudo iptables -t nat -L | grep REDIRECT",
-          :ignore_error => true,
-          :commentary   => "Current firewall NAT configuration:" },
-        { :command      => "sudo stop #{former_service} || echo 'No previous instance running'",
-          :ignore_error => true },
-      ]
-
-      execute_on_server steps, instructions
-    end
-
-    def execute_on_server steps, instructions
-      server      = instructions[:server]
-      user        = instructions[:user]
-      password    = instructions[:password]
-      keyfile     = instructions[:keyfile]
-      key         = instructions[:key]
-
-      keyfile.sub! '~' , ENV['HOME'] # Remote shell won't expand this for us
-
-      # SSH authentication methods
-      options = { :verbose => :warn }
-
-      if password.blank?
-        # If there's no password we must supply a private key
-        if key.blank?
-          raise RuntimeError, "No authentication methods supplied. You must supply a private key, key file or password in the configuration file" if keyfile.blank?
-          # Get the key from the key file
-          puts "Using private key from #{keyfile}"
-          key = File.read keyfile
-        else
-          puts "Using private key from the configuration file"
-        end
-
-        options[:key_data] = [key]
-      else
-        # Use the password supplied
-        options[:password] = password
-      end
-
-      # Capture output of last command to return to the calling routine
-      output = ''
-
-      # SSH connection
-      Net::SSH.start(server, user, options) do |ssh|
-        puts "Successfully connected to #{server}"
-
-        ssh.shell do |sh|
-          steps.each do |step|
-            # Output from this step
-            output    = ''
-            previous  = '' # We don't need or want the final CRLF
-
-            puts step[:commentary] || step[:command] unless step[:silent] == true
-
-            # Each step can be (1) a command or (2) a series of values to add to a file
-            if step.has_key? :key
-              step[:silent] = true
-
-              # Add values from the config file to a file on the remote machine
-              key       = step[:key]
-              prefix    = step[:prefix]     || ''
-              suffix    = step[:suffix]     || ''
-              path      = step[:path]       || ''
-              before    = step[:before]     || ''
-              delimiter = step[:delimiter]  || ''
-              after     = step[:after]      || ''
-
-              filename  = '%s%s%s%s' % [path, prefix, key, suffix]
-              commands  = step.has_key?(:header) ? ['echo "%s" >> %s' % [step[:header], filename]] : []
-
-              instructions[key].each { |k, v| commands << 'echo "%s%s%s%s%s" >> %s' % [before, k, delimiter, v, after, filename] }
-            else
-              # ...or just execute the command specified
-              commands = [step[:command]]
-            end
-
-            commands.each do |command|
-              process = sh.execute command
-
-              process.on_output do |p, o|
-                previous  = o
-                output    += previous
-              end
-
-              sh.wait!
-
-              if step[:ignore_error] == true || process.exit_status == 0
-                print "#{output}" unless step[:silent] == true
-              else
-                raise RuntimeError, output
-              end
-            end
-          end
-        end
-      end
-
-      output
-    end
-
-    # Returns a new hash with +hash+ and +other_hash+ merged recursively, including arrays.
-    #
-    #   h1 = { x: { y: [4,5,6] }, z: [7,8,9] }
-    #   h2 = { x: { y: [7,8,9] }, z: 'xyz' }
-    #   h1.deep_merge_with_arrays(h2)
-    #   #=> {:x=>{:y=>[4, 5, 6, 7, 8, 9]}, :z=>[7, 8, 9, "xyz"]}
-    def deep_merge_with_arrays(hash, other_hash)
-      new_hash = hash.deep_dup
-
-      other_hash.each_pair do |k,v|
-        tv = new_hash[k]
-
-        if tv.is_a?(Hash) && v.is_a?(Hash)
-          new_hash[k] = deep_merge_with_arrays(tv, v)
-        elsif tv.is_a?(Array) || v.is_a?(Array)
-          new_hash[k] = Array.wrap(tv) + Array.wrap(v)
-        else
-          new_hash[k] = v
-        end
-      end
-
-      new_hash
-    end
-  end
-end