Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .config/dotnet-tools.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"isRoot": true,
"tools": {
"dotnet-reportgenerator-globaltool": {
"version": "5.4.3",
"version": "5.5.0",
"commands": [
"reportgenerator"
],
Expand Down
1 change: 1 addition & 0 deletions .github/workflows/dotnet.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ jobs:
dotnet-version: |
8.0.x
9.0.x
10.0.x
- name: Restore dependencies
run: dotnet restore
- name: Build
Expand Down
58 changes: 28 additions & 30 deletions GraphHealthChecks.Tests/GraphHealthChecks.Tests.csproj
Original file line number Diff line number Diff line change
@@ -1,36 +1,34 @@
<Project Sdk="Microsoft.NET.Sdk">

<PropertyGroup>
<TargetFrameworks>net8.0;net9.0</TargetFrameworks>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<IsPackable>false</IsPackable>
<IsTestProject>true</IsTestProject>
</PropertyGroup>
<PropertyGroup>
<TargetFrameworks>net8.0;net9.0;net10.0</TargetFrameworks>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<IsPackable>false</IsPackable>
<IsTestProject>true</IsTestProject>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="HotChocolate.AspNetCore" Version="15.0.3"/>
<PackageReference Include="HotChocolate.AspNetCore.Authorization" Version="15.0.3"/>
<PackageReference Include="ILogger.Moq" Version="1.1.10"/>
<PackageReference Include="Moq" Version="[4.18.4]"/>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.12.0"/>
<PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks" Version="9.0.1"/>
<PackageReference Include="Moq.Contrib.HttpClient" Version="1.4.0"/>
<PackageReference Include="System.Text.Json" Version="9.0.1"/>
<PackageReference Include="xunit" Version="2.9.3"/>
<PackageReference Include="xunit.runner.visualstudio" Version="3.0.2">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="coverlet.msbuild" Version="6.0.4">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="Snapshooter.Xunit" Version="1.0.1"/>
</ItemGroup>
<ItemGroup>
<PackageReference Include="HotChocolate.AspNetCore" Version="15.1.11" />
<PackageReference Include="HotChocolate.AspNetCore.Authorization" Version="15.1.11" />
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="18.0.1" />
<PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks" Version="10.0.0" />
<PackageReference Include="NSubstitute" Version="5.3.0" />
<PackageReference Include="System.Text.Json" Version="10.0.0" />
<PackageReference Include="xunit" Version="2.9.3" />
<PackageReference Include="xunit.runner.visualstudio" Version="3.1.5">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="coverlet.msbuild" Version="6.0.4">
<PrivateAssets>all</PrivateAssets>
<IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
</PackageReference>
<PackageReference Include="Snapshooter.Xunit" Version="1.0.1" />
</ItemGroup>

<ItemGroup>
<ProjectReference Include="..\GraphHealthChecks\GraphHealthChecks.csproj"/>
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\GraphHealthChecks\GraphHealthChecks.csproj" />
</ItemGroup>

</Project>
103 changes: 70 additions & 33 deletions GraphHealthChecks.Tests/GraphQLHealthCheckTests.cs
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
using Microsoft.Extensions.DependencyInjection;
using Microsoft.Extensions.Diagnostics.HealthChecks;
using Microsoft.Extensions.Logging;
using NSubstitute.ExceptionExtensions;
using Snapshooter.Xunit;

namespace GraphHealthChecks.Tests;
Expand All @@ -24,12 +25,12 @@ private static object GetErrorResult(HealthCheckResult result) =>
[Fact(DisplayName = "GraphQLHealthCheck - No Logger - Unhealthy Schema")]
public async Task NoLoggerUnhealthySchema()
{
var mockRequestExecutorResolver = new Mock<IRequestExecutorResolver>();
var mockRequestExecutorResolver = Substitute.For<IRequestExecutorResolver>();
mockRequestExecutorResolver
.Setup(m => m.GetRequestExecutorAsync(It.IsAny<string?>(), It.IsAny<CancellationToken>()))
.ThrowsAsync(new SchemaException());
.GetRequestExecutorAsync(Arg.Any<string?>(), Arg.Any<CancellationToken>())
.Throws(new SchemaException());

var result = await new GraphHealthCheck(mockRequestExecutorResolver.Object)
var result = await new GraphHealthCheck(mockRequestExecutorResolver)
.CheckHealthAsync(null!);

Assert.Equal(HealthStatus.Unhealthy, result.Status);
Expand All @@ -41,12 +42,12 @@ public async Task NoLoggerUnhealthySchema()
[Fact(DisplayName = "GraphQLHealthCheck - No Logger - General Error")]
public async Task NoLoggerGeneralError()
{
var mockRequestExecutorResolver = new Mock<IRequestExecutorResolver>();
var mockRequestExecutorResolver = Substitute.For<IRequestExecutorResolver>();
mockRequestExecutorResolver
.Setup(m => m.GetRequestExecutorAsync(It.IsAny<string?>(), It.IsAny<CancellationToken>()))
.ThrowsAsync(new Exception("Splash!"));
.GetRequestExecutorAsync(Arg.Any<string?>(), Arg.Any<CancellationToken>())
.Throws(new Exception("Splash!"));

var result = await new GraphHealthCheck(mockRequestExecutorResolver.Object).CheckHealthAsync(null!);
var result = await new GraphHealthCheck(mockRequestExecutorResolver).CheckHealthAsync(null!);

Assert.Equal(HealthStatus.Unhealthy, result.Status);
Assert.IsAssignableFrom<Exception>(result.Exception);
Expand Down Expand Up @@ -76,15 +77,15 @@ public async Task NoLoggerHealthy()
[Fact(DisplayName = "GraphQLHealthCheck - ILogger - General Error")]
public async Task ILoggerGeneralError()
{
var mockLogger = new Mock<ILogger<GraphHealthCheck>>();
var mockResolver = new Mock<IRequestExecutorResolver>();
var mockLogger = Substitute.For<ILogger<GraphHealthCheck>>();
var mockResolver = Substitute.For<IRequestExecutorResolver>();
mockResolver
.Setup(m => m.GetRequestExecutorAsync(It.IsAny<string>(), It.IsAny<CancellationToken>()))
.ThrowsAsync(new Exception("Splash!"));
.GetRequestExecutorAsync(Arg.Any<string>(), Arg.Any<CancellationToken>())
.Throws(new Exception("Splash!"));

var result = await new GraphHealthCheck(
mockResolver.Object,
mockLogger.Object
mockResolver,
mockLogger
)
.CheckHealthAsync(null!);

Expand All @@ -93,15 +94,21 @@ public async Task ILoggerGeneralError()
Assert.NotNull(result.Description);
Assert.Contains("general", result.Description);

mockLogger.VerifyLog(m => m.LogError(It.IsAny<Exception?>(), It.IsAny<string?>(), It.IsAny<object>()), Times.Once);
mockLogger.Received(1).Log(
LogLevel.Error,
Arg.Any<EventId>(),
Arg.Any<object>(),
Arg.Is<Exception>(x => x.Message == "Splash!"),
Arg.Any<Func<object, Exception?, string>>()
);

GetErrorResult(result).MatchSnapshot();
}

[Fact(DisplayName = "GraphQLHealthCheck - ILogger - Unhealthy Schema")]
public async Task ILoggerUnhealthySchema()
{
var mockLogger = new Mock<ILogger<GraphHealthCheck>>();
var mockLogger = Substitute.For<ILogger<GraphHealthCheck>>();

var result = await new GraphHealthCheck(
new ServiceCollection()
Expand All @@ -110,7 +117,7 @@ public async Task ILoggerUnhealthySchema()
.Services
.BuildServiceProvider()
.GetRequiredService<IRequestExecutorResolver>(),
mockLogger.Object
mockLogger
)
.CheckHealthAsync(null!);

Expand All @@ -119,15 +126,21 @@ public async Task ILoggerUnhealthySchema()
Assert.NotNull(result.Description);
Assert.Contains("schema", result.Description);

mockLogger.VerifyLog(m => m.LogError(It.IsAny<SchemaException?>(), It.IsAny<string?>(), It.IsAny<object>()), Times.Once);
mockLogger.Received(1).Log(
LogLevel.Error,
Arg.Any<EventId>(),
Arg.Any<object>(),
Arg.Any<SchemaException>(),
Arg.Any<Func<object, Exception?, string>>()
);

GetErrorResult(result).MatchSnapshot();
}

[Fact(DisplayName = "GraphQLHealthCheck - ILogger - Unhealthy Schema - No Auth")]
public async Task ILoggerUnhealthySchemaNoAuth()
{
var mockLogger = new Mock<ILogger<GraphHealthCheck>>();
var mockLogger = Substitute.For<ILogger<GraphHealthCheck>>();

var result = await new GraphHealthCheck(
new ServiceCollection()
Expand All @@ -136,7 +149,7 @@ public async Task ILoggerUnhealthySchemaNoAuth()
.Services
.BuildServiceProvider()
.GetRequiredService<IRequestExecutorResolver>(),
mockLogger.Object
mockLogger
)
.CheckHealthAsync(null!);

Expand All @@ -145,35 +158,47 @@ public async Task ILoggerUnhealthySchemaNoAuth()
Assert.NotNull(result.Description);
Assert.Contains("schema", result.Description);

mockLogger.VerifyLog(m => m.LogError(It.IsAny<SchemaException?>(), It.IsAny<string?>(), It.IsAny<object>()), Times.Once);
mockLogger.Received(1).Log(
LogLevel.Error,
Arg.Any<EventId>(),
Arg.Any<object>(),
Arg.Any<SchemaException>(),
Arg.Any<Func<object, Exception?, string>>()
);

GetErrorResult(result).MatchSnapshot();
}

[Fact(DisplayName = "GraphQLHealthCheck - ILogger - Unhealthy Schema - No Auth - General Error")]
public async Task ILoggerUnhealthySchemaNoAuthGeneralError()
{
var mockLogger = new Mock<ILogger<GraphHealthCheck>>();
var mockRequestExecutorResolver = new Mock<IRequestExecutorResolver>();
var mockLogger = Substitute.For<ILogger<GraphHealthCheck>>();
var mockRequestExecutorResolver = Substitute.For<IRequestExecutorResolver>();
mockRequestExecutorResolver
.Setup(m => m.GetRequestExecutorAsync(It.IsAny<string?>(), It.IsAny<CancellationToken>()))
.ThrowsAsync(new Exception("Splash!"));
.GetRequestExecutorAsync(Arg.Any<string?>(), Arg.Any<CancellationToken>())
.Throws(new Exception("Splash!"));

var result = await new GraphHealthCheck(mockRequestExecutorResolver.Object, mockLogger.Object)
var result = await new GraphHealthCheck(mockRequestExecutorResolver, mockLogger)
.CheckHealthAsync(null!);

Assert.Equal(HealthStatus.Unhealthy, result.Status);
Assert.IsAssignableFrom<Exception>(result.Exception);

mockLogger.VerifyLog(m => m.LogError(It.IsAny<Exception?>(), It.IsAny<string?>(), It.IsAny<object>()), Times.Once);
mockLogger.Received(1).Log(
LogLevel.Error,
Arg.Any<EventId>(),
Arg.Any<object>(),
Arg.Is<Exception>(x => x.Message == "Splash!"),
Arg.Any<Func<object, Exception?, string>>()
);

GetErrorResult(result).MatchSnapshot();
}

[Fact(DisplayName = "GraphQLHealthCheck - ILogger - Healthy - Auth")]
public async Task ILoggerHealthyAuth()
{
var mockLogger = new Mock<ILogger<GraphHealthCheck>>();
var mockLogger = Substitute.For<ILogger<GraphHealthCheck>>();

var result = await new GraphHealthCheck(
new ServiceCollection()
Expand All @@ -183,22 +208,28 @@ public async Task ILoggerHealthyAuth()
.Services
.BuildServiceProvider()
.GetRequiredService<IRequestExecutorResolver>(),
mockLogger.Object
mockLogger
)
.CheckHealthAsync(null!);

Assert.Equal(HealthStatus.Healthy, result.Status);
Assert.Null(result.Description);

mockLogger.VerifyLog(m => m.LogError(It.IsAny<SchemaException?>(), It.IsAny<string?>(), It.IsAny<object>()), Times.Never);
mockLogger.Received(0).Log(
LogLevel.Error,
Arg.Any<EventId>(),
Arg.Any<object>(),
Arg.Any<SchemaException>(),
Arg.Any<Func<object, Exception?, string>>()
);

result.MatchSnapshot();
}

[Fact(DisplayName = "GraphQLHealthCheck - ILogger - Healthy")]
public async Task ILoggerHealthy()
{
var mockLogger = new Mock<ILogger<GraphHealthCheck>>();
var mockLogger = Substitute.For<ILogger<GraphHealthCheck>>();

var result = await new GraphHealthCheck(
new ServiceCollection()
Expand All @@ -207,14 +238,20 @@ public async Task ILoggerHealthy()
.Services
.BuildServiceProvider()
.GetRequiredService<IRequestExecutorResolver>(),
mockLogger.Object
mockLogger
)
.CheckHealthAsync(null!);

Assert.Equal(HealthStatus.Healthy, result.Status);
Assert.Null(result.Description);

mockLogger.VerifyLog(m => m.LogError(It.IsAny<SchemaException?>(), It.IsAny<string?>(), It.IsAny<object>()), Times.Never);
mockLogger.Received(0).Log(
LogLevel.Error,
Arg.Any<EventId>(),
Arg.Any<object>(),
Arg.Any<SchemaException>(),
Arg.Any<Func<object, Exception?, string>>()
);

result.MatchSnapshot();
}
Expand Down
2 changes: 1 addition & 1 deletion GraphHealthChecks.Tests/Usings.cs
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
global using Xunit;
global using Moq;
global using NSubstitute;
54 changes: 28 additions & 26 deletions GraphHealthChecks/GraphHealthChecks.csproj
Original file line number Diff line number Diff line change
@@ -1,31 +1,33 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFrameworks>net8.0;net9.0</TargetFrameworks>
<Nullable>enable</Nullable>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
<PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
<PackageId>$(MSBuildProjectName)</PackageId>
<Version>4.0.1</Version>
<Authors>Adamos Fiakkas</Authors>
<Description>Graph Health Checks for HotChocolate</Description>
<Copyright>Adamos Fiakkas</Copyright>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<PackageProjectUrl>https://github.com/fiakkasa/GraphHealthChecks</PackageProjectUrl>
<RepositoryUrl>https://github.com/fiakkasa/GraphHealthChecks</RepositoryUrl>
<RepositoryType>git</RepositoryType>
<PackageReadmeFile>README.md</PackageReadmeFile>
</PropertyGroup>

<ItemGroup>
<None Include="README.md" pack="true" PackagePath="."/>
</ItemGroup>
<PropertyGroup>
<TargetFrameworks>net8.0;net9.0;net10.0</TargetFrameworks>
<Nullable>enable</Nullable>
<GeneratePackageOnBuild>true</GeneratePackageOnBuild>
<PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
<PackageId>$(MSBuildProjectName)</PackageId>
<Version>5.0.0</Version>
<Authors>Adamos Fiakkas</Authors>
<Description>Graph Health Checks for HotChocolate</Description>
<Copyright>Adamos Fiakkas</Copyright>
<PackageLicenseExpression>MIT</PackageLicenseExpression>
<PackageProjectUrl>https://github.com/fiakkasa/GraphHealthChecks</PackageProjectUrl>
<RepositoryUrl>https://github.com/fiakkasa/GraphHealthChecks</RepositoryUrl>
<RepositoryType>git</RepositoryType>
<PackageReadmeFile>README.md</PackageReadmeFile>
</PropertyGroup>

<ItemGroup>
<PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks" Version="9.0.1"/>
<PackageReference Include="HotChocolate.Execution" Version="15.0.3"/>
</ItemGroup>
<ItemGroup>
<None Include="README.md" pack="true" PackagePath="."/>
</ItemGroup>

<ItemGroup>
<PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks" Version="10.0.0" />
<PackageReference Include="HotChocolate.Execution" Version="15.1.11" />
</ItemGroup>

<ItemGroup>
<InternalsVisibleTo Include="GraphHealthChecks.Tests" />
</ItemGroup>

<ItemGroup>
<InternalsVisibleTo Include="GraphHealthChecks.Tests"/>
</ItemGroup>
</Project>
Loading