chris-peterson / kekiri

A .NET framework that supports writing low-ceremony BDD tests using Gherkin language

Overview

👋 Hi, I'm Chris. I've been writing software for the last few decades.

Lately, I've been working on:

pwsh-gitlab

a PowerShell wrapper around GitLab API

I use the GitlabCli module for performing various tasks that would otherwise be difficult/tedious (e.g. cloning all the projects in a group). My favorite part of using this module is that it has implicit context based on your working directory making it easy to jump back and forth between local code artifacts and remote API resources. You can invoke APIs, or simply pipe any object to | go to navigate to the Web UI, e.g. mr | go brings you to the Merge Request UI for your current branch.

Give it a try here

Other Projects

I've created and actively maintain a few projects, including

Assurance

Kekiri

Spiffy

Contributions to OSS

I've made a few (small) contributions to various projects that I've used throughtout the years, including:

• Newtownsoft.Json
• Swashbuckle
• Autofac
• NHibernate
• and more :)

kekiri's Issues

add nunit 3.x support

Our testing projects vary between nunit 2.6.4 and nunit 3.5

It would be useful to be able to support the nunit 3.5 projects with Kekiri in a low-friction way.

Are there any thoughts or ideas to support this? The strong name of nunit.framework has changed between 2 and 3, so an assembly redirect is out. Simply subclassing Kekiri.Test and applying the OneTimeSetUp and OneTimeTearDown attributes [local to my own project] is an "almost" solution, but falls short in that the Kekiri.ThenAttribute can't be used because of the dependency on nunit 2.6.
Creating a new ThenAttribute class isn't an option because of the internal interface IStepAttribute [no access to the type to implement it.]

Any ideas? A straight update to nunit 3.5 in the Kekiri solution leaves a solid portion of tests in a failing state, so any update would require additional work, for certain.

Shorthand for `Throws`

Add a new extension whereby

When(xyz).Throws();
Catch<YourExceptionType>();

Could be abbreviated by When(xyz).Throws<YourException>()

Kekiri.IoC.Container is missing Resolve(Type type) method

When using Automapper with IoC, it accepts a method Func<Type, object> constructor to specify how to construct resolvers, mappers, etc.

However, Kekiri only has T Resolve<T>(), and no object Resolve(Type type)

Docs still refer to GivenAttribute, WhenAttribute, etc.

Update documentation

The documentation is for NUnit. Needs to be updated to XUnit (e.g. Scenario -> Scenarios).

scenario output (to console) not working for NUnit

Due to parallelism introduced in NUnit 3.0, the preferred mechanism for emitting output is
https://github.com/nunit/docs/wiki/TestContext#writeline

xUnit: Scenarios with strongly-typed context are not discovered

XUnit runner is not detecting Scenario<T>

NUnit: Support Step with default parameters

A step with default values will experience runtime errors (particularly if it is a When)

xUnit: Paramatereized Scenarios are not supported

When trying to add [Example] to [Scenario], xUnit complains --

 System.InvalidOperationException : [Fact] methods are not allowed to have parameters. Did you mean to use [Theory]?```

Create a migration guide

Need to have a migration guide from earlier versions of Kekiri to V4

xUnit IoC bootstrap initialization is high-friction

Investigate a lower-friction alternative, e.g.
https://xunit.github.io/docs/shared-context.html#collection-fixture

Add support for parameterized Fluent steps

Much like [Example] has a matching algorithm to tailor output based on parameter values, the Fluent Givens should support this as well (not sure if any other step types [When/Then]make sense).

Container.Register within an autofac Step<T> should allow "open" types

Example, I would have a Given<AMockDatastore>() which can register the datastore easily, but when I want to do a Given<MyController>(), I can't register the type itself, only an instance, which means I would end up having to Resolve, and therefor not being able to register anything else.

Support lambdas

Surprisingly, when defining

When(() => {}) a test will fail:

[xUnit.net 00:00:00.41]     UnitTests.CustomTimestamp.DefaultBehavior [FAIL]
  Failed UnitTests.CustomTimestamp.DefaultBehavior [13 ms]
  Error Message:
   Kekiri.Impl.Exceptions.WhenFailed : Error in 'CustomTimestamp':
'<DefaultBehavior>b  1 0' threw an exception.  If this is expected behavior use .Throws() and add a step that uses Catch<>
---- System.Reflection.TargetException : Object does not match target type.
  Stack Trace:
     at Kekiri.Impl.ScenarioRunner.RunWhenAsync()
   at Kekiri.Impl.ScenarioRunner.RunAsync()
   at Kekiri.ScenarioBase.RunAsync()
   at Kekiri.ScenarioBase.RunAsync()
--- End of stack trace from previous location ---
----- Inner Stack Trace -----
   at System.Reflection.RuntimeMethodInfo.Invoke(Object obj, BindingFlags invokeAttr, Binder binder, Object[] parameters, CultureInfo culture)
   at System.Reflection.MethodBase.Invoke(Object obj, Object[] parameters)
   at Kekiri.Impl.StepMethodInvoker.InvokeAsync(ScenarioBase scenario)
   at Kekiri.Impl.ScenarioRunner.RunWhenAsync()

Failed!  - Failed:     1

Generally, we'd prefer if a method name is provided, but it seems desirable to provide lamdas, particularly for "do nothing"

build.bat doesn't work with C#6 features

the invocation of msbuild is hard-coded to v4 version of msbuild.exe, which breaks on the string interpolation in the TestGen project.

will issue PR shortly

To break up the fixture trace file

[for the wiki, or the readme]

To break up the generated fixture file into individual files for use with tools like Pickles https://github.com/picklesdoc/pickles

Create a script file: SplitFixtureFile.ps1

# From http://rafdelgado.blogspot.com/2012/06/powershell-removing-special-characters.html
Function Convert-ToFriendlyName
{
    param ($Text)

    # Unwanted characters (includes spaces and '-') converted to a regex:
    $SpecChars = '!', '"', '£', '$', '%', '&', '^', '*', '(', ')', '@', '=', '+', '¬', '`', '\', '<', '>', '.', '?', '/', ':', ';', '#', '~', "'", '0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '-', ' '
    $remspecchars = [string]::join('|', ($SpecChars | % {[regex]::escape($_)}))

    # Convert the text given to correct naming format (Uppercase)
    $name = (Get-Culture).textinfo.totitlecase(“$Text”.tolower())

    # Remove unwanted characters
    $name = $name -replace $remspecchars, ""
    $name
}

function SplitFixtureFile
{
    param([string]$filepath,[string]$deployDestination)

    if (Test-Path $filepath -PathType Leaf) {
        $reader = new-object System.IO.StreamReader($filepath)
        $filename = "NUL"

        if(!(Test-Path -Path $deployDestination )){
            New-Item -ItemType directory -Path $TARGETDIR
        }

        while(($line = $reader.ReadLine()) -ne $null)
        {
            if ($line.ToLower().StartsWith("fixture:") || )
            {
                $line -imatch "fixture: (?<content>.*)"
                $fixture_name = Convert-ToFriendlyName $matches['content']

                $filename = "{0}\{1}.fixture" -f ($deployDestination, $fixture_name)
            }
            Add-Content -path $fileName -value $line
        }

        $reader.Close()
    }
}

SplitFixtureFile $args[0] $args[1]

And a post-build task, as follows:

<Target Name="SplitFixtureFile" Condition=" '$(WriteLogEntry)'!='false' ">
  <PropertyGroup>
    <PowerShellExe Condition=" '$(PowerShellExe)'=='' "> 
      %WINDIR%\System32\WindowsPowerShell\v1.0\powershell.exe
    </PowerShellExe>
    <ScriptLocation Condition=" '$(ScriptLocation)'=='' ">
      $(MSBuildProjectDirectory)\SplitFixtureFile.ps1
    </ScriptLocation>
    <FixtureFileOutputPath Condition=" '$(FixtureFileOutputPath)'=='' ">
      $(MSBuildProjectDirectory)\Fixtures
    </FixtureFileOutputPath>
  </PropertyGroup>
  <Exec Command="$(PowerShellExe) -NonInteractive -executionpolicy Unrestricted 
                 -command &quot;&amp; { 
                          &amp;&apos;$(ScriptLocation)&apos; 
                          &apos;$(FixtureFileOutputPath)&apos; } &quot;" 
  /> 
</Target>