gta 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6282ea52c54d66479c7bb48a0429f8e4e4113ef7
-  data.tar.gz: c1e27e7e8a29454847b5081109aeb2a6ae4444e0
+  metadata.gz: c4ffc18a8b88a8e3ffa8c99a042a8862ae4ce43c
+  data.tar.gz: 85a82924459a0def9f5430961d4be27d4d2ebc83
 SHA512:
-  metadata.gz: 817bcf144b42c8e96c56f0ec3709d1fcc8c1f217a1bbb15c3f7bce9428645569fe4817fa2279c0f179b75ac65f6a21619769694c82b3a77c62f817fc788e4765
-  data.tar.gz: 16cfc6bc1416af0080822bf1fef98a585421e59fc58c9684789080dc6e47a4567f19c456a18287f685f8e524e85ddee58b975f61d04f83d6b5f937a6f2ca62c1
+  metadata.gz: 421748d39efd34d5b21c3fa5a24b42ed4857cf5c93e3f126bc0bda394ab89a3216fc7921b77eeec4992a0aef7c1aa9bee881fdb962fa6085d01c06e2fcb1956c
+  data.tar.gz: 156c066293e496a062830acee3ed9bf828ea59c0d18ad497f5dcd38de8653c7e23a2c2675af3dec20199e2b45d3377aa14332bba35d3178103082fe47c47b4dc

data/.gitignore

@@ -18,3 +18,4 @@ tmp
 .idea
 .DS_Store
 **/.DS_Store
+log/*

data/README.md

@@ -31,7 +31,10 @@ Or install it yourself as:
 
 ## Usage
 
-Rake tasks are in progress; stay tuned.
+The main use case is via rake task. Include the rake tasks via the
+project Rakefile.
+
+    
 
 ## Contributing
 

data/lib/gta.rb

@@ -1,3 +1,4 @@
+require 'open3'
 require 'ansi/code'
 
 require "gta/version"
@@ -9,3 +10,5 @@ require "gta/local_db"
 require "gta/db"
 require "gta/hotfix"
 require "gta/tag_finder"
+require "gta/commander"
+require "gta/file_logger"

data/lib/gta/commander.rb

@@ -0,0 +1,104 @@
+module GTA
+  class Commander
+    attr_reader :command, :output, :exit_status
+
+    LINE_LENGTH = 80
+
+    def initialize(command=nil)
+      @output = []
+      @command = command
+    end
+
+    def perform
+      _perform(false)
+    end
+
+    def perform!
+      _perform(true)
+    end
+
+    def write_output(line)
+      message = normalize_output(" #{line}")
+      puts "#{ANSI.white_on_black}#{message}"
+      output << line
+    end
+
+    def write_failure(message = command)
+      message = normalize_output(" Command failed: #{message}")
+      puts "#{ANSI.red_on_black}#{message}#{ANSI.ansi}"
+      write_to_log(message)
+      write_to_log("-"*LINE_LENGTH)
+    end
+
+    # --------------
+
+    def _perform(should_raise)
+      run_command(should_raise)
+      puts_reset
+
+      write_to_log(output.join)
+      handle_failure(should_raise) unless exit_status && exit_status.success?
+
+      output.join
+    end
+
+    def run_command(should_raise)
+      write_command
+      Open3.popen3(command) do |stdin, stdout, stderr, process_status|
+        stderr.sync = true
+        stdout.sync = true
+
+        while (line = stderr.gets)
+          write_output line
+        end
+
+        while (line = stdout.gets)
+          write_output line
+        end
+
+        @exit_status = process_status.value
+      end
+    rescue Errno::ENOENT => e
+      handle_failure(should_raise, e)
+    end
+
+    def handle_failure(should_raise, e=nil)
+      write_failure
+      if e
+        output << e.message
+        write_failure(e.message)
+        write_failure(e.backtrace)
+      end
+      raise CommandFailure, "FAILED! #{command}" if should_raise
+    end
+
+    def normalize_output(output)
+      normalized = output.gsub("\n",'') 
+      normalized += " "*(LINE_LENGTH-normalized.size-1) if normalized.size < LINE_LENGTH
+      normalized += ' '
+      normalized
+    end
+
+    def write_command
+      message = normalize_output(" GTA: #{command}")
+      puts "#{ANSI.black_on_white}#{message}#{ANSI.ansi}"
+      write_to_log(command)
+      write_to_log("-"*LINE_LENGTH)
+    end
+
+    def puts_reset
+      puts "#{ANSI.ansi}"
+    end
+
+    def logger
+      @logger ||= FileLogger.new
+    end
+
+    def write_to_log(response)
+      logger.write(response)
+    end
+
+    class CommandFailure < StandardError
+    end
+  end
+end

data/lib/gta/file_logger.rb

@@ -0,0 +1,25 @@
+module GTA
+  class FileLogger
+    attr_reader :log_dir
+
+    def initialize(log_dir=nil)
+      @log_dir = log_dir ||= "#{Dir.pwd}/log"
+      ensure_log_dir_and_file
+    end
+
+    def ensure_log_dir_and_file
+      FileUtils.mkdir_p(log_dir)
+      FileUtils.touch(log_file) unless File.exist?(log_file)
+    end
+
+    def log_file
+      "#{log_dir}/gta.log"
+    end
+
+    def write(stuff)
+      File.open(log_file, 'a') do |f|
+        f.write(stuff)
+      end
+    end
+  end
+end

data/lib/gta/heroku_db.rb

@@ -10,8 +10,7 @@ module GTA
     end
 
     def url
-      # using backticks in order to get the bash response
-      `heroku pgbackups:url --app #{app_signature}`
+      sh!("heroku pgbackups:url --app #{app_signature}").strip
     end
 
     def backup
@@ -19,11 +18,11 @@ module GTA
     end
 
     def restore_from(url)
-      sh("heroku pgbackups:restore DATABASE_URL \"#{url}\" --app #{app_signature} --confirm #{app_signature}")
+      sh!("heroku pgbackups:restore DATABASE_URL \"#{url}\" --app #{app_signature} --confirm #{app_signature}")
     end
 
     def fetch
-      sh("curl -o #{file_name} \"#{url}\"")
+      sh!("curl -o #{file_name} \"#{url}\"")
     end
 
     def file_name

data/lib/gta/hotfix.rb

@@ -1,5 +1,7 @@
 module GTA
   class Hotfix
+    include Sh
+
     attr_reader :gta_config_path
 
     def initialize(gta_config_path = nil)
@@ -20,7 +22,7 @@ module GTA
       stage_name = branch_name
       stage = stage_for(stage_name)
       not_hotfixable!(stage_name) if !stage || !stage_name
-      sh "git push #{stage_name} #{stage_name}:master"
+      sh!("git push #{stage_name} #{stage_name}:master")
     end
 
     def not_hotfixable!(stage_name)
@@ -32,8 +34,7 @@ module GTA
     end
 
     def branch_name
-      # using `` because we need the bash output
-      branches = `git branch`
+      branches = sh!("git branch").strip
       matches = branches.match(/\*\s+(.*)/)
       matches[1].strip if matches
     end

data/lib/gta/local_db.rb

@@ -10,7 +10,7 @@ module GTA
     end
 
     def load(backup_path)
-      sh "pg_restore --verbose --clean --no-acl --no-owner -h localhost#{username}#{database} #{backup_path}"
+      sh("pg_restore --verbose --clean --no-acl --no-owner -h localhost#{username}#{database} #{backup_path}")
     end
 
     def config

data/lib/gta/manager.rb

@@ -8,7 +8,7 @@ module GTA
 
     def push_to(name, forced = nil)
       s = stage!(name)
-      fetch
+      fetch!
       if forced == :force
         s.force_push
       else
@@ -30,6 +30,10 @@ module GTA
       stages.each(&:fetch)
     end
 
+    def fetch!
+      stages.each(&:fetch!)
+    end
+
     def setup
       stages.each(&:add_remote)
     end

data/lib/gta/sh.rb

@@ -1,8 +1,15 @@
 module GTA
   module Sh
     def sh(command)
-      puts "#{ANSI.black_on_white} GTA: #{command} #{ANSI.ansi}"
-      system(command)
+      commander(command).perform
+    end
+
+    def sh!(command)
+      commander(command).perform
+    end
+
+    def commander(command=nil)
+      Commander.new(command)
     end
   end
 end

data/lib/gta/stage.rb

@@ -29,23 +29,39 @@ module GTA
       raise "no name defined for #{self}" unless name
       raise "no repository defined for #{name}" unless repository
 
-      sh "git remote add #{name} #{repository}"
+      sh("git remote add #{name} #{repository}")
     end
 
     def checkout
-      sh "git checkout -b #{name} -t #{name}/#{branch}"
+      sh(checkout_command)
+    end
+
+    def checkout!
+      sh!(checkout_command)
+    end
+
+    def checkout_command
+      "git checkout -b #{name} -t #{name}/#{branch}"
     end
 
     def push(s=source, forced=nil)
-      sh push_command(source_from(s), forced)
+      sh!(push_command(source_from(s), forced))
     end
 
     def force_push(s=source)
-      sh push_command(source_from(s), :force)
+      sh!(push_command(source_from(s), :force))
     end
 
     def fetch
-      sh "git fetch #{name}"
+      sh(fetch_command)
+    end
+
+    def fetch!
+      sh!(fetch_command)
+    end
+
+    def fetch_command
+      "git fetch #{name}"
     end
 
     def ==(other)

data/lib/gta/version.rb

@@ -1,3 +1,3 @@
 module GTA
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/commander_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe GTA::Commander do
+  let(:commander) { GTA::Commander.new(command) }
+  let(:log_path) { File.dirname(__FILE__) + "/../log/gta.log" }
+  let(:log) { File.read(log_path) }
+
+  before do
+    File.delete(log_path) if File.exist?(log_path)
+  end
+
+  context 'when command is successful' do
+    let(:command) { 'echo foo' }
+
+    it "performs the command and returns the output" do
+      capture_stdout do
+        commander.perform.should == "foo\n"
+      end
+    end
+
+    it "writes to the log" do
+      capture_stdout do
+        commander.perform
+      end
+
+      log.should include "foo"
+    end
+  end
+
+  context 'when the command is not successful' do
+    context 'with a bash error, that bubbles up to a Ruby error' do
+      let(:command) { 'foo' }
+
+      context 'when #perform! used' do
+        it "raises an error when the #perform! method is called" do
+          capture_stdout do
+            expect {
+              commander.perform!
+            }.to raise_error
+          end
+        end
+      end
+
+      context 'when #perform is used' do
+        it "sends outputs the message in red" do
+          output = capture_stdout do
+            commander.perform
+          end
+          output.should include(ANSI.red_on_black)
+          output.should include("No such file or directory - foo")
+        end
+
+        it "returns the error message when the non-bang method is used" do
+          capture_stdout do
+            commander.perform.should == "No such file or directory - foo"
+          end
+        end
+
+        it "writes to the log" do
+          capture_stdout do
+            commander.perform
+          end
+
+          log.should include "No such file or directory - foo"
+        end
+      end
+    end
+  end
+end

data/spec/heroku_db_spec.rb

@@ -6,7 +6,7 @@ describe GTA::HerokuDB do
 
   describe '#url' do
     it "gets the temporary database url from heroku" do
-      heroku_db.should_receive(:`)
+      heroku_db.should_receive(:sh!)
         .with("heroku pgbackups:url --app activator-staging")
         .and_return('backup url')
       heroku_db.url.should == 'backup url'
@@ -23,7 +23,7 @@ describe GTA::HerokuDB do
 
   describe '#restore_from(url)' do
     it "sends a heroku command to restore the database from the given url" do
-      heroku_db.should_receive(:sh)
+      heroku_db.should_receive(:sh!)
         .with('heroku pgbackups:restore DATABASE_URL "http://my-database-url.com" --app activator-staging --confirm activator-staging')
       heroku_db.restore_from("http://my-database-url.com")
     end
@@ -32,7 +32,7 @@ describe GTA::HerokuDB do
   describe '#fetch' do
     it "downloads the latest database backup to an appropriately named file in downloads" do
       heroku_db.should_receive(:url).and_return('http://heroku-backup-url.com')
-      heroku_db.should_receive(:sh)
+      heroku_db.should_receive(:sh!)
         .with('curl -o ~/Downloads/activator-staging.sql "http://heroku-backup-url.com"')
       heroku_db.fetch
     end

data/spec/hotfix_spec.rb

@@ -43,8 +43,13 @@ describe GTA::Hotfix do
   describe '#deploy' do
     context "when on a branch that maps to a stage" do
       before do
-        hotfix.stub(:`).and_return(branch_output)
-        hotfix.stub(:sh)
+        hotfix.stub(:sh!) do |command|
+          if command == "git branch"
+            branch_output
+          else
+            "deploying"
+          end
+        end
       end
 
       context "if it is hotfixable" do
@@ -53,7 +58,7 @@ describe GTA::Hotfix do
         }
 
         it "should call #sh with the right deploy command" do
-          hotfix.should_receive(:sh)
+          hotfix.should_receive(:sh!)
             .with("git push qa qa:master")
             .and_return("deploying")
           hotfix.deploy.should == "deploying"

data/spec/manager_spec.rb

@@ -93,12 +93,12 @@ describe GTA::Manager do
 
   describe '#push_to' do
     before do
-      manager.stub(:fetch)
+      manager.stub(:fetch!)
       manager.stage(:qa).stub(:push)
     end
 
     it "fetches" do
-      manager.should_receive(:fetch)
+      manager.should_receive(:fetch!)
       manager.push_to(:qa)
     end
 

data/spec/stage_spec.rb

@@ -98,7 +98,7 @@ describe GTA::Stage do
 
     context "when using internally defined source object" do
       it "sends the right git shell command" do
-        stage.should_receive(:sh).with("git push staging ci:master")
+        stage.should_receive(:sh!).with("git push staging ci:master")
         stage.push
       end
     end
@@ -107,7 +107,7 @@ describe GTA::Stage do
       let(:origin) { GTA::Stage.new('origin', manager, opts.merge('branch' => 'sendit')) }
 
       it "sends the right git shell command" do
-        stage.should_receive(:sh).with("git push staging origin:master")
+        stage.should_receive(:sh!).with("git push staging origin:master")
         stage.push(origin)
       end
     end
@@ -116,7 +116,7 @@ describe GTA::Stage do
       let(:branch) { 'alt_branch' }
 
       it "sends the right git shell command" do
-        stage.should_receive(:sh).with("git push staging foo:alt_branch")
+        stage.should_receive(:sh!).with("git push staging foo:alt_branch")
         stage.push('foo')
       end
     end
@@ -127,14 +127,14 @@ describe GTA::Stage do
 
       it "uses the tag as the source reference" do
         GTA::TagFinder.should_receive(:new).with(tag).and_return(tag_finder)
-        stage.should_receive(:sh).with("git push staging my-tag:master")
+        stage.should_receive(:sh!).with("git push staging my-tag:master")
         stage.push
       end
     end
 
     context "force push" do
       it "adds the -f flag to the git command" do
-        stage.should_receive(:sh).with("git push -f staging ci:master")
+        stage.should_receive(:sh!).with("git push -f staging ci:master")
         stage.force_push
       end
     end

data/spec/support/capturers.rb

@@ -0,0 +1,21 @@
+def capture_stdout
+  old_stdout = $stdout.dup
+  rd, wr = IO.method(:pipe).arity.zero? ? IO.pipe : IO.pipe("BINARY")
+  $stdout = wr
+  yield
+  wr.close
+  rd.read
+ensure
+  $stdout = old_stdout
+end
+
+def capture_stderr
+  old_stderr = $stderr.dup
+  rd, wr = IO.method(:pipe).arity.zero? ? IO.pipe : IO.pipe("BINARY")
+  $stderr = wr
+  yield
+  wr.close
+  rd.read
+ensure
+  $stderr = old_stderr
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gta
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - socialchorus
@@ -84,7 +84,9 @@ files:
 - Rakefile
 - gta.gemspec
 - lib/gta.rb
+- lib/gta/commander.rb
 - lib/gta/db.rb
+- lib/gta/file_logger.rb
 - lib/gta/heroku_db.rb
 - lib/gta/hotfix.rb
 - lib/gta/local_db.rb
@@ -94,11 +96,13 @@ files:
 - lib/gta/stage.rb
 - lib/gta/tag_finder.rb
 - lib/gta/tasks.rb
+- lib/gta/tasks/commander.rb
 - lib/gta/tasks/deploy.rake
 - lib/gta/tasks/gta.rake
 - lib/gta/tasks/heroku_db.rake
 - lib/gta/tasks/hotfix.rake
 - lib/gta/version.rb
+- spec/commander_spec.rb
 - spec/db_spec.rb
 - spec/fixtures/config/database.yml
 - spec/fixtures/config/gta.yml
@@ -108,6 +112,7 @@ files:
 - spec/manager_spec.rb
 - spec/spec_helper.rb
 - spec/stage_spec.rb
+- spec/support/capturers.rb
 - spec/tag_finder_spec.rb
 homepage: http://github.com/socialchorus/gta
 licenses:
@@ -135,6 +140,7 @@ specification_version: 4
 summary: 'GTA: the Git Transit Authority - A git based deploy tool for moving code
   from stage to stage.'
 test_files:
+- spec/commander_spec.rb
 - spec/db_spec.rb
 - spec/fixtures/config/database.yml
 - spec/fixtures/config/gta.yml
@@ -144,4 +150,5 @@ test_files:
 - spec/manager_spec.rb
 - spec/spec_helper.rb
 - spec/stage_spec.rb
+- spec/support/capturers.rb
 - spec/tag_finder_spec.rb