HoNoSoFt.XUnit.Extensions 1.1.0

XUnit extensions in order to have new attributes. The attributes depending how you use them can be fully discoverable or more simple and not fully displayed in your test explorer.

- Theory + FileData: Load the file content as string
- Theory + JsonFileData: Load the JSON file into a typed object
- Theory + XmlFileData: Load the XML file into a typed object
- Theory + BinaryFileData: Load binary files into a byte[] object

Install-Package HoNoSoFt.XUnit.Extensions -Version 1.1.0
dotnet add package HoNoSoFt.XUnit.Extensions --version 1.1.0
<PackageReference Include="HoNoSoFt.XUnit.Extensions" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add HoNoSoFt.XUnit.Extensions --version 1.1.0
The NuGet Team does not provide support for this client. Please contact its maintainers for support.

GitHub Build status NuGet NuGet

HoNoSoFt.XUnit.Extensions

XUnit extensions in order to have new attributes.

Available attributes

| Name | Short Description |
|------|-------------------|
| FileData | Read the content as is as string |
| JsonFileData | Read the content and try to cast to the desired object (see next section) |
| XmlFileData | Read the content and try to cast to the desired object (Same as JsonFileData) |
| BinaryFileData | Read the content and send the content as byte[] |

Attribute JsonFileData

This attribute is in order to use Json file. This attribute can be used in two different way.

  1. The easy and strongly typed version
    • Issue that can't be fixed due to XUnit framework: The display in test explorer will show 1, and all tests are combined. Basically it's because we use a strongly typed object and that the framework can't allow that.
  2. The bit more step, but somewhat strongly typed
    • Issue: Require a bit more typing

Lazy version

This will display as one global tests, if ran in command line, all tests will be counted properly.

public class MyTests {
  [Theory]
  [JsonFileData("./assets/sample.json", "data")]
  [JsonFileData("./assets/sample.json", "data2")]
  public void JsonFileAttribute(Sample mySample, string expectedResult)
  {
      Assert.Equal(expectedResult, mySample.SampleProp);
  }
}

public class Sample
{
    public string SampleProp { get; set; }
}

Discoverable in test explorer version

This will display as multiple global tests (one per JsonFileData), if ran in command line, all tests will be counted properly.

Also, it's important to note that even if the serialization happens, we still keep the original data available in the attribute Original. For example mySpecialJson.Original will contains the raw file content.

public class MyTests {

  [Theory]
  [JsonFileData("./assets/sample.json", typeof(Sample), "data")]
  [JsonFileData("./assets/sample2.json", typeof(Sample), "data2")]
  public void JsonFileAttribute(JsonData mySpecialJson, string expectedResult)
  {
      Assert.Equal(typeof(Sample), mySpecialJson.Data.GetType());
      Assert.Equal(expectedResult, (mySample.Data as Sample).SampleProp);
  }
}

public class Sample
{
    public string SampleProp { get; set; }
}

Attribute XmlFileData

This attribute works the same way as the Json attribute.

Contributor(s)

At the moment, no specific contributor except the author @Nordes ;).

License

MIT (Enjoy)

GitHub Build status NuGet NuGet

HoNoSoFt.XUnit.Extensions

XUnit extensions in order to have new attributes.

Available attributes

| Name | Short Description |
|------|-------------------|
| FileData | Read the content as is as string |
| JsonFileData | Read the content and try to cast to the desired object (see next section) |
| XmlFileData | Read the content and try to cast to the desired object (Same as JsonFileData) |
| BinaryFileData | Read the content and send the content as byte[] |

Attribute JsonFileData

This attribute is in order to use Json file. This attribute can be used in two different way.

  1. The easy and strongly typed version
    • Issue that can't be fixed due to XUnit framework: The display in test explorer will show 1, and all tests are combined. Basically it's because we use a strongly typed object and that the framework can't allow that.
  2. The bit more step, but somewhat strongly typed
    • Issue: Require a bit more typing

Lazy version

This will display as one global tests, if ran in command line, all tests will be counted properly.

public class MyTests {
  [Theory]
  [JsonFileData("./assets/sample.json", "data")]
  [JsonFileData("./assets/sample.json", "data2")]
  public void JsonFileAttribute(Sample mySample, string expectedResult)
  {
      Assert.Equal(expectedResult, mySample.SampleProp);
  }
}

public class Sample
{
    public string SampleProp { get; set; }
}

Discoverable in test explorer version

This will display as multiple global tests (one per JsonFileData), if ran in command line, all tests will be counted properly.

Also, it's important to note that even if the serialization happens, we still keep the original data available in the attribute Original. For example mySpecialJson.Original will contains the raw file content.

public class MyTests {

  [Theory]
  [JsonFileData("./assets/sample.json", typeof(Sample), "data")]
  [JsonFileData("./assets/sample2.json", typeof(Sample), "data2")]
  public void JsonFileAttribute(JsonData mySpecialJson, string expectedResult)
  {
      Assert.Equal(typeof(Sample), mySpecialJson.Data.GetType());
      Assert.Equal(expectedResult, (mySample.Data as Sample).SampleProp);
  }
}

public class Sample
{
    public string SampleProp { get; set; }
}

Attribute XmlFileData

This attribute works the same way as the Json attribute.

Contributor(s)

At the moment, no specific contributor except the author @Nordes ;).

License

MIT (Enjoy)

This package is not used by any popular GitHub repositories.

Version History

Version Downloads Last updated
1.1.0 263 9/4/2018
1.0.2 176 8/31/2018
1.0.1 143 8/31/2018
1.0.0 136 8/29/2018
0.5.0 137 8/28/2018