regressiontest 0.0.2 → 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 15439a663924842f6fa896369b1e4c9ee7a235bc
+  data.tar.gz: b68ed08e39c2f2c18e8b024df017b2731231dba2
+SHA512:
+  metadata.gz: 384c85b722be84e0f67955bd6a21d7d63471e32909cf4a9a54477cca6b024e73a5f0fc362fcbf1edfae910b498b3d39dfcf6709d0774f3932641b06825fc5556
+  data.tar.gz: 15be021ca148723f575c2d6eca9c2d56ba67c95369068754c122fda1b7efb0040e66111e7f1fddbca51678abefaa88861a388077401250a78ce12e1c95910a0b

data/Gemfile

@@ -6,11 +6,10 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem "shoulda", ">= 0"
-  gem "rdoc", "~> 3.12"
-  gem "cucumber", ">= 0"
-  gem "jeweler", "~> 1.8.3"
-  gem "bundler", ">= 1.0.21"
-  gem "bio", ">= 1.4.2"
-  gem "rdoc", "~> 3.12"
+  gem "shoulda"
+  gem "cucumber"
+  gem "jeweler", "~> 2.0.1"
+  gem "bundler"
+  gem "rspec"
+  gem "rdoc"
 end

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Pjotr Prins
+Copyright (c) 2012-2014 Pjotr Prins
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -36,11 +36,48 @@ by default a .ref and a .new file are created in the
 lines of output (as a regex), e.g.
 
 ```ruby
-  RegressionTest::CliExec::exec("ls","-l",:ignore: 'INFO bio-gff3: Memory used')
+  RegressionTest::CliExec::exec("ls","-l",ignore: 'INFO bio-gff3: Memory used')
 ```
 
+Other options are :timeout and :should_fail.
+
 The API doc is online. For more code examples see the test files in
-the source tree.
+the source tree. A good example can be found in the
+[bio-table](https://github.com/pjotrp/bioruby-table) project which uses
+cucumber features combined with the regressiontest gem. The features
+look like
+
+```ruby
+Scenario: Test the numerical filter by indexed column values
+  Given I have input file(s) named "test/data/input/table1.csv"
+  When I execute "./bin/bio-table --num-filter 'values[3] > 0.05'"
+  Then I expect the named output to match "table1-0_05"
+```
+
+and are listed in
+[cli.feature](https://github.com/pjotrp/bioruby-table/blob/master/features/cli.feature)
+and the matching steps are simply
+
+```ruby
+Given /^I have input file\(s\) named "(.*?)"$/ do |arg1|
+  @filenames = arg1.split(/,/)
+end
+
+When /^I execute "(.*?)"$/ do |arg1|
+  @cmd = arg1 + ' ' + @filenames.join(' ')
+end
+
+Then /^I expect the named output to match "(.*?)"$/ do |arg1|
+  RegressionTest::CliExec::exec(@cmd,arg1).should be_true
+end
+```
+
+and listed in
+[cli.rb](https://github.com/pjotrp/bioruby-table/blob/master/features/step_definitions/cli-feature.rb).
+The automatically generated regression output files are checked into
+git in the
+[test/data/regression](https://github.com/pjotrp/bioruby-table/tree/master/test/data/regression)
+directory and checked with 'bundle exec rake'.
         
 ## Project home page
 
@@ -64,5 +101,5 @@ This Biogem is published at [#regressiontest](http://biogems.info/index.html)
 
 ## Copyright
 
-Copyright (c) 2012 Pjotr Prins. See LICENSE.txt for further details.
+Copyright (c) 2012-2014 Pjotr Prins. See LICENSE.txt for further details.
 

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/bin/regressiontest

@@ -2,7 +2,6 @@
 #
 # BioRuby regressiontest Plugin BioRegressiontest
 # Author:: Pjotr Prins
-# Copyright:: 2012
 
 USAGE = "Describe regressiontest"
 
@@ -13,7 +12,7 @@ VERSION_FILENAME=File.join(gempath,'VERSION')
 version = File.new(VERSION_FILENAME).read.chomp
 
 # print banner
-print "regressiontest #{version} by Pjotr Prins 2012\n"
+print "regressiontest #{version} by Pjotr Prins\n"
 
 if ARGV.size == 0
   print USAGE

data/lib/regressiontest/cli_exec.rb

@@ -7,45 +7,76 @@ module RegressionTest
   # 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 
+  # You can add an :ignore regex option which ignores lines in the comparson files 
   # matching a regex
+  #
+  # :timeout sets the time out for calling a system command
+  #
+  # :should_fail expects the system command to return a non-zero
   module CliExec
+    FilePair = Struct.new(:outfn,:reffn)
+
     def CliExec::exec command, testname, options = {}
       # ---- Find .ref file
       fullname = DEFAULT_TESTDIR + "/" + testname 
-      basefn = if File.exist?(testname+".ref")
+      basefn = if File.exist?(testname+".ref") || File.exist?(testname+"-stderr.ref")
                 testname 
-              elsif fullname + ".ref"
+              elsif File.exist?(fullname + ".ref") || File.exist?(fullname+"-stderr.ref")
                 FileUtils.mkdir_p DEFAULT_TESTDIR
                 fullname
               else
                 raise "Can not find reference file for #{testname} - expected #{fullname}.ref"
               end
-      outfn = basefn + ".new"
-      reffn = basefn + ".ref"
+      std_out = FilePair.new(basefn + ".new", basefn + ".ref")
+      std_err = FilePair.new(basefn + "-stderr.new", basefn + "-stderr.ref")
+      files = [std_out,std_err]
       # ---- Create .new file
-      cmd = command + " > #{outfn}"
+      cmd = command + " > #{std_out.outfn} 2>#{std_err.outfn}"
       $stderr.print cmd,"\n"
-      if Kernel.system(cmd) == false
+      exec_ret = nil
+      if options[:timeout] && options[:timeout] > 0
+        Timeout.timeout(options[:timeout]) do
+          begin
+            exec_ret = Kernel.system(cmd)
+          rescue Timeout::Error
+            $stderr.print cmd, " failed to finish in under #{options[:timeout]}\n"
+            return false
+          end
+        end
+      else
+        exec_ret = Kernel.system(cmd)
+      end
+      expect_fail = (options[:should_fail] != nil)
+      if !expect_fail and exec_ret==0
         $stderr.print cmd," returned an error\n"
         return false 
       end
+      if expect_fail and exec_ret
+        $stderr.print cmd," did not return 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}/
+        files.each do |f|
+          outfn = f.outfn
+          outfn1 = outfn + ".1"
+          FileUtils.mv(outfn,outfn1)
+          f1 = File.open(outfn1)
+          f2 = File.open(outfn,"w")
+          f1.each_line do | line |
+            f2.print(line) if line !~ /#{regex}/
+          end
+          f1.close
+          f2.close
+          FileUtils::rm(outfn1)
         end
-        f1.close
-        f.close
-        FileUtils::rm(outfn1)
       end
       # ---- Compare the two files
-      compare_files(outfn,reffn,options[:ignore])
+      files.each do |f|
+        next unless File.exist?(f.reffn)
+        return false unless compare_files(f.outfn,f.reffn,options[:ignore])
+      end
+      return true
     end
 
     def CliExec::compare_files fn1, fn2, ignore = nil

metadata

@@ -1,93 +1,99 @@
 --- !ruby/object:Gem::Specification
 name: regressiontest
 version: !ruby/object:Gem::Version
-  version: 0.0.2
-  prerelease: 
+  version: 0.0.3
 platform: ruby
 authors:
 - Pjotr Prins
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-20 00:00:00.000000000Z
+date: 2014-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &21093520 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21093520
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: &21092280 !ruby/object:Gem::Requirement
-    none: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
-  type: :development
-  prerelease: false
-  version_requirements: *21092280
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &21089660 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21089660
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: jeweler
-  requirement: &21088240 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.8.3
+        version: 2.0.1
   type: :development
   prerelease: false
-  version_requirements: *21088240
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.0.1
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &21086560 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.21
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21086560
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: bio
-  requirement: &21084920 !ruby/object:Gem::Requirement
-    none: false
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.4.2
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21084920
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rdoc
-  requirement: &21083440 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *21083440
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Regression testing for the command line, and library API
 email: pjotr.public01@thebird.nl
 executables:
@@ -97,8 +103,8 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files:
-- .document
-- .travis.yml
+- ".document"
+- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -115,29 +121,25 @@ files:
 homepage: http://github.com/pjotrp/regressiontest
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -25856528596506647
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Functional (regression) testing library
 test_files: []