Shims 1.0.0

Shims

Shims is a .NET project that allows the creation of unit tests for class methods and properties using shims (mocking).

Features

• Creation of shims for methods
• Unit tests for property getters
• Handling exceptions and callbacks in tests

Installation

Via NuGet Package

1. Open your project in your preferred .NET IDE.

2. In the Package Manager Console, run the following command:

   Install-Package Shims
   

Cloning the Repository

1. Clone the repository:

   git clone https://github.com/Nixsoft-FR/Shims.git
   

2. Open the project in your preferred .NET IDE.

Usage

Prerequisites

Ensure your unit test classes inherit from UnitTestBase to fully leverage shim features:

public class MyTestClass : UnitTestBase
{
    // Your test methods here
}

Creating a Shim for a Method

To create a shim for a method in MyClass, you can use the Shim<MyClass> class:

Shim<MyClass> shim = new Shim<MyClass>();
shim.Setup(mock => mock.MyMethod()).Returns("Hello Shim!");

MyClass instance = new MyClass();
string result = instance.MyMethod();

Assert.AreEqual("Hello Shim!", result);

Testing a Property Getter

To test a property getter in MyClass, use Shim<MyClass> and SetupGet:

[TestMethod]
public void MyClass_MyPropertyString_Get()
{
    Shim<MyClass> shim = new Shim<MyClass>();
    shim.SetupGet(mock => mock.MyPropertyString).Returns("Test Value");
    MyClass instance = new MyClass();
    Assert.AreEqual("Test Value", instance.MyPropertyString);
}

Handling Exceptions and Callbacks

You can also handle exceptions and callbacks in your tests:

[TestMethod]
public void MyClass_MyMethod_ThrowsException()
{
    Shim<MyClass> shim = new Shim<MyClass>();
    shim.Setup(mock => mock.MyMethod()).Throws<ArgumentException>();

    MyClass instance = new MyClass();
    Assert.ThrowsException<ArgumentException>(() => instance.MyMethod());
}

[TestMethod]
public void MyClass_MyMethod_WithCallback()
{
    bool callbackCalled = false;

    Shim<MyClass> shim = new Shim<MyClass>();
    shim.Setup(mock => mock.MyMethod()).Callback(() => callbackCalled = true);

    MyClass instance = new MyClass();
    instance.MyMethod();

    Assert.IsTrue(callbackCalled);
}

Acknowledgments

Special thanks to the Harmony.Lib library for its use in this project.

We also want to thank the Moq library, which greatly inspired the syntax used in Shims.

Contribution

Contributions are welcome! Please submit an issue or a pull request for any suggestions or improvements.

License

This project is licensed under the MIT License. See the LICENSE file for details.