mobiusloop 0.1.2

data/features/docs/formatters/api_methods.feature

@@ -0,0 +1,37 @@
+Feature: Formatter API methods
+
+  Some utility methods are provided to make it easier to write your own formatters.
+
+  Here are some examples.
+
+  Scenario: A formatter that uses `Cucumber::Formatter::Io#ensure_file`
+
+    The ensure_file method is a little helper function that some formatters use,
+    normally when given a CLI argument with `--out` to check that the file passed
+    by the user actually exists.
+
+    The second argument is the name of the formatter, used to print a useful
+    error message if the file can't be created for some reason.
+
+    Given a file named "features/f.feature" with:
+      """
+      Feature: Test
+        Scenario: Test
+      """
+    And a directory named "my/special"
+    And a file named "features/support/custom_formatter.rb" with:
+      """
+      require 'cucumber/formatter/io'
+      module Cucumber
+        module Formatter
+          class Test
+            include Io
+            def initialize(runtime, path_or_io, options)
+              ensure_file("my/special/output.file", "custom formatter")
+            end
+          end
+        end
+      end
+      """
+    When I run `cucumber features/f.feature --format Cucumber::Formatter::Test`
+    Then it should pass

data/features/docs/formatters/debug_formatter.feature

@@ -0,0 +1,47 @@
+Feature: Debug formatter
+
+  In order to help you easily visualise the listener API, you can use
+  the `debug` formatter that prints the calls to the listener as a
+  feature is run.
+
+  Background:
+    Given the standard step definitions
+
+  Scenario: title
+    Given a file named "features/test.feature" with:
+      """
+      Feature:
+        Scenario:
+          Given this step passes
+      """
+    When I run `cucumber -f debug`
+    Then the stderr should not contain anything
+    Then it should pass with:
+      """
+      before_test_case
+      before_features
+      before_feature
+      before_tags
+      after_tags
+      feature_name
+      before_test_step
+      after_test_step
+      before_test_step
+      before_feature_element
+      before_tags
+      after_tags
+      scenario_name
+      before_steps
+      before_step
+      before_step_result
+      step_name
+      after_step_result
+      after_step
+      after_test_step
+      after_steps
+      after_feature_element
+      after_test_case
+      after_feature
+      after_features
+      done
+      """

data/features/docs/formatters/formatter_step_file_colon_line.feature

@@ -0,0 +1,44 @@
+Feature: Formatter API: Step file path and line number (Issue #179)
+  To all reporter to understand location of current executing step let's fetch this information
+  from step/step_invocation and pass to reporters
+
+  Scenario: my own formatter
+    Given a file named "features/f.feature" with:
+      """
+      Feature: I'll use my own
+        because I'm worth it
+        Scenario: just print step current line and feature file name
+          Given step at line 4
+          Given step at line 5
+      """
+    And a file named "features/step_definitions/steps.rb" with:
+      """
+      Given(/^step at line (.*)$/) {|line| }
+      """
+    And a file named "features/support/jb/formatter.rb" with:
+      """
+      module Jb
+        class Formatter
+          def initialize(runtime, io, options)
+            @io = io
+          end
+
+          def before_step_result(keyword, step_match, multiline_arg, status, exception, source_indent, background, file_colon_line)
+            @io.puts "step result event: #{file_colon_line}"
+          end
+
+          def step_name(keyword, step_match, status, source_indent, background, file_colon_line)
+            @io.puts "step name event: #{file_colon_line}"
+          end
+        end
+      end
+      """
+    When I run `cucumber features/f.feature --format Jb::Formatter`
+    Then it should pass with exactly:
+      """
+      step result event: features/f.feature:4
+      step name event: features/f.feature:4
+      step result event: features/f.feature:5
+      step name event: features/f.feature:5
+
+      """

data/features/docs/formatters/html_formatter.feature

@@ -0,0 +1,91 @@
+Feature: HTML output formatter
+
+  Background:
+    Given the standard step definitions
+    And a file named "features/scenario_outline_with_undefined_steps.feature" with:
+      """
+      Feature:
+
+        Scenario Outline:
+          Given this step is undefined
+
+        Examples:
+          |foo|
+          |bar|
+      """
+    And a file named "features/scenario_outline_with_pending_step.feature" with:
+      """
+      Feature: Outline
+
+        Scenario Outline: Will it blend?
+          Given this step is pending
+          And other step
+          When I do something with <example>
+          Then I should see something
+          Examples:
+            | example |
+            | one     |
+            | two     |
+            | three   |
+      """
+    And a file named "features/failing_background_step.feature" with:
+      """
+      Feature: Feature with failing background step
+
+        Background:
+          Given this step fails
+
+        Scenario:
+          When I do something
+          Then I should see something
+      """
+
+  Scenario: an scenario outline, one undefined step, one random example, expand flag on
+    When I run `cucumber features/scenario_outline_with_undefined_steps.feature --format html --expand `
+    Then it should pass
+
+  Scenario Outline: an scenario outline, one pending step
+    When I run `cucumber <file> --format html <flag>`
+    Then it should pass
+    And the output should contain:
+    """
+    makeYellow('scenario_1')
+    """
+    And the output should not contain:
+    """
+    makeRed('scenario_1')
+    """
+
+    Examples:
+      | file                                                   | flag     |
+      | features/scenario_outline_with_pending_step.feature    | --expand |
+      | features/scenario_outline_with_pending_step.feature    |          |
+
+    Examples:
+      | file                                                   | flag     |
+      | features/scenario_outline_with_undefined_steps.feature | --expand |
+      | features/scenario_outline_with_undefined_steps.feature |          |
+
+  Scenario: when using a profile the html shouldn't include 'Using the default profile...'
+    And a file named "cucumber.yml" with:
+    """
+      default: -r features
+    """
+    When I run `cucumber features/scenario_outline_with_undefined_steps.feature --profile default --format html`
+    Then it should pass
+    And the output should not contain:
+    """
+    Using the default profile...
+    """
+
+  Scenario: a feature with a failing background step
+    When I run `cucumber features/failing_background_step.feature --format html`
+    Then the output should not contain:
+    """
+    makeRed('scenario_0')
+    """
+    And the output should contain:
+    """
+    makeRed('background_0')
+    """
+

data/features/docs/formatters/json_formatter.feature

@@ -0,0 +1,767 @@
+Feature: JSON output formatter
+  In order to simplify processing of Cucumber features and results
+  Developers should be able to consume features as JSON
+
+  Background:
+    Given the standard step definitions
+    And a file named "features/one_passing_one_failing.feature" with:
+      """
+      @a
+      Feature: One passing scenario, one failing scenario
+
+        @b
+        Scenario: Passing
+          Given this step passes
+
+        @c
+        Scenario: Failing
+          Given this step fails
+      """
+    And a file named "features/step_definitions/json_steps.rb" with:
+      """
+      Given /^I embed a screenshot/ do
+        File.open("screenshot.png", "w") { |file| file << "foo" }
+        embed "screenshot.png", "image/png"
+      end
+
+      Given /^I print from step definition/ do
+        puts "from step definition"
+      end
+
+      Given /^I embed data directly/ do
+        data = "YWJj"
+        embed data, "mime-type;base64"
+      end
+      """
+    And a file named "features/embed.feature" with:
+      """
+      Feature: A screenshot feature
+
+        Scenario:
+          Given I embed a screenshot
+
+      """
+    And a file named "features/outline.feature" with:
+      """
+      Feature: An outline feature
+
+        Scenario Outline: outline
+          Given this step <status>
+
+          Examples: examples1
+            | status |
+            | passes |
+            | fails  |
+
+          Examples: examples2
+            | status |
+            | passes |
+      """
+    And a file named "features/print_from_step_definition.feature" with:
+      """
+      Feature: A print from step definition feature
+
+        Scenario:
+          Given I print from step definition
+          And I print from step definition
+
+      """
+    And a file named "features/print_from_step_definition.feature" with:
+      """
+      Feature: A print from step definition feature
+
+        Scenario:
+          Given I print from step definition
+          And I print from step definition
+
+      """
+    And a file named "features/embed_data_directly.feature" with:
+      """
+      Feature: An embed data directly feature
+
+        Scenario:
+          Given I embed data directly
+
+        Scenario Outline:
+          Given I embed data directly
+
+	  Examples:
+	  | dummy |
+	  |  1    |
+	  |  2    |
+
+      """
+    And a file named "features/out_scenario_out_scenario_outline.feature" with:
+      """
+      Feature:
+        Scenario:
+          Given this step passes
+        Scenario Outline:
+          Given this step <status>
+          Examples:
+          | status |
+          | passes |
+      """
+
+  # Need to investigate why this won't pass in-process. error_message doesn't get det?
+  @spawn
+  Scenario: one feature, one passing scenario, one failing scenario
+    When I run `cucumber --format json features/one_passing_one_failing.feature`
+    Then it should fail with JSON:
+      """
+      [
+        {
+          "uri": "features/one_passing_one_failing.feature",
+          "keyword": "Feature",
+          "id": "one-passing-scenario,-one-failing-scenario",
+          "name": "One passing scenario, one failing scenario",
+          "line": 2,
+          "description": "",
+          "tags": [
+            {
+              "name": "@a",
+              "line": 1
+            }
+          ],
+          "elements": [
+            {
+              "keyword": "Scenario",
+              "id": "one-passing-scenario,-one-failing-scenario;passing",
+              "name": "Passing",
+              "line": 5,
+              "description": "",
+              "tags": [
+                {
+                  "name": "@a",
+                  "line": 1
+                },
+                {
+                  "name": "@b",
+                  "line": 4
+                }
+              ],
+              "type": "scenario",
+              "steps": [
+                {
+                  "keyword": "Given ",
+                  "name": "this step passes",
+                  "line": 6,
+                  "match": {
+                    "location": "features/step_definitions/steps.rb:1"
+                  },
+                  "result": {
+                    "status": "passed",
+                    "duration": 1
+                  }
+                }
+              ]
+            },
+            {
+              "keyword": "Scenario",
+              "id": "one-passing-scenario,-one-failing-scenario;failing",
+              "name": "Failing",
+              "line": 9,
+              "description": "",
+              "tags": [
+                {
+                  "name": "@a",
+                  "line": 1
+                },
+                {
+                  "name": "@c",
+                  "line": 8
+                }
+              ],
+              "type": "scenario",
+              "steps": [
+                {
+                  "keyword": "Given ",
+                  "name": "this step fails",
+                  "line": 10,
+                  "match": {
+                    "location": "features/step_definitions/steps.rb:4"
+                  },
+                  "result": {
+                    "status": "failed",
+                    "error_message": " (RuntimeError)\n./features/step_definitions/steps.rb:4:in `/^this step fails$/'\nfeatures/one_passing_one_failing.feature:10:in `Given this step fails'",
+                    "duration": 1
+                  }
+                }
+              ]
+            }
+          ]
+        }
+      ]
+
+      """
+
+  @spawn
+  Scenario: one feature, one passing scenario, one failing scenario with prettyfied json
+    When I run `cucumber --format json_pretty features/one_passing_one_failing.feature`
+    Then it should fail with JSON:
+      """
+      [
+        {
+          "uri": "features/one_passing_one_failing.feature",
+          "keyword": "Feature",
+          "id": "one-passing-scenario,-one-failing-scenario",
+          "name": "One passing scenario, one failing scenario",
+          "line": 2,
+          "description": "",
+          "tags": [
+            {
+              "name": "@a",
+              "line": 1
+            }
+          ],
+          "elements": [
+            {
+              "keyword": "Scenario",
+              "id": "one-passing-scenario,-one-failing-scenario;passing",
+              "name": "Passing",
+              "line": 5,
+              "description": "",
+              "tags": [
+                {
+                  "name": "@a",
+                  "line": 1
+                },
+                {
+                  "name": "@b",
+                  "line": 4
+                }
+              ],
+              "type": "scenario",
+              "steps": [
+                {
+                  "keyword": "Given ",
+                  "name": "this step passes",
+                  "line": 6,
+                  "match": {
+                    "location": "features/step_definitions/steps.rb:1"
+                  },
+                  "result": {
+                    "status": "passed",
+                    "duration": 1
+                  }
+                }
+              ]
+            },
+            {
+              "keyword": "Scenario",
+              "id": "one-passing-scenario,-one-failing-scenario;failing",
+              "name": "Failing",
+              "line": 9,
+              "description": "",
+              "tags": [
+                {
+                  "name": "@a",
+                  "line": 1
+                },
+                {
+                  "name": "@c",
+                  "line": 8
+                }
+              ],
+              "type": "scenario",
+              "steps": [
+                {
+                  "keyword": "Given ",
+                  "name": "this step fails",
+                  "line": 10,
+                  "match": {
+                    "location": "features/step_definitions/steps.rb:4"
+                  },
+                  "result": {
+                    "status": "failed",
+                    "error_message": " (RuntimeError)\n./features/step_definitions/steps.rb:4:in `/^this step fails$/'\nfeatures/one_passing_one_failing.feature:10:in `Given this step fails'",
+                    "duration": 1
+                  }
+                }
+              ]
+            }
+          ]
+        }
+      ]
+
+      """
+
+  Scenario: DocString
+    Given a file named "features/doc_string.feature" with:
+      """
+      Feature: A DocString feature
+
+        Scenario:
+          Then I should fail with
+            \"\"\"
+            a string
+            \"\"\"
+      """
+    And a file named "features/step_definitions/steps.rb" with:
+      """
+      Then /I should fail with/ do |s|
+        raise RuntimeError, s
+      end
+      """
+    When I run `cucumber --format json features/doc_string.feature`
+    Then it should fail with JSON:
+      """
+      [
+        {
+          "id": "a-docstring-feature",
+          "uri": "features/doc_string.feature",
+          "keyword": "Feature",
+          "name": "A DocString feature",
+          "line": 1,
+          "description": "",
+          "elements": [
+            {
+              "id": "a-docstring-feature;",
+              "keyword": "Scenario",
+              "name": "",
+              "line": 3,
+              "description": "",
+              "type": "scenario",
+              "steps": [
+                {
+                  "keyword": "Then ",
+                  "name": "I should fail with",
+                  "line": 4,
+                  "doc_string": {
+                    "content_type": "",
+                    "value": "a string",
+                    "line": 5
+                  },
+                  "match": {
+                    "location": "features/step_definitions/steps.rb:1"
+                  },
+                  "result": {
+                    "status": "failed",
+                    "error_message": "a string (RuntimeError)\n./features/step_definitions/steps.rb:2:in `/I should fail with/'\nfeatures/doc_string.feature:4:in `Then I should fail with'",
+                    "duration": 1
+                  }
+                }
+              ]
+            }
+          ]
+        }
+      ]
+      """
+
+  Scenario: embedding screenshot
+    When I run `cucumber --format json features/embed.feature`
+    Then it should pass with JSON:
+    """
+    [
+      {
+        "uri": "features/embed.feature",
+        "id": "a-screenshot-feature",
+        "keyword": "Feature",
+        "name": "A screenshot feature",
+        "line": 1,
+        "description": "",
+        "elements": [
+          {
+            "id": "a-screenshot-feature;",
+            "keyword": "Scenario",
+            "name": "",
+            "line": 3,
+            "description": "",
+            "type": "scenario",
+            "steps": [
+              {
+                "keyword": "Given ",
+                "name": "I embed a screenshot",
+                "line": 4,
+                "embeddings": [
+                  {
+                    "mime_type": "image/png",
+                    "data": "Zm9v"
+                  }
+                ],
+                "match": {
+                  "location": "features/step_definitions/json_steps.rb:1"
+                },
+                "result": {
+                  "status": "passed",
+                  "duration": 1
+                }
+              }
+            ]
+          }
+        ]
+      }
+    ]
+
+    """
+
+  @spawn
+  Scenario: scenario outline
+    When I run `cucumber --format json features/outline.feature`
+    Then it should fail with JSON:
+    """
+    [
+      {
+        "uri": "features/outline.feature",
+        "id": "an-outline-feature",
+        "keyword": "Feature",
+        "name": "An outline feature",
+        "line": 1,
+        "description": "",
+        "elements": [
+          {
+            "id": "an-outline-feature;outline;examples1;2",
+            "keyword": "Scenario Outline",
+            "name": "outline",
+            "description": "",
+            "line": 8,
+            "type": "scenario",
+            "steps": [
+              {
+                "keyword": "Given ",
+                "name": "this step passes",
+                "line": 8,
+                "match": {
+                  "location": "features/step_definitions/steps.rb:1"
+                },
+                "result": {
+                  "status": "passed",
+                  "duration": 1
+                }
+              }
+            ]
+          },
+          {
+            "id": "an-outline-feature;outline;examples1;3",
+            "keyword": "Scenario Outline",
+            "name": "outline",
+            "description": "",
+            "line": 9,
+            "type": "scenario",
+            "steps": [
+              {
+                "keyword": "Given ",
+                "name": "this step fails",
+                "line": 9,
+                "match": {
+                  "location": "features/step_definitions/steps.rb:4"
+                },
+                "result": {
+                  "status": "failed",
+                  "error_message": " (RuntimeError)\n./features/step_definitions/steps.rb:4:in `/^this step fails$/'\nfeatures/outline.feature:9:in `Given this step fails'\nfeatures/outline.feature:4:in `Given this step <status>'",
+                  "duration": 1
+                }
+              }
+            ]
+          },
+          {
+            "id": "an-outline-feature;outline;examples2;2",
+            "keyword": "Scenario Outline",
+            "name": "outline",
+            "description": "",
+            "line": 13,
+            "type": "scenario",
+            "steps": [
+              {
+                "keyword": "Given ",
+                "name": "this step passes",
+                "line": 13,
+                "match": {
+                  "location": "features/step_definitions/steps.rb:1"
+                },
+                "result": {
+                  "status": "passed",
+                  "duration": 1
+                }
+              }
+            ]
+          }
+        ]
+      }
+    ]
+
+    """
+
+  Scenario: print from step definition
+    When I run `cucumber --format json features/print_from_step_definition.feature`
+    Then it should pass with JSON:
+    """
+    [
+      {
+        "uri": "features/print_from_step_definition.feature",
+        "id": "a-print-from-step-definition-feature",
+        "keyword": "Feature",
+        "name": "A print from step definition feature",
+        "line": 1,
+        "description": "",
+        "elements": [
+          {
+            "id": "a-print-from-step-definition-feature;",
+            "keyword": "Scenario",
+            "name": "",
+            "line": 3,
+            "description": "",
+            "type": "scenario",
+            "steps": [
+              {
+                "keyword": "Given ",
+                "name": "I print from step definition",
+                "line": 4,
+                "output": [
+                  "from step definition"
+                ],
+                "match": {
+                  "location": "features/step_definitions/json_steps.rb:6"
+                },
+                "result": {
+                  "status": "passed",
+                  "duration": 1
+                }
+              },
+              {
+                "keyword": "And ",
+                "name": "I print from step definition",
+                "line": 5,
+                "output": [
+                  "from step definition"
+                ],
+                "match": {
+                  "location": "features/step_definitions/json_steps.rb:6"
+                },
+                "result": {
+                  "status": "passed",
+                  "duration": 1
+                }
+              }
+            ]
+          }
+        ]
+      }
+    ]
+
+    """
+
+  @spawn
+  Scenario: scenario outline expanded
+    When I run `cucumber --expand --format json features/outline.feature`
+    Then it should fail with JSON:
+    """
+    [
+      {
+        "uri": "features/outline.feature",
+        "id": "an-outline-feature",
+        "keyword": "Feature",
+        "name": "An outline feature",
+        "line": 1,
+        "description": "",
+        "elements": [
+          {
+            "id": "an-outline-feature;outline;examples1;2",
+            "keyword": "Scenario Outline",
+            "name": "outline",
+            "line": 8,
+            "description": "",
+            "type": "scenario",
+            "steps": [
+              {
+                "keyword": "Given ",
+                "name": "this step passes",
+                "line": 8,
+                "match": {
+                  "location": "features/step_definitions/steps.rb:1"
+                },
+                "result": {
+                  "status": "passed",
+                  "duration": 1
+                }
+              }
+            ]
+          },
+          {
+            "id": "an-outline-feature;outline;examples1;3",
+            "keyword": "Scenario Outline",
+            "name": "outline",
+            "line": 9,
+            "description": "",
+            "type": "scenario",
+            "steps": [
+              {
+                "keyword": "Given ",
+                "name": "this step fails",
+                "line": 9,
+                "match": {
+                  "location": "features/step_definitions/steps.rb:4"
+                },
+                "result": {
+                  "status": "failed",
+                  "error_message" : " (RuntimeError)\n./features/step_definitions/steps.rb:4:in `/^this step fails$/'\nfeatures/outline.feature:9:in `Given this step fails'\nfeatures/outline.feature:4:in `Given this step <status>'",
+		  "duration": 1
+                }
+              }
+            ]
+          },
+          {
+            "id": "an-outline-feature;outline;examples2;2",
+            "keyword": "Scenario Outline",
+            "name": "outline",
+            "line": 13,
+            "description": "",
+            "type": "scenario",
+            "steps": [
+              {
+                "keyword": "Given ",
+                "name": "this step passes",
+                "line": 13,
+                "match": {
+                  "location": "features/step_definitions/steps.rb:1"
+                },
+                "result": {
+                  "status": "passed",
+                  "duration": 1
+                }
+              }
+            ]
+          }
+        ]
+      }
+    ]
+
+    """
+
+  Scenario: embedding data directly
+    When I run `cucumber --format json -x features/embed_data_directly.feature`
+    Then it should pass with JSON:
+    """
+    [
+      {
+        "uri": "features/embed_data_directly.feature",
+        "id": "an-embed-data-directly-feature",
+        "keyword": "Feature",
+        "name": "An embed data directly feature",
+        "line": 1,
+        "description": "",
+        "elements": [
+          {
+            "id": "an-embed-data-directly-feature;",
+            "keyword": "Scenario",
+            "name": "",
+            "line": 3,
+            "description": "",
+            "type": "scenario",
+            "steps": [
+              {
+                "keyword": "Given ",
+                "name": "I embed data directly",
+                "line": 4,
+                "embeddings": [
+                  {
+		    "mime_type": "mime-type",
+		    "data": "YWJj"
+                  }
+                ],
+                "match": {
+                  "location": "features/step_definitions/json_steps.rb:10"
+                },
+                "result": {
+                  "status": "passed",
+                  "duration": 1
+                }
+              }
+            ]
+          },
+          {
+            "keyword": "Scenario Outline",
+            "name": "",
+            "line": 11,
+            "description": "",
+            "id": "an-embed-data-directly-feature;;;2",
+            "type": "scenario",
+            "steps": [
+              {
+                "keyword": "Given ",
+                "name": "I embed data directly",
+                "line": 11,
+                "embeddings": [
+                  {
+                    "mime_type": "mime-type",
+                    "data": "YWJj"
+                  }
+                ],
+                "match": {
+                  "location": "features/step_definitions/json_steps.rb:10"
+                },
+                "result": {
+                  "status": "passed",
+                  "duration": 1
+                }
+              }
+            ]
+          },
+          {
+            "keyword": "Scenario Outline",
+            "name": "",
+            "line": 12,
+            "description": "",
+            "id": "an-embed-data-directly-feature;;;3",
+            "type": "scenario",
+            "steps": [
+              {
+                "keyword": "Given ",
+                "name": "I embed data directly",
+                "line": 12,
+                "embeddings": [
+                  {
+                    "mime_type": "mime-type",
+                    "data": "YWJj"
+                  }
+                ],
+                "match": {
+                  "location": "features/step_definitions/json_steps.rb:10"
+                },
+                "result": {
+                  "status": "passed",
+                  "duration": 1
+                }
+              }
+            ]
+          }
+        ]
+      }
+    ]
+
+    """
+  Scenario: handle output from hooks
+     Given a file named "features/step_definitions/output_steps.rb" with:
+      """
+      Before do
+        puts "Before hook 1"
+        embed "src", "mime_type", "label"
+      end
+
+      Before do
+        puts "Before hook 2"
+        embed "src", "mime_type", "label"
+      end
+
+      AfterStep do
+        puts "AfterStep hook 1"
+        embed "src", "mime_type", "label"
+      end
+
+      AfterStep do
+        puts "AfterStep hook 2"
+        embed "src", "mime_type", "label"
+      end
+
+      After do
+        puts "After hook 1"
+        embed "src", "mime_type", "label"
+      end
+
+      After do
+        puts "After hook 2"
+        embed "src", "mime_type", "label"
+      end
+      """
+    When I run `cucumber --format json features/out_scenario_out_scenario_outline.feature`
+    Then it should pass