TngTech.ArchUnitNET
0.11.1
dotnet add package TngTech.ArchUnitNET --version 0.11.1
NuGet\Install-Package TngTech.ArchUnitNET -Version 0.11.1
<PackageReference Include="TngTech.ArchUnitNET" Version="0.11.1" />
paket add TngTech.ArchUnitNET --version 0.11.1
#r "nuget: TngTech.ArchUnitNET, 0.11.1"
// Install TngTech.ArchUnitNET as a Cake Addin #addin nuget:?package=TngTech.ArchUnitNET&version=0.11.1 // Install TngTech.ArchUnitNET as a Cake Tool #tool nuget:?package=TngTech.ArchUnitNET&version=0.11.1
<img src="Logo/ArchUnitNET-Logo.png" height="64" alt="ArchUnit">
ArchUnitNET
Visit our documentation at https://archunitnet.readthedocs.io/en/latest/.
ArchUnitNET is a free, simple library for checking the architecture of C# code. It is the C# fork of https://www.archunit.org/ for Java. ArchUnitNET can check dependencies between classes, members, interfaces, and more. This is done by analyzing C# bytecode and importing all classes into our C# code structure. The main focus of ArchUnitNET is to automatically test architecture and coding rules.
An Example
To use ArchUnitNET, install the ArchUnitNET package from NuGet:
PS> Install-Package TngTech.ArchUnitNET
If you want to use xUnit, NUnit or MSTestV2 for your unit tests, you should instead install the corresponding ArchUnit extension:
PS> Install-Package TngTech.ArchUnitNET.xUnit
PS> Install-Package TngTech.ArchUnitNET.NUnit
PS> Install-Package TngTech.ArchUnitNET.MSTestV2
Create a Test
Then you will want to create a class to start testing. We used xUnit with the ArchUnit extension here, but it works similarly with NUnit or other Unit Test Frameworks.
using ArchUnitNET.Domain;
using ArchUnitNET.Loader;
using ArchUnitNET.Fluent;
using Xunit;
//add a using directive to ArchUnitNET.Fluent.ArchRuleDefinition to easily define ArchRules
using static ArchUnitNET.Fluent.ArchRuleDefinition;
namespace ExampleTest
{
public class ExampleArchUnitTest
{
// TIP: load your architecture once at the start to maximize performance of your tests
private static readonly Architecture Architecture = new ArchLoader().LoadAssemblies(
System.Reflection.Assembly.Load("ExampleClassAssemblyName"),
System.Reflection.Assembly.Load("ForbiddenClassAssemblyName")
).Build();
// replace <ExampleClass> and <ForbiddenClass> with classes from the assemblies you want to test
//declare variables you'll use throughout your tests up here
//use As() to give them a custom description
private readonly IObjectProvider<IType> ExampleLayer =
Types().That().ResideInAssembly("ExampleAssembly").As("Example Layer");
private readonly IObjectProvider<Class> ExampleClasses =
Classes().That().ImplementInterface("IExampleInterface").As("Example Classes");
private readonly IObjectProvider<IType> ForbiddenLayer =
Types().That().ResideInNamespace("ForbiddenNamespace").As("Forbidden Layer");
private readonly IObjectProvider<Interface> ForbiddenInterfaces =
Interfaces().That().HaveFullNameContaining("forbidden").As("Forbidden Interfaces");
//write some tests
[Fact]
public void TypesShouldBeInCorrectLayer()
{
//you can use the fluent API to write your own rules
IArchRule exampleClassesShouldBeInExampleLayer =
Classes().That().Are(ExampleClasses).Should().Be(ExampleLayer);
IArchRule forbiddenInterfacesShouldBeInForbiddenLayer =
Interfaces().That().Are(ForbiddenInterfaces).Should().Be(ForbiddenLayer);
//check if your architecture fulfils your rules
exampleClassesShouldBeInExampleLayer.Check(Architecture);
forbiddenInterfacesShouldBeInForbiddenLayer.Check(Architecture);
//you can also combine your rules
IArchRule combinedArchRule =
exampleClassesShouldBeInExampleLayer.And(forbiddenInterfacesShouldBeInForbiddenLayer);
combinedArchRule.Check(Architecture);
}
[Fact]
public void ExampleLayerShouldNotAccessForbiddenLayer()
{
//you can give your rules a custom reason, which is displayed when it fails
//(together with the types that failed the rule)
IArchRule exampleLayerShouldNotAccessForbiddenLayer = Types().That().Are(ExampleLayer).Should()
.NotDependOnAny(ForbiddenLayer).Because("it's forbidden");
exampleLayerShouldNotAccessForbiddenLayer.Check(Architecture);
}
[Fact]
public void ForbiddenClassesShouldHaveCorrectName()
{
Classes().That().AreAssignableTo(ForbiddenInterfaces).Should().HaveNameContaining("forbidden")
.Check(Architecture);
}
[Fact]
public void ExampleClassesShouldNotCallForbiddenMethods()
{
Classes().That().Are(ExampleClasses).Should().NotCallAny(
MethodMembers().That().AreDeclaredIn(ForbiddenLayer).Or().HaveNameContaining("forbidden"))
.Check(Architecture);
}
}
}
Further Info and Help
Check out test examples for the current release at ArchUnitNET Examples.
License
ArchUnitNET is published under the Apache License 2.0. For more information concerning the license, see Apache License 2.0.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net5.0 was computed. net5.0-windows was computed. net6.0 was computed. 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 was computed. 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. |
.NET Core | netcoreapp2.0 was computed. netcoreapp2.1 was computed. netcoreapp2.2 was computed. netcoreapp3.0 was computed. netcoreapp3.1 was computed. |
.NET Standard | netstandard2.0 is compatible. netstandard2.1 was computed. |
.NET Framework | net45 is compatible. net451 was computed. net452 was computed. net46 was computed. net461 was computed. net462 was computed. net463 was computed. net47 was computed. net471 was computed. net472 was computed. net48 was computed. net481 was computed. |
MonoAndroid | monoandroid was computed. |
MonoMac | monomac was computed. |
MonoTouch | monotouch was computed. |
Tizen | tizen40 was computed. tizen60 was computed. |
Xamarin.iOS | xamarinios was computed. |
Xamarin.Mac | xamarinmac was computed. |
Xamarin.TVOS | xamarintvos was computed. |
Xamarin.WatchOS | xamarinwatchos was computed. |
-
.NETFramework 4.5
- CycleDetection (>= 2.0.0)
- JetBrains.Annotations (>= 2020.3.0)
- Mono.Cecil (>= 0.11.6)
- Newtonsoft.Json (>= 13.0.3)
- System.ValueTuple (>= 4.5.0)
-
.NETStandard 2.0
- CycleDetection (>= 2.0.0)
- JetBrains.Annotations (>= 2020.3.0)
- Mono.Cecil (>= 0.11.6)
- Newtonsoft.Json (>= 13.0.3)
- System.ValueTuple (>= 4.5.0)
NuGet packages (6)
Showing the top 5 NuGet packages that depend on TngTech.ArchUnitNET:
Package | Downloads |
---|---|
TngTech.ArchUnitNET.xUnit
xUnit Extension for the C# Version of ArchUnit (see: archunit.org) |
|
TngTech.ArchUnitNET.NUnit
NUnit Extension for the C# Version of ArchUnit (see: archunit.org) |
|
TngTech.ArchUnitNET.MSTestV2
MSTestV2 Extension for the C# Version of ArchUnit (see: archunit.org) |
|
Cash2u.UnitTesting
Library contains objects for testing |
|
ModuleName.ArchitectureUnitTest
Package Description |
GitHub repositories (2)
Showing the top 2 popular GitHub repositories that depend on TngTech.ArchUnitNET:
Repository | Stars |
---|---|
karaoke-dev/karaoke
Will be the best karaoke system.
|
|
valentinajemuovic/banking-kata-dotnet
Banking Kata (.NET)
|
Version | Downloads | Last updated |
---|---|---|
0.11.1 | 34,452 | 10/25/2024 |
0.11.0 | 104,366 | 8/23/2024 |
0.11.0-preview.1 | 209 | 8/19/2024 |
0.10.6 | 1,065,370 | 7/12/2023 |
0.10.5 | 474,884 | 11/12/2022 |
0.10.4 | 193,522 | 8/7/2022 |
0.10.3 | 23,796 | 8/3/2022 |
0.10.2 | 19,531 | 7/31/2022 |
0.10.1 | 151,698 | 4/29/2022 |
0.10.0 | 2,535 | 4/27/2022 |
0.9.1 | 98,061 | 3/7/2022 |
0.9.0 | 172,286 | 12/1/2021 |
0.8.5 | 9,349 | 12/1/2021 |
0.8.4 | 20,358 | 10/19/2021 |
0.8.3 | 23,259 | 10/7/2021 |
0.8.2 | 5,467 | 9/28/2021 |
0.8.1 | 5,117 | 9/27/2021 |
0.8.0 | 84,844 | 9/20/2021 |
0.7.3 | 1,893 | 9/20/2021 |
0.7.2 | 5,857 | 8/30/2021 |
0.7.1 | 21,594 | 8/25/2021 |
0.7.0 | 13,984 | 7/22/2021 |
0.6.2 | 1,846 | 7/22/2021 |
0.6.1 | 8,841 | 6/18/2021 |
0.6.0 | 20,916 | 6/10/2021 |
0.5.6 | 22,324 | 5/21/2021 |
0.5.5 | 2,123 | 5/20/2021 |
0.5.4 | 9,531 | 4/28/2021 |
0.5.3 | 41,743 | 3/24/2021 |
0.5.2 | 1,940 | 3/19/2021 |
0.5.1 | 1,435 | 3/18/2021 |
0.5.0 | 7,480 | 2/26/2021 |
0.4.3 | 9,858 | 1/28/2021 |
0.4.2 | 2,375 | 1/20/2021 |
0.3.4 | 25,540 | 12/3/2020 |
0.3.3 | 7,529 | 10/31/2020 |
0.3.2 | 18,786 | 10/5/2020 |
0.3.0 | 1,945 | 8/28/2020 |
0.2.4 | 1,512 | 8/24/2020 |
0.2.3 | 11,271 | 2/16/2020 |
0.2.2 | 3,879 | 12/17/2019 |
0.2.1 | 8,983 | 11/26/2019 |
0.2.0 | 3,239 | 10/31/2019 |
0.1.0 | 1,563 | 7/26/2019 |