cbratest

cbratest

Prints a list of the components that have changed since the last commit and for which tests need to be run. Uses the dependencies within component-based Ruby/Rails applications (#cbra) to also print all transitively affected components.

Installation

Add this line to your application's Gemfile:

gem 'cbratest'

And then execute:

$ bundle

Or install it yourself as:

$ gem install cbratest

Usage

cbratest [OPTION] [application path]

Test runner employing the structure of Component-based Ruby/Rails apps to optimize what needs to run.

Options are...
    -h, -H, --help                   Display this help message.

    -r, --results                    DEFAULT Display the directories of the components in need of running tests
    -v, --verbose                    Verbose output of all parts of the calculation

Example

There are sample #cbra folder structures in spec/examples. Here is an example run when changing a file in component C:

± |master ✗| → bin/cbratest ~/workspace/cbratest/spec/examples/letters/A
/Users/stephan/workspace/cbratest/spec/examples/letters/B/test.sh
/Users/stephan/workspace/cbratest/spec/examples/letters/C/test.sh
/Users/stephan/workspace/cbratest/spec/examples/letters/A/test.sh

This output can be used to run the necessary tests like so:

bin/cbratest ~/workspace/cbratest/spec/examples/letters/A | xargs -n1 /bin/bash

In verbose mode one can check the correctness of cbratest's calculation:

± |master ✗| → bin/cbratest -v ~/workspace/cbra/cbratest/spec/examples/letters/A
All components
B    /Users/stephan/workspace/cbra/cbratest/spec/examples/letters/B
C    /Users/stephan/workspace/cbra/cbratest/spec/examples/letters/C
D    /Users/stephan/workspace/cbra/cbratest/spec/examples/letters/D
E1   /Users/stephan/workspace/cbra/cbratest/spec/examples/letters/E1
E2   /Users/stephan/workspace/cbra/cbratest/spec/examples/letters/E2
F    /Users/stephan/workspace/cbra/cbratest/spec/examples/letters/F
A    /Users/stephan/workspace/cbra/cbratest/spec/examples/letters/A

Changes since last commit
/Users/stephan/workspace/cbra/cbratest/README.md
/Users/stephan/workspace/cbra/cbratest/spec/examples/letters/C/Gemfile

Directly affected components
C    /Users/stephan/workspace/cbra/cbratest/spec/examples/letters/C

Transitively affected components
B    /Users/stephan/workspace/cbra/cbratest/spec/examples/letters/B
C    /Users/stephan/workspace/cbra/cbratest/spec/examples/letters/C
A    /Users/stephan/workspace/cbra/cbratest/spec/examples/letters/A

Test scripts to run
/Users/stephan/workspace/cbra/cbratest/spec/examples/letters/B/test.sh
/Users/stephan/workspace/cbra/cbratest/spec/examples/letters/C/test.sh
/Users/stephan/workspace/cbra/cbratest/spec/examples/letters/A/test.sh

Todos

• make algorithm work for structures where a gem is in a sub folder of another gem (only the inner gem should be diectly affected)
• allow for other test runners to be specified
• optionally check for changes since origin/master
• optionally allow branch to compare against to be specified

License

Copyright (c) 2014 Stephan Hagemann, [e-mail], @shageman

Released under the MIT license. See LICENSE file for details.