Cucumber.CCK 29.1.4

Cucumber Compatibility Kit

Test data for validating compatibility of a Cucumber implementation

The CCK (Cucumber Compatibility Kit) is a set of features and messages. It aims to validate an implementation of the Cucumber Messages protocol.

Overview

This kit (package) consists of a set of features, miscellaneous files, and messages:

• Each area will contain one or more features, which, once executed, will emit a set of messages as specified by the protocol.
• Some of these areas may "also" require miscellaneous files to be used when testing functions such as attaching images or documents or reading data from files.
• Each area will contain a set of messages - serialised as a single .ndjson file.

This is the reference for the CCK: a given feature from the kit, when executed using any dedicated step definitions, must emit a corresponding equivalent set of messages.

Installation and Usage

Available as Cucumber.CCK on NuGet.

dotnet add package Cucumber.CCK

Or via Package Manager Console:

Install-Package Cucumber.CCK

The compatibility kit packages gherkin files and sample data as content files that are automatically copied to your output directory when you reference the package. The files will be available in the cck/samples/ directory relative to your output folder.

Customizing the Content Path

You can change where the CCK files appear in your project by setting the CucumberCCKContentPath MSBuild property in your project file:

<PropertyGroup>
   <CucumberCCKContentPath>TestData\CCK</CucumberCCKContentPath>
</PropertyGroup>

If not set, the default value is cck\samples.

More Info

The Cucumber Compatibility Kit is part of the development tools of Cucumber. It helps ensure that all implementations are properly supporting our internal protocol and are compatible (and consistent) with each other and our common tools like the html-formatter.

It can be a valuable tool if you are developing integration with Cucumber or your own implementation of it.

Join us on github/cucumber/compatibility-kit for more help if needed.

You can also take a look at cucumber-ruby to see how the kit is used in Ruby.

Development

Before building this project locally, ensure the samples exist in the devkit directory at the root of the repository.

To build the NuGet package:

cd dotnet/Cucumber.CCK
dotnet pack

The package will include all files from ../../devkit/samples as contentFiles.