regressiontest 0.0.1 → 0.0.2

data/README.md

@@ -2,9 +2,16 @@
 
 [![Build Status](https://secure.travis-ci.org/pjotrp/regressiontest.png)](http://travis-ci.org/pjotrp/regressiontest)
 
-Full description goes here
+regressiontest, at this point, is a simple module for calling programs
+on the command line, capturing output and comparing output against an
+existing reference file. The idea is to capture changes in output at a
+very global level, perhaps with different input files and command line
+options.
 
-Note: this software is under active development!
+Note that JRuby on Travis does not allow invoking the command line,
+but MRI and Rubinius work fine.
+
+Note: this software is under active development, your mileage may vary!
 
 ## Installation
 
@@ -18,6 +25,20 @@ Note: this software is under active development!
     require 'regressiontest'
 ```
 
+Simple usage
+
+```ruby
+  RegressionTest::CliExec::exec("ls","-l").should be_true
+```
+
+by default a .ref and a .new file are created in the 
+./test/data/regression directory. A filter can be added to ignore
+lines of output (as a regex), e.g.
+
+```ruby
+  RegressionTest::CliExec::exec("ls","-l",:ignore: 'INFO bio-gff3: Memory used')
+```
+
 The API doc is online. For more code examples see the test files in
 the source tree.
         

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/lib/regressiontest/cli_exec.rb

@@ -1,9 +1,14 @@
+require 'fileutils'
+
 module RegressionTest
 
   DEFAULT_TESTDIR = "test/data/regression"
 
   # Regression test runner compares output in ./test/data/regression (by default).
   # The convention is to have a file with names .ref (reference) and create .new
+  #
+  # You can add an :ignore regex option which ignores lines in the comparsion files 
+  # matching a regex
   module CliExec
     def CliExec::exec command, testname, options = {}
       # ---- Find .ref file
@@ -25,16 +30,35 @@ module RegressionTest
         $stderr.print cmd," returned an error\n"
         return false 
       end
+      if options[:ignore]
+        regex = options[:ignore]
+        outfn1 = outfn + ".1"
+        FileUtils.mv(outfn,outfn1)
+        buf = []
+        f1 = File.open(outfn1)
+        f = File.open(outfn,"w")
+        f1.each_line do | line |
+          f.print(line) if line !~ /#{regex}/
+        end
+        f1.close
+        f.close
+        FileUtils::rm(outfn1)
+      end
       # ---- Compare the two files
-      compare_files(outfn,reffn)
+      compare_files(outfn,reffn,options[:ignore])
     end
 
-    def CliExec::compare_files fn1, fn2
-      cmd = "diff #{fn2} #{fn1}"
-      $stderr.print cmd+"\n"
-      return true if Kernel.system(cmd) == true
-      $stderr.print "If it is correct, execute \"cp #{fn1} {fn2}\", and run again"
-      false
+    def CliExec::compare_files fn1, fn2, ignore = nil
+      if not File.exist?(fn2)
+        FileUtils::cp(fn1,fn2)
+        true
+      else
+        cmd = "diff #{fn2} #{fn1}"
+        $stderr.print cmd+"\n"
+        return true if Kernel.system(cmd) == true
+        $stderr.print "If it is correct, execute \"cp #{fn1} #{fn2}\", and run again"
+        false
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: regressiontest
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-27 00:00:00.000000000Z
+date: 2012-08-20 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &27821800 !ruby/object:Gem::Requirement
+  requirement: &21093520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *27821800
+  version_requirements: *21093520
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &27820620 !ruby/object:Gem::Requirement
+  requirement: &21092280 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *27820620
+  version_requirements: *21092280
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &27819580 !ruby/object:Gem::Requirement
+  requirement: &21089660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *27819580
+  version_requirements: *21089660
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &27818860 !ruby/object:Gem::Requirement
+  requirement: &21088240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.8.3
   type: :development
   prerelease: false
-  version_requirements: *27818860
+  version_requirements: *21088240
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &27818060 !ruby/object:Gem::Requirement
+  requirement: &21086560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: 1.0.21
   type: :development
   prerelease: false
-  version_requirements: *27818060
+  version_requirements: *21086560
 - !ruby/object:Gem::Dependency
   name: bio
-  requirement: &27814360 !ruby/object:Gem::Requirement
+  requirement: &21084920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: 1.4.2
   type: :development
   prerelease: false
-  version_requirements: *27814360
+  version_requirements: *21084920
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &27807100 !ruby/object:Gem::Requirement
+  requirement: &21083440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -87,7 +87,7 @@ dependencies:
         version: '3.12'
   type: :development
   prerelease: false
-  version_requirements: *27807100
+  version_requirements: *21083440
 description: Regression testing for the command line, and library API
 email: pjotr.public01@thebird.nl
 executables:
@@ -127,7 +127,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2174228862267285081
+      hash: -25856528596506647
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements: