cuke_cataloger 1.0.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+/.idea/

data/.simplecov

@@ -0,0 +1,8 @@
+SimpleCov.start do
+  root File.dirname(__FILE__)
+
+  add_filter '/features/'
+  add_filter '/spec/'
+
+  merge_timeout 300
+end

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - 2.0.0
+  - 2.1.6
+  - 2.2.2
+
+script: bundle exec rake cuke_cataloger:ci_build

data/Gemfile

@@ -0,0 +1,17 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cuke_cataloger.gemspec
+gemspec
+
+
+if RUBY_VERSION =~ /^1\.8/
+  gem 'cucumber', '<1.3.0'
+  gem 'gherkin', '<2.12.0'
+  gem 'mime-types', '<2.0.0'
+  gem 'rest-client', '<1.7.0'
+elsif RUBY_VERSION =~ /^1\./
+  gem 'cucumber', '<2.0.0'
+end
+
+
+gem 'coveralls', :require => false, :group => :development

data/History.md

@@ -0,0 +1,5 @@
+# Release history
+
+### Version 1.0.0 / 2015-10-05
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Eric Kessler
+
+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,67 @@
+# CukeCataloger
+
+
+[![Gem Version](https://badge.fury.io/rb/cuke_cataloger.svg)](http://badge.fury.io/rb/cuke_cataloger)
+[![Build Status](https://travis-ci.org/enkessler/cuke_cataloger.svg?branch=master)](https://travis-ci.org/enkessler/cuke_cataloger)
+[![Coverage Status](https://coveralls.io/repos/enkessler/cuke_cataloger/badge.svg?branch=master&service=github)](https://coveralls.io/github/enkessler/cuke_cataloger?branch=master)
+[![Code Climate](https://codeclimate.com/github/enkessler/cuke_cataloger/badges/gpa.svg)](https://codeclimate.com/github/enkessler/cuke_cataloger)
+[![Project License](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/enkessler/cuke_cataloger/blob/master/LICENSE.txt)
+
+
+The cuke_cataloger gem is a convenient way to provide a unique id to every test case in your Cucumber test suite. 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'cuke_cataloger'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cuke_cataloger
+
+## Usage
+
+The simplest way to use this gem is to include the Rake tasks that it provides in your project. Just require the gem
+
+    require 'cuke_cataloger'
+
+and then call its task creation method in your Rakefile (or wherever you like to keep your Rake tasks) in order to generate the tasks.
+
+    CukeCataloger.create_tasks
+
+If you want the tasks to be created in a certain namespace, simply call the creation method from within that namespace.
+
+    namespace 'foo' do
+      CukeCataloger.create_tasks
+    end
+
+The classes used to tag and validate tests could also be used directly in other scripts if you want to do something more complex than the functionality provided by the two predefined Rake tasks.
+  
+### Adding ids to tests
+
+The tag_tests task will add an id tag to every scenario (and an id column to every outline) in a test suite. To do this, it needs to be provided a directory in which the tests are located and a prefix upon which to base the tagging scheme.
+
+    rake tag_tests['path/to/your/tests','@test_case_']
+
+The above example would result in the tags @test_case_1, @test_case_2, @test_case_3, etc. being added to every test in the given directory.
+
+### Validating test ids
+
+The validate_tests task scans a given directory for any problems related to id tags and generates a report detailing its results. To do this, it needs to be provided a directory in which the tests are located and a prefix upon which to base the tagging scheme. It can optionally take a file location to which it should output its report instead of printing it to the console.
+
+    rake validate_tests['path/to/your/tests','@test_case_','validation_results.txt']
+
+The above example would result in a report called 'validation_results.txt' being generated for any test had problems related to their id (e.g. did not have an id tag, had the same id tag as another test, etc.).
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/cuke_cataloger/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 new Pull Request

data/Rakefile

@@ -0,0 +1,26 @@
+require 'racatt'
+require 'coveralls/rake/task'
+
+
+namespace 'cuke_cataloger' do
+
+  task :clear_coverage do
+    # Remove previous coverage results so that they don't get merged into 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
+
+
+  Racatt.create_tasks
+
+  # Redefining the task from 'racatt' in order to clear the code coverage results
+  task :test_everything, [:command_options] => :clear_coverage
+
+
+  # The task that CI will use
+  Coveralls::RakeTask.new
+  task :ci_build => [:test_everything, 'coveralls:push']
+end
+
+
+task :default => 'cuke_cataloger:test_everything'

data/cuke_cataloger.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cuke_cataloger/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'cuke_cataloger'
+  spec.version       = CukeCataloger::VERSION
+  spec.authors       = ['Eric Kessler']
+  spec.email         = ['morrow748@gmail.com']
+  spec.summary       = 'A tool to give every Cucumber test a unique id'
+  spec.description   = 'Scans existing Cucumber tests and updates them to include an id tag that is unique for the test suite.'
+  spec.homepage      = 'https://github.com/enkessler/cuke_cataloger'
+  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_runtime_dependency 'cql', '~>1.0', '>= 1.0.1'
+  spec.add_runtime_dependency 'rake'
+
+  spec.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'cucumber'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'racatt'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'coveralls'
+end

data/features/formatting.feature

@@ -0,0 +1,191 @@
+Feature: Tagging formatting
+
+  In an effort to have the added tag scheme be as unobtrusive as possible, tagging needs to fit in with the existing
+  source code as well as possible.
+
+
+  Background:
+    And a tag prefix of "@test_case_"
+
+  Scenario: Test level tags have the same indentation as the test itself
+    Given the following feature file:
+    """
+    Feature:
+
+    Scenario:
+      * a step
+
+      Scenario:
+      * a step
+
+        Scenario:
+        * a step
+    """
+    When the files are processed
+    Then the resulting file is:
+    """
+    Feature:
+
+    @test_case_1
+    Scenario:
+      * a step
+
+      @test_case_2
+      Scenario:
+      * a step
+
+        @test_case_3
+        Scenario:
+        * a step
+    """
+
+  Scenario: The column for sub-ids is appropriately whitespace buffered
+    Given the following feature file:
+    """
+    Feature:
+
+      @test_case_1
+      Scenario Outline:
+        * a step
+      Examples: column name is longer than sub-id
+        | param 1 |
+        | value 1 |
+
+      @test_case_123456789101112
+      Scenario Outline:
+        * a step
+      Examples: sub-id is longer than column name
+        | param 1 |
+        | value 1 |
+    """
+    When the files are processed
+    Then the resulting file is:
+    """
+    Feature:
+
+      @test_case_1
+      Scenario Outline:
+        * a step
+      Examples: column name is longer than sub-id
+        | param 1 | test_case_id |
+        | value 1 | 1-1          |
+
+      @test_case_123456789101112
+      Scenario Outline:
+        * a step
+      Examples: sub-id is longer than column name
+        | param 1 | test_case_id      |
+        | value 1 | 123456789101112-1 |
+    """
+
+  Scenario: The column for sub-ids is last
+    Given a feature file
+    When the file is processed
+    Then the column for sub-ids is placed after all other columns
+
+  Scenario: Test tags can be added above existing tags
+    Given the following feature file:
+    """
+    Feature:
+
+      @tag_1
+      @tag_2 @tag_3
+
+      Scenario: Test with tags
+
+      Scenario: Test without tags
+    """
+    And  the tag should be at the "top"
+    When the files are processed
+    Then the resulting file is:
+    """
+    Feature:
+
+      @test_case_1
+      @tag_1
+      @tag_2 @tag_3
+
+      Scenario: Test with tags
+
+      @test_case_2
+      Scenario: Test without tags
+    """
+
+  Scenario: Test tags can be added below existing tags
+    Given the following feature file:
+    """
+    Feature:
+
+      @tag_1
+      @tag_2 @tag_3
+
+      Scenario: Test with tags
+
+      Scenario: Test without tags
+    """
+    And  the tag should be at the "bottom"
+    When the files are processed
+    Then the resulting file is:
+    """
+    Feature:
+
+      @tag_1
+      @tag_2 @tag_3
+      @test_case_1
+
+      Scenario: Test with tags
+
+      @test_case_2
+      Scenario: Test without tags
+    """
+
+  Scenario: Test tags can be added adjacent to the test
+    Given the following feature file:
+    """
+    Feature:
+
+      @tag_1
+      @tag_2 @tag_3
+
+      Scenario: Test with tags
+
+      Scenario: Test without tags
+    """
+    And  the tag should be at the "side"
+    When the files are processed
+    Then the resulting file is:
+    """
+    Feature:
+
+      @tag_1
+      @tag_2 @tag_3
+
+      @test_case_1
+      Scenario: Test with tags
+
+      @test_case_2
+      Scenario: Test without tags
+    """
+
+  Scenario: Test tagging location defaults to adjacent
+    Given the following feature file:
+    """
+    Feature:
+
+      @tag_1
+      @tag_2 @tag_3
+
+      Scenario:
+    """
+    And  the tag location is unspecified
+    When the files are processed
+    Then the resulting file is:
+    """
+    Feature:
+
+      @tag_1
+      @tag_2 @tag_3
+
+      @test_case_1
+      Scenario:
+    """

data/features/step_definitions/action_steps.rb

@@ -0,0 +1,28 @@
+When(/^the files? (?:is|are) processed$/) do
+  @start_index ||= {}
+  @directory = CukeModeler::Directory.new(@test_directory)
+
+  tagger = CukeCataloger::UniqueTestCaseTagger.new
+  tagger.tag_location = @above_or_below if @above_or_below
+
+  tagger.tag_tests(@directory.path, @tag_prefix, @start_index)
+end
+
+When(/^the ids in the test suite are validated$/) do
+  @directory = CukeModeler::Directory.new(@test_directory)
+
+  @test_results = CukeCataloger::UniqueTestCaseTagger.new.validate_test_ids(@directory.path, @tag_prefix)
+end
+
+When(/^the files are scanned$/) do
+  @directory = CukeModeler::Directory.new(@test_directory)
+  @exception_raised = false
+
+  @test_results = CukeCataloger::UniqueTestCaseTagger.new.scan_for_tagged_tests(@directory.path, @tag_prefix)
+end
+
+When(/^the existing ids are determined$/) do
+  @directory = CukeModeler::Directory.new(@test_directory)
+
+  @ids_found = CukeCataloger::UniqueTestCaseTagger.new.determine_known_ids(@directory.path, @tag_prefix)
+end

data/features/step_definitions/setup_steps.rb

@@ -0,0 +1,56 @@
+Given /^the following feature file(?: "([^"]*)")?:$/ do |file_name, file_text|
+  @test_directory = @default_file_directory
+  @files_created ||= 0
+  @feature_files ||= []
+
+  file_name ||= "#{@default_feature_file_name}_#{@files_created + 1}.feature"
+  file_path = "#{@test_directory}/#{file_name}"
+  @feature_files << file_path
+
+  File.open(file_path, 'w') { |file| file.write file_text }
+
+  @files_created += 1
+end
+
+When(/^a tag prefix of "([^"]*)"$/) do |prefix|
+  @tag_prefix = prefix
+end
+
+And(/^a start index of "([^"]*)"$/) do |index|
+  @start_index ||= {:sub => {}}
+  @start_index[:primary] = index
+end
+
+And(/^a start index of "([^"]*)" for testcase "([^"]*)"$/) do |sub_index, parent_index|
+  @start_index ||= {:sub => {}}
+  @start_index[:sub][parent_index.to_s] = sub_index
+end
+
+Given(/^a feature file$/) do
+  @test_directory = @default_file_directory
+  @files_created ||= 0
+  @feature_files ||= []
+
+  file_name ||= "#{@default_feature_file_name}_#{@files_created + 1}.feature"
+  file_path = "#{@test_directory}/#{file_name}"
+  @feature_files << file_path
+
+  File.open(file_path, 'w') { |file| file.write "Feature:\nScenario Outline:\n* a step\nExamples:\n| param 1 |\n| value 1 |" }
+
+  @files_created += 1
+end
+
+And(/^the tag should be at the "([^"]*)"$/) do |tag_location|
+  case tag_location
+    when 'top'
+      @above_or_below = :above
+    when 'bottom'
+      @above_or_below = :below
+    when 'side'
+      @above_or_below = :adjacent
+  end
+end
+
+And(/^the tag location is unspecified$/) do
+  @above_or_below = nil
+end

data/features/step_definitions/verification_steps.rb

@@ -0,0 +1,162 @@
+Then(/^the resulting file(?: "([^"]*)")? is:$/) do |file_index, expected_text|
+  file_index ||= 1
+  file_name = @feature_files[file_index - 1]
+
+  actual_text = File.read(file_name)
+
+  expect(actual_text).to eq(expected_text)
+end
+
+Then(/^the following tests are found to be missing ids:$/) do |expected_tests|
+  verify_category_results(:missing_tag, expected_tests)
+end
+
+Then(/^no tests are found to be missing ids$/) do
+  verify_no_results
+end
+
+Then(/^the following tests rows are found to be missing sub ids:$/) do |expected_rows|
+  verify_category_results(:missing_row_id, expected_rows)
+end
+
+Then(/^no tests rows are found to be missing sub ids$/) do
+  verify_no_results
+end
+
+Then(/^the following tests examples are found to be missing a parameter for sub ids:$/) do |expected_examples|
+  verify_category_results(:missing_id_column, expected_examples)
+end
+
+Then(/^no test examples are found to be missing id parameters$/) do
+  verify_no_results
+end
+
+Then(/^the following tests example rows are found to have mismatched sub ids:$/) do |expected_rows|
+  verify_category_results(:mismatched_row_id, expected_rows)
+end
+
+Then(/^no test example rows are found to have mismatched ids$/) do
+  verify_no_results
+end
+
+Then(/^the following tests are found to have multiple test ids:$/) do |expected_tests|
+  verify_category_results(:multiple_tags, expected_tests)
+end
+
+Then(/^no tests are found to have multiple test ids$/) do
+  verify_no_results
+end
+
+Then(/^the following tests are found to have a duplicated id:$/) do |expected_tests|
+  verify_category_results(:duplicate_id_tag, expected_tests)
+end
+
+Then(/^no tests are found to have duplicated ids$/) do
+  verify_no_results
+end
+
+Then(/^the following tests example rows are found to have duplicated sub ids:$/) do |expected_rows|
+  verify_category_results(:duplicate_row_id, expected_rows)
+end
+
+Then(/^no test example rows are found to have duplicated sub ids$/) do
+  verify_no_results
+end
+
+Then(/^the following tests example rows are found to have malformed sub ids:$/) do |expected_rows|
+  verify_category_results(:malformed_sub_id, expected_rows)
+end
+
+Then(/^no test example rows are found to have malformed sub ids$/) do
+  verify_no_results
+end
+
+Then(/^the following tagged test objects are found:$/) do |expected_results|
+  verify_results(expected_results)
+end
+
+Then(/^the payload is a test object$/) do
+  expect(@test_results.first[:object]).to be_a_kind_of(CukeModeler::TestElement)
+end
+
+Then(/^the payload has a test and a test row$/) do
+  expect(@test_results[0][:object]).to be_a_kind_of(CukeModeler::Outline)
+  expect(@test_results[1][:object]).to be_a_kind_of(CukeModeler::Row)
+end
+
+Then(/^the following ids are found:$/) do |expected_ids|
+  expect(@ids_found).to match_array(expected_ids.raw.flatten)
+end
+
+Then(/^the following feature is found to have a test case tag:$/) do |expected_results|
+  verify_category_results(:feature_test_tag, expected_results)
+end
+
+Then(/^no feature is found to have a test case tag$/) do
+  verify_no_results
+end
+
+Then(/^the column for sub-ids is placed after all other columns$/) do
+  file_model = CukeModeler::FeatureFile.new(@feature_files.first)
+  outline_model = file_model.feature.outlines.first
+
+  expect(outline_model.examples.first.parameters.last).to eq('test_case_id')
+end
+
+
+def verify_no_results
+  expect(@test_results).to be_empty
+end
+
+def verify_category_results(category, results)
+  @test_results = @test_results.select { |test_result| test_result[:problem] == category }
+  verify_results(results)
+end
+
+def verify_results(results)
+  expect(@test_results.collect { |test_result| test_result[:test] }).to match_array(process_results(results))
+end
+
+def process_results(results)
+  results = results.raw.flatten
+  results.collect { |test_path| test_path.sub('path/to', @default_file_directory) }
+end
+
+Then(/^the resulting first file is:$/) do |expected_text|
+  file_name = @feature_files[0]
+
+  actual_text = File.read(file_name)
+
+  # The order in which Ruby returns files various across version and operating system. This, in turn, will
+  # affect the order in which files are tagged. Either order is acceptable as long as the tagging is
+  # consistent for any given ordering.
+  begin
+    expect(actual_text).to eq(expected_text)
+  rescue RSpec::Expectations::ExpectationNotMetError => e
+    if RUBY_PLATFORM =~ /linux/
+      expected_text.sub!('test_case_1', 'test_case_2')
+      expect(actual_text).to eq(expected_text)
+      @switched = true
+    else
+      raise e
+    end
+  end
+
+end
+
+And(/^the resulting second file is:$/) do |expected_text|
+  file_name = @feature_files[1]
+
+  actual_text = File.read(file_name)
+
+  # The order in which Ruby returns files various across version and operating system. This, in turn, will
+  # affect the order in which files are tagged. Either order is acceptable as long as the tagging is
+  # consistent for any given ordering.
+  if @switched
+    expected_text.sub!('test_case_2', 'test_case_1')
+    expected_text.sub!('2-1', '1-1')
+    expected_text.sub!('2-2', '1-2')
+  end
+
+  expect(actual_text).to eq(expected_text)
+end

data/features/support/env.rb

@@ -0,0 +1,22 @@
+unless RUBY_VERSION.to_s < '1.9.0'
+  require 'simplecov'
+  SimpleCov.command_name('cuke_cataloger-cucumber')
+end
+
+require 'cuke_cataloger'
+
+
+DEFAULT_FEATURE_FILE_NAME = 'test_feature'
+DEFAULT_FILE_DIRECTORY = "#{File.dirname(__FILE__)}/../temp_files"
+
+
+Before do
+  @default_feature_file_name = DEFAULT_FEATURE_FILE_NAME
+  @default_file_directory = DEFAULT_FILE_DIRECTORY
+
+  FileUtils.mkdir(@default_file_directory)
+end
+
+After do
+  FileUtils.remove_dir(@default_file_directory, true)
+end

data/features/support/transforms.rb

@@ -0,0 +1,3 @@
+Transform /^(-?\d+)$/ do |number|
+  number.to_i
+end