foreplay 0.7.6 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2c3e2f8cd2782d6841948aa40004fcb67b5ef8d9
-  data.tar.gz: d19106d2b46fb6ee029218f83cebbecb8ebba241
+  metadata.gz: 9a1dbd3b362d4784a5b5878bba559b812106e9c8
+  data.tar.gz: fe058cb4c473892115225f78587d0f88929bc745
 SHA512:
-  metadata.gz: 73737f31d440c221d87f1faafe4ff4a90bc816275142610111bd4f8eba0aafacd863e0a54c5c91ce7055c281ef8130c54de2745dd42888b0a7e44ccbbd15d66e
-  data.tar.gz: 34b56f5bf72f7c6f523f41d8951a075491cda0d669a59ba06756508f3b60cb17469a71f707656b4453285352661248ade925f0d4fc6d361fe68adb3982950212
+  metadata.gz: 08f86cc7dfb91d26d9865dbfdcd05adf603e1f5afa690e51503215b2005ed3c93982fca7b798589b6de490184f0a3ddd875a6068ce14ed00b0ba1c871065b4cc
+  data.tar.gz: 3d360c7d1ab0a3fdd61d25eaa46d6da0ba38f88df993daa78ac180f57979d43e9073390de2842abb566d63028cf3c6238ad151a69b1c7a37c5ebe8a6384d4974

data/.rubocop.yml

@@ -1,4 +1,6 @@
 ---
+# These are OK:
+
 StringLiterals:
   EnforcedStyle: single_quotes
   Enabled: true
@@ -6,44 +8,45 @@ StringLiterals:
 DotPosition:
   Description: 'Checks the position of the dot in multi-line method calls.'
   EnforcedStyle: leading
-  # EnforcedStyle: trailing
   Enabled: true
 
-LineLength:
-  Description: 'Limit lines to 137 characters.'
-  Max: 137
+ClassAndModuleChildren:
+  Description: 'Checks style of children classes and modules.'
+  EnforcedStyle: compact
   Enabled: true
 
-FileName:
-  Description: 'Use snake_case for source file names.'
+Documentation:
+  Description: 'Document classes and non-namespace modules.'
   Enabled: false
 
-MethodLength:
-  Description: 'Avoid methods longer than 10 lines of code.'
+Output:
+  Description: 'Checks for calls to puts, print, etc.'
   Enabled: false
 
-Documentation:
-  Description: 'Document classes and non-namespace modules.'
+ExtraSpacing:
   Enabled: false
 
+FileName:
+  Description: 'Use snake_case for source file names.'
+  Enabled: true
+
+# Work on these:
+
+LineLength:
+  Description: 'Limit lines to 137 characters.'
+  Max: 120
+  Enabled: true
+
+MethodLength:
+  Description: 'Avoid methods longer than 10 lines of code.'
+  Max: 27 # 85
+
 CyclomaticComplexity:
   Description: 'Avoid complex methods.'
-  Max: 13
+  Max: 9
 
 PerceivedComplexity:
-  Max: 17
-
-ClassLength:
-  Description: 'Avoid classes longer than 100 lines of code.'
-  CountComments: false  # count full line comments?
-  Max: 295
-
-Output:
-  Description: 'Checks for calls to puts, print, etc.'
-  Enabled: false
+  Max: 11 # 17
 
 AbcSize:
-  Max: 62
-
-ExtraSpacing:
-  Enabled: false
+  Max: 48 # 62

data/.ruby-version

@@ -1 +1 @@
-2.2.0
+2.2.2

data/foreplay.gemspec

@@ -8,28 +8,26 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Xenapto']
   spec.email         = ['developers@xenapto.com']
   spec.description   = 'Deploying Rails projects to Ubuntu using Foreman'
-  spec.summary       = 'Example: foreplay push to production'
+  spec.summary       = 'Example: foreplay deploy production'
   spec.homepage      = 'https://github.com/Xenapto/foreplay'
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
-  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(/^(test|spec|features|coverage)\//)
+  spec.executables   = spec.files.grep(%r{^bin\/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features|coverage)\/})
   spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'activesupport', '>= 3.2'
-  spec.add_runtime_dependency 'colorize', '>= 0.7'
   spec.add_runtime_dependency 'foreman', '>= 0.76'
   spec.add_runtime_dependency 'ssh-shell', '>= 0.4'
-  # spec.add_runtime_dependency 'thor', '~> 0.19' # Dependency of foreman anyway
 
-  spec.add_development_dependency 'bundler', '>= 1.6'
-  spec.add_development_dependency 'rake', '>= 10.3'
-  spec.add_development_dependency 'rspec', '>= 3.2'
-  spec.add_development_dependency 'cucumber', '>= 1.3'
-  spec.add_development_dependency 'aruba', '>= 0.5'
-  spec.add_development_dependency 'gem-release', '>= 0.7'
-  spec.add_development_dependency 'simplecov', '>= 0.7', '>= 0.7.1' # https://github.com/colszowka/simplecov/issues/281
-  spec.add_development_dependency 'coveralls', '>= 0.7'
-  spec.add_development_dependency 'rubocop', '> 0.29'
+  spec.add_development_dependency 'bundler', '~> 1.9'
+  spec.add_development_dependency 'rake', '~> 10.4'
+  spec.add_development_dependency 'rspec', '~> 3.2'
+  spec.add_development_dependency 'cucumber', '~> 2.0'
+  spec.add_development_dependency 'aruba', '~> 0.6'
+  spec.add_development_dependency 'gem-release', '~> 0.7'
+  spec.add_development_dependency 'simplecov', '~> 0.10'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'rubocop', '~> 0.30'
 end

data/lib/foreplay/cli.rb

@@ -1,48 +1,47 @@
 require 'thor'
 require 'foreplay'
+require 'foreplay/setup'
 
-module Foreplay
-  class CLI < Thor
-    desc 'deploy ENVIRONMENT', 'Deploys to specified environment'
-
-    method_option :role,        aliases: '-r'
-    method_option :server,      aliases: '-s'
-
-    def deploy(environment)
-      Foreplay::Deploy.start [:deploy, environment, options]
-    end
-
-    desc 'check ENVIRONMENT', 'Checks if configuration is OK for specified environment'
-
-    method_option :role,        aliases: '-r'
-    method_option :server,      aliases: '-s'
-
-    def check(environment)
-      Foreplay::Deploy.start [:check, environment, options]
-    end
-
-    desc 'setup', 'Create the Foreplay config file'
-
-    method_option :name,        aliases: '-n'
-    method_option :repository,  aliases: '-r'
-    method_option :user,        aliases: '-u'
-    method_option :password
-    method_option :keyfile
-    method_option :private_key, aliases: '-k'
-    method_option :path,        aliases: '-f'
-    method_option :port,        aliases: '-p', type: :numeric
-    method_option :servers,     aliases: '-s', type: :array
-    method_option :db_adapter,  aliases: '-a'
-    method_option :db_encoding, aliases: '-e'
-    method_option :db_name,     aliases: '-d'
-    method_option :db_pool,                    type: :numeric
-    method_option :db_host,     aliases: '-h'
-    method_option :db_user
-    method_option :db_password
-    method_option :resque_redis
-
-    def setup
-      Foreplay::Setup.start
-    end
+class Foreplay::CLI < Thor
+  desc 'deploy ENVIRONMENT', 'Deploys to specified environment'
+
+  method_option :role,        aliases: '-r'
+  method_option :server,      aliases: '-s'
+
+  def deploy(environment)
+    Foreplay::Launcher.start [:deploy, environment, options]
+  end
+
+  desc 'check ENVIRONMENT', 'Checks if configuration is OK for specified environment'
+
+  method_option :role,        aliases: '-r'
+  method_option :server,      aliases: '-s'
+
+  def check(environment)
+    Foreplay::Launcher.start [:check, environment, options]
+  end
+
+  desc 'setup', 'Create the Foreplay config file'
+
+  method_option :name,        aliases: '-n'
+  method_option :repository,  aliases: '-r'
+  method_option :user,        aliases: '-u'
+  method_option :password
+  method_option :keyfile
+  method_option :private_key, aliases: '-k'
+  method_option :path,        aliases: '-f'
+  method_option :port,        aliases: '-p', type: :numeric
+  method_option :servers,     aliases: '-s', type: :array
+  method_option :db_adapter,  aliases: '-a'
+  method_option :db_encoding, aliases: '-e'
+  method_option :db_name,     aliases: '-d'
+  method_option :db_pool,                    type: :numeric
+  method_option :db_host,     aliases: '-h'
+  method_option :db_user
+  method_option :db_password
+  method_option :resque_redis
+
+  def setup
+    Foreplay::Setup.start
   end
 end

data/lib/foreplay/engine/remote.rb

@@ -0,0 +1,121 @@
+require 'net/ssh'
+
+class Foreplay::Engine::Remote
+  include Foreplay
+  attr_reader :server, :steps, :instructions
+
+  def initialize(s, st, i)
+    @server = s
+    @steps = st
+    @instructions = i
+  end
+
+  def deploy
+    output = ''
+
+    puts "#{host}#{INDENT}Connecting to #{host} on port #{port}"
+
+    # SSH connection
+    session = start_session(host, user, options)
+
+    puts "#{host}#{INDENT}Successfully connected to #{host} on port #{port}"
+
+    session.shell do |sh|
+      steps.each do |step|
+        puts "#{host}#{INDENT}#{(step['commentary'] || step['command']).yellow}" unless step['silent'] == true
+
+        # Output from this step
+        output    = ''
+        previous  = '' # We don't need or want the final CRLF
+        commands  = Foreplay::Engine::Step.new(step, instructions).build
+
+        commands.each do |command|
+          process = sh.execute command
+
+          process.on_output do |_, o|
+            previous = o
+            output += previous
+          end
+
+          sh.wait!
+
+          if step['ignore_error'] == true || process.exit_status == 0
+            print output.gsub!(/^/, "#{host}#{INDENT * 2}") unless step['silent'] == true || output.blank?
+          else
+            terminate(output)
+          end
+        end
+      end
+    end
+
+    session.close
+    output
+  end
+
+  # Deployment check: just say what we would have done
+  def check
+    steps.each do |step|
+      puts "#{host}#{INDENT}#{(step['commentary'] || step['command']).yellow}" unless step['silent'] == true
+      commands = Foreplay::Engine::Step.new(step, instructions).build
+      commands.each { |command| puts "#{host}#{INDENT * 2}#{command}" unless step['silent'] }
+    end
+
+    ''
+  end
+
+  def user
+    @user = instructions[:user]
+  end
+
+  def host
+    @host ||= host_port[0]
+  end
+
+  def port
+    @port ||= (host_port[1] || 22)
+  end
+
+  def host_port
+    @host_port ||= server.split(':') # Parse host + port
+  end
+
+  def options
+    return @options if @options
+
+    password    = instructions[:password]
+    keyfile     = instructions[:keyfile]
+    private_key = instructions[:private_key]
+
+    keyfile.sub! '~', ENV['HOME'] || '/' unless keyfile.blank? # Remote shell won't expand this for us
+
+    # SSH authentication methods
+    @options = { verbose: :warn, port: port }
+
+    if password.blank?
+      # If there's no password we must supply a private key
+      if private_key.blank?
+        message = 'No authentication methods supplied. '\
+                  'You must supply a private key, key file or password in the configuration file'
+        terminate(message) if keyfile.blank?
+        # Get the key from the key file
+        puts "#{INDENT}Using private key from #{keyfile}"
+        private_key = File.read keyfile
+      else
+        puts "#{INDENT}Using private key from the configuration file"
+      end
+
+      @options[:key_data] = [private_key]
+    else
+      # Use the password supplied
+      @options[:password] = password
+    end
+
+    @options
+  end
+
+  def start_session(host, user, options)
+    Net::SSH.start(host, user, options)
+  rescue SocketError => e
+    terminate "#{host}#{INDENT}There was a problem starting an ssh session on #{host}:\n#{e.message}"
+  end
+end

data/lib/foreplay/engine/role.rb

@@ -0,0 +1,23 @@
+class Foreplay::Engine::Role
+  attr_reader :environment, :mode, :instructions, :servers
+
+  def initialize(e, m, i)
+    @environment  = e
+    @mode         = m
+    @instructions = i
+    @servers      = @instructions[:servers]
+
+    preposition = mode == :deploy ? 'to' : 'for'
+
+    return 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..."
+  end
+
+  def threads
+    servers.map do |server|
+      Thread.new { Foreplay::Engine::Server.new(environment, mode, instructions, server).execute }
+    end
+  end
+end

data/lib/foreplay/engine/server.rb

@@ -0,0 +1,123 @@
+require 'active_support/inflector'
+
+class Foreplay::Engine::Server
+  include Foreplay
+  attr_reader :environment, :mode, :instructions, :server
+
+  def initialize(e, m, i, s)
+    @environment  = e
+    @mode         = m
+    @instructions = i
+    @server       = s
+  end
+
+  def execute
+    preposition = mode == :deploy ? 'to' : 'for'
+
+    message = "#{mode.capitalize}ing #{name.yellow} #{preposition} #{host.yellow} "
+    message += "for the #{role.dup.yellow} role in the #{environment.dup.yellow} environment"
+    puts message
+
+    instructions[:foreman]['app']   = current_service
+    instructions[:foreman]['port']  = current_port
+    instructions[:foreman]['user']  = user
+    instructions[:foreman]['log']   = "$HOME/#{path}/#{current_port}/log"
+
+    # Contents of .env file
+    instructions[:env]['HOME']  = '$HOME'
+    instructions[:env]['SHELL'] = '$SHELL'
+    instructions[:env]['PATH']  = '$PATH:`which bundle`'
+
+    Foreplay::Engine::Remote.new(server, steps, instructions).__send__ mode
+  end
+
+  def role
+    @role ||= instructions[:role]
+  end
+
+  def user
+    @user ||= instructions[:user]
+  end
+
+  def name
+    @name ||= instructions[:name]
+  end
+
+  def path
+    return @path if @path
+
+    @path = instructions[:path]
+    @path.gsub! '%u', user
+    @path.gsub! '%a', name
+    @path
+  end
+
+  def host
+    return @host if @host
+    @host, _ = server.split(':') # Parse host + port
+    @host
+  end
+
+  def steps
+    @steps ||= YAML.load(
+      ERB.new(
+        File.read(
+          "#{File.dirname(__FILE__)}/steps.yml"
+        )
+      ).result(binding)
+    )
+  end
+
+  def current_port
+    @current_port ||= port_details[:current_port]
+  end
+
+  def current_service
+    @current_service ||= port_details[:current_service]
+  end
+
+  def former_port
+    @former_port ||= port_details[:former_port]
+  end
+
+  def former_service
+    @former_service ||= port_details[:former_service]
+  end
+
+  def current_port_file
+    @current_port_file ||= ".foreplay/#{name}/current_port"
+  end
+
+  def port_steps
+    @port_steps ||= [
+      {
+        'command' => "mkdir -p .foreplay/#{name} && touch #{current_port_file} && cat #{current_port_file}",
+        'silent' => true
+      }
+    ]
+  end
+
+  def port_details
+    return @port_details if @port_details
+
+    current_port_string = Foreplay::Engine::Remote.new(server, port_steps, instructions).__send__(mode).strip!
+
+    if current_port_string.blank?
+      puts "#{host}#{INDENT}No instance is currently deployed"
+    else
+      puts "#{host}#{INDENT}Current instance is using port #{current_port_string}"
+    end
+
+    cp      = current_port_string.to_i
+    port    = instructions[:port]
+    ports   = [port + 1000, port]
+    cp, fp  = cp == port ? ports : ports.reverse
+
+    @port_details = {
+      current_port: cp,
+      current_service: "#{name}-#{cp}",
+      former_port: fp,
+      former_service: "#{name}-#{fp}"
+    }
+  end
+end

data/lib/foreplay/engine/step.rb

@@ -0,0 +1,52 @@
+class Foreplay::Engine::Step
+  attr_reader :step, :instructions
+
+  def initialize(s, i)
+    @step = s
+    @instructions = i
+  end
+
+  def build
+    # Each step can be (1) a command or (2) a series of values to add to a file
+    if step.key?('key')
+      instructions.key?(step['key']) ? build_commands(step, instructions) : []
+    else
+      # ...or just execute the command specified
+      [step['command']]
+    end
+  end
+
+  def build_commands(step, instructions)
+    # 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'] || ''
+
+    step['silent'] = true
+    filename = "#{path}#{prefix}#{key}#{suffix}"
+
+    if step.key?('header')
+      commands  = ["echo \"#{step['header']}\" > #{filename}"]
+      redirect  = '>>'
+    else
+      commands  = []
+      redirect  = '>'
+    end
+
+    if instructions[key].is_a? Hash
+      instructions[key].each do |k, v|
+        commands << "echo \"#{before}#{k}#{delimiter}#{v}#{after}\" #{redirect} #{filename}"
+        redirect = '>>'
+      end
+    else
+      commands << "echo \"#{before}#{delimiter}#{instructions[key]}#{after}\" #{redirect} #{filename}"
+      redirect = '>>'
+    end
+
+    commands
+  end
+end

data/lib/foreplay/engine/steps.yml

@@ -0,0 +1,75 @@
+---
+- command:      "echo Foreplay version <%= VERSION %>"
+  commentary:   "Foreplay running from <%= `hostname -f` %><%= `which foreman` %>"
+- command:      "mkdir -p <%= path %> && cd <%= path %> && rm -rf <%= current_port %> && git clone -b <%= instructions[:branch] || 'master' %> <%= instructions[:repository] %> <%= current_port %>"
+  commentary:   "Cloning <%= instructions[:branch] || 'master' %> branch of repository <%= instructions[:repository] %>"
+- command:      "rvm rvmrc trust <%= current_port %>"
+  commentary:   'Trusting the .rvmrc file for the new instance'
+- command:      "rvm rvmrc warning ignore <%= current_port %>"
+  commentary:   'Ignoring the .rvmrc warning for the new instance'
+- command:      'gpg --keyserver hkp://pool.sks-keyservers.net --recv-keys D39DC0E3'
+  commentary:   "Trusting RVM's public key"
+  ignore_error: true
+- command:      "cd <%= current_port %> && mkdir -p tmp doc log config"
+  commentary:   'If you have a .rvmrc file there may be a delay now while we install a new ruby'
+- command:      'if [ -f .ruby-version ] ; then rvm install `cat .ruby-version` ; else echo "No .ruby-version file found" ; fi'
+  commentary:   'If you have a .ruby-version file there may be a delay now while we install a new ruby'
+- 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/'
+- key:          :resque
+  delimiter:    ': '
+  suffix:       '.yml'
+  commentary:   'Building config/resque.yml'
+  before:       environment
+  path:         'config/'
+- command:      'if [ -d ../cache/vendor/bundle/bundle ] ; then rm -rf ../cache/vendor/bundle/bundle ; else echo No evidence of legacy copy bug ; fi'
+  commentary:   'Fixing legacy copy bug'
+- command:      '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'
+  commentary:   'Attempting to restore bundle from cache'
+- command:      'sudo ln -f `which bundle` /usr/bin/bundle || echo Using default version of bundle'
+  commentary:   'Setting the current version of bundle to be the default'
+- command:      'bundle install --deployment --clean --jobs 2 --without development test'
+  commentary:   'Using bundler to install the required gems in deployment mode'
+- command:      'mkdir -p ../cache/vendor && rsync -aW --no-compress --delete --info=STATS1 vendor/bundle/ ../cache/vendor/bundle'
+  commentary:   'Caching bundle'
+- command:      'if [ -f public/assets/manifest.yml ] ; then echo "Not precompiling assets" ; else RAILS_ENV=<%= environment %> bundle exec foreman run rake assets:precompile ; fi'
+  commentary:   'Precompiling assets unless they were supplied'
+- command:      'sudo bundle exec 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:      "echo <%= current_port %> > $HOME/<%= current_port_file %>"
+  commentary:   "Setting the port for the new instance to <%= current_port %>"
+- 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 %>"
+  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 %>"
+  commentary:   "Removing previous firewall rule directing traffic to port <%= former_port %>"
+  ignore_error: true
+- 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:'
+- command:      "sudo stop <%= former_service %> || echo 'No previous instance running'"
+  commentary:   'Stopping the previous instance'
+  ignore_error: true