cukable 0.1.1

data/bin/cuke2fit

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+
+# Script to convert Cucumber features into FitNesse wiki pages
+
+# Desired behavior:
+#
+# - Recursively search for .feature files in a directory
+# - Create a FitNesse wiki hierarchy that mirrors the .feature hierarchy, with
+#   one wiki page for each .feature file
+# - Fill those wiki pages with a table - essentially just the text of the
+#   .feature file with |...| wrapping each line. Empty lines should be skipped.
+#
+
+require 'cukable/conversion'
+
+if ARGV.count == 0
+  puts "Usage: cuke2fit.rb <features_path> <fitnesse_path>"
+else
+  converter = Cukable::Converter.new
+  messages = converter.features_to_fitnesse(ARGV[0], ARGV[1])
+  messages.each do |message|
+    puts message
+  end
+end
+

data/cukable.gemspec

@@ -0,0 +1,26 @@
+Gem::Specification.new do |s|
+  s.name = "cukable"
+  s.version = "0.1.1"
+  s.summary = "Runs Cucumber tests from FitNesse"
+  s.description = <<-EOS
+    Cukable allows running Cucumber test scenarios from FitNesse
+  EOS
+  s.authors = ["Eric Pierce", "Ken Brazier"]
+  s.email = "wapcaplet88@gmail.com"
+  s.homepage = "http://github.com/wapcaplet/cukable"
+  s.platform = Gem::Platform::RUBY
+
+  s.add_dependency 'json'
+  s.add_dependency 'cucumber'
+  s.add_dependency 'diff-lcs'
+
+  s.add_development_dependency 'rspec', '>= 2.2.0'
+  s.add_development_dependency 'rcov'
+  s.add_development_dependency 'yard'
+  s.add_development_dependency 'bluecloth'
+
+  s.files = `git ls-files`.split("\n")
+  s.require_path = 'lib'
+
+  s.executables = ['cuke2fit']
+end

data/features/conversion.feature

@@ -0,0 +1,54 @@
+Feature: Conversion
+
+  Background:
+    Given a standard Cucumber project directory structure
+    And a FitNesse wiki
+
+  Scenario: Convert features to FitNesse
+    Given a file named "features/passing.feature" with:
+      """
+      Feature: Passing
+        Scenario: Passing
+          Given a step passes
+      """
+    And a file named "features/failing.feature" with:
+      """
+      Feature: Failing
+        Scenario: Failing
+          Given a step fails
+      """
+    When I convert features to FitNesse
+
+    Then I should have a Suite "FeatureS" containing:
+      """
+      These variables must be defined for rubyslim to work:
+      !define TEST_SYSTEM {slim}
+      !define TEST_RUNNER {rubyslim}
+      !define COMMAND_PATTERN {rubyslim}
+
+      Extra command-line arguments to pass to Cucumber:
+      !define CUCUMBER_ARGS {}
+
+      !contents -R9 -p -f -h
+      """
+
+    And I should have a Test "FeatureS/AaaAccelerator" containing:
+      """
+      """
+
+    And I should have a Test "FeatureS/PassingFeature" containing:
+      """
+      !| Table: Cuke |
+      | Feature: Passing |
+      | Scenario: Passing |
+      | Given a step passes |
+      """
+
+    And I should have a Test "FeatureS/FailingFeature" containing:
+      """
+      !| Table: Cuke |
+      | Feature: Failing |
+      | Scenario: Failing |
+      | Given a step fails |
+      """
+

data/features/cuke_fixture.feature

@@ -0,0 +1,147 @@
+Feature: Cuke fixture
+
+  Background:
+    Given a standard Cucumber project directory structure
+
+  Scenario: Do table
+    Given a Cuke fixture
+    When I do this table:
+      | Feature: Table |
+      | Scenario: Table |
+
+    Then "slim_results/features/fitnesse/fitnesse_test.feature.json" should contain JSON:
+      """
+      [
+        ["report:Feature: Table"],
+        ["report:Scenario: Table"]
+      ]
+      """
+
+  Scenario: Write features
+    Given a Cuke fixture
+    And a FitNesse wiki
+    And a FitNesse suite "TestSuite" with:
+      """
+      !contents
+      """
+    And a FitNesse test "TestSuite/HelloWorld" with:
+      """
+      | Table: Cuke |
+      | Feature: Hello |
+      | Scenario: Hello |
+      """
+    And a FitNesse test "TestSuite/GoodbyeWorld" with:
+      """
+      | Table: Cuke |
+      | Feature: Goodbye |
+      | Scenario: Goodbye |
+      """
+    When I write features for suite "TestSuite"
+
+    Then "features/fitnesse/HelloWorld_0.feature" should contain:
+      """
+      Feature: Hello
+      Scenario: Hello
+      """
+    And "features/fitnesse/GoodbyeWorld_0.feature" should contain:
+      """
+      Feature: Goodbye
+      Scenario: Goodbye
+      """
+
+
+  Scenario: Accelerate suite
+    Given a FitNesse wiki
+    And a Cuke fixture
+    And a Suite "FeatureS" containing:
+      """
+      !define TEST_SYSTEM {slim}
+      !define TEST_RUNNER {rubyslim}
+      !define COMMAND_PATTERN {rubyslim}
+      !define CUCUMBER_ARGS {}
+      """
+
+    And a Test "FeatureS/AaaAccelerator" containing:
+      """
+      """
+
+    And a Test "FeatureS/PassingFeature" containing:
+      """
+      !| Table: Cuke |
+      | Feature: Passing |
+      | Scenario: Passing |
+      | Given a step passes |
+      """
+
+    And a Test "FeatureS/FailingFeature" containing:
+      """
+      !| Table: Cuke |
+      | Feature: Failing |
+      | Scenario: Failing |
+      | Given a step fails |
+      """
+
+    When I run the accelerator for suite "FeatureS"
+
+    Then "slim_results/features/fitnesse/PassingFeature_0.feature.json" should contain JSON:
+      """
+      [
+        ["report:Feature: Passing"],
+        ["report:Scenario: Passing"],
+        ["error:Given a step passes"]
+      ]
+      """
+
+    And "slim_results/features/fitnesse/FailingFeature_0.feature.json" should contain JSON:
+      """
+      [
+        ["report:Feature: Failing"],
+        ["report:Scenario: Failing"],
+        ["error:Given a step fails"]
+      ]
+      """
+
+
+  @wip
+  Scenario: Accelerate suite with skipped tags
+    # FIXME: Fails when run with other scenarios. Lack of init/cleanup in self_test dir?
+    Given a FitNesse wiki
+    And a Cuke fixture
+
+    And a Test "FeatureS/SkippedScenariosFeature" containing:
+      """
+      !| Table: Cuke |
+      | Feature: Passing |
+      | @skip |
+      | Scenario: Skipped scenario |
+      | Given a step passes |
+      | Scenario: Passing |
+      | Given a step passes |
+      | @skip |
+      | Scenario: Another skipped scenario |
+      | Given a step passes |
+      """
+
+    And a Test "FeatureS/SkippedFeature" containing:
+      """
+      !| Table: Cuke |
+      | @skip |
+      | Feature: Skipped feature |
+      | Scenario: Failing |
+      | Given a step fails |
+      """
+
+    When I set CUCUMBER_ARGS to "--tags ~@skip"
+    And I run the accelerator for suite "FeatureS"
+
+    Then "slim_results/features/fitnesse/SkippedScenariosFeature_0.feature.json" should contain JSON:
+      """
+      [
+        ["report:Feature: Passing"],
+        ["report:Scenario: Passing"],
+        ["error:Given a step passes"]
+      ]
+      """
+
+    And "slim_results/features/fitnesse/SkippedFeature_0.feature.json" should not exist
+

data/features/slim_json_formatter.feature

@@ -0,0 +1,153 @@
+@wip
+Feature: Slim JSON Formatter
+
+  Background:
+    Given a standard Cucumber project directory structure
+
+
+  Scenario: Passing step
+    Given a file named "features/passing.feature" with:
+      """
+      Feature: Passing
+        Scenario: Passing
+          Given a step passes
+      """
+    When I run cucumber on "features/passing.feature"
+    Then "slim_results/features/passing.feature.json" should contain JSON:
+      """
+        [
+          ["report:Feature: Passing"],
+          ["report:Scenario: Passing"],
+          ["pass:Given a step passes"]
+        ]
+      """
+
+
+  Scenario: Failing step
+    Given a file named "features/failing.feature" with:
+      """
+      Feature: Failing
+        Scenario: Failing
+          Given a step fails
+      """
+    When I run cucumber on "features/failing.feature"
+    Then "slim_results/features/failing.feature.json" should contain JSON:
+      """
+        [
+          ["report:Feature: Failing"],
+          ["report:Scenario: Failing"],
+          ["fail:Given a step fails"]
+        ]
+      """
+
+
+  Scenario: Undefined step
+    Given a file named "features/undefined.feature" with:
+      """
+      Feature: Undefined
+        Scenario: Undefined
+          Given a step is undefined
+      """
+    When I run cucumber on "features/undefined.feature"
+    Then "slim_results/features/undefined.feature.json" should contain JSON:
+      """
+        [
+          ["report:Feature: Undefined"],
+          ["report:Scenario: Undefined"],
+          ["error:Given a step is undefined"]
+        ]
+      """
+
+
+  Scenario: Skipped step
+    Given a file named "features/skipped.feature" with:
+      """
+      Feature: Skipped
+        Scenario: Skipped
+          When a step fails
+          Then a step is skipped
+      """
+    When I run cucumber on "features/skipped.feature"
+    Then "slim_results/features/skipped.feature.json" should contain JSON:
+      """
+        [
+          ["report:Feature: Skipped"],
+          ["report:Scenario: Skipped"],
+          ["fail:When a step fails"],
+          ["ignore:Then a step is skipped"]
+        ]
+      """
+
+
+  Scenario: Passing table
+    Given a file named "features/passing_table.feature" with:
+      """
+      Feature: Passing table
+        Scenario: Passing table
+          When I have a table:
+            | OK | OK | OK |
+            | OK | OK | OK |
+      """
+    When I run cucumber on "features/passing_table.feature"
+    Then "slim_results/features/passing_table.feature.json" should contain JSON:
+      """
+        [
+          ["report:Feature: Passing table"],
+          ["report:Scenario: Passing table"],
+          ["pass:When I have a table:"],
+          ["report: ", "pass:OK", "pass:OK", "pass:OK"],
+          ["report: ", "pass:OK", "pass:OK", "pass:OK"]
+        ]
+      """
+
+
+  Scenario: Failing table
+    Given a file named "features/failing_table.feature" with:
+      """
+      Feature: Failing table
+        Scenario: Failing table
+          When I have a table:
+            | OK | OK   | OK |
+            | OK | FAIL | OK |
+      """
+    When I run cucumber on "features/failing_table.feature"
+    Then "slim_results/features/failing_table.feature.json" should contain JSON:
+      # FIXME: The table rows should probably not be marked 'pass' here!
+      """
+        [
+          ["report:Feature: Failing table"],
+          ["report:Scenario: Failing table"],
+          ["fail:When I have a table:"],
+          ["report: ", "pass:OK", "pass:OK", "pass:OK"],
+          ["report: ", "pass:OK", "pass:FAIL", "pass:OK"]
+        ]
+      """
+
+
+  Scenario: Scenario Outline
+    Given a file named "features/scenario_outline.feature" with:
+      """
+      Feature: Failing table
+        Scenario Outline: Outline
+          Given a step <result>
+
+          Examples:
+            | result |
+            | passes |
+            | fails |
+      """
+    When I run cucumber on "features/scenario_outline.feature"
+    Then "slim_results/features/scenario_outline.feature.json" should contain JSON:
+      """
+        [
+          ["report:Feature: Failing table"],
+          ["report:Scenario Outline: Outline"],
+          ["ignore:Given a step &lt;result&gt;"],
+          ["report:Examples: "],
+          ["report: ", "pass:result"],
+          ["report: ", "pass:passes"],
+          ["report: ", "fail:fails"],
+          ["fail:<br/>"]
+        ]
+      """
+

data/features/step_definitions/cukable_steps.rb

@@ -0,0 +1,115 @@
+# Steps for Cukable self-tests
+# NOTE: Helper methods are defined in features/support/env.rb
+
+require 'json'
+require 'cukable/cuke'
+
+
+Given /^a standard Cucumber project directory structure$/ do
+  create_standard_cucumber_dir
+end
+
+
+Given /^a FitNesse wiki$/ do
+  create_standard_fitnesse_dir
+  @fitnesse_root = 'FitNesseRoot'
+end
+
+
+Given /^a FitNesse suite "(.+)" with:$/ do |page_name, content|
+  create_fitnesse_page(page_name, content)
+end
+
+
+Given /^a FitNesse test "(.+)" with:$/ do |page_name, content|
+  create_fitnesse_page(page_name, content)
+end
+
+
+Given /^a file named "(.+)" with:$/ do |filename, content|
+  create_file(filename, content)
+end
+
+
+When /^I run cucumber on "(.+)"$/ do |feature_files|
+  format = "--format Cucumber::Formatter::SlimJSON --out slim_results"
+  run_cucumber("#{format} #{feature_files}")
+end
+
+
+Then /^"(.+)" should contain:$/ do |filename, text|
+  file_should_contain(filename, text)
+end
+
+
+Then /^"(.+)" should contain JSON:$/ do |filename, json_text|
+  file_should_contain_json(filename, json_text)
+end
+
+
+Then /^"(.+)" should not exist$/ do |filename|
+  in_test_dir do
+    if File.exist?(filename)
+      raise Exception, "Expected #{filename} to be non-existent, but it exists"
+    end
+  end
+end
+
+
+Given /^a (Test|Suite) "(.+)" containing:$/ do |type, filename, content|
+  content_file = File.join(@fitnesse_root, filename, 'content.txt')
+  properties_file = File.join(@fitnesse_root, filename, 'properties.xml')
+  create_file(content_file, content)
+  create_file(properties_file, xml_content(type))
+end
+
+
+Then /^I should have a (Test|Suite) "(.+)" containing:$/ do |type, filename, content|
+  content_file = File.join(@fitnesse_root, filename, 'content.txt')
+  properties_file = File.join(@fitnesse_root, filename, 'properties.xml')
+  file_should_contain(content_file, content)
+  file_should_contain(properties_file, xml_content(type))
+end
+
+
+Given /^a Cuke fixture$/ do
+  in_test_dir do
+    @cuke = Cukable::Cuke.new
+    @cucumber_args = ''
+  end
+end
+
+
+When /^I do this table:$/ do |table|
+  in_test_dir do
+    @table = @cuke.do_table(table.raw)
+  end
+end
+
+
+When /^I write features for suite "(.+)"$/ do |suite_name|
+  in_test_dir do
+    @cuke.write_suite_features("FitNesseRoot/#{suite_name}")
+  end
+end
+
+
+When /^I convert features to FitNesse$/ do
+  in_test_dir do
+    @converter = Cukable::Converter.new
+    @converter.features_to_fitnesse('features', @fitnesse_root)
+  end
+end
+
+
+When /^I set CUCUMBER_ARGS to "(.+)"$/ do |args|
+  @cucumber_args = args
+end
+
+
+When /^I run the accelerator for suite "(.+)"$/ do |suite_name|
+  in_test_dir do
+    @cuke.accelerate("#{suite_name}.AaaAccelerator", @cucumber_args)
+  end
+end
+