kasthack.NotEmpty.Xunit 1.3.0

There is a newer version of this package available.
See the version list below for details.
dotnet add package kasthack.NotEmpty.Xunit --version 1.3.0                
NuGet\Install-Package kasthack.NotEmpty.Xunit -Version 1.3.0                
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="kasthack.NotEmpty.Xunit" Version="1.3.0" />                
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add kasthack.NotEmpty.Xunit --version 1.3.0                
#r "nuget: kasthack.NotEmpty.Xunit, 1.3.0"                
#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 kasthack.NotEmpty.Xunit as a Cake Addin
#addin nuget:?package=kasthack.NotEmpty.Xunit&version=1.3.0

// Install kasthack.NotEmpty.Xunit as a Cake Tool
#tool nuget:?package=kasthack.NotEmpty.Xunit&version=1.3.0                

kasthack.NotEmpty

NuGet GitHub release license .NET Status Patreon pledges Patreon patrons

What?

kasthack.Empty is a library for recursively checking objects for emptinness(being null, default value, an empty collection or a string). It saves you from writing boilerplate in tests for deserializers / parsers / API clients.

Why does this exist?

Manually checking properties for emptinness leaves an opportunity to miss something and makes the developer to write boilerplate.

Usage

  1. Install the appropriate package
  1. Check your objects / their properties for emptinness. Look at the <a href="src/kasthack.NotEmpty.Tests/NotEmptyTestBase.cs">tests</a> for more details.
using kasthack.NotEmpty.Xunit;  // replace the namespace to match your test framework

public class MyAmazingTest
{
    [Fact]
    public void MyThingWorks()
    {
        var targetObject = MyClass.GetResult();

        targetObject.NotEmpty();

        //<actual asserts>
    }

    [Fact]
    public void TestOptions()
    {
        // won't throw
        new {
            PropertyThanLegitimatelyCanBeAnEmptyStringButNotNull = "",
        }.NotEmpty(new AssertOptions {
            AllowEmptyStrings = true,
        });

        //won't throw
        new {
            PropertyThanLegitimatelyCanBeAnEmptyCollectionButNotNull = new int[]{},
        }.NotEmpty(new AssertOptions {
            AllowEmptyCollections = true,
        });

        // won't throw
        new {
            FileContentThatObviouslyContainsSomeNullBytes = new byte[]{ 0 }
        }.NotEmpty(new AssertOptions {
            AllowZerosInNumberArrays = true
        });

        // won't throw BUT will stop at 200 iterations
        // default MaxDepth is 100
        new {
            DeeplyNestedObject = new InfiniteNestedStruct()
        }.NotEmpty(new AssertOptions {
            MaxDepth = 200
        });
    }

    public struct InfiniteNestedStruct
    {
        public int Value { get; set; } = 1;

        public InfiniteNestedStruct Child => new InfiniteNestedStruct { Value = this.Value + 1 };
    }
}
Product Compatible and additional computed target framework versions.
.NET net6.0 is compatible.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 is compatible.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 was computed.  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. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last updated
1.4.0 379 1/8/2023
1.3.0 299 1/7/2023
1.2.0 297 12/29/2022
1.1.1 293 1/6/2022
1.1.0 252 1/6/2022
1.0.7 274 12/25/2021
1.0.6 259 12/25/2021
1.0.5 272 12/25/2021
1.0.4 277 12/19/2021
1.0.3 291 12/18/2021
1.0.2 288 12/12/2021