cbratest 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 16bd9373d934ef9e11eda3fef3e7c1c565684bcf
+  data.tar.gz: 5d9433bf389ac8b5e5aa4e17beb66ec5759d2849
+SHA512:
+  metadata.gz: 7b13cdfad482952919d2206676069c9651883dbb03fb21db1d679ff74b7d4318e7c96e4d60b582a7b88803f15055d871ac0fce81d1f5288738c9d3974c14d8ae
+  data.tar.gz: 494e91e3e8855674531303bc69d75985ee7d40b1e31858009457599580082e87013384ecdbce3c057f485fa26d7c28bd82c1e800300dad5d62451bdb20b663c8

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cbratest.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Stephan Hagemann
+
+MIT License
+
+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,83 @@
+# cbratest [![Build Status](https://travis-ci.org/shageman/cbratest.svg?branch=master)](https://travis-ci.org/shageman/cbratest) [![Gem Version](https://badge.fury.io/rb/cbratest.svg)](http://badge.fury.io/rb/cbratest) [![Code Climate](https://codeclimate.com/github/shageman/cbratest.png)](https://codeclimate.com/github/shageman/cbratest) [![Dependency Status](https://gemnasium.com/shageman/cbratest.svg)](https://gemnasium.com/shageman/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, stephan.hagemann@gmail.com, [@shageman](http://twitter.com/shageman)
+
+Released under the MIT license. See LICENSE file for details.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/bin/cbratest

@@ -0,0 +1,47 @@
+#!/usr/bin/ruby
+
+require_relative "../lib/cbratest"
+
+def help_text
+  <<-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
+  USAGE
+end
+
+option = "-r"
+path = nil
+
+case ARGV.size
+  when 0
+  when 1
+    if ARGV[0].start_with? "-"
+      option = ARGV[0]
+    else
+      path = ARGV[0]
+    end
+  when 2
+    option = ARGV[0]
+    path = ARGV[1]
+  else
+    puts "Incorrect invocation. Please see help:\n\n"
+    puts help_text
+    exit 1
+end
+
+if option
+  if %w(--help -h -H).include? option
+    puts help_text
+  elsif %w(-r --results).include? option
+    Cbratest::Runner.new(false).run path
+  elsif %w(-v --verbose).include? option
+    Cbratest::Runner.new(true).run path
+  end
+end

data/cbratest.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cbratest'
+  spec.version       = '0.1.0'
+  spec.authors       = ['Stephan Hagemann']
+  spec.email         = ['stephan.hagemann@gmail.com']
+  spec.summary       = %q{A test runner for your #cbra application}
+  spec.description   = %q{A test runner that optimizes the tests it runs based on the recent changes of your application. Makes use of #cbra dependencies to infer which parts of the application are definitely unaffected. Science! BOOM!}
+  spec.homepage      = 'https://github.com/shageman/cbradeps'
+  spec.license       = 'MIT'
+
+  spec.files         = %w(
+                          bin/cbratest
+                          cbratest.gemspec
+                          Gemfile
+                          lib/cbratest/affected_component_finder.rb
+                          lib/cbratest/gemfile_scraper.rb
+                          lib/cbratest/tests_to_run_selector.rb
+                          lib/cbratest/transitive_affected_component_finder.rb
+                          lib/cbratest.rb
+                          LICENSE
+                          Rakefile
+                          README.md
+                          )
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+end

data/lib/cbratest/affected_component_finder.rb

@@ -0,0 +1,15 @@
+module Cbratest
+  class AffectedComponentFinder
+    def find(components, changes)
+      components.inject({}) do |memo, component|
+        memo[component] = false
+        changes.each do |change|
+          if change.start_with? component[:options][:path]
+            memo[component] = true
+          end
+        end
+        memo
+      end
+    end
+  end
+end

data/lib/cbratest/gemfile_scraper.rb

@@ -0,0 +1,93 @@
+module Cbratest
+  class GemfileScraper
+    def initialize(root_path)
+      @root_path = root_path
+    end
+
+    def name
+      Pathname.new(@root_path).basename.to_s
+    end
+
+    def to_s
+      {name: name, options: {path: @root_path}}
+    end
+
+    def cbra_dependencies
+      dirdep = direct_dependencies
+      transitive_cbra_dependencies.select do |dep|
+        dirdep.include?(dep[:name]) || dep[:options][:direct]
+      end
+    end
+
+    def transitive_cbra_dependencies
+      gem_dependencies.inject([]) do |memo, dep|
+        if !!dep[:options][:path]
+          absolute_dep = dep.clone
+          absolute_dep[:options][:path] = File.expand_path(File.join(@root_path, dep[:options][:path]))
+          memo << dep
+        end
+        memo
+      end
+    end
+
+    private
+
+    def raw_gemspec
+      path = File.expand_path(File.join(@root_path, "#{underscore(name)}.gemspec"))
+      File.exist?(path) ? File.read(path) : ""
+    end
+
+    def direct_dependencies
+      raw_gemspec.split("\n").inject([]) do |memo, line|
+        match = line.match(/add_(?:development_)?dependency\s+["']([^'"]+)["']/)
+        memo << match[1] if match
+        memo
+      end
+    end
+
+    def raw_gemfile
+      path = File.expand_path(File.join(@root_path, "Gemfile"))
+      File.read(path)
+    end
+
+    def gem_dependencies
+      raw_gemfile.split("\n").inject([]) do |memo, line|
+        match = line.match(/gem\s+["']([^'"]+)["'](.*)/)
+        if match
+          memo << {name: match[1], options: OptionParser.new(match[2]).parse}
+        end
+        memo
+      end
+    end
+
+    def underscore(string)
+      string.gsub(/::/, '/').
+          gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2').
+          gsub(/([a-z\d])([A-Z])/, '\1_\2').
+          tr("-", "_").
+          downcase
+    end
+
+    class OptionParser
+      def initialize(options)
+        @options = options
+      end
+
+      def parse
+        {}.merge(path).merge(direct)
+      end
+
+      private
+
+      def path
+        match = @options.match(/path(?:\s*=>|:)\s+["']([^'"]+)["']/)
+        match ? {path: match[1]} : {}
+      end
+
+      def direct
+        match = @options.match(/direct(?:\s*=>|:)\s+true/)
+        match ? {direct: true} : {}
+      end
+    end
+  end
+end

data/lib/cbratest/tests_to_run_selector.rb

@@ -0,0 +1,10 @@
+module Cbratest
+  class TestsToRunSelector
+    def list(affected)
+      affected.keys.inject([]) do |memo, key|
+        memo << File.join(key[:options][:path], "test.sh") if affected[key]
+        memo
+      end
+    end
+  end
+end

data/lib/cbratest/transitive_affected_component_finder.rb

@@ -0,0 +1,16 @@
+module Cbratest
+  class TransitiveAffectedComponentFinder
+    def find(affected)
+      all_affected = {}
+      affected.keys.each do |key|
+        gem = GemfileScraper.new(key[:options][:path])
+        if gem.transitive_cbra_dependencies.any? { |dep| affected[dep] }
+          all_affected[key] = true
+        else
+          all_affected[key] = affected[key] || false
+        end
+      end
+      all_affected
+    end
+  end
+end

data/lib/cbratest.rb

@@ -0,0 +1,73 @@
+require 'set'
+require 'pathname'
+require 'graphviz'
+
+module Cbratest
+  require_relative "cbratest/gemfile_scraper"
+  require_relative "cbratest/affected_component_finder"
+  require_relative "cbratest/transitive_affected_component_finder"
+  require_relative "cbratest/tests_to_run_selector"
+
+  class Runner
+    def initialize(verbose_output)
+      @verbose_output = verbose_output
+    end
+
+    def run(root_path)
+      path = root_path || current_path
+      app = GemfileScraper.new(path)
+
+      outputs "All components"
+      cbra_deps = app.transitive_cbra_dependencies.to_set
+      components = cbra_deps << app.to_s
+      outputs component_out(components.to_a)
+
+
+      outputs "\nChanges since last commit"
+      root_dir = `cd #{path} && git rev-parse --show-toplevel`.chomp
+      changes = `cd #{root_dir} && git status -s -u`.split("\n").map { |file| File.join(root_dir, file.sub(/^.../, "")) }
+      outputs changes
+
+
+      outputs "\nDirectly affected components"
+      affected = AffectedComponentFinder.new.find(components, changes)
+      outputs affected_out(affected)
+
+      outputs "\nTransitively affected components"
+      all_affected = TransitiveAffectedComponentFinder.new.find(affected)
+      outputs affected_out(all_affected)
+
+      outputs "\nTest scripts to run"
+      outputs all_in_need_of_running = TestsToRunSelector.new.list(all_affected), true
+    end
+
+    private
+
+    def outputs(arg, even_non_verbose = false)
+      output(arg) if even_non_verbose || @verbose_output
+    end
+
+    def output(arg)
+      puts arg
+    end
+
+    def component_out(array)
+      array.map do |component|
+        "#{component[:name].ljust(max_key_width(array))} #{component[:options][:path]}"
+      end
+    end
+
+    def affected_out(hash)
+      hash.keys.inject([]) do |memo, component|
+        memo << "#{component[:name].ljust(max_key_width(hash.keys))} #{component[:options][:path]}" if hash[component]
+        memo
+      end
+    end
+
+    def max_key_width(array)
+      array.inject(0) do |memo, component|
+        [memo, component[:name].length].max
+      end + 2
+    end
+  end
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: cbratest
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Stephan Hagemann
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'A test runner that optimizes the tests it runs based on the recent changes
+  of your application. Makes use of #cbra dependencies to infer which parts of the
+  application are definitely unaffected. Science! BOOM!'
+email:
+- stephan.hagemann@gmail.com
+executables:
+- cbratest
+extensions: []
+extra_rdoc_files: []
+files:
+- bin/cbratest
+- cbratest.gemspec
+- Gemfile
+- lib/cbratest/affected_component_finder.rb
+- lib/cbratest/gemfile_scraper.rb
+- lib/cbratest/tests_to_run_selector.rb
+- lib/cbratest/transitive_affected_component_finder.rb
+- lib/cbratest.rb
+- LICENSE
+- Rakefile
+- README.md
+homepage: https://github.com/shageman/cbradeps
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: 'A test runner for your #cbra application'
+test_files: []