rcomp 0.1.1 → 0.2.0

data/.gitignore

@@ -16,9 +16,3 @@ tmp
 .yardoc
 _yardoc
 doc/
-
-# RComp files
-.rcomp
-
-# simplecov
-coverage

data/CHANGELOG.rdoc

@@ -1,3 +1,11 @@
+== 0.2.0, released 2012-11-25
+
+* Add "ignore" configuration option
+* Add "timeout" configuration option
+* Remove "set-command"
+* Remove "set-directory"
+* Upgrade "init" to handle command setting when neccessary
+
 == 0.1.1, released 2012-11-20
 
 * Ignore dotfiles in tests directory

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    rcomp (0.1.0)
+    rcomp (0.2.0)
+      childprocess (~> 0.3.6)
       thor (~> 0.16.0)
 
 GEM

data/README.md

@@ -14,13 +14,11 @@ $ gem install rcomp
 ```
 $ rcomp
 Tasks:
-  rcomp generate             # Generate expected output for all tests
-  rcomp help [TASK]          # Describe available tasks or one specific task
-  rcomp init                 # Setup rcomp test directory
-  rcomp set_command COMMAND  # Sets the command RComp will run tests with
-  rcomp set_directory PATH   # Set the directory RComp will store files
-  rcomp test                 # Run all tests
-  rcomp version              # Prints RComp's version information
+  rcomp generate     # Generate expected output for all tests
+  rcomp help [TASK]  # Describe available tasks or one specific task
+  rcomp init         # Setup rcomp test directory
+  rcomp test         # Run all tests
+  rcomp version      # Prints RComp's version information
 ```
 
 ## Setup
@@ -28,7 +26,6 @@ Tasks:
 In your project root directory, run:
 
 ```
-$ rcomp set-command ./some-executable
 $ rcomp init
 ```
 
@@ -57,7 +54,7 @@ Managed by RComp. Stores the results of your most recent test suite run.
 
 ---
 
-A simple RComp suite might look something like this:
+A simple RComp suite might look something like:
 
 ```
 .
@@ -75,7 +72,7 @@ A simple RComp suite might look something like this:
 
 ## Configuration
 
-All custom configuration is stored in a `.rcomp` file as YAML
+All custom configuration is stored in `.rcomp` as YAML
 
 <table>
   <th>Setting</th><th>Config</th><th>Default</th><th>Description</th>
@@ -91,6 +88,23 @@ All custom configuration is stored in a `.rcomp` file as YAML
     <td><code>rcomp</code></td>
     <td>Directory RComp will store tests, results and expected in</td>
   </tr>
+  <tr>
+  	<td>ignore</td>
+  	<td>
+  	  <code>
+  	    ignore:
+  	  	  - [PATTERN]
+  	  </code>
+  	</td>
+  	<td></td>
+  	<td>List of patterns RComp will ignore when finding tests</td>
+  </tr>
+  <tr>
+  	<td>timeout</td>
+  	<td><code>timeout: [TIMEOUT]</code></td>
+  	<td><code>5</code></td>
+  	<td>Test execution time limit (seconds)</td>
+  </tr>
 </table>
 
 ## Aliases
@@ -105,14 +119,6 @@ All custom configuration is stored in a `.rcomp` file as YAML
     <td><code>generate</code></td>
     <td><code>g</code></td>
   </tr>
-  <tr>
-    <td><code>set-command</code></td>
-    <td><code>c</code></td>
-  </tr>
-  <tr>
-    <td><code>set-directory</code></td>
-    <td><code>d</code></td>
-  </tr>
   <tr>
     <td><code>version</code></td>
     <td><code>-v</code><code>--version</code></td>

data/Rakefile

@@ -4,4 +4,9 @@ require 'bundler/gem_tasks'
 desc "Run features"
 Cucumber::Rake::Task.new(:features)
 
+desc "Clean"
+task :clean do
+  rm_rf "pkg"
+end
+
 task :default => :features

data/features/generate.feature

@@ -8,13 +8,21 @@ Feature: Generate
     And the exit status should be 1
 
   Scenario: Generate without init
-    Given I run `rcomp c ./exec`
+    Given a file named ".rcomp" with:
+      """
+      command: ./test_exec
+
+      """
     When I run `rcomp generate`
     Then the output should contain "No RComp directory"
     And the exit status should be 1
 
   Scenario: Generate with partial init
-    Given I run `rcomp c ./exec`
+    Given a file named ".rcomp" with:
+      """
+      command: ./test_exec
+
+      """
     And a directory named "rcomp"
     And a directory named "rcomp/tests"
     When I run `rcomp generate`
@@ -211,6 +219,60 @@ Feature: Generate
     Then the output should contain "2 files (2 generated)"
     And the exit status should be 0
 
+  # ignore from config
+  @basic-conf
+  @load-assorted-tests
+  Scenario: Test with config ignore filter set: catches all
+    Given I append to ".rcomp" with:
+      """
+      ignore:
+        - xyz
+      
+      """
+    When I run `rcomp g`
+    Then the output should contain "3 files (2 skipped, 1 generated)"
+    And the exit status should be 0
+
+  @basic-conf
+  @load-assorted-tests
+  Scenario: Test with config ignore filter set: catches some
+    Given I append to ".rcomp" with:
+      """
+      ignore:
+        - foo
+
+      """
+    When I run `rcomp g`
+    Then the output should contain "2 files (2 skipped)"
+    And the exit status should be 0
+
+  @basic-conf
+  @load-assorted-tests
+  Scenario: Test with config ignore filter set: catches none
+    Given I append to ".rcomp" with:
+      """
+      ignore:
+        - test
+
+      """
+    When I run `rcomp g`
+    Then the output should contain "0 files ()"
+    And the exit status should be 0
+
+  @basic-conf
+  @load-assorted-tests
+  Scenario: Test with multiple config ignore filters set
+    Given I append to ".rcomp" with:
+      """
+      ignore:
+        - test_a
+        - test_b
+
+      """
+    When I run `rcomp g`
+    Then the output should contain "1 file (1 generated)"
+    And the exit status should be 0
+
   # custom generate directory
   @custom-conf
   Scenario: Custom conf generate
@@ -251,3 +313,33 @@ Feature: Generate
     When I run `rcomp generate`
     Then the output should contain "3 files (2 skipped, 1 generated)"
     And the exit status should be 0
+
+  # timeout
+  @loop-conf
+  Scenario: Test hanging test with default timeout
+    Given a file named "rcomp/tests/test1.test" with:
+      """
+      ABC
+
+      """
+    When I run `rcomp generate` for up to 6 seconds
+    Then the output should contain "1 file (1 failed)"
+    And the output should contain "timeout : /test1"
+    And the exit status should be 1
+
+  @loop-conf
+  Scenario: Test hanging test with custom timeout
+    Given I append to ".rcomp" with:
+      """
+      timeout: 1
+
+      """
+    And a file named "rcomp/tests/test1.test" with:
+      """
+      ABC
+
+      """
+    When I run `rcomp generate` for up to 2 seconds
+    Then the output should contain "1 file (1 failed)"
+    And the output should contain "timeout : /test1"
+    And the exit status should be 1

data/features/init.feature

@@ -2,43 +2,67 @@ Feature: Init
   A user should be able to initialize the RComp's test directories
 
   Scenario: Blind init
-    When I run `rcomp init`
+    When I run `rcomp init` interactively
+    And I type "./something"
     Then the following directories should exist:
       | rcomp |
       | rcomp/tests |
       | rcomp/results |
       | rcomp/expected |
+    And the file ".rcomp" should contain "command: ./something"
     And the exit status should be 0
 
   Scenario: Init with directory set in project root
-    Given I run `rcomp d dir`
-    When I run `rcomp init`
+    Given a file named ".rcomp" with:
+      """
+      directory: dir
+
+      """
+    When I run `rcomp init` interactively
+    And I type "./something"
     Then the following directories should exist:
       | dir |
       | dir/tests |
       | dir/results |
       | dir/expected |
+    And the file ".rcomp" should contain "command: ./something"
     And the exit status should be 0
 
-  Scenario: Init with directory set in subdirectory
+  Scenario: Init with directory set in subdirectory that exists
     Given a directory named "spec/dir"
-    And I run `rcomp d spec/dir/rcomp`
-    When I run `rcomp init`
+    And a file named ".rcomp" with:
+      """
+      directory: spec/dir/rcomp
+
+      """
+    When I run `rcomp init` interactively
+    And I type "./something"
     Then the following directories should exist:
       | spec/dir/rcomp |
       | spec/dir/rcomp/tests |
       | spec/dir/rcomp/results |
       | spec/dir/rcomp/expected |
+    And the file ".rcomp" should contain "command: ./something"
     And the exit status should be 0
+  
+  Scenario: Init with directory set in subdirectory that doesn't exist
+    Given a file named ".rcomp" with:
+      """
+      directory: spec/dir/rcomp
 
-  Scenario: Init with directory set in nonexistant subdirectory
-    Given I run `rcomp d nonexistant/rcomp`
-    When I run `rcomp init`
-    Then the output should contain "No directory nonexistant"
-    And the exit status should be 1
+      """
+    When I run `rcomp init` interactively
+    And I type "./something"
+    Then the following directories should exist:
+      | spec/dir/rcomp |
+      | spec/dir/rcomp/tests |
+      | spec/dir/rcomp/results |
+      | spec/dir/rcomp/expected |
+    And the file ".rcomp" should contain "command: ./something"
+    And the exit status should be 0
 
+  @basic-conf
   Scenario: Already initialized
-    Given I run `rcomp init`
     When I run `rcomp init`
     Then the output should contain "already initialized"
     And the exit status should be 1

data/features/step_definitions/test_steps.rb

@@ -0,0 +1,5 @@
+require 'aruba/api'
+
+When /^I run `(.*?)` for up to (\d+) seconds$/ do |cmd, secs|
+  run_simple(unescape(cmd), false, secs && secs.to_i)
+end

data/features/step_definitions/version_steps.rb

@@ -0,0 +1,7 @@
+require 'aruba/api'
+require 'rcomp/version'
+
+Then /^the output should contain the version number$/ do
+  expected = "RComp version #{RComp::VERSION}\n"
+  assert_exact_output(expected, all_output)
+end

data/features/support/env.rb

@@ -4,20 +4,23 @@ require 'aruba/cucumber'
 require 'test/unit/assertions'
 
 # Helpers
-def create_executable
-  content = "#!/usr/bin/env ruby\nputs IO.binread(ARGV[0])"
+def create_executable(content)
   write_file("test_exec", content)
   in_current_dir do
     FileUtils.chmod(0755, "test_exec")
   end
 end
 
-def create_err_executable
-  content = "#!/usr/bin/env ruby\n$stderr.puts IO.binread(ARGV[0])"
-  write_file("test_exec", content)
-  in_current_dir do
-    FileUtils.chmod(0755, "test_exec")
-  end
+def basic_executable
+  "#!/usr/bin/env ruby\nputs IO.binread(ARGV[0])"
+end
+
+def err_executable
+  "#!/usr/bin/env ruby\n$stderr.puts IO.binread(ARGV[0])"
+end
+
+def loop_executable
+  "!#/usr/bin/env ruby\nsleep 30"
 end
 
 def create_assorted_tests
@@ -28,27 +31,31 @@ end
 
 # Custom Tags
 Before('@basic-conf') do
-  create_executable
+  create_executable(basic_executable)
   # Spin up basic RComp configuration
-  run_simple('rcomp c ./test_exec', false)
-  run_simple('rcomp init', false)
+  write_file(".rcomp", "command: ./test_exec\n")
+  run_simple('rcomp init')
 end
 
 Before('@err-conf') do
-  create_err_executable
+  create_executable(err_executable)
   # Spin up RComp configuraton with an erroring executable
-  run_simple('rcomp c ./test_exec', false)
-  run_simple('rcomp init', false)
+  write_file(".rcomp", "command: ./test_exec\n")
+  run_simple('rcomp init')
 end
 
 Before('@custom-conf') do
-  create_executable
+  create_executable(basic_executable)
   # Spin up custom path RComp configuration
-  run_simple('mkdir test', false)
-  run_simple('mkdir test/integration', false)
-  run_simple('rcomp d test/integration/rcomp')
-  run_simple('rcomp c ./test_exec', false)
-  run_simple('rcomp init', false)
+  write_file(".rcomp", 
+             "command: ./test_exec\ndirectory: test/integration/rcomp\n")
+  run_simple('rcomp init')
+end
+
+Before('@loop-conf') do
+  create_executable(loop_executable)
+  write_file(".rcomp", "command: ./test_exec\n")
+  run_simple('rcomp init')
 end
 
 Before('@load-assorted-tests') do

data/features/test.feature

@@ -8,13 +8,21 @@ Feature: Test
     And the exit status should be 1
 
   Scenario: Test without init
-    Given I run `rcomp c ./exec`
+    Given a file named ".rcomp" with:
+      """
+      command: ./test_exec
+
+      """
     When I run `rcomp test`
     Then the output should contain "No RComp directory"
     And the exit status should be 1
 
   Scenario: Test with partial init
-    Given I run `rcomp c ./exec`
+    Given a file named ".rcomp" with:
+      """
+      command: ./test_exec
+
+      """
     And a directory named "rcomp"
     And a directory named "rcomp/tests"
     When I run `rcomp test`
@@ -151,6 +159,60 @@ Feature: Test
     Then the output should contain "0 tests ()"
     And the exit status should be 0
 
+  # ignore from config
+  @basic-conf
+  @load-assorted-tests
+  Scenario: Test with config ignore filter set: catches all
+    Given I append to ".rcomp" with:
+      """
+      ignore:
+        - xyz
+      
+      """
+    When I run `rcomp t`
+    Then the output should contain "3 tests (1 failed, 1 skipped, 1 passed)"
+    And the exit status should be 1
+
+  @basic-conf
+  @load-assorted-tests
+  Scenario: Test with config ignore filter set: catches some
+    Given I append to ".rcomp" with:
+      """
+      ignore:
+        - foo
+
+      """
+    When I run `rcomp t`
+    Then the output should contain "2 tests (1 failed, 1 passed)"
+    And the exit status should be 1
+
+  @basic-conf
+  @load-assorted-tests
+  Scenario: Test with config ignore filter set: catches none
+    Given I append to ".rcomp" with:
+      """
+      ignore:
+        - test
+
+      """
+    When I run `rcomp t`
+    Then the output should contain "0 tests ()"
+    And the exit status should be 0
+
+  @basic-conf
+  @load-assorted-tests
+  Scenario: Test with multiple config ignore filters set
+    Given I append to ".rcomp" with:
+      """
+      ignore:
+        - test_a
+        - test_b
+
+      """
+    When I run `rcomp t`
+    Then the output should contain "1 test (1 skipped)"
+    And the exit status should be 0
+
   # custom tests directory
   @custom-conf
   Scenario: Custom conf test
@@ -196,3 +258,43 @@ Feature: Test
     When I run `rcomp test`
     Then the output should contain "3 tests (1 failed, 1 skipped, 1 passed)"
     And the exit status should be 1
+
+  # timeout
+  @loop-conf
+  Scenario: Test hanging test with default timeout
+    Given a file named "rcomp/tests/test1.test" with:
+      """
+      ABC
+
+      """
+    And a file named "rcomp/expected/test1.out" with:
+      """
+      ABC
+
+      """
+    When I run `rcomp test` for up to 6 seconds
+    Then the output should contain "1 test (1 failed)"
+    And the output should contain "timeout : /test1"
+    And the exit status should be 1
+
+  @loop-conf
+  Scenario: Test hanging test with custom timeout
+    Given I append to ".rcomp" with:
+      """
+      timeout: 1
+
+      """
+    And a file named "rcomp/tests/test1.test" with:
+      """
+      ABC
+
+      """
+    And a file named "rcomp/expected/test1.out" with:
+      """
+      ABC
+
+      """
+    When I run `rcomp test` for up to 2 seconds
+    Then the output should contain "1 test (1 failed)"
+    And the output should contain "timeout : /test1"
+    And the exit status should be 1