mau 0.1.1

data/README

@@ -0,0 +1,5 @@
+
+Updates rails and non-rails applications on a server from a git reference. 
+
+SYNOPSIS
+

data/bin/mau

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+# Updates an application on one of the servers. 
+
+# 'lib' into load path
+$:.unshift File.expand_path(
+  File.join(File.dirname(__FILE__), '..', 'lib'))
+  
+require 'app_update'
+AppUpdate.new(ARGV).run

data/lib/app_update.rb

@@ -0,0 +1,110 @@
+
+require 'optparse'
+require 'logger'
+require 'fileutils'
+
+require 'configuration'
+require 'application'
+require 'delegation'
+require 'runner'
+
+# Main class of the app update tool.
+class AppUpdate
+  extend Delegation
+  
+  APP_CONFIG = '.applications'
+  
+  attr_reader :opts
+  attr_reader :runner
+  attr_reader :logger
+  attr_reader :config
+  attr_reader :extra_args
+  
+  def initialize args
+    @opts, extra_args = parse_options(args)
+    @config = Configuration.current
+
+    @runner = config.runner
+    @logger = config.logger
+    @extra_args = extra_args
+  end
+  
+  def parse_options args
+    opts = {
+      force: false
+    }
+    
+    args = OptionParser.new do |parser|
+      parser.banner = "Usage: mau [options] APPLICATION_NAME"
+      parser.separator ""
+      parser.separator "Specific options:"
+
+      parser.on('-r', '--ref REF', 'Target git reference to update to') do |v|
+        opts[:ref] = v
+      end.on('-f', '--force', 'Forces update') do |v|
+        opts[:force] = true
+      end.on("-v", "--[no-]verbose", "Run verbosely") do |v|
+        opts[:verbose] = v
+      end.on_tail("-h", "--help", "Show this message") do
+        puts parser
+        exit
+      end
+    end.parse(args)
+    
+    return opts, args
+  end
+  
+  def run
+    # If extra_args is empty, we need to look at all apps that were deployed
+    # here before. 
+    app_names = extra_args
+    
+    if app_names.empty?
+      begin
+        app_names = IO.readlines(applications_path).map(&:chomp)
+      rescue Errno::ENOENT
+        warn "Could not read application names from #{APP_CONFIG}."
+      end
+    end
+
+    # Iterate over all applications, updating every one of them. 
+    successful_apps = app_names.select do |name|
+      run_for_app name
+    end
+    
+    # Keep track of what applications are deployed here. 
+    File.write applications_path, successful_apps.join("\n")
+  end
+  
+  def run_for_app name
+    info "Attempting update of #{name}."
+    app(name).update
+    info "Done. (updating #{name})"
+    
+    return true
+  rescue
+    error "Failed to update #{name}, see exception for details."
+    raise
+  end  
+  
+  # ----------------------------------------------------------------- internal
+  
+  def app(name)
+    Application.new(name, config, opts)
+  end
+  def applications_path
+    config.app_base_path(APP_CONFIG)
+  end
+  
+  def panic message
+    puts message
+    fatal message
+    exit 1
+  end
+  
+  delegate :debug, :info, :warn, :error, :fatal, 
+    to: :logger
+
+  delegate :shell, :shell_as, 
+    to: :runner
+end

data/lib/application.rb

@@ -0,0 +1,176 @@
+require 'delegation'
+
+class Application
+  extend Delegation
+  
+  def initialize(name, configuration, options={})
+    @runner = configuration.runner
+    @logger = configuration.logger
+    @configuration = configuration
+    @options = options
+    
+    @name = name
+    @base_path = configuration.app_base_path(name)
+    @git_repo = "git@github.com:mobino/#{name}.git"
+  end
+  
+  attr_reader :options
+  attr_reader :logger
+  attr_reader :name
+  attr_reader :configuration
+  attr_reader :base_path
+  attr_reader :git_repo
+  
+  def update
+    # initial_checkout returns true if it performs work.
+    nothing_there = initial_checkout
+
+    # Save this flag now, since updating the code will modify it. 
+    fetch_remote
+    update_requested = update_requested?
+    
+    if nothing_there || update_requested
+      update_application
+    end
+    
+    update_configuration
+    
+    db_create if nothing_there
+    db_migrate if update_requested
+  end
+  
+  # Assuming that nothing is there except the application directory (below
+  # /srv) usually, this will do the initial checkout. 
+  #
+  def initial_checkout
+    # Prepare app environment, if needed. 
+    unless current.directory? && shared.directory?
+      FileUtils.mkdir_p current
+      FileUtils.chown_R 'app', 'app', current
+
+      FileUtils.mkdir_p shared('tmp', 'pids')
+      FileUtils.mkdir_p shared('log')
+      FileUtils.chown_R 'app', 'app', shared
+    end
+    
+    return false if current('.git').directory?
+    
+    panic "No checkout in place and no git reference to update to given. Use '--ref'. " \
+      unless ref
+        
+    info "Performing a complete initial installation."
+
+    shell "git clone #{git_repo} ."
+    shell "git checkout -B deployed #{ref}"
+
+    File.write path('.ref'), ref
+    
+    info "Done. (initial installation)"
+    return true
+  end
+  
+  # Fetches the remote refs for the current application. This will not change
+  # the currently deployed branch, just makes sure that the repository is up
+  # to date. 
+  #
+  def fetch_remote
+    shell "git fetch origin"
+  end
+  
+  def update_requested?
+    shell("git diff --shortstat #{ref} deployed") != "" ||
+      options[:force]
+  end
+  
+  def update_application
+    info "Performing an app update."
+    
+    # Write down the update intention (so we can repeat this easily)
+    File.write path('.ref'), ref
+    
+    # Then try to update
+    shell "git reset --hard #{ref}"
+    
+    # Install gems
+    shell "bundle install --deployment \
+      --without test spec development cucumber mac jruby"
+      
+    # Create a few directories that the app also wants. 
+    %w(tmp log).each do |dir_name|
+      begin
+        FileUtils.ln_sf shared(dir_name), current
+      rescue Errno::EEXIST
+        warn "Target directory (#{dir_name}) already exists."
+      end
+    end
+    
+    info "Done (app update)."
+  end
+  
+  def update_configuration
+    info "Updating configuration files (symlinks)."
+    
+    # Link the configuration files from app base. (base -> current('config'))
+    %w(*.yml *.rb).each do |glob|
+      Dir[path(glob)].each do |override_file|
+        FileUtils.ln_sf override_file, current('config')
+      end
+    end
+    
+    # Make sure that whatever owners the files had, they now belong to 'app'.
+    FileUtils.chown_R 'app', 'app', current('config')
+  end
+  
+  def db_migrate
+    info "Attempting database migration."
+    
+    # Try to update the database
+    shell "bundle exec rake db:migrate"
+    
+    info "Done (db migration)."
+  rescue Runner::CommandFailed
+    warn "Could not migrate the database schema."
+  end
+  def db_create
+    info "Attempting database creation & seeding."
+    
+    # Try to update the database
+    shell "bundle exec rake db:create"
+    shell 'bundle exec rake db:seed || true'
+
+    info "Done (db creation & seed)."
+  rescue Runner::CommandFailed
+    warn "Could not migrate the database schema."
+  end
+  
+  def path *args
+    base_path.join(*args)
+  end
+  
+  def current *args
+    path 'current', *args
+  end
+  def shared *args
+    path 'shared', *args
+  end  
+  
+  def ref
+    options[:ref] || target_ref
+  end
+  
+  # Runs a command in a subshell in the #current directory. As user 'app'.
+  #
+  def shell cmd, opts={}
+    @runner.shell_as 'app', cmd, {cwd: current}.merge(opts)
+  end
+  
+  def target_ref
+    ref_path = path('.ref')
+    if ref_path.file?
+      return File.read(ref_path).strip
+    end
+  end
+  
+  delegate :debug, :info, :warn, :error, :fatal, 
+    to: :logger
+end

data/lib/configuration.rb

@@ -0,0 +1,35 @@
+
+require 'pathname'
+
+class Configuration
+  class << self
+    def reset; @current = nil; end
+    def current; @current ||= new; end
+    def method_missing(sym, *args, &block)
+      return current.send(sym, *args, &block) if current.respond_to?(sym)
+      super
+    end
+  end
+  
+  def initialize
+    @log_file = $stderr
+    @app_base = '/srv'
+
+    @logger = Logger.new(log_file)
+    @runner = Runner.new(logger)
+  end
+
+  attr_reader   :log_file
+  attr_accessor :app_base
+  attr_accessor :runner
+  attr_reader   :logger
+  
+  def log_file=(file)
+    @log_file = file
+    @logger = Logger.new(file)
+  end
+  
+  def app_base_path *args
+    Pathname.new File.join(@app_base, *args)
+  end
+end

data/lib/delegation.rb

@@ -0,0 +1,36 @@
+
+module Delegation
+  # Defines a delegation to another object. Use this as follows: 
+  #
+  #   delegate_to :a, :b, to: :foobar
+  #
+  # This will delegate local methods 'a' and 'b' to the object returned by
+  # the accessor :foobar. Calling
+  #
+  #   self.a('test') 
+  #
+  # will now really call
+  #
+  #   self.foobar.a('test')
+  #
+  def delegate(*arguments)
+    opts = arguments.pop
+        
+    raise ArgumentError, "Missing options hash at end of delegate arguments." \
+      unless opts && opts[:to]
+    
+    to_ref = opts[:to]
+    silent = opts[:silent]
+    
+    arguments.each do |name|
+      define_method(name) do |*args, &block|
+        obj = self.send(to_ref)
+        
+        fail "Delegation to nil object. (#{to_ref} - #{name})." \
+          if !obj && !silent
+
+        obj.send(name, *args, &block) if obj
+      end
+    end
+  end
+end

data/lib/runner.rb

@@ -0,0 +1,63 @@
+
+require 'mixlib/shellout'
+
+require 'delegation'
+
+class Runner
+  extend Delegation
+  
+  def initialize(logger=nil)
+    @logger = logger
+  end
+  
+  attr_reader :logger
+  
+  class CommandFailed < StandardError; end
+  
+  def shell cmd, opts={}
+    cmd = cmd.strip
+    
+    # As a default, escape from the bundler jail:
+    environment = opts[:environment] ||= {}
+    environment['RUBYOPT'] = ''
+    environment['BUNDLE_GEMFILE'] = ''
+    environment['RAILS_ENV'] = 'production'
+    environment['RACK_ENV'] = 'production'
+    
+    debug "Executing '#{cmd}'."
+    command = shell_out(cmd, opts)
+    
+    command.run_command
+    command.error!
+    
+    return command.stdout
+  rescue Mixlib::ShellOut::ShellCommandFailed => error
+    warn "Failed command (exit #{command.exitstatus}): #{cmd} "
+    
+    lines = command.stderr.lines.to_a
+    warn "STDERR: #{lines.size} lines of output:" unless lines.empty?
+    lines.each_with_index do |line, idx|
+      symbol = idx == lines.size-1 ? '`-' : '|-'
+      debug " #{symbol} #{line.chomp}"
+    end
+
+    lines = command.stdout.lines.to_a
+    warn "STDOUT: #{lines.size} lines of output:" unless lines.empty?
+    lines.each_with_index do |line, idx|
+      symbol = idx == lines.size-1 ? '`-' : '|-'
+      debug " #{symbol} #{line.chomp}"
+    end
+    
+    raise CommandFailed, "'#{cmd}' exited with #{command.exitstatus}. (see log for details)"
+  end
+  def shell_as user, cmd, opts={}
+    shell cmd, opts.merge(user: user)
+  end
+
+  def shell_out(*args)
+    Mixlib::ShellOut.new(*args)
+  end
+  
+  delegate :debug, :info, :warn, :error, :fatal, 
+    to: :logger, silent: true
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: mau
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- John Appleseed
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mixlib-shellout
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email: contact@mobino.com
+executables:
+- mau
+extensions: []
+extra_rdoc_files:
+- README
+files:
+- README
+- lib/app_update.rb
+- lib/application.rb
+- lib/configuration.rb
+- lib/delegation.rb
+- lib/runner.rb
+- bin/mau
+homepage: 
+licenses: []
+post_install_message: 
+rdoc_options:
+- --main
+- README
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Update applications on hosts from a git reference.
+test_files: []