Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/cezarypiatek/RoslynTestKit

A lightweight framework for writing unit tests for Roslyn diagnostic analyzers, code fixes, refactorings and completion providers.
https://github.com/cezarypiatek/RoslynTestKit

roslyn roslyn-analyzer roslyn-diagnostics test

Last synced: 24 days ago
JSON representation

A lightweight framework for writing unit tests for Roslyn diagnostic analyzers, code fixes, refactorings and completion providers.

Awesome Lists containing this project

README 

        
# RoslynTestKit



A lightweight framework for writing unit tests for Roslyn diagnostic analyzers, code fixes, refactorings and completion providers.

This is a port of [RoslynNUnitLight.NetStandard](https://github.com/phoenix172/RoslynNUnitLight.NetStandard). The main reasons to create a fork that is independent were:



- make the library independent of the test framework

- decrease response time for reported issues



### Quick Start



1. Install the [SmartAnalyzers.RoslynTestKit ](https://www.nuget.org/packages/SmartAnalyzers.RoslynTestKit/)

   package from NuGet into your project.

2. Create appropriate test fixture using `RoslynFixtureFactory`

3. Fix the fixture to perform assertion!



### Code location markers



RoslynTestKit accepts strings that are marked up with ```[|``` and ```|]``` to identify a particular span. This could represent the span of an expected

diagnostic or the text selection before a refactoring is applied. 

Instead of the markers you can also provide line number to locate the place of expected diagnostic.



### Framework dependencies



By default RoslynTestKit adds to the compilation the following references:

- `mscorlib.dll` (and its dependencies)

- `System.Private.CoreLib.dll`

- `System.Linq.dll`

- `System.Linq.Expression.dll`



You can change that behavior by overriding `CreateFrameworkMetadataReferences()` method. You can also take full control of how the workspace/compilation is created by overriding :



```Document CreateDocumentFromCode(string code, string languageName, IReadOnlyCollection extraReferences)```



### External dependencies



Every `*TestFixture` can be configured to import external dependencies required by the test case code/markup. There is also a couple of helper methods in `ReferenceSource` class that allow to easily define these dependencies. A sample setup for analyzer test with external dependencies can looks as follows:



```csharp

public class SampleTests

{



    [Test]

    public void should_verify_analyzer()

    {

        var fixture = RoslynFixtureFactory.Create(new () {

            References = new []{

                ReferenceSource.FromType() 

            };

        });



        //TODO: test your analyzer

    }

}

```



#### Example: Test presence of a diagnostic



```C#

[Test]

public void AutoPropDeclaredAndUsedInConstructor()

{

    const string code = @"

class C

{

	public bool MyProperty { get; [|private set;|] }

	public C(bool f)

	{

		MyProperty = f;

	}

}";



    var fixture = RoslynFixtureFactory.Create();



    fixture.HasDiagnostic(code, DiagnosticIds.UseGetterOnlyAutoProperty);

}

```



#### Example: Override test project and test document names



```C#

[Test]

public void AutoPropDeclaredAndUsedInConstructor()

{

    const string markup = @"

class C

{

	public bool MyProperty { get; [|private set;|] }

	public C(bool f)

	{

		MyProperty = f;

	}

}";



    var fixture = RoslynFixtureFactory.Create();



    var document = this.CreateDocumentFromMarkup(markup, "MySampleProject", "MySampleDocument");

    var diagnosticLocation = this.GetMarkerLocation(markup);

    fixture.HasDiagnostic(document, DiagnosticIds.UseGetterOnlyAutoProperty, diagnosticLocation);

}

```



#### Example: Test absence of a diagnostic



```C#

[Test]

public void AutoPropAlreadyReadonly()

{

    const string code = @"

class C

{

    public bool MyProperty { get; }

    public C(bool f)

    {

        MyProperty = f;

    }

}";



    var fixture = RoslynFixtureFactory.Create();

    fixture.NoDiagnostic(code, DiagnosticIds.UseGetterOnlyAutoProperty);

}

```



#### Example: Test code fix behavior



```C#

[Test]

public void TestSimpleProperty()

{

    const string markupCode = @"

class C

{

    public bool P1 { get; [|private set;|] }

}";



    const string expected = @"

class C

{

    public bool P1 { get; }

}";



    var fixture = RoslynFixtureFactory.Create();

    fixture.TestCodeFix(markupCode, expected, DiagnosticDescriptors.UseGetterOnlyAutoProperty);

}

```

Instead of the diagnostic descriptor, you can also use Diagnostic Id (error code) to identify the issue which should be fixed by tested code fix. This allows testing code fixes which respond to standard C# compiler errors such as `CS0736`.



### Example: Test code fix that fixes issue reported by provided `DiagnosticAnalyzer`



```csharp

public class SampleTest

{   



    [Test]

    public void should_be_able_fix_issue_reported_by_analyzer()

    {



        var fixture = RoslynFixtureFactory.Create(new ()

        {

            AdditionalAnalyzers = new [] {

                new[] { new UseGetterOnlyAutoPropertyAnalyzer()

            }

        });



        fixture.TestCodeFix(/*Here comes code with issue */, /*Here comes fixed code*/, /*Diagnostic Id*/);

    }

}

```



#### Example: Test code refactoring behavior



```C#

[Test]

public void SimpleTest()

{

    const string markupCode = @"

class C

{

    void M()

    {

        var s = [|string.Format(""{0}"", 42)|];

    }

}";



    const string expected = @"

class C

{

    void M()

    {

        var s = $""{42}"";

    }

}";



    var fixture = RoslynFixtureFactory.Create();

    fixture.TestCodeRefactoring(markupCode, expected);

}

```



#### Example: Test completion provider based on expected suggestions



```csharp

[Test]

public void SimpleTest()

{

    const string markupCode = @"

class C

{

    void M()

    {

        var s = string.Format([||], 42);

    }

}";



    var fixture = RoslynFixtureFactory.Create();



    fixture.TestCompletion(markupCode, new []

    {

        "first expected suggestion",

        "second expected suggestion"

    });

}

```



#### Example: Test completion provider based on custom checks

```csharp

[Test]

public void SimpleTest()

{

    const string markupCode = @"

class C

{

    void M()

    {

        var s = string.Format([||], 42);

    }

}";



    var fixture = RoslynFixtureFactory.Create();



    fixture.TestCompletion(markupCode, (ImmutableArray suggestions) =>

    {

        //TODO: Custom assertions

    });

}

```



## Code comparison



In case of discrepancy between the expected code and the generated one, when testing `CodeFixes` and `CodeRefactorings`, the `TransformedCodeDifferentThanExpectedException` is thrown. The Text difference is presented in the console using inline diff format, which looks as follows:



```plaintext

RoslynTestKit.TransformedCodeDifferentThanExpectedException : Transformed code is different than expected:

===========================

From line 25:

- ················ZipCode·=·src.MainAddress.ZipCode,␍␊

===========================

From line 29:

- ············dst.Addresses·=·src.Addresses.ConvertAll(srcAddress·=>·new·AddressDTO()␍␊

- ············{␍␊

- ················City·=·srcAddress.City,␍␊

- ················ZipCode·=·srcAddress.ZipCode,␍␊

- ················Street·=·srcAddress.Street,␍␊

- ················FlatNo·=·srcAddress.FlatNo,␍␊

- ················BuildingNo·=·srcAddress.BuildingNo␍␊

- ············}).AsReadOnly();␍␊

- ············dst.UnitId·=·src.Unit.Id;␍␊

===========================

From line 71:

- ········public·string·ZipCode·{·get;·set;·}␍␊

+ ········public·string·ZipCode·{·get;·}␍␊

===========================

From line 94:

- ········public·List·Addresses·{·get;·set;·}␍␊

- ········public·UnitEntity·Unit·{·get;·set;·}␍␊

===========================

From line 124:

- ········public·string·BankName·{·get;·set;·}␍␊

+ ············public·string·BankName·{·get;·set;·}␍␊

```



However, when the test is run with the attached debugger, an external `diff tool` is launched to present the differences. RoslynTestKit is using under the hood the [ApprovalTests.Net](https://github.com/approvals/ApprovalTests.Net) so a wide range of diff tools on `Windows`, `Linux` and `Mac` are supported.



![example visual diff](doc/diff.png)