rcomp 0.1.0

data/.gitignore

@@ -0,0 +1,24 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+
+# RComp files
+.rcomp
+
+# simplecov
+coverage

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - jruby-19mode
+  - rbx-19mode
+matrix:
+  allow_failures:
+    - rvm: jruby-19mode
+    - rvm: rbx-19mode

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,39 @@
+PATH
+  remote: .
+  specs:
+    rcomp (0.1.0)
+      thor (~> 0.16.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    aruba (0.5.1)
+      childprocess (~> 0.3.6)
+      cucumber (>= 1.1.1)
+      rspec-expectations (>= 2.7.0)
+    builder (3.1.4)
+    childprocess (0.3.6)
+      ffi (~> 1.0, >= 1.0.6)
+    cucumber (1.2.1)
+      builder (>= 2.1.2)
+      diff-lcs (>= 1.1.3)
+      gherkin (~> 2.11.0)
+      json (>= 1.4.6)
+    diff-lcs (1.1.3)
+    ffi (1.2.0)
+    gherkin (2.11.5)
+      json (>= 1.4.6)
+    json (1.7.5)
+    rake (10.0.2)
+    rspec-expectations (2.12.0)
+      diff-lcs (~> 1.1.3)
+    thor (0.16.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  aruba (~> 0.5.0)
+  cucumber (~> 1.2.1)
+  rake
+  rcomp!

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright (c) 2012 Chris Knadler
+
+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/README.md

@@ -0,0 +1,124 @@
+# RComp [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/cknadler/rcomp) [![Dependency Status](https://gemnasium.com/cknadler/rcomp.png)](https://gemnasium.com/cknadler/rcomp) [![Build Status](https://travis-ci.org/cknadler/rcomp.png)](https://travis-ci.org/cknadler/rcomp)
+
+
+RComp is a simple framework for testing command line application output. It works by passing a specified command tests (files) by argument and comparing the result with expected output.
+
+## Installation
+
+```
+$ gem install rcomp
+```
+
+## Usage
+
+```
+$ 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
+```
+
+## Setup
+
+In your project root directory, run:
+
+```
+$ rcomp set-command ./some-executable
+$ rcomp init
+```
+
+Then create some tests in `rcomp/tests`
+
+## Structure
+
+After running `rcomp init` the following directories are created by default:
+
+```
+.
+|--rcomp
+|----tests
+|----expected
+|----results
+```
+
+### tests
+Stores test files. All subdirectories will be searched for tests.
+
+### expected
+Stores the expected output of tests. Format is `testname.out` for `stdout` and `testname.err` for `stderr`.
+
+### results
+Managed by RComp. Stores the results of your most recent test suite run.
+
+---
+
+A simple RComp suite might look something like this:
+
+```
+.
+|--rcomp
+|----tests
+|------test1.test
+|------dir
+|--------test2.test
+|----expected
+|------test1.out
+|------dir
+|--------test2.out
+|--------test2.err
+```
+
+## Configuration
+
+All custom configuration is stored in a `.rcomp` file as YAML
+
+<table>
+  <th>Setting</th><th>Config</th><th>Default</th><th>Description</th>
+  <tr>
+    <td>command</td>
+    <td><code>command: [COMMAND]</code></td>
+    <td></td>
+    <td>Command RComp will run tests with</td>
+  </tr>
+  <tr>
+    <td>directory</td>
+    <td><code>directory: [DIRECTORY]</code></td>
+    <td><code>rcomp</code></td>
+    <td>Directory RComp will store tests, results and expected in</td>
+  </tr>
+</table>
+
+## Aliases
+
+<table>
+  <th>Task</th><th>Alias</th>
+  <tr>
+    <td><code>test</code></td>
+    <td><code>t</code></td>
+  </tr>
+  <tr>
+    <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>
+  </tr>
+</table>
+
+## Copyright
+
+Copyright (c) 2012 Chris Knadler. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,7 @@
+require 'cucumber/rake/task'
+require 'bundler/gem_tasks'
+
+desc "Run features"
+Cucumber::Rake::Task.new(:features)
+
+task :default => :features

data/bin/rcomp

@@ -0,0 +1,6 @@
+#!/usr/bin/env ruby
+
+require 'rcomp'
+require 'rcomp/cli'
+
+RComp::CLI.start

data/contributing.md

@@ -0,0 +1,7 @@
+# Contributing to RComp
+* Fork the project.
+* Make a topic branch.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a future version unintentionally.
+* Commit, do not mess with rakefile, version, or history. If you want to have your own version, thats fine but bump version in a commit by itself I can ignore when I pull.
+* Send me a pull request.

data/features/generate.feature

@@ -0,0 +1,224 @@
+Feature: Generate
+  Users should have the ability to generate expected output for tests
+
+  # faulty configuration
+  Scenario: Generate without command
+    When I run `rcomp generate`
+    Then the output should contain "No command present"
+    And the exit status should be 1
+
+  Scenario: Generate without init
+    Given I run `rcomp c ./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`
+    And a directory named "rcomp"
+    And a directory named "rcomp/tests"
+    When I run `rcomp generate`
+    Then the output should contain "Missing RComp directories"
+    And the exit status should be 1
+
+  # no tests
+  @basic-conf
+  Scenario: Generate with no tests
+    When I run `rcomp generate`
+    Then the output should contain "0 files ()"
+    And the exit status should be 0
+
+  # stdout single generate
+  @basic-conf
+  Scenario: Generate a single result
+    Given a file named "rcomp/tests/test1.test" with:
+      """
+      ABC
+
+      """
+    When I run `rcomp generate`
+    Then the output should contain "1 file (1 generated)"
+    And the file "rcomp/expected/test1.out" should contain "ABC"
+    And the exit status should be 0
+
+  @basic-conf
+  Scenario: Skip a single result
+    Given a file named "rcomp/tests/test1.test" with:
+      """
+      ABC
+
+      """
+    And a file named "rcomp/expected/test1.out" with:
+      """
+      DEF 
+
+      """
+    When I run `rcomp generate`
+    Then the output should contain "1 file (1 skipped)"
+    And the file "rcomp/expected/test1.out" should contain "DEF"
+    And the exit status should be 0
+
+  @basic-conf
+  Scenario: Overwrite a single result
+    Given a file named "rcomp/tests/test1.test" with:
+      """
+      ABC
+
+      """
+    And a file named "rcomp/expected/test1.out" with:
+      """
+      DEF
+
+      """
+    When I run `rcomp generate -O` interactively
+    And I type "y"
+    Then the output should contain "overwrite all existing" 
+    And the output should contain "1 file (1 generated)"
+    And the file "rcomp/expected/test1.out" should contain "ABC"
+    And the exit status should be 0
+
+  # stdout multiple generate
+  @basic-conf
+  @load-assorted-tests
+  Scenario: Generate multiple results
+    When I run `rcomp generate`
+    Then the output should contain "3 files (2 skipped, 1 generated)"
+    And the file "rcomp/expected/test_a.out" should contain "ABC"
+    And the file "rcomp/expected/dir/test_b.out" should contain "XYZ"
+    And the file "rcomp/expected/dir/foo/test_c.out" should contain "GHI"
+    And the exit status should be 0
+
+  @basic-conf
+  @load-assorted-tests
+  Scenario: Overwrite multiple results
+    When I run `rcomp generate -O` interactively
+    And I type "y"
+    Then the output should contain "overwrite all existing" 
+    And the file "rcomp/expected/test_a.out" should contain "ABC"
+    And the file "rcomp/expected/dir/test_b.out" should contain "DEF"
+    And the file "rcomp/expected/dir/foo/test_c.out" should contain "GHI"
+    And the output should contain "3 files (3 generated)"
+    And the exit status should be 0
+
+  # stderr single generate
+  @err-conf
+  Scenario: Generate a single err result
+    Given a file named "rcomp/tests/test1.test" with:
+      """
+      ABC
+
+      """
+    When I run `rcomp generate`
+    Then the output should contain "1 file (1 generated)"
+    And the file "rcomp/expected/test1.err" should contain "ABC"
+    And the exit status should be 0
+
+  @err-conf
+  Scenario: Skip a single err result
+    Given a file named "rcomp/tests/test1.test" with:
+      """
+      ABC
+
+      """
+    And a file named "rcomp/expected/test1.err" with:
+      """
+      XYZ
+
+      """
+    When I run `rcomp generate`
+    Then the output should contain "1 file (1 skipped)"
+    And the file "rcomp/expected/test1.err" should contain "XYZ"
+    And the exit status should be 0
+
+  @err-conf
+  Scenario: Overwrite a single err result
+    Given a file named "rcomp/tests/test1.test" with:
+      """
+      ABC
+
+      """
+    And a file named "rcomp/expected/test1.err" with:
+      """
+      XYZ
+
+      """
+    When I run `rcomp generate -O` interactively
+    And I type "y"
+    Then the output should contain "1 file (1 generated)"
+    And the file "rcomp/expected/test1.err" should contain "ABC"
+    And the exit status should be 0
+
+  # stderr multiple generate
+  @err-conf
+  @load-assorted-err-tests
+  Scenario: Generate multiple err results
+    When I run `rcomp generate`
+    Then the output should contain "3 files (2 skipped, 1 generated)"
+    And the file "rcomp/expected/test_a.err" should contain "ABC"
+    And the file "rcomp/expected/dir/test_b.err" should contain "XYZ"
+    And the file "rcomp/expected/dir/foo/test_c.err" should contain "GHI"
+    And the exit status should be 0
+
+  @err-conf
+  @load-assorted-err-tests
+  Scenario: Overwrite multiple err results
+    When I run `rcomp generate -O` interactively
+    And I type "y"
+    Then the output should contain "3 files (3 generated)"
+    And the output should contain "overwrite all existing"
+    And the file "rcomp/expected/test_a.err" should contain "ABC"
+    And the file "rcomp/expected/dir/test_b.err" should contain "DEF"
+    And the file "rcomp/expected/dir/foo/test_c.err" should contain "GHI"
+    And the exit status should be 0
+
+  # alias
+  @basic-conf
+  @load-assorted-tests
+  Scenario: Generate alias g
+    When I run `rcomp g`
+    Then the output should contain "3 files (2 skipped, 1 generated)"
+    And the file "rcomp/expected/test_a.out" should contain "ABC"
+    And the file "rcomp/expected/dir/test_b.out" should contain "XYZ"
+    And the file "rcomp/expected/dir/foo/test_c.out" should contain "GHI"
+    And the exit status should be 0
+
+  # filters
+  @basic-conf
+  @load-assorted-tests
+  Scenario: Generate with filter: catches all
+    When I run `rcomp generate --grep=test`
+    Then the output should contain "3 files (2 skipped, 1 generated)"
+    And the exit status should be 0
+
+  @basic-conf
+  @load-assorted-tests
+  Scenario: Generate with filter: catches some
+    When I run `rcomp generate --grep=dir`
+    Then the output should contain "2 files (1 skipped, 1 generated)"
+    And the exit status should be 0
+
+  @basic-conf
+  @load-assorted-tests
+  Scenario: Generate with filter: catches none
+    When I run `rcomp generate --grep=xyz`
+    Then the output should contain "0 files ()"
+    And the exit status should be 0
+
+  @basic-conf
+  @load-assorted-tests
+  Scenario: Generate with filter: catches some with overwrite
+    When I run `rcomp generate -O --grep=dir` 
+    Then the output should contain "2 files (2 generated)"
+    And the exit status should be 0
+
+  # custom generate directory
+  @custom-conf
+  Scenario: Custom conf generate
+    Given a file named "test/integration/rcomp/tests/test1.test" with:
+      """
+      ABC
+
+      """
+    When I run `rcomp generate`
+    Then the output should contain "1 file (1 generated)"
+    And the exit status should be 0

data/features/init.feature

@@ -0,0 +1,44 @@
+Feature: Init
+  A user should be able to initialize the RComp's test directories
+
+  Scenario: Blind init
+    When I run `rcomp init`
+    Then the following directories should exist:
+      | rcomp |
+      | rcomp/tests |
+      | rcomp/results |
+      | rcomp/expected |
+    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`
+    Then the following directories should exist:
+      | dir |
+      | dir/tests |
+      | dir/results |
+      | dir/expected |
+    And the exit status should be 0
+
+  Scenario: Init with directory set in subdirectory
+    Given a directory named "spec/dir"
+    And I run `rcomp d spec/dir/rcomp`
+    When I run `rcomp init`
+    Then the following directories should exist:
+      | spec/dir/rcomp |
+      | spec/dir/rcomp/tests |
+      | spec/dir/rcomp/results |
+      | spec/dir/rcomp/expected |
+    And the exit status should be 0
+
+  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
+
+  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/set_command.feature

@@ -0,0 +1,24 @@
+Feature: Set Command
+  A user should be able to set the command RComp tests with from the CLI
+
+  @announce
+  Scenario: Set command
+    When I run `rcomp set-command ./test_exec`
+    Then a file named ".rcomp" should exist
+    And the file ".rcomp" should contain "command: ./test_exec"
+    And the exit status should be 0
+
+  @announce
+  Scenario: Set command alias
+    When I run `rcomp c ./test_exec`
+    Then a file named ".rcomp" should exist
+    And the file ".rcomp" should contain "command: ./test_exec"
+    And the exit status should be 0
+
+  @announce
+  Scenario: Overwrite command
+    When I run `rcomp c ./first`
+    And I run `rcomp c ./second`
+    Then a file named ".rcomp" should exist
+    And the file ".rcomp" should contain "command: ./second"
+    And the exit status should be 0

data/features/set_directory.feature

@@ -0,0 +1,22 @@
+Feature: Set Directory
+  A user should be able to set the directory that RComp
+  stores tests in from the CLI
+
+  Scenario: Set directory
+    When I run `rcomp set-directory spec/rcomp`
+    Then a file named ".rcomp" should exist
+    And the file ".rcomp" should contain "directory: spec/rcomp"
+    And the exit status should be 0
+
+  Scenario: Set directory alias
+    When I run `rcomp d spec/rcomp`
+    Then a file named ".rcomp" should exist
+    And the file ".rcomp" should contain "directory: spec/rcomp"
+    And the exit status should be 0
+
+  Scenario: Overwrite directory
+    When I run `rcomp d first`
+    And I run `rcomp d second`
+    Then a file named ".rcomp" should exist
+    And the file ".rcomp" should contain "directory: second"
+    And the exit status should be 0

data/features/support/env.rb

@@ -0,0 +1,66 @@
+require 'rcomp'
+require 'aruba/api'
+require 'aruba/cucumber'
+require 'test/unit/assertions'
+
+# Helpers
+def create_executable
+  content = "#!/usr/bin/env ruby\nputs IO.binread(ARGV[0])"
+  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
+end
+
+def create_assorted_tests
+  write_file("rcomp/tests/test_a.test", "ABC\n")
+  write_file("rcomp/tests/dir/test_b.test", "DEF\n")
+  write_file("rcomp/tests/dir/foo/test_c.test", "GHI\n")
+end
+
+# Custom Tags
+Before('@basic-conf') do
+  create_executable
+  # Spin up basic RComp configuration
+  run_simple('rcomp c ./test_exec', false)
+  run_simple('rcomp init', false)
+end
+
+Before('@err-conf') do
+  create_err_executable
+  # Spin up RComp configuraton with an erroring executable
+  run_simple('rcomp c ./test_exec', false)
+  run_simple('rcomp init', false)
+end
+
+Before('@custom-conf') do
+  create_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)
+end
+
+Before('@load-assorted-tests') do
+  create_assorted_tests
+  write_file("rcomp/expected/test_a.out", "ABC\n")
+  write_file("rcomp/expected/dir/test_b.out", "XYZ\n")
+end
+
+Before('@load-assorted-err-tests') do
+  create_assorted_tests
+  write_file("rcomp/expected/test_a.err", "ABC\n")
+  write_file("rcomp/expected/dir/test_b.err", "XYZ\n")
+end
+
+World(Test::Unit::Assertions)