cuke_slicer 1.0.0

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.simplecov

@@ -0,0 +1,7 @@
+SimpleCov.start do
+  add_filter '/spec/'
+  add_filter '/features/'
+
+  #Ignore results that are older than 10 minutes
+  merge_timeout 600
+end

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Grange Insurance
+
+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,53 @@
+# CukeSlicer
+
+The cuke_slicer gem provides an easy and programmatic way to divide a Cucumber test suite into granular test
+cases that can then be dealt with on an individual basis. Often this means handing them off to a distributed
+testing system in order to parallelize test execution.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cuke_slicer'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cuke_slicer
+
+## Usage
+
+    require 'cuke_slicer'
+
+
+    # Choose which part of your test suite that you want to slice up
+    test_directory = 'path/to/your_test_directory'
+
+    # Choose your slicing filters
+    filters = {excluded_tags: ['@tag1','@tag2'],
+               included_tags: '@tag3',
+               excluded_paths: 'foo',
+               included_paths: [/test_directory/]}
+
+    # Use the slicer to find all tests matching those filters
+    found_tests = CukeSlicer::Slicer.new.slice(test_directory, filters)
+
+
+    # Arrange the sliced pieces to suit your particular needs. In this case, we will dump them
+    # into a file that Cucumber can consume.
+
+    File.open('tests_to_run.txt', 'w') { |file| file.puts found_tests }
+
+    system('cucumber @tests_to_run.txt')
+
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/cuke_slicer/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,49 @@
+require "bundler/gem_tasks"
+require 'cucumber/rake/task'
+require 'rspec/core/rake_task'
+
+
+def set_cucumber_options(options)
+  ENV['CUCUMBER_OPTS'] = options
+end
+
+def combine_options(set_1, set_2)
+  set_2 ? "#{set_1} #{set_2}" : set_1
+end
+
+
+namespace 'cuke_slicer' do
+
+  task :clear_coverage do
+    puts 'Clearing old code coverage results...'
+
+    # Remove previous coverage results so that they don't get merged in the new results
+    code_coverage_directory = File.join(File.dirname(__FILE__), 'coverage')
+    FileUtils.remove_dir(code_coverage_directory, true) if File.exists?(code_coverage_directory)
+  end
+
+  namespace 'cucumber' do
+    desc 'Run all Cucumber tests for the gem'
+    task :tests, [:command_options] do |t, args|
+      set_cucumber_options(combine_options('-t ~@wip -t ~@off', args[:command_options]))
+    end
+    Cucumber::Rake::Task.new(:tests)
+  end
+
+  namespace 'rspec' do
+    desc 'Run all RSpec tests for the gem'
+    RSpec::Core::RakeTask.new(:specs, :command_options) do |t, args|
+      t.rspec_opts = combine_options('--tag ~wip', args[:command_options])
+    end
+  end
+
+  desc 'Run all tests for the gem'
+  task :test_everything, [:command_options] => :clear_coverage do |t, args|
+    Rake::Task['cuke_slicer:rspec:specs'].invoke(args[:command_options])
+    Rake::Task['cuke_slicer:cucumber:tests'].invoke(args[:command_options])
+  end
+
+end
+
+
+task :default => 'cuke_slicer:test_everything'

data/cuke_slicer.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cuke_slicer/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "cuke_slicer"
+  spec.version       = CukeSlicer::VERSION
+  spec.authors       = ["Eric Kessler"]
+  spec.email         = ["morrow748@gmail.com"]
+  spec.summary       = %q{A gem for extracting test cases from a Cucumber test suite.}
+  spec.description   = spec.summary
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_runtime_dependency "cuke_modeler"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", '~> 3.0'
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "simplecov"
+end

data/features/step_definitions/action_steps.rb

@@ -0,0 +1,106 @@
+When(/^test cases are extracted from "([^"]*)"$/) do |target|
+  @output ||= {}
+  filters = {}
+
+  filters[:excluded_tags] = @excluded_tag_filters if @excluded_tag_filters
+  filters[:included_tags] = @included_tag_filters if @included_tag_filters
+  filters[:excluded_paths] = @excluded_path_filters if @excluded_path_filters
+  filters[:included_paths] = @included_path_filters if @included_path_filters
+
+  @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", filters, &@custom_filter)
+end
+
+When(/^test cases are extracted from it$/) do
+  @output ||= {}
+  filters = {}
+  target = @targets.first
+
+  begin
+    @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", filters)
+  rescue ArgumentError => e
+    @error_raised = e
+  end
+end
+
+When(/^test cases are extracted from them$/) do
+  @output ||= {}
+  filters = {}
+
+  @targets.each do |target|
+    @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", filters)
+  end
+end
+
+When(/^test cases are extracted from "([^"]*)" using the following exclusive tag filters:$/) do |target, filters|
+  @output ||= {}
+  options = {}
+
+  options[:excluded_tags] = filters.raw.flatten.collect { |filter| process_filter(filter) }
+
+  @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", options)
+end
+
+When(/^test cases are extracted from "([^"]*)" using the following inclusive tag filters:$/) do |target, filters|
+  @output ||= {}
+  options = {}
+
+  options[:included_tags] = filters.raw.flatten.collect { |filter| process_filter(filter) }
+
+  @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", options)
+end
+
+When(/^test cases are extracted from "([^"]*)" using the following inclusive path filters:$/) do |target, filters|
+  @output ||= {}
+  options = {}
+
+  options[:included_paths] = filters.raw.flatten.collect { |filter| process_filter(filter) }
+
+  @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", options)
+end
+
+When(/^test cases are extracted from "([^"]*)" using the following exclusive path filters:$/) do |target, filters|
+  @output ||= {}
+  options = {}
+
+  options[:excluded_paths] = filters.raw.flatten.collect { |filter| process_filter(filter) }
+
+  @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", options)
+end
+
+When(/^test cases are extracted from "([^"]*)" using the following custom filter:$/) do |target, filter_block|
+  @output ||= {}
+
+  custom_filter = eval("Proc.new #{filter_block}")
+
+  @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", &custom_filter)
+end
+
+When(/^test cases are extracted from "([^"]*)" using "([^"]*)"$/) do |target, included_tag_filters|
+  @output ||= {}
+  options = {}
+
+  options[:included_tags] = eval("[#{included_tag_filters}]")
+
+  @output[target] = CukeSlicer::Slicer.new.slice("#{@default_file_directory}/#{target}", options)
+end
+
+def process_filter(filter)
+  filter.sub!('path/to', @default_file_directory)
+  filter =~ /^\/.+\/$/ ? Regexp.new(filter.slice(1..-2)) : filter
+end
+
+When(/^it tries to extract test cases using an unknown filter type$/) do
+  begin
+    @slicer.slice(@default_file_directory, {unknown_filter: 'foo'})
+  rescue ArgumentError => e
+    @error_raised = e
+  end
+end
+
+When(/^it tries to extract test cases using an invalid filter$/) do
+  begin
+    @slicer.slice(@default_file_directory, {included_tags: 7})
+  rescue ArgumentError => e
+    @error_raised = e
+  end
+end

data/features/step_definitions/setup_steps.rb

@@ -0,0 +1,79 @@
+Given(/^the following feature file(?: "([^"]*)")?:$/) do |file_name, file_text|
+  @test_directory ||= @default_file_directory
+  file_name ||= @default_feature_file_name
+
+  @targets ||= []
+  @targets << file_name
+
+  File.open("#{@test_directory}/#{file_name}", 'w') { |file| file.write(file_text) }
+end
+
+Given(/^the directory "([^"]*)"$/) do |directory_name|
+  @test_directory = "#{@default_file_directory}/#{directory_name}"
+
+  FileUtils.mkdir(@test_directory)
+end
+
+Given(/^the following tag filters:$/) do |filters|
+  filters.hashes.each do |filter|
+    case filter['filter type']
+      when 'excluded'
+        @excluded_tag_filters = filter['filter']
+      when 'included'
+        @included_tag_filters = filter['filter']
+      else
+        raise("Unknown filter type #{filter['filter type']}")
+    end
+  end
+end
+
+And(/^the following path filters:$/) do |filters|
+  @excluded_path_filters = []
+  @included_path_filters = []
+
+  filters.hashes.each do |filter|
+    case filter['filter type']
+      when 'excluded'
+        @excluded_path_filters << process_filter(filter['filter'])
+      when 'included'
+        @included_path_filters << process_filter(filter['filter'])
+      else
+        raise("Unknown filter type #{filter['filter type']}")
+    end
+  end
+end
+
+And(/^the following custom filter:$/) do |filter|
+  @custom_filter = eval("Proc.new #{filter}")
+end
+
+Given(/^the file "([^"]*)" does not exist$/) do |file_name|
+  @test_directory ||= @default_file_directory
+
+  @targets ||= []
+  @targets << file_name
+
+  file_path = "#{@test_directory}/#{file_name}"
+  FileUtils.rm(file_path) if File.exists?(file_path)
+end
+
+Given(/^the directory "([^"]*)" does not exist$/) do |directory_name|
+  @targets ||= []
+  @targets << directory_name
+
+  file_path = "#{@default_file_directory}/#{directory_name}"
+  FileUtils.remove_dir(file_path) if File.exists?(file_path)
+end
+
+And(/^the file "([^"]*)"$/) do |file_name|
+  @test_directory ||= @default_file_directory
+
+  @targets ||= []
+  @targets << file_name
+
+  File.open("#{@test_directory}/#{file_name}", 'w') { |file| file.write('') }
+end
+
+Given(/^a slicer$/) do
+  @slicer = CukeSlicer::Slicer.new
+end

data/features/step_definitions/verification_steps.rb

@@ -0,0 +1,47 @@
+Then(/^the following test cases are found$/) do |expected_test_cases|
+  expected_test_cases = expected_test_cases.raw.flatten
+  expected_test_cases.collect! { |test_case| test_case.sub('path/to', @default_file_directory) }
+
+  found_test_cases = @output.values.flatten
+
+  expect(found_test_cases).to match_array(expected_test_cases)
+end
+
+Then(/^no test cases are found$/) do
+  expect(@output.values.flatten).to be_empty
+end
+
+Then(/^The following filter types are valid:$/) do |filter_types|
+  filter_types = filter_types.raw.flatten.collect { |filter| filter.to_sym }
+
+  expect(CukeSlicer::Slicer.known_filters).to match_array(filter_types)
+end
+
+Then(/^"([^"]*)" are found$/) do |test_cases|
+  expected_test_cases = test_cases.delete(' ').split(',')
+  expected_test_cases.collect! { |test_case| test_case.sub('path/to', @default_file_directory) }
+
+  found_test_cases = @output.values.flatten
+
+  expect(found_test_cases).to match_array(expected_test_cases)
+end
+
+Then(/^an error indicating that the (?:file|directory) does not exist will be triggered$/) do
+  expect(@error_raised).to_not be_nil
+  expect(@error_raised.message).to match(/file.*directory.*does not exist/i)
+end
+
+Then(/^an error indicating that the feature file is invalid will be triggered$/) do
+  expect(@error_raised).to_not be_nil
+  expect(@error_raised.message).to match(/syntax.*lexing/)
+end
+
+Then(/^an error indicating that the filter type is unknown will be triggered$/) do
+  expect(@error_raised).to_not be_nil
+  expect(@error_raised.message).to match(/unknown filter/i)
+end
+
+Then(/^an error indicating that the filter is invalid will be triggered$/) do
+  expect(@error_raised).to_not be_nil
+  expect(@error_raised.message).to match(/invalid filter/i)
+end

data/features/support/env.rb

@@ -0,0 +1,18 @@
+require 'simplecov'
+SimpleCov.command_name('cuke_slicer-cucumber_tests')
+
+
+require 'cuke_slicer'
+
+
+Before do
+  feature_directory = "#{File.dirname(__FILE__)}/.."
+  @default_file_directory = "#{feature_directory}/temp_files"
+  @default_feature_file_name = 'unnamed_feature.feature'
+
+  FileUtils.mkdir(@default_file_directory)
+end
+
+After do
+  FileUtils.remove_dir(@default_file_directory, true)
+end