foreplay 0.7.6 → 0.8.0

data/lib/foreplay/engine.rb

@@ -0,0 +1,138 @@
+require 'yaml'
+require 'string'
+
+class Foreplay::Engine
+  include Foreplay
+  attr_reader :environment, :filters, :mode
+
+  DEFAULTS_KEY  = 'defaults'
+  CONFIG_FILE   = "#{Dir.getwd}/config/foreplay.yml"
+
+  def initialize(e, f)
+    @environment  = e
+    @filters      = f
+  end
+
+  def deploy
+    @mode = :deploy
+    execute
+  end
+
+  def check
+    @mode = :check
+    execute
+  end
+
+  def execute
+    # Explain what we're going to do
+    puts "#{mode.capitalize}ing #{environment.dup.yellow} environment, "\
+         "#{explanatory_text(filters, 'role')}, #{explanatory_text(filters, 'server')}"
+
+    threads = []
+
+    roles.each do |role, additional_instructions|
+      next if role == DEFAULTS_KEY # 'defaults' is not a role
+      next if filters.key?('role') && filters['role'] != role
+
+      threads.concat Foreplay::Engine::Role.new(
+        environment,
+        mode,
+        build_instructions(role, additional_instructions)
+      ).threads
+    end
+
+    threads.each(&:join)
+
+    puts mode == :deploy ? 'Finished deployment' : 'Deployment configuration check was successful'
+  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.supermerge(h2)
+  #   #=> {:x=>{:y=>[4, 5, 6, 7, 8, 9]}, :z=>[7, 8, 9, "xyz"]}
+  def supermerge(hash, other_hash)
+    fail 'supermerge only works if you pass two hashes. '\
+      "You passed a #{hash.class} and a #{other_hash.class}." unless hash.is_a?(Hash) && other_hash.is_a?(Hash)
+
+    new_hash = hash.deep_dup.with_indifferent_access
+
+    other_hash.each_pair do |k, v|
+      tv = new_hash[k]
+
+      if tv.is_a?(Hash) && v.is_a?(Hash)
+        new_hash[k] = supermerge(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
+
+  private
+
+  def explanatory_text(hsh, key)
+    hsh.key?(key) ? "#{hsh[key].dup.yellow} #{key}" : "all #{key.pluralize}"
+  end
+
+  def build_instructions(role, additional_instructions)
+    instructions        = supermerge(defaults, additional_instructions).symbolize_keys
+    instructions[:role] = role
+    required_keys       = [:name, :environment, :role, :servers, :path, :repository]
+
+    required_keys.each do |key|
+      next if instructions.key? key
+      terminate("Required key #{key} not found in instructions for #{environment} environment.\nCheck #{CONFIG_FILE}")
+    end
+
+    # Apply server filter
+    instructions[:servers] &= server_filter if server_filter
+    instructions
+  end
+
+  def server_filter
+    @server_filter ||= filters['server'].split(',') if filters.key?('server')
+  end
+
+  def defaults
+    return @defaults if @defaults
+
+    # Establish defaults
+    # First the default defaults
+    @defaults = {
+      name:         File.basename(Dir.getwd),
+      environment:  environment,
+      env:          { 'RAILS_ENV' => environment },
+      port:         50_000
+    }
+
+    @defaults = supermerge(@defaults, roles_all[DEFAULTS_KEY]) if roles_all.key? DEFAULTS_KEY
+    @defaults = supermerge(@defaults, roles[DEFAULTS_KEY])     if roles.key? DEFAULTS_KEY
+  end
+
+  def roles
+    @roles ||= roles_all[environment]
+  end
+
+  def roles_all
+    return @roles_all if @roles_all
+
+    @roles_all = YAML.load(File.read(CONFIG_FILE))
+
+    # This environment
+    unless @roles_all.key? environment
+      terminate("No deployment configuration defined for #{environment} environment.\nCheck #{CONFIG_FILE}")
+    end
+
+    @roles_all
+  rescue Errno::ENOENT
+    terminate "Can't find configuration file #{CONFIG_FILE}.\nPlease run foreplay setup or create the file manually."
+  rescue Psych::SyntaxError
+    terminate "I don't understand the configuration file #{CONFIG_FILE}.\n"\
+      'Please run foreplay setup or edit the file manually.'
+  end
+end

data/lib/foreplay/foreplay.rb

@@ -0,0 +1,10 @@
+require 'active_support/core_ext/object'
+require 'active_support/core_ext/hash'
+
+module Foreplay
+  INDENT = "\t"
+
+  def terminate(message)
+    fail message
+  end
+end

data/lib/foreplay/launcher.rb

@@ -0,0 +1,13 @@
+require 'thor/group'
+
+class Foreplay::Launcher < Thor::Group
+  include Thor::Actions
+
+  argument :mode,         type: :string, required: true
+  argument :environment,  type: :string, required: true
+  argument :filters,      type: :hash,   required: false
+
+  def parse
+    Foreplay::Engine.new(environment, filters).__send__ mode
+  end
+end

data/lib/foreplay/setup.rb

@@ -1,33 +1,31 @@
 require 'thor/group'
 
-module Foreplay
-  class Setup < Thor::Group
-    include Thor::Actions
+class Foreplay::Setup < Thor::Group
+  include Thor::Actions
 
-    class_option :name,         aliases: '-n', default: File.basename(Dir.getwd)
-    class_option :repository,   aliases: '-r'
-    class_option :user,         aliases: '-u'
-    class_option :password
-    class_option :keyfile
-    class_option :private_key,  aliases: '-k'
-    class_option :port,         aliases: '-p', default: 50_000
-    class_option :path,         aliases: '-f'
-    class_option :servers,      aliases: '-s', type: :array
-    class_option :db_adapter,   aliases: '-a', default: 'postgresql'
-    class_option :db_encoding,  aliases: '-e', default: 'utf8'
-    class_option :db_pool,                     default: 5
-    class_option :db_name,      aliases: '-d'
-    class_option :db_host,      aliases: '-h'
-    class_option :db_user
-    class_option :db_password
-    class_option :resque_redis
+  class_option :name,         aliases: '-n', default: File.basename(Dir.getwd)
+  class_option :repository,   aliases: '-r'
+  class_option :user,         aliases: '-u'
+  class_option :password
+  class_option :keyfile
+  class_option :private_key,  aliases: '-k'
+  class_option :port,         aliases: '-p', default: 50_000
+  class_option :path,         aliases: '-f'
+  class_option :servers,      aliases: '-s', type: :array
+  class_option :db_adapter,   aliases: '-a', default: 'postgresql'
+  class_option :db_encoding,  aliases: '-e', default: 'utf8'
+  class_option :db_pool,                     default: 5
+  class_option :db_name,      aliases: '-d'
+  class_option :db_host,      aliases: '-h'
+  class_option :db_user
+  class_option :db_password
+  class_option :resque_redis
 
-    def self.source_root
-      File.dirname(__FILE__)
-    end
+  def self.source_root
+    File.dirname(__FILE__)
+  end
 
-    def config
-      template('setup/foreplay.yml', 'config/foreplay.yml')
-    end
+  def config
+    template('setup/foreplay.yml', 'config/foreplay.yml')
   end
 end

data/lib/foreplay/version.rb

@@ -1,3 +1,3 @@
 module Foreplay
-  VERSION = '0.7.6'
+  VERSION = '0.8.0'
 end

data/lib/foreplay.rb

@@ -1,4 +1,8 @@
 require 'foreplay/version'
-require 'foreplay/setup'
-require 'foreplay/deploy'
-require 'foreplay/utility'
+require 'foreplay/foreplay'
+require 'foreplay/launcher'
+require 'foreplay/engine'
+require 'foreplay/engine/remote'
+require 'foreplay/engine/role'
+require 'foreplay/engine/server'
+require 'foreplay/engine/step'

data/lib/string.rb

@@ -0,0 +1,17 @@
+# Some useful additions to the String class
+class String
+  colors = %w(black red green yellow blue magenta cyan white)
+
+  colors.each_with_index do |fg_color, i|
+    fg = 30 + i
+    define_method(fg_color) { ansi_attributes(fg) }
+
+    colors.each_with_index do |bg_color, j|
+      define_method("#{fg_color}_on_#{bg_color}") { ansi_attributes(fg, 40 + j) }
+    end
+  end
+
+  def ansi_attributes(*args)
+    "\e[#{args.join(';')}m#{self}\e[0m"
+  end
+end

data/spec/lib/foreplay/deploy_spec.rb

@@ -1,8 +1,8 @@
 require 'spec_helper'
-require 'foreplay'
 require 'net/ssh/shell'
+require 'foreplay'
 
-describe Foreplay::Deploy do
+describe Foreplay::Launcher do
   let(:session) { double(Net::SSH::Connection::Session) }
   let(:shell)   { double(Net::SSH::Shell) }
   let(:process) { double(Net::SSH::Shell::Process) }
@@ -10,7 +10,13 @@ describe Foreplay::Deploy do
   before :each do
     # Setup foreplay
     `rm -f config/foreplay.yml`
-    `foreplay setup -r git@github.com:Xenapto/foreplay.git -s web1.example.com web2.example.com -f apps/%a -u fred --password trollope`
+    command = 'foreplay setup '\
+              '-r git@github.com:Xenapto/foreplay.git '\
+              '-s web1.example.com web2.example.com '\
+              '-f apps/%a '\
+              '-u fred '\
+              '--password trollope'
+    `#{command}`
 
     # Stub all the things
     allow(Net::SSH).to receive(:start).and_return(session)
@@ -24,37 +30,68 @@ describe Foreplay::Deploy do
 
   it "complains on check if there's no config file" do
     `rm -f config/foreplay.yml`
-    expect { Foreplay::Deploy.start([:check, 'production', '']) }
+    expect { Foreplay::Launcher.start([:check, 'production', '']) }
       .to raise_error(RuntimeError, /.*Please run foreplay setup or create the file manually.*/)
   end
 
   it "complains on deploy if there's no config file" do
     `rm -f config/foreplay.yml`
-    expect { Foreplay::Deploy.start([:deploy, 'production', '']) }
+    expect { Foreplay::Launcher.start([:deploy, 'production', '']) }
       .to raise_error(RuntimeError, /.*Please run foreplay setup or create the file manually.*/)
   end
 
+  it 'complains on check if the config file is not valid YAML' do
+    `echo %*:*: > config/foreplay.yml`
+    expect { Foreplay::Launcher.start([:check, 'production', '']) }
+      .to raise_error(RuntimeError, /.*Please run foreplay setup or edit the file manually.*/)
+  end
+
+  it 'complains on deploy if the config file is not valid YAML' do
+    `echo %*:*: > config/foreplay.yml`
+    expect { Foreplay::Launcher.start([:deploy, 'production', '']) }
+      .to raise_error(RuntimeError, /.*Please run foreplay setup or edit the file manually.*/)
+  end
+
   it 'complains if there are no authentication methods defined in the config file' do
+    command = 'foreplay setup '\
+              '-r git@github.com:Xenapto/foreplay.git '\
+              '-s web.example.com '\
+              '-f apps/%a '\
+              '-u fred '\
+              '--password ""'
+
+    match = 'No authentication methods supplied. '\
+            'You must supply a private key, key file or password in the configuration file.'
+
     `rm -f config/foreplay.yml`
-    `foreplay setup -r git@github.com:Xenapto/foreplay.git -s web.example.com -f apps/%a -u fred --password ""`
-    expect { Foreplay::Deploy.start([:deploy, 'production', '']) }
+    `#{command}`
+
+    expect { Foreplay::Launcher.start([:deploy, 'production', '']) }
       .to raise_error(
         RuntimeError,
-        /.*No authentication methods supplied. You must supply a private key, key file or password in the configuration file.*/
+        /.*#{Regexp.quote(match)}*/
       )
   end
 
   it "complains if the private keyfile defined in the config file doesn't exist" do
+    command = 'foreplay setup '\
+              '-r git@github.com:Xenapto/foreplay.git '\
+              '-s web.example.com '\
+              '-f apps/%a '\
+              '-u fred '\
+              '--keyfile "/home/fred/no-such-file"'
+
     `rm -f config/foreplay.yml`
-    `foreplay setup -r git@github.com:Xenapto/foreplay.git -s web.example.com -f apps/%a -u fred --keyfile "/home/fred/no-such-file"`
-    expect { Foreplay::Deploy.start([:deploy, 'production', '']) }
+    `#{command}`
+
+    expect { Foreplay::Launcher.start([:deploy, 'production', '']) }
       .to raise_error(Errno::ENOENT, %r{.*No such file or directory @ rb_sysopen - /home/fred/no-such-file.*})
   end
 
   it 'complains if a mandatory key is missing from the config file' do
     `sed -i 's/path:/pxth:/' config/foreplay.yml`
 
-    expect { Foreplay::Deploy.start([:deploy, 'production', '']) }
+    expect { Foreplay::Launcher.start([:deploy, 'production', '']) }
       .to raise_error(
         RuntimeError,
         /.*Required key path not found in instructions for production environment.*/
@@ -62,7 +99,7 @@ describe Foreplay::Deploy do
   end
 
   it 'complains if we try to deploy an environment that isn\'t defined' do
-    expect { Foreplay::Deploy.start([:deploy, 'unknown', '']) }
+    expect { Foreplay::Launcher.start([:deploy, 'unknown', '']) }
       .to raise_error(
         RuntimeError,
         /.*No deployment configuration defined for unknown environment.*/
@@ -71,18 +108,18 @@ describe Foreplay::Deploy do
 
   it 'terminates if a remote process exits with a non-zero status' do
     allow(process).to receive(:exit_status).and_return(1)
-    expect { Foreplay::Deploy.start([:deploy, 'production', '']) }.to raise_error(RuntimeError, /.*output message.*/)
+    expect { Foreplay::Launcher.start([:deploy, 'production', '']) }.to raise_error(RuntimeError, /.*output message.*/)
   end
 
   it "terminates if a connection can't be established with the remote server" do
     allow(Net::SSH).to receive(:start).and_call_original
-    expect { Foreplay::Deploy.start([:deploy, 'production', '']) }
+    expect { Foreplay::Launcher.start([:deploy, 'production', '']) }
       .to raise_error(RuntimeError, /.*There was a problem starting an ssh session on web1.example.com.*/)
   end
 
   it 'checks the config' do
     expect($stdout).to receive(:puts).at_least(:once)
-    Foreplay::Deploy.start [:check, 'production', '']
+    Foreplay::Launcher.start [:check, 'production', '']
   end
 
   it 'deploys to the environment' do
@@ -93,7 +130,9 @@ describe Foreplay::Deploy do
       .and_return(session)
 
     [
-      'mkdir -p apps/foreplay && cd apps/foreplay && rm -rf 50000 && git clone -b master git@github.com:Xenapto/foreplay.git 50000',
+      "echo Foreplay version #{Foreplay::VERSION}",
+      'mkdir -p apps/foreplay && cd apps/foreplay && rm -rf 50000 && '\
+      'git clone -b master git@github.com:Xenapto/foreplay.git 50000',
       'rvm rvmrc trust 50000',
       'rvm rvmrc warning ignore 50000',
       'cd 50000 && mkdir -p tmp doc log config',
@@ -113,11 +152,13 @@ describe Foreplay::Deploy do
       'echo "  password: TODO Put here the database user\'s password" >> config/database.yml',
       'if [ -d ../cache/vendor/bundle/bundle ] ; then rm -rf ../cache/vendor/bundle/bundle'\
       ' ; else echo No evidence of legacy copy bug ; fi',
-      'if [ -d ../cache/vendor/bundle ] ; then rsync -aW --no-compress --delete --info=STATS3 ../cache/vendor/bundle/ vendor/bundle'\
+      'if [ -d ../cache/vendor/bundle ] ; then '\
+      'rsync -aW --no-compress --delete --info=STATS1 ../cache/vendor/bundle/ vendor/bundle'\
       ' ; else echo No bundle to restore ; fi',
       'sudo ln -f `which bundle` /usr/bin/bundle || echo Using default version of bundle',
       'bundle install --deployment --clean --jobs 2 --without development test',
-      'mkdir -p ../cache/vendor && rsync -aW --no-compress --delete --info=STATS1 vendor/bundle/ ../cache/vendor/bundle',
+      'mkdir -p ../cache/vendor && '\
+      'rsync -aW --no-compress --delete --info=STATS1 vendor/bundle/ ../cache/vendor/bundle',
       'if [ -f public/assets/manifest.yml ] ; then echo "Not precompiling assets"'\
       ' ; else RAILS_ENV=production bundle exec foreman run rake assets:precompile ; fi',
       'sudo bundle exec foreman export upstart /etc/init',
@@ -135,24 +176,38 @@ describe Foreplay::Deploy do
       expect(shell).to receive(:execute).with(command).and_return(process)
     end
 
-    Foreplay::Deploy.start [:deploy, 'production', '']
+    Foreplay::Launcher.start [:deploy, 'production', '']
   end
 
   it "uses another port if there's already an installed instance" do
     allow(process).to receive(:on_output).and_yield(process, "50000\n")
     expect(shell).to receive(:execute).with('echo 51000 > $HOME/.foreplay/foreplay/current_port').and_return(process)
-    Foreplay::Deploy.start [:deploy, 'production', '']
+    Foreplay::Launcher.start [:deploy, 'production', '']
   end
 
   it 'uses the private key provided in the config file' do
+    command = 'foreplay setup '\
+              '-r git@github.com:Xenapto/foreplay.git '\
+              '-s web.example.com '\
+              '-f apps/%a '\
+              '-u fred '\
+              '-k "top secret private key"'
+
     `rm -f config/foreplay.yml`
-    `foreplay setup -r git@github.com:Xenapto/foreplay.git -s web.example.com -f apps/%a -u fred -k "top secret private key"`
-    Foreplay::Deploy.start([:deploy, 'production', ''])
+    `#{command}`
+    Foreplay::Launcher.start([:deploy, 'production', ''])
   end
 
   it 'adds Redis details for Resque' do
+    command = 'foreplay setup '\
+              '-r git@github.com:Xenapto/foreplay.git '\
+              '-s web.example.com '\
+              '-f apps/%a '\
+              '-u fred '\
+              '--resque-redis "redis://localhost:6379"'
+
     `rm -f config/foreplay.yml`
-    `foreplay setup -r git@github.com:Xenapto/foreplay.git -s web.example.com -f apps/%a -u fred --resque-redis "redis://localhost:6379"`
-    Foreplay::Deploy.start([:deploy, 'production', ''])
+    `#{command}`
+    Foreplay::Launcher.start([:deploy, 'production', ''])
   end
 end

data/spec/lib/foreplay/engine_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+require 'foreplay'
+
+describe Foreplay::Engine do
+  context '#supermerge' do
+    let(:engine) { Foreplay::Engine.new('b', 'b') }
+
+    it 'should complain unless two hashes are passed to it' do
+      expect { engine.supermerge('x', 'y') }.to raise_error(RuntimeError)
+    end
+
+    it 'should merge two simple hashes' do
+      expect(engine.supermerge({ a: 'x' }, b: 'y')).to eq('a' => 'x', 'b' => 'y')
+    end
+
+    it 'should merge two hashes both with arrays at the same key' do
+      expect(engine.supermerge({ a: ['x'] }, a: ['y'])).to eq('a' => %w(x y))
+    end
+
+    it 'should merge an array and a value at the same key' do
+      expect(engine.supermerge({ a: 'x' }, a: ['y'])).to eq('a' => %w(x y))
+    end
+
+    it 'should replace a value at the same key' do
+      expect(engine.supermerge({ a: 'x' }, a: 'y')).to eq('a' => 'y')
+    end
+
+    it 'should merge two subhashes at the same key' do
+      expect(engine.supermerge({ a: { b: 'x' } }, a: { c: 'y' })).to eq('a' => { 'b' => 'x', 'c' => 'y' })
+    end
+  end
+end

data/spec/lib/foreplay/setup_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'foreplay'
+require 'foreplay/setup'
 
 describe Foreplay::Setup do
   before :each do