gittest 0.1.2

data/History.txt

@@ -0,0 +1,3 @@
+=== 0.1.1 2010-12-30
+
+* Initial release

data/Manifest.txt

@@ -0,0 +1,6 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+bin/gittest
+lib/gittest.rb

data/README.txt

@@ -0,0 +1,65 @@
+= Gittest
+
+* https://github.com/thickpaddy/gittest
+
+== Description:
+
+Gittest uses your autotest mappings to run tests based on the files
+you've created or changed, according to git diff.
+
+== Usage:
+
+Typically, you just execute gittest on the command line. Run it with 
+the help option to see what other options are available:
+
+  gittest --help
+
+Of note is the --commit option. You can use this to customise the
+commit argument to git diff, which defaults to 'HEAD', i.e. the last 
+commit. This is really handy when you're working on a topic branch 
+and want to run tests based on all the files you've changed in that 
+branch, not just those that have been created or modified since the 
+last commit. For example:
+
+  gittest --commit origin/master
+  
+You can also create a Gittest instance and both interrogate it and ask 
+it to run the tests (this is exactly what the executable does). Have a 
+look at the code, it's pretty simple.
+
+== Install:
+
+The latest release should be available from rubygems.org
+
+  sudo gem install gittest
+
+To install directly from source...
+
+  git clone git://github.com/thickpaddy/gittest.git
+  cd gittest
+  rake install_gem
+
+== License:
+
+(The MIT License)
+
+Copyright (c) 2010 Mark Woods
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,12 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/gittest'
+
+Hoe.spec 'gittest' do
+  self.developer 'Mark Woods', 'mark dot woods at jgp, a company in the uk'
+  self.rubyforge_name     = self.name # TODO this is default value
+  self.extra_deps         = [['ZenTest', '>= 0']]
+end
+

data/bin/gittest

@@ -0,0 +1,81 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'optparse'
+require 'gittest'
+
+options = {:commit => 'HEAD'}
+OptionParser.new do |opts|
+  opts.banner = "Usage: gittest [options]"
+  opts.on("-c MANDATORY", "--commit MANDATORY", "Commit argument for git diff command used to check for new or modified files (defaults to HEAD)") do |o|
+    options[:commit] = o
+  end
+  opts.on("-l", "--load", "Run pending migrations and load test database from schema before running tests (Rails only)") do |o|
+    options[:load] = o
+  end
+  opts.on("-p", "--prepare", "Purge test database and re-create by running all migrations before running tests (Rails only)") do |o|
+    options[:prepare] = o
+  end
+  opts.on("-t", "--trace", "Enable full backtrace on exception") do |o|
+    options[:trace] = o
+  end  
+end.parse!
+
+# create an instance of Gittest to do the dirty work
+begin
+  gt = Gittest.new(options[:commit])
+rescue LoadError => e
+  puts "LoadError: #{e.message}, exiting"
+  if options[:trace]
+    puts e.backtrace
+  else
+    puts "(see full trace by running command with --trace option)"
+  end
+  exit 1
+end
+
+rake_options = options[:trace] ? '--trace' : ''
+if options[:prepare]
+  puts "Preparing test database..."
+  exit $?.exitstatus unless system "rake db:test:purge #{rake_options}"
+  exit $?.exitstatus unless system "rake db:migrate RAILS_ENV=test #{rake_options}"
+end
+if options[:load]
+  puts "Loading test database..."
+  exit $?.exitstatus unless system "rake db:migrate RAILS_ENV=test #{rake_options}"
+  exit $?.exitstatus unless system "rake db:test:load #{rake_options}"
+end
+
+# look for modified files
+if gt.new_or_modified_files.empty?
+  puts "No modified files, exiting"
+  exit
+end
+msg = "#{gt.new_or_modified_files.size} new or modified file" 
+msg << "s" unless gt.new_or_modified_files.size == 1
+puts msg + ":"
+gt.new_or_modified_files.each {|f| puts "\t#{f}"}
+
+# look for files to test
+if gt.files_to_test.empty?
+  puts "No matching files to test, exiting"
+  exit 
+end
+msg = "#{gt.files_to_test.size} file" 
+msg << "s" unless gt.files_to_test.size == 1
+msg << " to test"
+puts msg + ":"
+puts "\t" + gt.files_to_test.map{|k,v| k}.sort.join("\n\t")
+
+# give user an option to quit now, before running the tests/specs
+puts "Press ENTER to continue, or CTRL+C to quit"
+begin
+  $stdin.gets # note: Kernel#gets assumes that ARGV contains a list of files from which to read next line
+rescue Interrupt
+  exit
+end
+
+# run those tests baby
+puts "Running tests and/or specs, please wait..." 
+gt.run_tests
+

data/lib/gittest.rb

@@ -0,0 +1,138 @@
+require 'rubygems'
+require 'autotest'
+require 'rbconfig'
+
+class Gittest
+
+  VERSION = '0.1.2'
+
+  attr_reader :commit, :test_mappings
+
+  # Create a new Gittest instance. Raises LoadError if current working directory not within a git repository. Changes current working directory to root of git repository.
+  def initialize(commit='HEAD')
+    # Force fast start option for autotest. Although not used directly here, hooks might 
+    # do things like preparing test databases unless the fast start option is enabled.
+    Autotest.respond_to?(:options) ? Autotest.options[:no_full_after_start] = true : $f = true
+    raise LoadError, "Not in a git repository" unless silence_stream(STDERR) { system("git rev-parse") } # note: git rev-parse will exit 0 if it's in a repo
+    cd_to_repository_root # note: I'm assuming that the repository root is the project root, and any .autotest file will be in the project root
+    @at = Autotest.new
+    @at.hook :initialize
+    @at.find_files # find known files on initialisation
+    @test_mappings = @at.instance_eval { @test_mappings }
+    @commit = commit
+  end
+
+  # Reset the known files and both new_or_modified_files and files_to_test values
+  def reset
+    @at.find_files
+    @new_or_modified_files = nil
+    @files_to_test = nil
+  end
+
+  # Returns the new or modified files, initially found by calling find_new_or_modified_files
+  def new_or_modified_files
+    @new_or_modified_files ||= find_new_or_modified_files
+  end
+
+  # Returns the files to test, initially found by calling find_files_to_test
+  def files_to_test
+    @files_to_test ||= find_files_to_test
+  end
+
+  # Finds new or modified files by executing git diff and parsing output
+  def find_new_or_modified_files
+    `git diff --name-only #{@commit}`.split("\n").uniq
+  end
+
+  # Finds files to test by checking if the autotest test mappings match any of the new or modified files
+  def find_files_to_test
+    files_to_test = @at.new_hash_of_arrays
+    new_or_modified_files.each do |f|
+      next if f =~ @at.exceptions # skip exceptions
+      result = @test_mappings.find { |file_re, ignored| f =~ file_re }
+      unless result.nil?
+        [result.last.call(f, $~)].flatten.each {|match| files_to_test[match] if File.exist?(match)}
+      end
+    end
+    return files_to_test
+  end
+
+  # Runs tests and ask autotest to handle the results. Also calls autotest :run_command and :ran_command hooks appropriately.
+  def run_tests
+    @at.hook :run_command
+    cmd = @at.make_test_cmd(files_to_test)
+    # copied from Autotest#run_tests and updated to use ansi colours in TURN enabled test output and specs run with the format option set to specdoc
+    colors = { :red => 31, :green => 32, :yellow => 33 }
+    old_sync = $stdout.sync
+    $stdout.sync = true
+    results = []
+    line = []
+    begin
+      open("| #{cmd}", "r") do |f|
+        until f.eof? do
+          c = f.getc or break
+          # putc c
+          line << c
+          if c == ?\n then
+            str = if RUBY_VERSION >= "1.9" then
+                              line.join
+                            else
+                              line.pack "c*"
+                            end
+            results << str
+            line.clear
+            if str.match(/(PASS|FAIL|ERROR)$/)
+              # test output
+              case $1
+                when 'PASS' ; color = :green
+                when 'FAIL' ; color = :red
+                when 'ERROR' ; color = :yellow
+              end
+              print "\e[#{colors[color]}m" + str + "\e[0m"
+            elsif str.match(/^\- /)
+              # spec output 
+              if str.match(/^\- .*(ERROR|FAILED) \- [0-9]+/)
+                color = $1 == 'FAILED' ? :red : :yellow 
+                print "\e[#{colors[color]}m" + str + "\e[0m"
+              else
+                print "\e[#{colors[:green]}m" + str + "\e[0m"
+              end
+            else
+              print str
+            end
+          end
+        end
+      end
+    ensure
+      $stdout.sync = old_sync
+    end
+    @at.hook :ran_command
+    @at.handle_results(results.join)
+  end
+
+  private
+
+  # Changes the working directory to the root path for the repository (assumes current working directory is within a repository)
+  def cd_to_repository_root #:nodoc:
+    loop do
+      begin
+        Dir.entries('.git')
+        break
+      rescue SystemCallError
+        Dir.chdir('..')
+        next
+      end
+    end
+  end
+
+  # Silences a stream for the duration of the block - copied directly from Rails Kernel extensions
+  def silence_stream(stream) #:nodoc:
+    old_stream = stream.dup
+    stream.reopen(RbConfig::CONFIG['host_os'] =~ /mswin|mingw/ ? 'NUL:' : '/dev/null')
+    stream.sync = true
+    yield
+  ensure
+    stream.reopen(old_stream)
+  end
+
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification 
+name: gittest
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Mark Woods
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-14 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ZenTest
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        - 3
+        version: 2.3.3
+  type: :development
+  version_requirements: *id002
+description: |-
+  Gittest uses your autotest mappings to run tests based on the files
+  you've created or changed, according to git diff.
+email: 
+- mark dot woods at jgp, a company in the uk
+executables: 
+- gittest
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- bin/gittest
+- lib/gittest.rb
+has_rdoc: true
+homepage: https://github.com/thickpaddy/gittest
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: gittest
+rubygems_version: 1.4.1
+signing_key: 
+specification_version: 3
+summary: Gittest uses your autotest mappings to run tests based on the files you've created or changed, according to git diff.
+test_files: []
+