egads 0.0.8 → 0.2.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZjFlZmRlNWRmNTUwYmM5MjAxM2Y1NjMzNTFmOGIyMTkxYWM1Njc3YQ==
-  data.tar.gz: !binary |-
-    M2U5MjdmMzc0YWFhMGIzZjM4Y2ViNWIwZTdhYjE3ZjMxZDAyMjBmMw==
-!binary "U0hBNTEy":
-  metadata.gz: !binary |-
-    M2VhOWNlMmEwMjI0MTIzNjRkODFjMWYzNTU0YzY3OWIxYWZhNGEzMmI5MTgw
-    MmU3NjdhMTk1Y2FjMDdmODExODMyNjkwOWFjNjVmZjE2YjU3ZWQxZDdjZTA2
-    MjRmN2I3NDJkZGFmZmZiOTI4YzU1MDMzMjg3ODQ0Y2M0Nzg4ZDg=
-  data.tar.gz: !binary |-
-    NWM4MWQ5ZjQ2YmVkMzg2OTJhYjBhNDZmMTdkZDgxZTkwZjI5NTYwNWU5ZTcw
-    MGM3OGY0ZTFjMzA3MjYzMDQ5OTE1N2U1MzNhMWNiODNiMjJjNjQxZjViMDdi
-    MGI0OWI5ZTlhNWE5YTNiODY3M2NmYTI5OWIzM2I0MjhjZmU0M2Y=
+SHA1:
+  metadata.gz: 42ec1036274bdc5a2f82a3e9b7cc104a13b026ed
+  data.tar.gz: 805811a6fcba6b004c181c7c0f0afbd281633904
+SHA512:
+  metadata.gz: f6c59fa7fae40a6c6ef32422367b5f3deacddafdaace0320f23fad1b6495e5c5f13bb76ee0224b845b1cb574b4e90a600594eb30db0a015f9e5ecf090e662203
+  data.tar.gz: f5bdec599424d240ecae7aefce605614a7e1dde7fc0b4de35d76a1c3ba8e254d4d63bde4b41e24a2ab2474a1baf4049f477f63268b7dd716f9b3b5672713e1f7

data/.gitignore

@@ -3,6 +3,7 @@
 .bundle
 .config
 coverage
+Gemfile.lock
 InstalledFiles
 lib/bundler/man
 pkg

data/Gemfile

@@ -2,3 +2,6 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'debugger', require: nil
+# Use my fork until https://github.com/guard/guard-minitest/pull/65 is released
+gem 'guard-minitest', '>= 1.0.0.rc.2'
+gem 'terminal-notifier-guard'

data/Guardfile

@@ -0,0 +1,24 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'minitest' do
+  # with Minitest::Unit
+  #watch(%r|^test/(.*)\/?test_(.*)\.rb|)
+  #watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  #watch(%r|^test/test_helper\.rb|)    { "test" }
+
+  # with Minitest::Spec
+  watch(%r|^spec/(.*)_spec\.rb|)
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+
+  # Rails 3.2
+  # watch(%r|^app/controllers/(.*)\.rb|) { |m| "test/controllers/#{m[1]}_test.rb" }
+  # watch(%r|^app/helpers/(.*)\.rb|)     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r|^app/models/(.*)\.rb|)      { |m| "test/unit/#{m[1]}_test.rb" }  
+  
+  # Rails
+  # watch(%r|^app/controllers/(.*)\.rb|) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r|^app/helpers/(.*)\.rb|)     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r|^app/models/(.*)\.rb|)      { |m| "test/unit/#{m[1]}_test.rb" }  
+end

data/bin/egads

@@ -2,4 +2,4 @@
 # TODO: remove this
 $: << './lib'
 require 'egads'
-Egads::CLI.start
+Egads::Command.start

data/egads.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   s.add_dependency "thor"
   s.add_development_dependency "rake"
   s.add_development_dependency "minitest"
+  #s.add_development_dependency "simple_mock" # Via http://tatey.com/2012/02/07/mocking-with-minitest-mock-and-simple-delegator/
 
   s.description = %s{
     A collection of scripts for making a deployable tarball of a git commit,

data/example/egads_remote.yml

@@ -1,3 +1,4 @@
+# AWS S3 config for generating signed URL for tarball
 s3:
   bucket: my-bucket
   access_key: mykey
@@ -10,9 +11,11 @@ release_to: /var/apps/my_project/current
 
 restart_command: /etc/init.d/rails_services restart
 
+# Options to pass to bundler
+bundler:
+  options: --deployment --quiet --without development:test --path /var/apps/my_project/shared/bundle
+
 # environment variables to set before executing commands
 env:
   RAILS_ENV: production
   SHARED_PATH: /var/apps/my_project/shared
-  BUNDLE_PATH: /var/apps/my_project/shared/bundle
-  BUNDLE_WITHOUT: development:test

data/lib/egads.rb

@@ -1,7 +1,11 @@
 require 'yaml'
 require 'fog'
 require 'thor'
+require 'benchmark'
+
+module Egads; end
+
 require 'egads/config'
 require 'egads/s3_tarball'
-require 'egads/cli'
-require 'egads/ext/thor_actions'
+require 'egads/group'
+require 'egads/command'

data/lib/egads/command.rb

@@ -0,0 +1,18 @@
+module Egads
+  class Command < Thor
+    require 'egads/command/build'
+    require 'egads/command/upload'
+    require 'egads/command/extract'
+    require 'egads/command/stage'
+    require 'egads/command/release'
+    require 'egads/command/trim'
+
+    register(Build, 'build', 'build [REV]', '[local] Compiles a deployable tarball of the current commit and uploads it to S3')
+    register(Upload, 'upload', 'upload SHA', '[local, plumbing] Uploads a tarball for SHA to S3')
+    register(Extract, 'extract', 'extract SHA', '[remote, plumbing] Downloads tarball for SHA from S3 and extracts it to the filesystem')
+    register(Stage, 'stage', 'stage SHA', '[remote, plumbing] Downloads tarball for SHA from S3 and extracts it to the filesystem')
+    register(Release, 'release', 'release SHA', '[remote, plumbing] Downloads tarball for SHA from S3 and extracts it to the filesystem')
+    register(Trim, 'trime', 'trim [N]', "[remote, plumbing] Deletes old releases, keeping the N most recent (by mtime)")
+
+  end
+end

data/lib/egads/command/build.rb

@@ -0,0 +1,114 @@
+module Egads
+  class Build < Group
+    include Thor::Actions
+
+    desc "[local] Compiles a deployable tarball of the current commit and uploads it to S3"
+    class_option :force, type: :boolean, aliases: '-f', default: false, banner: "Build and overwrite existing tarball on S3"
+    class_option :wait, type: :boolean, aliases: '-w', default: false, banner: "Wait for the build to exist. Poll S3 every 2 seconds."
+    class_option 'no-upload', type: :boolean, default: false, banner: "Don't upload the tarball to S3"
+    argument :rev, type: :string, default: 'HEAD', desc: 'git revision to build'
+
+    def check_build
+      say_status :rev, "#{rev} parsed to #{sha}"
+
+      wait_for_build if options[:wait]
+      unless should_build?
+        say_status :done, "Tarball for #{sha} already exists. Pass --force to rebuild."
+        exit 0
+      end
+
+      say_status :rev, "#{rev} parsed to #{sha}"
+      exit 1 unless can_build?
+    end
+
+    def make_git_archive
+      say_status :build, "Making tarball for #{sha}", :yellow
+      FileUtils.mkdir_p(File.dirname(tarball.local_tar_path))
+      run_with_code "git archive #{sha} --format=tar > #{tarball.local_tar_path}"
+    end
+
+    def append_revision_file
+      File.open('REVISION', 'w') {|f| f << sha + "\n" }
+      run_with_code "tar -uf #{tarball.local_tar_path} REVISION"
+    end
+
+    def run_after_build_hooks
+      run_hooks_for(:build,:after)
+    end
+
+    def append_extra_paths
+      extra_paths = Config.build_extra_paths
+      if extra_paths.any?
+        run_with_code "tar -uf #{tarball.local_tar_path} #{extra_paths * " "}"
+      end
+    end
+
+    def gzip_archive
+      run_with_code "gzip -9f #{tarball.local_tar_path}"
+    end
+
+    def upload
+      invoke(Egads::Upload, [sha]) unless options['no-upload']
+    end
+
+    module BuildHelpers
+      def sha
+        @sha ||= run_with_code("git rev-parse --verify #{rev}").strip
+      end
+
+      def short_sha
+        sha[0,7]
+      end
+
+      def tarball
+        @tarball ||= S3Tarball.new(sha)
+      end
+
+      def should_build?
+        options[:force] || !tarball.exists?
+      end
+
+      def can_build?
+        sha_is_checked_out? && working_directory_is_clean?
+      end
+
+      def sha_is_checked_out?
+        head = run_with_code("git rev-parse --verify HEAD", capture: true).strip
+        short_head = head[0,7]
+        head == sha or error [
+          "Cannot build #{short_sha} because #{short_head} is checked out.",
+          "Run `git checkout #{short_sha}` and try again"
+        ]
+      end
+
+      def working_directory_is_clean?
+        run("git status -s", capture: true).empty? or
+        error [
+          "Cannot build #{short_sha} because the working directory is not clean.",
+          "Stash your changes with `git add . && git stash` and try again."
+        ]
+      end
+
+      def error(message)
+        lines = Array(message)
+        say_status :error, lines.shift, :red
+        lines.each {|line| say_status '', line }
+
+        false
+      end
+
+      def wait_for_build
+        say_status :wait, "Waiting for tarball to exist...", :yellow
+        loop do
+          start = Time.now
+          break if tarball.exists?
+          printf '.'
+          sleep [2 - (Time.now - start), 0].max
+        end
+        printf "\n"
+      end
+
+    end
+    include BuildHelpers
+  end
+end

data/lib/egads/command/extract.rb

@@ -0,0 +1,68 @@
+module Egads
+  class Extract < Group
+    include Thor::Actions
+
+    desc "[remote, plumbing] Downloads tarball for SHA from S3 and extracts it to the filesystem"
+    class_option :force, type: :boolean, default: false, banner: "Overwrite existing files"
+    argument :sha, type: :string, required: true, desc: 'git SHA to download and extract'
+
+    def setup_environment
+      RemoteConfig.setup_environment
+    end
+
+    def download
+      if should_download?
+        say_status :download, "Downloading tarball for #{sha}", :yellow
+        FileUtils.mkdir_p(release_dir)
+        duration = Benchmark.realtime do
+          File.open(path, 'w') {|f| f << tarball.contents }
+        end
+        size = File.size(path)
+        say_status :done, "Downloaded in %.1f seconds (%.1f KB/s)" % [duration, (size.to_f / 2**10) / duration]
+      else
+        say_status :done, "Tarball already downloaded. Use --force to overwrite"
+      end
+    end
+
+    def extract
+      # Check revision file to see if tarball is already extracted
+      if should_extract?
+        # Silence stderr warnings "Ignoring unknown extended header keyword"
+        # due to BSD/GNU tar.
+        inside(release_dir) { run_with_code "tar -zxf #{path} 2>/dev/null" }
+      else
+        say_status :done, "Tarball already extracted. Use --force to overwrite"
+      end
+    end
+
+    def mark_as_extracted
+      FileUtils.touch(extract_flag_path)
+    end
+
+    protected
+    def release_dir
+      RemoteConfig.release_dir(sha)
+    end
+
+    def path
+      File.join(release_dir, "#{sha}.tar.gz")
+    end
+
+    def tarball
+      @tarball ||= S3Tarball.new(sha, true)
+    end
+
+    def should_download?
+      options[:force] || File.zero?(path) || !File.exists?(path)
+    end
+
+    def extract_flag_path
+      File.join(release_dir, '.egads-extract-success')
+    end
+
+    def should_extract?
+      options[:force] || !File.exists?(extract_flag_path)
+    end
+
+  end
+end

data/lib/egads/command/release.rb

@@ -0,0 +1,64 @@
+module Egads
+  class Release < Group
+    include Thor::Actions
+
+    desc "[remote] Symlinks SHA to current and restarts services. If needed, stages SHA"
+    class_option :force, type: :boolean, default: false, banner: "Overwrite existing release"
+    argument :sha, type: :string, required: true, desc: 'git SHA to stage'
+    def setup_environment
+      RemoteConfig.setup_environment
+    end
+
+    def stage
+      invoke(Egads::Stage, [sha], options)
+    end
+
+    def run_before_release_hooks
+      return unless should_release?
+      inside(dir) { run_hooks_for(:release, :before) }
+    end
+
+    def symlink_release
+      return unless should_release?
+      symlink_directory(dir, release_to)
+    end
+
+    def restart
+      return unless should_release?
+
+      inside release_to do
+        # Restart services
+        run_with_code(RemoteConfig.restart_command)
+      end
+    end
+
+    def run_after_release_hooks
+      inside release_to do
+        run_hooks_for(:release, :after)
+      end
+    end
+
+    def trim
+      FileUtils.touch(dir) # Ensure this release isn't trimmed
+      invoke(:trim, [4], {})
+    end
+
+    protected
+    def dir
+      RemoteConfig.release_dir(sha)
+    end
+
+    def release_to
+      RemoteConfig.release_to
+    end
+
+    def current_symlink_destination
+      File.readlink(RemoteConfig.release_to) rescue nil
+    end
+
+    def should_release?
+      @should_release = options[:force] || dir != current_symlink_destination unless defined?(@should_release)
+      @should_release
+    end
+  end
+end

data/lib/egads/command/stage.rb

@@ -0,0 +1,78 @@
+module Egads
+  class Stage < Group
+    include Thor::Actions
+
+
+    desc "[remote] Readies SHA for release. If needed, generates URL for SHA and extracts"
+    class_option :force, type: :boolean, default: false, banner: "Overwrite existing files"
+    argument :sha, type: :string, required: true, desc: 'git SHA to stage'
+
+    def setup_environment
+      RemoteConfig.setup_environment
+    end
+
+    def extract
+      invoke(Egads::Extract, [sha], options)
+    end
+
+    def run_before_hooks
+      return unless should_stage?
+      inside(dir){ run_hooks_for(:stage, :before) }
+    end
+
+    def bundle
+      return unless should_stage?
+
+      inside(dir) do
+        run_with_code("bundle install #{RemoteConfig.bundler_options}") if File.readable?("Gemfile")
+      end
+    end
+
+    def symlink_system_paths
+      return unless should_stage? && shared_path
+      symlink_directory File.join(shared_path, 'system'), File.join(dir, 'public', 'system')
+      symlink_directory File.join(shared_path, 'log'), File.join(dir, 'log')
+    end
+
+    def symlink_config_files
+      return unless should_stage? && shared_path
+
+      shared_config = File.join(shared_path, 'config')
+      if File.directory?(shared_config)
+        Dir.glob("#{shared_config}/*").each do |source|
+          basename = File.basename(source)
+          destination = File.join(dir, 'config', basename)
+          symlink(source, destination)
+        end
+      end
+    end
+
+    def run_after_stage_hooks
+      return unless should_stage?
+      inside(dir) { run_hooks_for(:stage, :after) }
+    end
+
+    def mark_as_staged
+      FileUtils.touch(stage_flag_path)
+    end
+
+    protected
+    def dir
+      RemoteConfig.release_dir(sha)
+    end
+
+    def stage_flag_path
+      File.join(dir, '.egads-stage-success')
+    end
+
+    def should_stage?
+      options[:force] || !File.exists?(stage_flag_path)
+    end
+
+    def shared_path
+      ENV['SHARED_PATH']
+    end
+  end
+end
+
+

data/lib/egads/command/trim.rb

@@ -0,0 +1,18 @@
+module Egads
+  class Trim < Group
+    include Thor::Actions
+
+
+    desc "[remote, plumbing] Deletes old releases, keeping the N most recent (by mtime)"
+    def trim(n=4)
+      inside RemoteConfig.extract_to do
+        dirs = Dir.glob('*').sort_by{|path| File.mtime(path) }.reverse[n..-1].to_a
+        dirs.each do |dir|
+          say_status :trim, "Deleting #{dir}"
+          FileUtils.rm_rf(dir)
+        end
+      end
+    end
+
+  end
+end

data/lib/egads/command/upload.rb

@@ -0,0 +1,32 @@
+module Egads
+  class Upload < Group
+    include Thor::Actions
+
+    desc "[local, plumbing] Uploads a tarball for SHA to S3"
+    argument :sha, type: :string, required: true, desc: 'git SHA to upload'
+
+    attr_reader :sha
+    def upload
+      @sha = sha
+      size = File.size(path)
+
+      say_status :upload, "Uploading tarball (%.1f MB)" % (size.to_f / 2**20), :yellow
+      duration = Benchmark.realtime do
+        tarball.upload(path)
+      end
+      say_status :done, "Uploaded in %.1f seconds (%.1f KB/s)" % [duration, (size.to_f / 2**10) / duration]
+
+      File.delete(path)
+    end
+
+    private
+    def tarball
+      @tarball ||= S3Tarball.new(sha)
+    end
+
+    def path
+      tarball.local_gzipped_path
+    end
+
+  end
+end

data/lib/egads/config.rb

@@ -56,10 +56,6 @@ module Egads
       path
     end
 
-    def self.release_dir(sha)
-      File.join(config['extract_to'], sha)
-    end
-
     def self.release_to
       config['release_to']
     end
@@ -68,6 +64,10 @@ module Egads
       config['extract_to']
     end
 
+    def self.release_dir(sha)
+      File.join(config['extract_to'], sha)
+    end
+
     # Set environment variables from the config
     def self.setup_environment
       config['env'].each{|k,v| ENV[k] = v.to_s } if config['env']
@@ -76,5 +76,9 @@ module Egads
     def self.restart_command
       config['restart_command']
     end
+
+    def self.bundler_options
+      config['bundler']['options'] if config['bundler']
+    end
   end
 end

data/lib/egads/group.rb

@@ -0,0 +1,45 @@
+module Egads
+  class CommandError < Thor::Error; end
+
+  class Group < Thor::Group
+
+    protected
+    def run_with_code(command, config={})
+      result = nil
+      duration = Benchmark.realtime do
+        result = run(command, config.merge(capture: true))
+      end
+      say_status :done, "Finished in %.1f seconds" % duration
+
+      if $? != 0
+        raise CommandError.new("`#{command}` failed with exit status #{$?.exitstatus.inspect}")
+      end
+      result
+    end
+
+    # Run command hooks from config file
+    # E.g. run_hooks_for(:build, :after)
+    def run_hooks_for(cmd, hook)
+      say_status :hooks, "Running #{cmd} #{hook} hooks"
+      Config.hooks_for(cmd, hook).each do |command|
+        run_with_code command
+      end
+    end
+
+    # Symlinks a directory
+    # NB that `ln -f` doesn't work with directories.
+    # This is not atomic.
+    def symlink_directory(src, dest)
+      raise ArgumentError.new("#{src} is not a directory") unless File.directory?(src)
+      say_status :symlink, "from #{src} to #{dest}"
+      FileUtils.rm_rf(dest)
+      FileUtils.ln_s(src, dest)
+    end
+
+    def symlink(src, dest)
+      raise ArgumentError.new("#{src} is not a file") unless File.file?(src)
+      say_status :symlink, "from #{src} to #{dest}"
+      FileUtils.ln_sf(src, dest)
+    end
+  end
+end

data/lib/egads/version.rb

@@ -1,3 +1,3 @@
 module Egads
-  VERSION = '0.0.8'
+  VERSION = '0.2.0'
 end

data/spec/egads_build_spec.rb

@@ -0,0 +1,29 @@
+require_relative 'spec_helper'
+
+describe "Egads::Build" do
+  setup_configs!
+  subject { Egads::Build }
+
+  it 'should run the correct tasks' do
+    subject.commands.keys.must_equal %w(check_build make_git_archive append_revision_file run_after_build_hooks append_extra_paths gzip_archive upload)
+  end
+
+  it 'takes one argument' do
+  	subject.arguments.size.must_equal 1
+  end
+
+  it 'has a rev argument' do
+  	rev = subject.arguments.detect{|arg| arg.name == 'rev'}
+  	rev.default.must_equal 'HEAD'
+  	rev.required.must_equal false
+  end
+
+end
+
+describe "Egags::Build instance" do
+	subject { Egads::Build.new }
+	
+	it "has rev HEAD" do
+		subject.rev.must_equal 'HEAD'
+	end
+end

data/spec/egads_config_spec.rb

@@ -8,16 +8,61 @@ describe Egads::Config do
   end
 
   describe "with an config file" do
-    before { ENV['EGADS_CONFIG'] = "example/egads.yml" }
-    after { ENV.delete('EGAGS_CONFIG') }
+    setup_configs!
+
+    let(:yml) { YAML.load_file("example/egads.yml") }
+
+    describe '#config' do
+      it 'is a hash' do
+        subject.config.must_equal yml
+      end
+    end
 
     it "has an S3 bucket" do
-      subject.s3_bucket.key.must_equal 'my-bucket'
+      subject.s3_bucket.key.must_equal yml['s3']['bucket']
     end
 
     it "has an S3 prefix" do
-      subject.s3_prefix.must_equal 'my_project'
+      subject.s3_prefix.must_equal yml['s3']['prefix']
     end
   end
 
 end
+
+describe Egads::RemoteConfig do
+  subject { Egads::RemoteConfig }
+
+  it "raises ArgumentError for missing config" do
+    -> { subject.config_path }.must_raise(ArgumentError)
+  end
+
+  describe "with an config file" do
+    setup_configs!
+    let(:yml) { YAML.load_file("example/egads_remote.yml") }
+
+    describe '#config' do
+      it('is a hash') { subject.config.must_equal yml }
+    end
+
+    it('#release_to') { subject.release_to.must_equal yml['release_to'] }
+    it('#extract_to') { subject.extract_to.must_equal yml['extract_to'] }
+    it('#release_dir') { subject.release_dir('abc').must_equal File.join(yml['extract_to'], 'abc') }
+    it('#restart_command') { subject.restart_command.must_equal yml['restart_command'] }
+    it('#bundler_options') { subject.bundler_options.must_equal yml['bundler']['options'] }
+
+    describe '#setup_environment' do
+      before { subject.setup_environment }
+      after do
+        # Delete ENV from yaml data
+        yml['env'].keys.each{|key| ENV.delete(key) }
+      end
+
+      it 'should set ENV values' do
+        yml['env'].each do |key, value|
+          ENV[key].must_equal value
+        end
+      end
+    end
+
+  end
+end

data/spec/egads_extract_spec.rb

@@ -0,0 +1,10 @@
+require_relative 'spec_helper'
+
+describe "Egads::Extract" do
+  setup_configs!
+  subject { Egads::Extract }
+
+  it 'should run the correct tasks' do
+  subject.commands.keys.must_equal %w(setup_environment download extract mark_as_extracted)
+  end
+end

data/spec/egads_release_spec.rb

@@ -0,0 +1,10 @@
+require_relative 'spec_helper'
+
+describe "Egads::Release" do
+  setup_configs!
+  subject { Egads::Release }
+
+  it 'should run the correct tasks' do
+  subject.commands.keys.must_equal %w(setup_environment stage run_before_release_hooks symlink_release restart run_after_release_hooks trim)
+  end
+end

data/spec/egads_s3_tarball_spec.rb

@@ -1,6 +1,7 @@
 require_relative 'spec_helper'
 
 describe Egads::S3Tarball do
+  setup_configs!
 
   before { ENV['EGADS_CONFIG'] = "example/egads.yml" }
   after { ENV.delete('EGAGS_CONFIG') }
@@ -18,11 +19,10 @@ describe Egads::S3Tarball do
 
   describe 'when uploaded' do
     before do
-      Egads::Config.s3_bucket.save # Ensure bucket exists
       subject.upload(ENV['EGADS_CONFIG'])
     end
 
-    it('should exist') { subject.exists?.wont_be_nil }
+    it('should exist') { (!! subject.exists?).must_equal true }
   end
 
 

data/spec/egads_stage_spec.rb

@@ -0,0 +1,10 @@
+require_relative 'spec_helper'
+
+describe "Egads::Stage" do
+  setup_configs!
+  subject { Egads::Stage }
+
+  it 'should run the correct tasks' do
+  subject.commands.keys.must_equal %w(setup_environment extract run_before_hooks bundle symlink_system_paths symlink_config_files run_after_stage_hooks mark_as_staged)
+  end
+end

data/spec/egads_trim_spec.rb

@@ -0,0 +1,10 @@
+require_relative 'spec_helper'
+
+describe "Egads::Trim" do
+  setup_configs!
+  subject { Egads::Trim }
+
+  it 'should run the correct tasks' do
+  subject.commands.keys.must_equal %w(trim)
+  end
+end

data/spec/egads_upload_spec.rb

@@ -0,0 +1,10 @@
+require_relative 'spec_helper'
+
+describe "Egads::Upload" do
+  setup_configs!
+  subject { Egads::Upload }
+
+  it 'should run the correct tasks' do
+    subject.commands.keys.must_equal %w(upload)
+  end
+end

data/spec/spec_helper.rb

@@ -7,11 +7,29 @@ require "egads"
 
 Fog.mock!
 
+SHA = 'deadbeef' * 5 # Test git sha
+
 begin
   require 'debugger'
 rescue LoadError
   puts "Skipping debugger"
 end
 
+# Extensions
 class Minitest::Spec
+
+  def self.setup_configs!
+    before do
+      ENV['EGADS_CONFIG'] = "example/egads.yml"
+      ENV['EGADS_REMOTE_CONFIG'] = "example/egads_remote.yml"
+      Egads::Config.s3_bucket.save # Ensure bucket exists
+
+    end
+
+    after do
+      ENV.delete('EGADS_CONFIG')
+      ENV.delete('EGADS_REMOTE_CONFIG')
+    end
+
+  end
 end

metadata

@@ -1,73 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: egads
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Aaron Suggs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-18 00:00:00.000000000 Z
+date: 2013-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fog
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: thor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: ! "\n    A collection of scripts for making a deployable tarball of a
-  git commit,\n    uploading it to Amazon S3, and downloading it to your servers."
+description: |2-
+
+      A collection of scripts for making a deployable tarball of a git commit,
+      uploading it to Amazon S3, and downloading it to your servers.
 email:
 - aaron@ktheory.com
 executables:
@@ -78,7 +80,7 @@ extra_rdoc_files:
 files:
 - .gitignore
 - Gemfile
-- Gemfile.lock
+- Guardfile
 - README.md
 - Rakefile
 - bin/egads
@@ -87,13 +89,25 @@ files:
 - example/egads_remote.yml
 - lib/egads.rb
 - lib/egads/capistrano.rb
-- lib/egads/cli.rb
+- lib/egads/command.rb
+- lib/egads/command/build.rb
+- lib/egads/command/extract.rb
+- lib/egads/command/release.rb
+- lib/egads/command/stage.rb
+- lib/egads/command/trim.rb
+- lib/egads/command/upload.rb
 - lib/egads/config.rb
-- lib/egads/ext/thor_actions.rb
+- lib/egads/group.rb
 - lib/egads/s3_tarball.rb
 - lib/egads/version.rb
+- spec/egads_build_spec.rb
 - spec/egads_config_spec.rb
+- spec/egads_extract_spec.rb
+- spec/egads_release_spec.rb
 - spec/egads_s3_tarball_spec.rb
+- spec/egads_stage_spec.rb
+- spec/egads_trim_spec.rb
+- spec/egads_upload_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/kickstarter/egads
 licenses: []
@@ -105,22 +119,27 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.2
 signing_key: 
 specification_version: 4
 summary: Extensible Git Archive Deploy Strategy
 test_files:
+- spec/egads_build_spec.rb
 - spec/egads_config_spec.rb
+- spec/egads_extract_spec.rb
+- spec/egads_release_spec.rb
 - spec/egads_s3_tarball_spec.rb
+- spec/egads_stage_spec.rb
+- spec/egads_trim_spec.rb
+- spec/egads_upload_spec.rb
 - spec/spec_helper.rb
-has_rdoc: 

data/Gemfile.lock

@@ -1,49 +0,0 @@
-PATH
-  remote: .
-  specs:
-    egads (0.0.1)
-      fog
-      thor
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    builder (3.2.2)
-    columnize (0.3.6)
-    debugger (1.5.0)
-      columnize (>= 0.3.1)
-      debugger-linecache (~> 1.2.0)
-      debugger-ruby_core_source (~> 1.2.0)
-    debugger-linecache (1.2.0)
-    debugger-ruby_core_source (1.2.0)
-    excon (0.22.1)
-    fog (1.11.1)
-      builder
-      excon (~> 0.20)
-      formatador (~> 0.2.0)
-      json (~> 1.7)
-      mime-types
-      net-scp (~> 1.1)
-      net-ssh (>= 2.1.3)
-      nokogiri (~> 1.5.0)
-      ruby-hmac
-    formatador (0.2.4)
-    json (1.8.0)
-    mime-types (1.23)
-    minitest (5.0.3)
-    net-scp (1.1.1)
-      net-ssh (>= 2.6.5)
-    net-ssh (2.6.7)
-    nokogiri (1.5.9)
-    rake (10.0.4)
-    ruby-hmac (0.4.0)
-    thor (0.18.1)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  debugger
-  egads!
-  minitest
-  rake

data/lib/egads/cli.rb

@@ -1,221 +0,0 @@
-module Egads
-  class CLI < Thor
-    include Thor::Actions
-    ##
-    # Local commands
-
-    desc "build", "[local] Compiles a deployable tarball of the current commit and uploads it to S3"
-    method_option :force, type: :boolean, aliases: '-f', default: false, banner: "Build and overwrite existing tarball on S3"
-    method_option 'no-upload', type: :boolean, default: false, banner: "Don't upload the tarball to S3"
-    def build(rev='HEAD')
-      sha = run_or_die("git rev-parse --verify #{rev}", capture: true).strip
-      tarball = S3Tarball.new(sha)
-      if !options[:force] && tarball.exists?
-        say "Tarball for #{sha} already exists. Pass --force to rebuild."
-        return
-      end
-
-      say "Building tarball for #{sha}..."
-      # Check if we're on sha, if not, ask to check it out
-      head = run_or_die("git rev-parse --verify HEAD", capture: true).strip
-      unless head == sha
-        say "** Error **"
-        say "Trying to build #{sha[0,7]}, but #{head[0,7]} is checked out."
-        say "Run `git checkout #{head[0,7]}` and try again."
-        exit 1
-      end
-
-      # Ensure clean working directory
-      unless run("git status -s", capture: true).empty?
-        say "** Error **"
-        say "Working directory is not clean."
-        say "Stash your changes with `git add . && git stash` and try again."
-        exit 1
-      end
-
-      # Make git archive
-      FileUtils.mkdir_p(File.dirname(tarball.local_tar_path))
-      run_or_die "git archive #{sha} --format=tar > #{tarball.local_tar_path}"
-
-      # Write REVISION and add to tarball
-      File.open('REVISION', 'w') {|f| f << sha + "\n" }
-      run_or_die "tar -uf #{tarball.local_tar_path} REVISION"
-
-      run_hooks_for(:build, :after)
-
-      extra_paths = Config.build_extra_paths
-      if extra_paths.any?
-        run_or_die "tar -uf #{tarball.local_tar_path} #{extra_paths * " "}"
-      end
-
-      run_or_die "gzip -9f #{tarball.local_tar_path}"
-
-      invoke(:upload, [sha], force: options[:force]) unless options['no-upload']
-    end
-
-    method_option :force, type: :boolean, aliases: '-f', default: false, banner: "Overwrite existing tarball on S3"
-    desc "upload SHA", "[local, plumbing] Uploads a tarball for SHA to S3"
-    def upload(sha)
-      tarball = S3Tarball.new(sha)
-      if !options[:force] && tarball.exists?
-        say "Tarball for #{sha} already exists. Pass --force to upload again."
-        return
-      end
-
-      path = tarball.local_gzipped_path
-      size = File.size(path)
-
-      say "Uploading tarball (%.1f MB)" % (size.to_f / 2**20)
-      duration = Benchmark.realtime do
-        tarball.upload(path)
-      end
-      say "Uploaded in %.1f seconds (%.1f KB/s)" % [duration, (size.to_f / 2**10) / duration]
-
-      File.delete(path)
-    end
-
-    ##
-    # Remote commands
-
-    desc "extract SHA", "[remote, plumbing] Downloads tarball for SHA from S3 and extracts it to the filesystem"
-    method_option :force, type: :boolean, default: false, banner: "Overwrite existing files"
-    def extract(sha)
-      RemoteConfig.setup_environment
-      dir = RemoteConfig.release_dir(sha)
-      path = File.join(dir, "#{sha}.tar.gz")
-      tarball = S3Tarball.new(sha, true)
-
-      inside dir do
-        if options[:force] || File.zero?(path) || !File.exists?(path)
-          say "Downloading tarball"
-          duration = Benchmark.realtime do
-            File.open(path, 'w') {|f| f << tarball.contents }
-          end
-          size = File.size(path)
-          say "Downloaded in %.1f seconds (%.1f KB/s)" % [duration, (size.to_f / 2**10) / duration]
-        else
-          say "Tarball already downloaded. Use --force to overwrite"
-        end
-
-        # Check revision file to see if tarball is already extracted
-        extract_flag_path = File.join(dir, '.egads-extract-success')
-        if options[:force] || !File.exists?(extract_flag_path)
-          say "Extracting tarball"
-          run_or_die "tar -zxf #{path}"
-        else
-          say "Tarball already extracted. Use --force to overwrite"
-        end
-        FileUtils.touch(extract_flag_path)
-      end
-    end
-
-    desc "stage SHA", "[remote] Readies SHA for release. If needed, generates URL for SHA and extracts"
-    method_option :force, type: :boolean, default: false, banner: "Overwrite existing files"
-    def stage(sha)
-      RemoteConfig.setup_environment
-      invoke(:extract, [sha], options)
-      dir = RemoteConfig.release_dir(sha)
-      stage_flag_path = File.join(dir, '.egads-stage-success')
-      if options[:force] || !File.exists?(stage_flag_path)
-        inside dir do
-          run_hooks_for(:stage, :before)
-
-          # Bundler
-          if File.readable?("Gemfile")
-            bundler_args = %w(--deployment --quiet)
-            # Hack to force bundle options overridden by --deployment
-            bundler_args << "--without #{ENV['BUNDLE_WITHOUT']}" if ENV['BUNDLE_WITHOUT']
-            bundler_args << "--path #{ENV['BUNDLE_PATH']}"       if ENV['BUNDLE_PATH']
-
-            run_or_die("bundle install #{bundler_args * ' '}")
-          end
-
-          if shared_path = ENV['SHARED_PATH']
-            symlink_directory File.join(shared_path, 'system'), File.join(dir, 'public', 'system')
-            symlink_directory File.join(shared_path, 'log'), File.join(dir, 'log')
-
-            # Symlink config files
-            shared_config = File.join(shared_path, 'config')
-            if File.directory?(shared_config)
-              Dir.glob("#{shared_config}/*").each do |source|
-                basename = File.basename(source)
-                destination = File.join(dir, 'config', basename)
-                symlink(source, destination)
-              end
-            end
-          end
-
-          run_hooks_for(:stage, :after)
-        end
-      else
-        say "Already staged. Use --force to overwrite"
-      end
-      FileUtils.touch(stage_flag_path)
-    end
-
-    desc "release SHA", "[remote] Symlinks SHA to current and restarts services. If needed, stages SHA"
-    method_option :force, type: :boolean, default: false, banner: "Overwrite existing files while staging"
-    def release(sha)
-      RemoteConfig.setup_environment
-      invoke(:stage, [sha], options)
-      dir = RemoteConfig.release_dir(sha)
-      inside dir do
-        run_hooks_for(:release, :before)
-      end
-
-      # destination of the current symlink
-      current_release = File.readlink(RemoteConfig.release_to) rescue nil
-      unless dir == current_release
-        # Symlink this release to the release_to
-        symlink_directory(dir, RemoteConfig.release_to) unless dir == current_release
-      end
-
-      inside RemoteConfig.release_to do
-        # Restart services
-        run_or_die(RemoteConfig.restart_command)
-        run_hooks_for(:release, :after)
-      end
-
-      FileUtils.touch(dir) # Ensure this release isn't trimmed
-      invoke(:trim, [4])
-    end
-
-    desc "trim N", "[remote, plumbing] Deletes old releases, keeping the N most recent (by mtime)"
-    method_option :force, type: :boolean, default: false, banner: "No op, compatible with release"
-    def trim(n=4)
-      dirs = Dir.glob('*').sort_by{|path| File.mtime(path) }.reverse[n..-1].to_a
-      dirs.each do |dir|
-        say_status :trim, "Deleting #{dir}"
-        FileUtils.rm_rf(dir)
-      end
-    end
-
-    private
-    # Run command hooks from config file
-    # E.g. run_hooks_for(:build, :after)
-    def run_hooks_for(cmd, hook)
-      say_status :hooks, "Running #{cmd} #{hook} hooks"
-      Config.hooks_for(cmd, hook).each do |command|
-        say "Running `#{command}`"
-        run_or_die command
-      end
-    end
-
-    # Symlinks a directory
-    # NB that `ln -f` doesn't work with directories.
-    # This is not atomic.
-    def symlink_directory(src, dest)
-      raise ArgumentError.new("#{src} is not a directory") unless File.directory?(src)
-      say_status :symlink, "from #{src} to #{dest}"
-      FileUtils.rm_rf(dest)
-      FileUtils.ln_s(src, dest)
-    end
-
-    def symlink(src, dest)
-      raise ArgumentError.new("#{src} is not a file") unless File.file?(src)
-      say_status :symlink, "from #{src} to #{dest}"
-      FileUtils.ln_sf(src, dest)
-    end
-
-  end
-end

data/lib/egads/ext/thor_actions.rb

@@ -1,25 +0,0 @@
-require 'thor'
-require 'benchmark'
-class Thor
-  class CommandFailedError < Error; end
-
-  module Actions
-    # runs command, raises CommandFailedError unless exit status is 0.
-    # Also logs duration
-    def run_or_die(command, config={})
-      result = nil
-      duration = Benchmark.realtime do
-        result = run(command, config)
-      end
-      if behavior == :invoke && $?.exitstatus != 0
-        message = "#{command} failed with %s" % ($?.exitstatus ? "exit status #{$?.exitstatus}" : "no exit status (likely force killed)")
-        raise Thor::CommandFailedError.new(message)
-      end
-
-      say_status :done, "in %.1f seconds" % duration, config.fetch(:verbose, true)
-
-      result
-    end
-
-  end
-end