cucumber-compatibility-kit 13.0.0 → 13.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a77442c57282b3287863433f7406e85d334313b8f32a7ebfc2ae4794665cd7d
-  data.tar.gz: b9f629e52616779c3923bdee2dc1cdcdc6074708c04db4dcd3317b458b416113
+  metadata.gz: 571624730f6e04d4737391f34e4a8e04001a98d8ea71972b300393d8a3dc24a9
+  data.tar.gz: 98687934c3fe1a37a637696b8f362b34882479e4b6cad8630cb04309ffb61f8e
 SHA512:
-  metadata.gz: f11fd7556d7d94b758f1802c6a0b93b3e568c3e92b087c151269bb3a2a561a2de3a6d0c7530694945c40692573a8f2c3ff12d6ad2f130ec8be422e16d952eafe
-  data.tar.gz: 1b41eb113047d8a38ca077e4ce982dd49450c04a32d3dd043c7ff3ad1e0fb0bc04980fc635be9acd16d5c7986fe6677262da645293f0cbfd43cd989d63d36053
+  metadata.gz: 6faeb789cf47ac895fcd460fad7d2fff99652e3235b5d45a8d15c283acbd3bcdc35676f51ea2d414804c5822f97c17329653fb398b492b9afbb360731bd72932
+  data.tar.gz: fe388e4219711ecf17eefe17eda1085f8b742b48dc194208704880169f8490b25f7031b2e97f660c5dd7df55cf8174df65835cf62e9e35446c6f90461934304f

data/features/attachments/attachments.feature.rb

@@ -3,55 +3,44 @@
 require 'stringio'
 
 # Cucumber-JVM needs to use a Before hook in order to create attachments
-Before do
-  # no-op
-end
-
-def attach_or_embed(world, data, media_type, filename = nil)
-  # Backward compatibility as the steps are also used by cucumber-ruby 3 which does not support `attach`
-  world.respond_to?(:attach) ? attach(data, media_type, filename) : embed(data, media_type)
-end
+Before { nil }
 
 When('the string {string} is attached as {string}') do |text, media_type|
-  attach_or_embed(self, text, media_type)
+  attach(text, media_type)
 end
 
 When('the string {string} is logged') do |text|
-  # Backward compatibility
-  self.respond_to?(:log) ? log(text) : puts(text)
-end
-
-When('the following string is attached as {string}:') do |media_type, doc_string|
-  attach_or_embed(self, doc_string, media_type)
+  log(text)
 end
 
 When('text with ANSI escapes is logged') do
-  text = "This displays a \x1b[31mr\x1b[0m\x1b[91ma\x1b[0m\x1b[33mi\x1b[0m\x1b[32mn\x1b[0m\x1b[34mb\x1b[0m\x1b[95mo\x1b[0m\x1b[35mw\x1b[0m"
+  log("This displays a \x1b[31mr\x1b[0m\x1b[91ma\x1b[0m\x1b[33mi\x1b[0m\x1b[32mn\x1b[0m\x1b[34mb\x1b[0m\x1b[95mo\x1b[0m\x1b[35mw\x1b[0m")
+end
 
-  self.respond_to?(:log) ? log(text) : puts(text)
+When('the following string is attached as {string}:') do |media_type, doc_string|
+  attach(doc_string, media_type)
 end
 
 When('an array with {int} bytes is attached as {string}') do |size, media_type|
-  data = (0..size-1).map {|i| [i].pack('C') }.join
-  attach_or_embed(self, data, media_type)
+  data = (0..size-1).map { |i| [i].pack('C') }.join
+  attach(data, media_type)
 end
 
 When('a stream with {int} bytes are attached as {string}') do |size, media_type|
   stream = StringIO.new
   stream.puts (0..size).map(&:to_s).join('')
   stream.seek(0)
-
-  attach_or_embed(self, stream, media_type)
+  attach(stream, media_type)
 end
 
 When('a JPEG image is attached') do
-  attach_or_embed(self, File.open("#{__dir__}/cucumber.jpeg"), 'image/jpeg')
+  attach(File.open("#{__dir__}/cucumber.jpeg"), 'image/jpeg')
 end
 
 When('the {word} png is attached') do |filename|
-  attach_or_embed(self, File.open("#{__dir__}/#{filename}"), 'image/png')
+  attach(File.open("#{__dir__}/#{filename}"), 'image/png')
 end
 
 When('a PDF document is attached and renamed') do
-  attach_or_embed(self, File.open("#{__dir__}/document.pdf"), 'document/pdf', 'renamed.pdf')
+  attach(File.open("#{__dir__}/document.pdf"), 'document/pdf', 'renamed.pdf')
 end

data/features/hooks/hooks.feature.rb

@@ -1,10 +1,5 @@
 # frozen_string_literal: true
 
-def attach_or_embed(world, data, media_type)
-  # Backward compatibility as the steps are also used by cucumber-ruby 3 which does not support `attach`
-  world.respond_to?(:attach) ? attach(data, media_type) : embed(data, media_type)
-end
-
 Before do
   # no-op
 end
@@ -30,5 +25,5 @@ After('@some-tag or @some-other-tag') do
 end
 
 After('@with-attachment') do
-  attach_or_embed(self, File.open("#{__dir__}/cucumber.svg"), 'image/svg+xml')
+  attach(File.open("#{__dir__}/cucumber.svg"), 'image/svg+xml')
 end

data/features/skipped/skipped.feature

@@ -1,19 +1,19 @@
 Feature: Skipping scenarios
 
   Hooks and step definitions are able to signal at runtime that the scenario should
-  be skipped by returning or throwing a particular value.
+  be skipped by raising a particular kind of exception status (For example PENDING or SKIPPED).
 
-  This can be useful when e.g. the current environment doesn't have the right conditions
-  for running the scenario.
+  This can be useful in certain situations e.g. the current environment doesn't have
+  the right conditions for running a particular scenario.
 
   @skip
   Scenario: Skipping from a Before hook
-    Given a step that we expect to be skipped
+    Given a step that is skipped
 
   Scenario: Skipping from a step doesn't affect the previous steps
-    Given an implemented step
-    When a step that skips
+    Given a step that does not skip
+    And I skip a step
 
   Scenario: Skipping from a step causes the rest of the scenario to be skipped
-    Given a step that skips
-    When a step that we expect to be skipped
+    Given I skip a step
+    And a step that is skipped

data/features/skipped/skipped.feature.ndjson

@@ -1,12 +1,12 @@
 {"meta":{"ci":{"buildNumber":"154666429","git":{"remote":"https://github.com/cucumber-ltd/shouty.rb.git","revision":"99684bcacf01d95875834d87903dcb072306c9ad"},"name":"GitHub Actions","url":"https://github.com/cucumber-ltd/shouty.rb/actions/runs/154666429"},"cpu":{"name":"x64"},"implementation":{"name":"fake-cucumber","version":"16.3.0"},"os":{"name":"linux","version":"5.15.0-84-generic"},"protocolVersion":"22.0.0","runtime":{"name":"node.js","version":"18.18.0"}}}
-{"source":{"data":"Feature: Skipping scenarios\n\n  Hooks and step definitions are able to signal at runtime that the scenario should\n  be skipped by returning or throwing a particular value.\n\n  This can be useful when e.g. the current environment doesn't have the right conditions\n  for running the scenario.\n\n  @skip\n  Scenario: Skipping from a Before hook\n    Given a step that we expect to be skipped\n\n  Scenario: Skipping from a step doesn't affect the previous steps\n    Given an implemented step\n    When a step that skips\n\n  Scenario: Skipping from a step causes the rest of the scenario to be skipped\n    Given a step that skips\n    When a step that we expect to be skipped\n","mediaType":"text/x.cucumber.gherkin+plain","uri":"samples/skipped/skipped.feature"}}
-{"gherkinDocument":{"comments":[],"feature":{"children":[{"scenario":{"description":"","examples":[],"id":"6","keyword":"Scenario","location":{"column":3,"line":10},"name":"Skipping from a Before hook","steps":[{"id":"4","keyword":"Given ","keywordType":"Context","location":{"column":5,"line":11},"text":"a step that we expect to be skipped"}],"tags":[{"id":"5","location":{"column":3,"line":9},"name":"@skip"}]}},{"scenario":{"description":"","examples":[],"id":"9","keyword":"Scenario","location":{"column":3,"line":13},"name":"Skipping from a step doesn't affect the previous steps","steps":[{"id":"7","keyword":"Given ","keywordType":"Context","location":{"column":5,"line":14},"text":"an implemented step"},{"id":"8","keyword":"When ","keywordType":"Action","location":{"column":5,"line":15},"text":"a step that skips"}],"tags":[]}},{"scenario":{"description":"","examples":[],"id":"12","keyword":"Scenario","location":{"column":3,"line":17},"name":"Skipping from a step causes the rest of the scenario to be skipped","steps":[{"id":"10","keyword":"Given ","keywordType":"Context","location":{"column":5,"line":18},"text":"a step that skips"},{"id":"11","keyword":"When ","keywordType":"Action","location":{"column":5,"line":19},"text":"a step that we expect to be skipped"}],"tags":[]}}],"description":"  Hooks and step definitions are able to signal at runtime that the scenario should\n  be skipped by returning or throwing a particular value.\n\n  This can be useful when e.g. the current environment doesn't have the right conditions\n  for running the scenario.","keyword":"Feature","language":"en","location":{"column":1,"line":1},"name":"Skipping scenarios","tags":[]},"uri":"samples/skipped/skipped.feature"}}
-{"pickle":{"astNodeIds":["6"],"id":"14","language":"en","name":"Skipping from a Before hook","steps":[{"astNodeIds":["4"],"id":"13","text":"a step that we expect to be skipped","type":"Context"}],"tags":[{"astNodeId":"5","name":"@skip"}],"uri":"samples/skipped/skipped.feature"}}
-{"pickle":{"astNodeIds":["9"],"id":"17","language":"en","name":"Skipping from a step doesn't affect the previous steps","steps":[{"astNodeIds":["7"],"id":"15","text":"an implemented step","type":"Context"},{"astNodeIds":["8"],"id":"16","text":"a step that skips","type":"Action"}],"tags":[],"uri":"samples/skipped/skipped.feature"}}
-{"pickle":{"astNodeIds":["12"],"id":"20","language":"en","name":"Skipping from a step causes the rest of the scenario to be skipped","steps":[{"astNodeIds":["10"],"id":"18","text":"a step that skips","type":"Context"},{"astNodeIds":["11"],"id":"19","text":"a step that we expect to be skipped","type":"Action"}],"tags":[],"uri":"samples/skipped/skipped.feature"}}
-{"stepDefinition":{"id":"1","pattern":{"source":"an implemented step","type":"CUCUMBER_EXPRESSION"},"sourceReference":{"location":{"line":7},"uri":"samples/skipped/skipped.feature.ts"}}}
-{"stepDefinition":{"id":"2","pattern":{"source":"a step that we expect to be skipped","type":"CUCUMBER_EXPRESSION"},"sourceReference":{"location":{"line":11},"uri":"samples/skipped/skipped.feature.ts"}}}
-{"stepDefinition":{"id":"3","pattern":{"source":"a step that skips","type":"CUCUMBER_EXPRESSION"},"sourceReference":{"location":{"line":15},"uri":"samples/skipped/skipped.feature.ts"}}}
+{"source":{"data":"Feature: Skipping scenarios\n\n  Hooks and step definitions are able to signal at runtime that the scenario should\n  be skipped by raising a particular kind of exception status (For example PENDING or SKIPPED).\n\n  This can be useful in certain situations e.g. the current environment doesn't have\n  the right conditions for running a particular scenario.\n\n  @skip\n  Scenario: Skipping from a Before hook\n    Given a step that is skipped\n\n  Scenario: Skipping from a step doesn't affect the previous steps\n    Given a step that does not skip\n    And I skip a step\n\n  Scenario: Skipping from a step causes the rest of the scenario to be skipped\n    Given I skip a step\n    And a step that is skipped\n","mediaType":"text/x.cucumber.gherkin+plain","uri":"samples/skipped/skipped.feature"}}
+{"gherkinDocument":{"comments":[],"feature":{"children":[{"scenario":{"description":"","examples":[],"id":"6","keyword":"Scenario","location":{"column":3,"line":10},"name":"Skipping from a Before hook","steps":[{"id":"4","keyword":"Given ","keywordType":"Context","location":{"column":5,"line":11},"text":"a step that is skipped"}],"tags":[{"id":"5","location":{"column":3,"line":9},"name":"@skip"}]}},{"scenario":{"description":"","examples":[],"id":"9","keyword":"Scenario","location":{"column":3,"line":13},"name":"Skipping from a step doesn't affect the previous steps","steps":[{"id":"7","keyword":"Given ","keywordType":"Context","location":{"column":5,"line":14},"text":"a step that does not skip"},{"id":"8","keyword":"And ","keywordType":"Conjunction","location":{"column":5,"line":15},"text":"I skip a step"}],"tags":[]}},{"scenario":{"description":"","examples":[],"id":"12","keyword":"Scenario","location":{"column":3,"line":17},"name":"Skipping from a step causes the rest of the scenario to be skipped","steps":[{"id":"10","keyword":"Given ","keywordType":"Context","location":{"column":5,"line":18},"text":"I skip a step"},{"id":"11","keyword":"And ","keywordType":"Conjunction","location":{"column":5,"line":19},"text":"a step that is skipped"}],"tags":[]}}],"description":"  Hooks and step definitions are able to signal at runtime that the scenario should\n  be skipped by raising a particular kind of exception status (For example PENDING or SKIPPED).\n\n  This can be useful in certain situations e.g. the current environment doesn't have\n  the right conditions for running a particular scenario.","keyword":"Feature","language":"en","location":{"column":1,"line":1},"name":"Skipping scenarios","tags":[]},"uri":"samples/skipped/skipped.feature"}}
+{"pickle":{"astNodeIds":["6"],"id":"14","language":"en","name":"Skipping from a Before hook","steps":[{"astNodeIds":["4"],"id":"13","text":"a step that is skipped","type":"Context"}],"tags":[{"astNodeId":"5","name":"@skip"}],"uri":"samples/skipped/skipped.feature"}}
+{"pickle":{"astNodeIds":["9"],"id":"17","language":"en","name":"Skipping from a step doesn't affect the previous steps","steps":[{"astNodeIds":["7"],"id":"15","text":"a step that does not skip","type":"Context"},{"astNodeIds":["8"],"id":"16","text":"I skip a step","type":"Context"}],"tags":[],"uri":"samples/skipped/skipped.feature"}}
+{"pickle":{"astNodeIds":["12"],"id":"20","language":"en","name":"Skipping from a step causes the rest of the scenario to be skipped","steps":[{"astNodeIds":["10"],"id":"18","text":"I skip a step","type":"Context"},{"astNodeIds":["11"],"id":"19","text":"a step that is skipped","type":"Context"}],"tags":[],"uri":"samples/skipped/skipped.feature"}}
+{"stepDefinition":{"id":"1","pattern":{"source":"a step that does not skip","type":"CUCUMBER_EXPRESSION"},"sourceReference":{"location":{"line":7},"uri":"samples/skipped/skipped.feature.ts"}}}
+{"stepDefinition":{"id":"2","pattern":{"source":"a step that is skipped","type":"CUCUMBER_EXPRESSION"},"sourceReference":{"location":{"line":11},"uri":"samples/skipped/skipped.feature.ts"}}}
+{"stepDefinition":{"id":"3","pattern":{"source":"I skip a step","type":"CUCUMBER_EXPRESSION"},"sourceReference":{"location":{"line":15},"uri":"samples/skipped/skipped.feature.ts"}}}
 {"hook":{"id":"0","sourceReference":{"location":{"line":3},"uri":"samples/skipped/skipped.feature.ts"},"tagExpression":"@skip"}}
 {"testRunStarted":{"timestamp":{"nanos":0,"seconds":0}}}
 {"testCase":{"id":"23","pickleId":"14","testSteps":[{"hookId":"0","id":"21"},{"id":"22","pickleStepId":"13","stepDefinitionIds":["2"],"stepMatchArgumentsLists":[{"stepMatchArguments":[]}]}]}}

data/features/skipped/skipped.feature.rb

@@ -1,17 +1,17 @@
 # frozen_string_literal: true
 
 Before('@skip') do
-  'skipped'
+  skip_this_scenario('')
 end
 
-Given('an implemented step') do
+Given('a step that does not skip') do
   # no-op
 end
 
-Given('a step that we expect to be skipped') do
+Given('a step that is skipped') do
   # no-op
 end
 
-Given('a step that skips') do
-  'skipped'
+Given('I skip a step') do
+  skip_this_scenario('')
 end

data/features/stack-traces/stack-traces.feature

@@ -1,11 +1,9 @@
 Feature: Stack traces
-  Nothing beats stack traces when it comes to diagnosing the source of a bug.
-  Cucumber provides helpful stack traces that:
-  
-  - Include a stack frame from the Gherkin document
-  - Remove uninteresting frames by default
+  Stack traces can help you diagnose the source of a bug.
+  Cucumber provides helpful stack traces that includes the stack frames from the
+  Gherkin document and remove uninteresting frames by default
 
-  The first line of the stack trace must contain the feature file.
+  The first line of the stack trace will contain a reference to the feature file.
 
   Scenario: A failing step
     When a step throws an exception

data/features/stack-traces/stack-traces.feature.ndjson

@@ -1,12 +1,12 @@
 {"meta":{"ci":{"buildNumber":"154666429","git":{"remote":"https://github.com/cucumber-ltd/shouty.rb.git","revision":"99684bcacf01d95875834d87903dcb072306c9ad"},"name":"GitHub Actions","url":"https://github.com/cucumber-ltd/shouty.rb/actions/runs/154666429"},"cpu":{"name":"x64"},"implementation":{"name":"fake-cucumber","version":"16.3.0"},"os":{"name":"linux","version":"5.15.0-84-generic"},"protocolVersion":"22.0.0","runtime":{"name":"node.js","version":"18.18.0"}}}
-{"source":{"data":"Feature: Stack traces\n  Nothing beats stack traces when it comes to diagnosing the source of a bug.\n  Cucumber provides helpful stack traces that:\n  \n  - Include a stack frame from the Gherkin document\n  - Remove uninteresting frames by default\n\n  The first line of the stack trace must contain the feature file.\n\n  Scenario: A failing step\n    When a step throws an exception\n","mediaType":"text/x.cucumber.gherkin+plain","uri":"samples/stack-traces/stack-traces.feature"}}
-{"gherkinDocument":{"comments":[],"feature":{"children":[{"scenario":{"description":"","examples":[],"id":"2","keyword":"Scenario","location":{"column":3,"line":10},"name":"A failing step","steps":[{"id":"1","keyword":"When ","keywordType":"Action","location":{"column":5,"line":11},"text":"a step throws an exception"}],"tags":[]}}],"description":"  Nothing beats stack traces when it comes to diagnosing the source of a bug.\n  Cucumber provides helpful stack traces that:\n  \n  - Include a stack frame from the Gherkin document\n  - Remove uninteresting frames by default\n\n  The first line of the stack trace must contain the feature file.","keyword":"Feature","language":"en","location":{"column":1,"line":1},"name":"Stack traces","tags":[]},"uri":"samples/stack-traces/stack-traces.feature"}}
+{"source":{"data":"Feature: Stack traces\n  Stack traces can help you diagnose the source of a bug.\n  Cucumber provides helpful stack traces that includes the stack frames from the\n  Gherkin document and remove uninteresting frames by default\n\n  The first line of the stack trace will contain a reference to the feature file.\n\n  Scenario: A failing step\n    When a step throws an exception\n","mediaType":"text/x.cucumber.gherkin+plain","uri":"samples/stack-traces/stack-traces.feature"}}
+{"gherkinDocument":{"comments":[],"feature":{"children":[{"scenario":{"description":"","examples":[],"id":"2","keyword":"Scenario","location":{"column":3,"line":8},"name":"A failing step","steps":[{"id":"1","keyword":"When ","keywordType":"Action","location":{"column":5,"line":9},"text":"a step throws an exception"}],"tags":[]}}],"description":"  Stack traces can help you diagnose the source of a bug.\n  Cucumber provides helpful stack traces that includes the stack frames from the\n  Gherkin document and remove uninteresting frames by default\n\n  The first line of the stack trace will contain a reference to the feature file.","keyword":"Feature","language":"en","location":{"column":1,"line":1},"name":"Stack traces","tags":[]},"uri":"samples/stack-traces/stack-traces.feature"}}
 {"pickle":{"astNodeIds":["2"],"id":"4","language":"en","name":"A failing step","steps":[{"astNodeIds":["1"],"id":"3","text":"a step throws an exception","type":"Action"}],"tags":[],"uri":"samples/stack-traces/stack-traces.feature"}}
 {"stepDefinition":{"id":"0","pattern":{"source":"a step throws an exception","type":"CUCUMBER_EXPRESSION"},"sourceReference":{"location":{"line":3},"uri":"samples/stack-traces/stack-traces.feature.ts"}}}
 {"testRunStarted":{"timestamp":{"nanos":0,"seconds":0}}}
 {"testCase":{"id":"6","pickleId":"4","testSteps":[{"id":"5","pickleStepId":"3","stepDefinitionIds":["0"],"stepMatchArgumentsLists":[{"stepMatchArguments":[]}]}]}}
 {"testCaseStarted":{"attempt":0,"id":"7","testCaseId":"6","timestamp":{"nanos":1000000,"seconds":0}}}
 {"testStepStarted":{"testCaseStartedId":"7","testStepId":"5","timestamp":{"nanos":2000000,"seconds":0}}}
-{"testStepFinished":{"testCaseStartedId":"7","testStepId":"5","testStepResult":{"duration":{"nanos":1000000,"seconds":0},"exception":{"message":"BOOM","type":"Error"},"message":"BOOM\nsamples/stack-traces/stack-traces.feature:11","status":"FAILED"},"timestamp":{"nanos":3000000,"seconds":0}}}
+{"testStepFinished":{"testCaseStartedId":"7","testStepId":"5","testStepResult":{"duration":{"nanos":1000000,"seconds":0},"exception":{"message":"BOOM","type":"Error"},"message":"BOOM\nsamples/stack-traces/stack-traces.feature:9","status":"FAILED"},"timestamp":{"nanos":3000000,"seconds":0}}}
 {"testCaseFinished":{"testCaseStartedId":"7","timestamp":{"nanos":4000000,"seconds":0},"willBeRetried":false}}
 {"testRunFinished":{"success":false,"timestamp":{"nanos":5000000,"seconds":0}}}

data/features/stack-traces/stack-traces.feature.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 When('a step throws an exception') do
-  raise StandardError, 'An exception is raised here'
+  raise 'BOOM'
 end

data/features/undefined/undefined.feature

@@ -1,17 +1,16 @@
 Feature: Undefined steps
 
   At runtime, Cucumber may encounter a step in a scenario that it cannot match to a
-  step definition. In these cases, the scenario cannot run and so the step status
-  will be UNDEFINED, with subsequent steps being skipped and the overall result treated
-  as a failure.
+  step definition. In these cases, the scenario is not able to run and so the step status
+  will be UNDEFINED, with subsequent steps being SKIPPED and the overall result will be FAILURE
 
-  Scenario: Undefined step causes failure
-    Given a step that isnt implemented yet
+  Scenario: An undefined step causes a failure
+    Given a step that is yet to be defined
 
   Scenario: Steps before undefined steps are executed
     Given an implemented step
-    When a step that isnt implemented yet
+    And a step that is yet to be defined
 
   Scenario: Steps after undefined steps are skipped
-    Given a step that isnt implemented yet
-    Then a step that we expect to be skipped
+    Given a step that is yet to be defined
+    And a step that will be skipped

data/features/undefined/undefined.feature.ndjson

@@ -1,11 +1,11 @@
 {"meta":{"ci":{"buildNumber":"154666429","git":{"remote":"https://github.com/cucumber-ltd/shouty.rb.git","revision":"99684bcacf01d95875834d87903dcb072306c9ad"},"name":"GitHub Actions","url":"https://github.com/cucumber-ltd/shouty.rb/actions/runs/154666429"},"cpu":{"name":"x64"},"implementation":{"name":"fake-cucumber","version":"16.3.0"},"os":{"name":"linux","version":"5.15.0-84-generic"},"protocolVersion":"22.0.0","runtime":{"name":"node.js","version":"18.18.0"}}}
-{"source":{"data":"Feature: Undefined steps\n\n  At runtime, Cucumber may encounter a step in a scenario that it cannot match to a\n  step definition. In these cases, the scenario cannot run and so the step status\n  will be UNDEFINED, with subsequent steps being skipped and the overall result treated\n  as a failure.\n\n  Scenario: Undefined step causes failure\n    Given a step that isnt implemented yet\n\n  Scenario: Steps before undefined steps are executed\n    Given an implemented step\n    When a step that isnt implemented yet\n\n  Scenario: Steps after undefined steps are skipped\n    Given a step that isnt implemented yet\n    Then a step that we expect to be skipped\n","mediaType":"text/x.cucumber.gherkin+plain","uri":"samples/undefined/undefined.feature"}}
-{"gherkinDocument":{"comments":[],"feature":{"children":[{"scenario":{"description":"","examples":[],"id":"3","keyword":"Scenario","location":{"column":3,"line":8},"name":"Undefined step causes failure","steps":[{"id":"2","keyword":"Given ","keywordType":"Context","location":{"column":5,"line":9},"text":"a step that isnt implemented yet"}],"tags":[]}},{"scenario":{"description":"","examples":[],"id":"6","keyword":"Scenario","location":{"column":3,"line":11},"name":"Steps before undefined steps are executed","steps":[{"id":"4","keyword":"Given ","keywordType":"Context","location":{"column":5,"line":12},"text":"an implemented step"},{"id":"5","keyword":"When ","keywordType":"Action","location":{"column":5,"line":13},"text":"a step that isnt implemented yet"}],"tags":[]}},{"scenario":{"description":"","examples":[],"id":"9","keyword":"Scenario","location":{"column":3,"line":15},"name":"Steps after undefined steps are skipped","steps":[{"id":"7","keyword":"Given ","keywordType":"Context","location":{"column":5,"line":16},"text":"a step that isnt implemented yet"},{"id":"8","keyword":"Then ","keywordType":"Outcome","location":{"column":5,"line":17},"text":"a step that we expect to be skipped"}],"tags":[]}}],"description":"  At runtime, Cucumber may encounter a step in a scenario that it cannot match to a\n  step definition. In these cases, the scenario cannot run and so the step status\n  will be UNDEFINED, with subsequent steps being skipped and the overall result treated\n  as a failure.","keyword":"Feature","language":"en","location":{"column":1,"line":1},"name":"Undefined steps","tags":[]},"uri":"samples/undefined/undefined.feature"}}
-{"pickle":{"astNodeIds":["3"],"id":"11","language":"en","name":"Undefined step causes failure","steps":[{"astNodeIds":["2"],"id":"10","text":"a step that isnt implemented yet","type":"Context"}],"tags":[],"uri":"samples/undefined/undefined.feature"}}
-{"pickle":{"astNodeIds":["6"],"id":"14","language":"en","name":"Steps before undefined steps are executed","steps":[{"astNodeIds":["4"],"id":"12","text":"an implemented step","type":"Context"},{"astNodeIds":["5"],"id":"13","text":"a step that isnt implemented yet","type":"Action"}],"tags":[],"uri":"samples/undefined/undefined.feature"}}
-{"pickle":{"astNodeIds":["9"],"id":"17","language":"en","name":"Steps after undefined steps are skipped","steps":[{"astNodeIds":["7"],"id":"15","text":"a step that isnt implemented yet","type":"Context"},{"astNodeIds":["8"],"id":"16","text":"a step that we expect to be skipped","type":"Outcome"}],"tags":[],"uri":"samples/undefined/undefined.feature"}}
+{"source":{"data":"Feature: Undefined steps\n\n  At runtime, Cucumber may encounter a step in a scenario that it cannot match to a\n  step definition. In these cases, the scenario is not able to run and so the step status\n  will be UNDEFINED, with subsequent steps being SKIPPED and the overall result will be FAILURE\n\n  Scenario: An undefined step causes a failure\n    Given a step that is yet to be defined\n\n  Scenario: Steps before undefined steps are executed\n    Given an implemented step\n    And a step that is yet to be defined\n\n  Scenario: Steps after undefined steps are skipped\n    Given a step that is yet to be defined\n    And a step that will be skipped\n","mediaType":"text/x.cucumber.gherkin+plain","uri":"samples/undefined/undefined.feature"}}
+{"gherkinDocument":{"comments":[],"feature":{"children":[{"scenario":{"description":"","examples":[],"id":"3","keyword":"Scenario","location":{"column":3,"line":7},"name":"An undefined step causes a failure","steps":[{"id":"2","keyword":"Given ","keywordType":"Context","location":{"column":5,"line":8},"text":"a step that is yet to be defined"}],"tags":[]}},{"scenario":{"description":"","examples":[],"id":"6","keyword":"Scenario","location":{"column":3,"line":10},"name":"Steps before undefined steps are executed","steps":[{"id":"4","keyword":"Given ","keywordType":"Context","location":{"column":5,"line":11},"text":"an implemented step"},{"id":"5","keyword":"And ","keywordType":"Conjunction","location":{"column":5,"line":12},"text":"a step that is yet to be defined"}],"tags":[]}},{"scenario":{"description":"","examples":[],"id":"9","keyword":"Scenario","location":{"column":3,"line":14},"name":"Steps after undefined steps are skipped","steps":[{"id":"7","keyword":"Given ","keywordType":"Context","location":{"column":5,"line":15},"text":"a step that is yet to be defined"},{"id":"8","keyword":"And ","keywordType":"Conjunction","location":{"column":5,"line":16},"text":"a step that will be skipped"}],"tags":[]}}],"description":"  At runtime, Cucumber may encounter a step in a scenario that it cannot match to a\n  step definition. In these cases, the scenario is not able to run and so the step status\n  will be UNDEFINED, with subsequent steps being SKIPPED and the overall result will be FAILURE","keyword":"Feature","language":"en","location":{"column":1,"line":1},"name":"Undefined steps","tags":[]},"uri":"samples/undefined/undefined.feature"}}
+{"pickle":{"astNodeIds":["3"],"id":"11","language":"en","name":"An undefined step causes a failure","steps":[{"astNodeIds":["2"],"id":"10","text":"a step that is yet to be defined","type":"Context"}],"tags":[],"uri":"samples/undefined/undefined.feature"}}
+{"pickle":{"astNodeIds":["6"],"id":"14","language":"en","name":"Steps before undefined steps are executed","steps":[{"astNodeIds":["4"],"id":"12","text":"an implemented step","type":"Context"},{"astNodeIds":["5"],"id":"13","text":"a step that is yet to be defined","type":"Context"}],"tags":[],"uri":"samples/undefined/undefined.feature"}}
+{"pickle":{"astNodeIds":["9"],"id":"17","language":"en","name":"Steps after undefined steps are skipped","steps":[{"astNodeIds":["7"],"id":"15","text":"a step that is yet to be defined","type":"Context"},{"astNodeIds":["8"],"id":"16","text":"a step that will be skipped","type":"Context"}],"tags":[],"uri":"samples/undefined/undefined.feature"}}
 {"stepDefinition":{"id":"0","pattern":{"source":"an implemented step","type":"CUCUMBER_EXPRESSION"},"sourceReference":{"location":{"line":3},"uri":"samples/undefined/undefined.feature.ts"}}}
-{"stepDefinition":{"id":"1","pattern":{"source":"a step that we expect to be skipped","type":"CUCUMBER_EXPRESSION"},"sourceReference":{"location":{"line":7},"uri":"samples/undefined/undefined.feature.ts"}}}
+{"stepDefinition":{"id":"1","pattern":{"source":"a step that will be skipped","type":"CUCUMBER_EXPRESSION"},"sourceReference":{"location":{"line":7},"uri":"samples/undefined/undefined.feature.ts"}}}
 {"testRunStarted":{"timestamp":{"nanos":0,"seconds":0}}}
 {"testCase":{"id":"19","pickleId":"11","testSteps":[{"id":"18","pickleStepId":"10","stepDefinitionIds":[],"stepMatchArgumentsLists":[]}]}}
 {"testCase":{"id":"22","pickleId":"14","testSteps":[{"id":"20","pickleStepId":"12","stepDefinitionIds":["0"],"stepMatchArgumentsLists":[{"stepMatchArguments":[]}]},{"id":"21","pickleStepId":"13","stepDefinitionIds":[],"stepMatchArgumentsLists":[]}]}}

data/features/undefined/undefined.feature.rb

@@ -4,6 +4,6 @@ Given('an implemented step') do
   # no-op
 end
 
-Given('a step that we expect to be skipped') do
+Given('a step that will be skipped') do
   # no-op
 end

data/features/unknown-parameter-type/unknown-parameter-type.feature

@@ -3,4 +3,4 @@ Feature: Parameter Types
   an unknown parameter type, but the suite will run.
 
   Scenario: undefined parameter type
-    Given CDG is closed because of a strike
+    Given CDG is closed because of a strike

data/features/unknown-parameter-type/unknown-parameter-type.feature.ndjson

@@ -1,5 +1,5 @@
 {"meta":{"ci":{"buildNumber":"154666429","git":{"remote":"https://github.com/cucumber-ltd/shouty.rb.git","revision":"99684bcacf01d95875834d87903dcb072306c9ad"},"name":"GitHub Actions","url":"https://github.com/cucumber-ltd/shouty.rb/actions/runs/154666429"},"cpu":{"name":"x64"},"implementation":{"name":"fake-cucumber","version":"16.3.0"},"os":{"name":"linux","version":"5.15.0-84-generic"},"protocolVersion":"22.0.0","runtime":{"name":"node.js","version":"18.18.0"}}}
-{"source":{"data":"Feature: Parameter Types\n  Cucumber will generate an error message if a step definition registers\n  an unknown parameter type, but the suite will run.\n\n  Scenario: undefined parameter type\n    Given CDG is closed because of a strike","mediaType":"text/x.cucumber.gherkin+plain","uri":"samples/unknown-parameter-type/unknown-parameter-type.feature"}}
+{"source":{"data":"Feature: Parameter Types\n  Cucumber will generate an error message if a step definition registers\n  an unknown parameter type, but the suite will run.\n\n  Scenario: undefined parameter type\n    Given CDG is closed because of a strike\n","mediaType":"text/x.cucumber.gherkin+plain","uri":"samples/unknown-parameter-type/unknown-parameter-type.feature"}}
 {"gherkinDocument":{"comments":[],"feature":{"children":[{"scenario":{"description":"","examples":[],"id":"1","keyword":"Scenario","location":{"column":3,"line":5},"name":"undefined parameter type","steps":[{"id":"0","keyword":"Given ","keywordType":"Context","location":{"column":5,"line":6},"text":"CDG is closed because of a strike"}],"tags":[]}}],"description":"  Cucumber will generate an error message if a step definition registers\n  an unknown parameter type, but the suite will run.","keyword":"Feature","language":"en","location":{"column":1,"line":1},"name":"Parameter Types","tags":[]},"uri":"samples/unknown-parameter-type/unknown-parameter-type.feature"}}
 {"pickle":{"astNodeIds":["1"],"id":"3","language":"en","name":"undefined parameter type","steps":[{"astNodeIds":["0"],"id":"2","text":"CDG is closed because of a strike","type":"Context"}],"tags":[],"uri":"samples/unknown-parameter-type/unknown-parameter-type.feature"}}
 {"undefinedParameterType":{"expression":"{airport} is closed because of a strike","name":"airport"}}

data/features/unknown-parameter-type/unknown-parameter-type.feature.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-Given('{airport} is closed because of a strike') do |airport|
-  raise StandardError, 'Should not be called because airport type not defined'
+Given('{airport} is closed because of a strike') do |_airport|
+  raise 'Should not be called because airport parameter type has not been defined'
 end

data/lib/cck/helpers.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module CCK
+  module Helpers
+    def message_type(message)
+      message.to_h.each do |key, value|
+        return key unless value.nil?
+      end
+    end
+  end
+end

data/lib/cck/keys_checker.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+module CCK
+  class KeysChecker
+    def self.compare(detected, expected)
+      new(detected, expected).compare
+    end
+
+    attr_reader :detected, :expected
+
+    def initialize(detected, expected)
+      @detected = detected
+      @expected = expected
+    end
+
+    def compare
+      return [] if identical_keys?
+
+      errors << "Detected extra keys in message #{message_name}: #{extra_keys}" if extra_keys.any?
+      errors << "Missing keys in message #{message_name}: #{missing_keys}" if missing_keys.any?
+      errors
+    rescue StandardError => e
+      ["Unexpected error: #{e.message}"]
+    end
+
+    private
+
+    def detected_keys
+      @detected_keys ||= ordered_uniq_hash_keys(detected)
+    end
+
+    def expected_keys
+      @expected_keys ||= ordered_uniq_hash_keys(expected)
+    end
+
+    def identical_keys?
+      detected_keys == expected_keys
+    end
+
+    def missing_keys
+      (expected_keys - detected_keys).reject { |key| meta_message? && key == :ci }
+    end
+
+    def extra_keys
+      (detected_keys - expected_keys).reject { |key| meta_message? && key == :ci }
+    end
+
+    def meta_message?
+      detected.instance_of?(Cucumber::Messages::Meta)
+    end
+
+    def message_name
+      detected.class.name
+    end
+
+    def ordered_uniq_hash_keys(object)
+      object.to_h(reject_nil_values: true).keys.sort
+    end
+
+    def errors
+      @errors ||= []
+    end
+  end
+end

data/lib/cck/messages_comparator.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require_relative 'keys_checker'
+require_relative 'helpers'
+
+module CCK
+  class MessagesComparator
+    include Helpers
+
+    def initialize(validator, detected, expected)
+      @all_errors = []
+      @compared = []
+      @validator = validator
+
+      compare(detected, expected)
+    end
+
+    def errors
+      @all_errors.flatten
+    end
+
+    private
+
+    def compare(detected, expected)
+      detected_by_type = messages_by_type(detected)
+      expected_by_type = messages_by_type(expected)
+
+      detected_by_type.keys.each do |type|
+        compare_list(detected_by_type[type], expected_by_type[type])
+      rescue StandardError => e
+        @all_errors << "Error while comparing #{type}: #{e.message}"
+      end
+    end
+
+    def messages_by_type(messages)
+      by_type = Hash.new { |h, k| h[k] = [] }
+      messages.each do |msg|
+        by_type[message_type(msg)] << remove_envelope(msg)
+      end
+      by_type
+    end
+
+    def remove_envelope(message)
+      message.send(message_type(message))
+    end
+
+    def compare_list(detected, expected)
+      detected.each_with_index do |message, index|
+        compare_message(message, expected[index])
+      end
+    end
+
+    def compare_message(detected, expected)
+      return if not_message?(detected)
+      return if ignorable?(detected)
+      return if incomparable?(detected)
+
+      @all_errors << @validator.compare(detected, expected)
+      @compared << detected.class.name
+      compare_sub_messages(detected, expected)
+    end
+
+    def not_message?(detected)
+      !detected.is_a?(Cucumber::Messages::Message)
+    end
+
+    # These messages we need to ignore because they are too large or they feature timestamps which always vary
+    def ignorable?(detected)
+      too_large_message?(detected) || time_message?(detected)
+    end
+
+    def too_large_message?(detected)
+      detected.is_a?(Cucumber::Messages::GherkinDocument) || detected.is_a?(Cucumber::Messages::Pickle)
+    end
+
+    def time_message?(detected)
+      detected.is_a?(Cucumber::Messages::Timestamp) || detected.is_a?(Cucumber::Messages::Duration)
+    end
+
+    # These messages we need to ignore because they are often not of identical shape/value
+    def incomparable?(detected)
+      detected.is_a?(Cucumber::Messages::Ci) || detected.is_a?(Cucumber::Messages::Git)
+    end
+
+    def compare_sub_messages(detected, expected)
+      return unless expected.respond_to? :to_h
+      expected.to_h.keys.each do |key|
+        value = expected.send(key)
+        if value.is_a?(Array)
+          compare_list(detected.send(key), value)
+        else
+          compare_message(detected.send(key), value)
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/cucumber-compatibility-kit.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require 'shared_examples'
+
+module Cucumber::CompatibilityKit
+  class << self
+    def all_examples
+      gherkin_examples + markdown_examples
+    end
+
+    def gherkin_examples
+      Dir
+        .entries(examples_path)
+        .select do |file|
+          folder = File.join(examples_path, file)
+
+          file != '.' && file != '..' &&
+            File.directory?(folder) &&
+            gherkin_example?(folder)
+        end
+    end
+
+    def markdown_examples
+      Dir
+      .entries(examples_path)
+      .select do |file|
+        folder = File.join(examples_path, file)
+
+        file != '.' && file != '..' &&
+          File.directory?(folder) &&
+          markdown_example?(folder)
+      end
+    end
+
+    def examples_path
+      File.expand_path("#{File.dirname(__FILE__)}/../../features/")
+    end
+
+    def example_path(example_name)
+      path = File.join(examples_path, example_name)
+
+      return path if File.directory?(path)
+
+      raise ArgumentError.new
+    end
+
+    private
+
+    def gherkin_example?(example_folder)
+      Dir.entries(example_folder).select { |file| File.extname(file) == '.feature' }.count > 0
+    end
+
+    def markdown_example?(example_folder)
+      Dir.entries(example_folder).select { |file| File.extname(file) == '.md' }.count > 0
+    end
+  end
+end