PlayNicely.SpecFlow.Executor 1.1.1-beta-274

This is a prerelease version of PlayNicely.SpecFlow.Executor.
There is a newer version of this package available.
See the version list below for details.
dotnet add package PlayNicely.SpecFlow.Executor --version 1.1.1-beta-274                
NuGet\Install-Package PlayNicely.SpecFlow.Executor -Version 1.1.1-beta-274                
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="PlayNicely.SpecFlow.Executor" Version="1.1.1-beta-274" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add PlayNicely.SpecFlow.Executor --version 1.1.1-beta-274                
#r "nuget: PlayNicely.SpecFlow.Executor, 1.1.1-beta-274"                
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install PlayNicely.SpecFlow.Executor as a Cake Addin
#addin nuget:?package=PlayNicely.SpecFlow.Executor&version=1.1.1-beta-274&prerelease

// Install PlayNicely.SpecFlow.Executor as a Cake Tool
#tool nuget:?package=PlayNicely.SpecFlow.Executor&version=1.1.1-beta-274&prerelease                

Play Nicely SpecFlow Executor

The Play Nicely SpecFlow projects provide Gherkin language bindings for PlayNicely.Executor. These bindings allow you to require or uninstall commands, specify package sources and mappings, and set test case projects. These scenarios are designed to support building release tests for Play Nicely npm package projects.

Getting Started

To start using these bindings in a SpecFlow project, install this package, or one of the more specific packages, as a dependency. Then add or update the specflow.json so that the project picks up the bindings.

With this done, you can use the bindings to specify your scenarios.

Install the package

From the Package Manager Console:

Install-Package PlayNicely.SpecFlow.Executor -ProjectName "_your-specflow-project_"

ℹ️ Or use one of the more specific packages such as PlayNicely.SpecFlow.DotNet

Add or Update specflow.json

For SpecFlow to pick up the bindings from external assemblies, they have to be configured in the project's specflow.json file. If the project doesn't already have it, add the item to the root of your SpecFlow project.

Add the external assemblies to the file:

{
    "stepAssemblies": [
        { "assembly": "PlayNicely.SpecFlow.Executor" }
    ]
}

You can now use the step definitions and bindings from Play Nicely.

Working Examples

The PlayNicely.NpmNpx and PlayNicely.Sass projects contain real examples of how to set up your projects and configure test scenarios.

Creating Test Scenarios

This package provides step definitions and hooks to simplify scenario set up. Many scenarios require a test environment and, if a test fails, to output any data sent to stdout or stderr.

The test environment hook will run if you tag your features or scenarios with @test-environment. The order of these hooks are determined using the Order property on hook attributes, the values of these are defined in the SpecFlowConts.BindingOrder static class. You can use these to develop downstream hooks that rely on these concepts, e.g. if it needs a TestEnvironmentBuilder.

Step Definitions

This package provides the following step definitions for use in test scenarios.

Given
  • Given (command) is installed Ensures that command is on the $PATH in the test environment.
  • Given (command) is uninstalled If the command is found on the $PATH, its directory will be removed from the $PATH in the test environment. This simulates the command being unavailable (uninstalled).
When
  • When (command line) is executed Executes process based on the command line provided. The command line is parsed based on the Linux shell rules, \ is the escape character and both " and ' are accepted as quotes.
Then
  • Then the command should (succeed|fail) Test whether the process exited successfully.

Hooks and Extensions

The EnvironmentBuilderHooks create a TestEnvironmentBuilder before each scenario and stores it in the ScenarioContext. This builder can be accessed using the extension method ScenarioContext.RequireEnvironmentBuilder() and other methods of the TestEnvironmentBuilderExtensions class.

The ExecutionResultHooks checks to see if a scenario failed, and if it did, outputs any ExecutionResult stdout and stderr streams. Steps can Collect the result using the extension method ScenarioContext.CollectResult(result) of the ExecutionResultExtensions class (this collection is already done for Play Nicely defined steps). This class provides extensions for accessing the execution result, including results that include a context.

The DisposableExtensions allow scenarios to create disposable resources and have them disposed after the scenario finishes. Use the ScenarioContext.MarkForDisposal(disposable) method for this purpose.

Constants

The SpecFlowConsts class defines constants for tags and binding order.

Product Compatible and additional computed target framework versions.
.NET net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  net9.0 was computed.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on PlayNicely.SpecFlow.Executor:

Package Downloads
PlayNicely.SpecFlow.DotNet

SpecFlow bindings that allow you to run tests by executing dotnet commands against a pre-configured test environment and test case project.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
2.3.2-beta-550 86 3 months ago
2.3.2-beta-543 95 4 months ago
2.3.2-beta-535 93 4 months ago
2.3.2-beta-529 85 4 months ago
2.3.2-beta-518 105 4 months ago
2.3.2-beta-511 88 4 months ago
2.3.2-beta-509 85 4 months ago
2.3.2-beta-507 78 4 months ago
2.3.2-beta-505 88 4 months ago
2.3.2-beta-501 102 4 months ago
2.3.2-beta-499 103 4 months ago
2.3.2-beta-496 80 4 months ago
2.3.2-beta-494 92 4 months ago
2.3.2-beta-492 102 4 months ago
2.3.1 133 4 months ago
2.3.1-beta-487 89 4 months ago
2.3.0 134 4 months ago
2.3.0-beta-479 96 4 months ago
2.3.0-beta-472 110 4 months ago
2.2.0-beta-465 107 4 months ago
2.1.1 123 8 months ago
2.1.1-beta-450 101 6 months ago
2.1.1-beta-442 100 6 months ago
2.1.1-beta-432 85 6 months ago
2.1.1-beta-418 90 8 months ago
2.1.1-beta-398 82 8 months ago
2.1.0 145 8 months ago
2.1.0-beta-393 74 8 months ago
2.1.0-beta-382 125 8 months ago
2.1.0-beta-370 113 8 months ago
2.1.0-beta-355 124 8 months ago
2.0.0 144 8 months ago
2.0.0-beta-349 121 8 months ago
2.0.0-beta-346 133 8 months ago
2.0.0-beta-340 115 8 months ago
2.0.0-beta-323 105 8 months ago
1.3.0 131 9 months ago
1.3.0-beta-312 98 9 months ago
1.2.0 156 9 months ago
1.2.0-beta-299 117 9 months ago
1.2.0-beta-296 133 9 months ago
1.1.1 172 9 months ago
1.1.1-beta-287 119 9 months ago
1.1.1-beta-282 133 9 months ago
1.1.1-beta-280 132 9 months ago
1.1.1-beta-278 100 9 months ago
1.1.1-beta-276 119 9 months ago
1.1.1-beta-274 116 9 months ago
1.1.1-beta-272 118 9 months ago
1.1.0 140 10 months ago
1.1.0-beta-266 122 10 months ago
1.1.0-beta-260 113 10 months ago
1.0.1 176 3/10/2024
1.0.1-prerelease-20240301-0... 126 3/1/2024
1.0.1-beta-227 113 3/10/2024
1.0.1-beta-221 117 3/9/2024
1.0.1-beta-214 113 3/9/2024
1.0.1-beta-208 112 3/1/2024
1.0.1-beta-206 111 3/1/2024
1.0.0 189 2/29/2024
1.0.0-prerelease-20240229-1... 107 2/29/2024
1.0.0-prerelease-20240228-0... 103 2/28/2024
1.0.0-prerelease-20240226-1... 105 2/26/2024
1.0.0-prerelease-20240225-0... 100 2/25/2024
1.0.0-prerelease-20240225-0... 129 2/25/2024