AWS SNS HealthCheck

.github/workflows/healthchecks_aws_sns_cd.yml

@@ -0,0 +1,26 @@
+name: HealthChecks Aws Sns CD
+
+on:
+  push:
+    tags:
+      - release-aws_sns-*  # Push events to release-aws_sns*
+jobs:
+  build:
+    env:
+      BUILD_CONFIG: Release
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v2
+      with:
+        dotnet-version: 6.0.202
+        include-prerelease: false
+    - name: Restore
+      run: dotnet restore ./src/HealthChecks.Aws.Sns/HealthChecks.Aws.Sns.csproj
+    - name: Build
+      run: dotnet build --no-restore ./src/HealthChecks.Aws.Sns/HealthChecks.Aws.Sns.csproj -c $BUILD_CONFIG
+    - name: Pack
+      run: dotnet pack --no-build ./src/HealthChecks.Aws.Sns/HealthChecks.Aws.Sns.csproj -c $BUILD_CONFIG -o ./artifacts
+    - name: Publish
+      run: dotnet nuget push ./artifacts/AspNetCore.HealthChecks.Aws.Sns.*.nupkg -k ${{secrets.NUGET_API_KEY}} -s https://api.nuget.org/v3/index.json --skip-duplicate

.github/workflows/healthchecks_aws_sns_cd_preview.yml

@@ -0,0 +1,27 @@
+name: HealthChecks Aws Sns Preview CD
+
+on:
+  push:
+    tags:
+      - preview-aws_sns-*
+jobs:
+  build:
+    env:
+      BUILD_CONFIG: Release
+      VERSION_SUFFIX: -rc2.${{ github.run_number }}
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v2
+      with:
+        dotnet-version: 6.0.202
+        include-prerelease: false
+    - name: Restore
+      run: dotnet restore ./src/HealthChecks.Aws.Sns/HealthChecks.Aws.Sns.csproj
+    - name: Build
+      run: dotnet build --no-restore ./src/HealthChecks.Aws.Sns/HealthChecks.Aws.Sns.csproj -c $BUILD_CONFIG
+    - name: Pack
+      run: dotnet pack --no-build ./src/HealthChecks.Aws.Sns/HealthChecks.Aws.Sns.csproj --version-suffix $VERSION_SUFFIX -c $BUILD_CONFIG -o ./artifacts
+    - name: Publish
+      run: dotnet nuget push ./artifacts/AspNetCore.HealthChecks.Aws.Sns.*.nupkg -k ${{secrets.NUGET_API_KEY}} -s https://api.nuget.org/v3/index.json --skip-duplicate

.github/workflows/healthchecks_aws_sns_ci.yml

@@ -0,0 +1,48 @@
+name: HealthChecks Aws Sns CI
+
+on:
+  workflow_dispatch:
+  push:
+   branches: [ master ]
+   paths:
+    - src/HealthChecks.Aws.Sns/**
+    - test/HealthChecks.Aws.Sns.Tests/**
+    - .github/workflows/healthchecks_aws_sns_ci.yml
+    - Directory.Build.props
+    - Directory.Build.targets
+   tags-ignore:
+    - release-*
+
+  pull_request:
+    branches: [ master ]
+    paths:
+    - src/HealthChecks.Aws.Sns/**
+    - test/HealthChecks.Aws.Sns.Tests/**
+    - .github/workflows/healthchecks_aws_sns_ci.yml
+    - Directory.Build.props
+    - Directory.Build.targets
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: Setup .NET
+      uses: actions/setup-dotnet@v2
+      with:
+        dotnet-version: 6.0.202
+        include-prerelease: false
+    - name: Restore
+      run: |
+        dotnet restore ./src/HealthChecks.Aws.Sns/HealthChecks.Aws.Sns.csproj &&
+        dotnet restore ./test/HealthChecks.Aws.Sns.Tests/HealthChecks.Aws.Sns.Tests.csproj
+    - name: Check formatting
+      run: |
+        dotnet format --no-restore --verify-no-changes --severity warn ./src/HealthChecks.Aws.Sns/HealthChecks.Aws.Sns.csproj || (echo "Run 'dotnet format' to fix issues" && exit 1) &&
+        dotnet format --no-restore --verify-no-changes --severity warn ./test/HealthChecks.Aws.Sns.Tests/HealthChecks.Aws.Sns.Tests.csproj || (echo "Run 'dotnet format' to fix issues" && exit 1)
+    - name: Build
+      run: |
+        dotnet build --no-restore ./src/HealthChecks.Aws.Sns/HealthChecks.Aws.Sns.csproj &&
+        dotnet build --no-restore ./test/HealthChecks.Aws.Sns.Tests/HealthChecks.Aws.Sns.Tests.csproj
+    - name: Test
+      run: dotnet test --no-restore --no-build ./test/HealthChecks.Aws.Sns.Tests/HealthChecks.Aws.Sns.Tests.csproj
+

AspNetCore.Diagnostics.HealthChecks.sln

@@ -242,6 +242,9 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "workflows", "workflows", "{
 		.github\workflows\healthchecks_aws_secretsmanager_cd.yml = .github\workflows\healthchecks_aws_secretsmanager_cd.yml
 		.github\workflows\healthchecks_aws_secretsmanager_cd_preview.yml = .github\workflows\healthchecks_aws_secretsmanager_cd_preview.yml
 		.github\workflows\healthchecks_aws_secretsmanager_ci.yml = .github\workflows\healthchecks_aws_secretsmanager_ci.yml
+		.github\workflows\healthchecks_aws_sns_cd.yml = .github\workflows\healthchecks_aws_sns_cd.yml
+		.github\workflows\healthchecks_aws_sns_cd_preview.yml = .github\workflows\healthchecks_aws_sns_cd_preview.yml
+		.github\workflows\healthchecks_aws_sns_ci.yml = .github\workflows\healthchecks_aws_sns_ci.yml
 		.github\workflows\healthchecks_aws_sqs_cd.yml = .github\workflows\healthchecks_aws_sqs_cd.yml
 		.github\workflows\healthchecks_aws_sqs_cd_preview.yml = .github\workflows\healthchecks_aws_sqs_cd_preview.yml
 		.github\workflows\healthchecks_aws_sqs_ci.yml = .github\workflows\healthchecks_aws_sqs_ci.yml
@@ -376,6 +379,9 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "HealthChecks.Aws.SystemsMan
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "HealthChecks.AzureDigitalTwin.Tests", "test\HealthChecks.AzureDigitalTwin.Tests\HealthChecks.AzureDigitalTwin.Tests.csproj", "{7052C706-4B1A-4167-A33A-DF3E9FBCFE6B}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "HealthChecks.Aws.Sns", "src\HealthChecks.Aws.Sns\HealthChecks.Aws.Sns.csproj", "{38EB0FC4-C1D2-47D9-AE35-607DE14984CB}"
+EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "HealthChecks.Aws.Sns.Tests", "test\HealthChecks.Aws.Sns.Tests\HealthChecks.Aws.Sns.Tests.csproj", "{52539C76-F5C6-48D7-A03F-57DD1850BDEF}"
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "HealthChecks.Aws.Sqs", "src\HealthChecks.Aws.Sqs\HealthChecks.Aws.Sqs.csproj", "{3E28B63C-814E-46C9-ADBF-7357997148F5}"
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "HealthChecks.Aws.Sqs.Tests", "test\HealthChecks.Aws.Sqs.Tests\HealthChecks.Aws.Sqs.Tests.csproj", "{EFA76A2C-CA0E-42BC-8215-AEEB16414947}"
@@ -802,6 +808,14 @@ Global
 		{7052C706-4B1A-4167-A33A-DF3E9FBCFE6B}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{7052C706-4B1A-4167-A33A-DF3E9FBCFE6B}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{7052C706-4B1A-4167-A33A-DF3E9FBCFE6B}.Release|Any CPU.Build.0 = Release|Any CPU
+		{38EB0FC4-C1D2-47D9-AE35-607DE14984CB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{38EB0FC4-C1D2-47D9-AE35-607DE14984CB}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{38EB0FC4-C1D2-47D9-AE35-607DE14984CB}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{38EB0FC4-C1D2-47D9-AE35-607DE14984CB}.Release|Any CPU.Build.0 = Release|Any CPU
+		{52539C76-F5C6-48D7-A03F-57DD1850BDEF}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{52539C76-F5C6-48D7-A03F-57DD1850BDEF}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{52539C76-F5C6-48D7-A03F-57DD1850BDEF}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{52539C76-F5C6-48D7-A03F-57DD1850BDEF}.Release|Any CPU.Build.0 = Release|Any CPU
 		{3E28B63C-814E-46C9-ADBF-7357997148F5}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
 		{3E28B63C-814E-46C9-ADBF-7357997148F5}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{3E28B63C-814E-46C9-ADBF-7357997148F5}.Release|Any CPU.ActiveCfg = Release|Any CPU
@@ -920,6 +934,8 @@ Global
 		{FF492215-60BC-40C6-B118-D22DF9063547} = {2A3FD988-2BB8-43CF-B3A2-B70E648259D4}
 		{247EF2E5-F4B9-47D4-BB89-27860DF53D5F} = {FF4414C2-8863-4ADA-8A1D-4B9F25C361FE}
 		{7052C706-4B1A-4167-A33A-DF3E9FBCFE6B} = {FF4414C2-8863-4ADA-8A1D-4B9F25C361FE}
+		{38EB0FC4-C1D2-47D9-AE35-607DE14984CB} = {2A3FD988-2BB8-43CF-B3A2-B70E648259D4}
+		{52539C76-F5C6-48D7-A03F-57DD1850BDEF} = {FF4414C2-8863-4ADA-8A1D-4B9F25C361FE}
 		{3E28B63C-814E-46C9-ADBF-7357997148F5} = {2A3FD988-2BB8-43CF-B3A2-B70E648259D4}
 		{EFA76A2C-CA0E-42BC-8215-AEEB16414947} = {FF4414C2-8863-4ADA-8A1D-4B9F25C361FE}
 	EndGlobalSection

README.md

@@ -1,6 +1,7 @@
 [![ArangoDb Build status](https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/actions/workflows/healthchecks_arangodb_ci.yml/badge.svg)](https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/actions/workflows/healthchecks_arangodb_ci.yml)
 [![Aws S3 Build status](https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/actions/workflows/healthchecks_aws_s3_ci.yml/badge.svg)](https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/actions/workflows/healthchecks_aws_s3_ci.yml)
 [![Aws SecretsManager Build status](https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/actions/workflows/healthchecks_aws_secretsmanager_ci.yml/badge.svg)](https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/actions/workflows/healthchecks_aws_secretsmanager_ci.yml)
+[![Aws Sns Build status](https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/actions/workflows/healthchecks_aws_sns_ci.yml/badge.svg)](https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/actions/workflows/healthchecks_aws_sns_ci.yml)
 [![Aws Sqs Build status](https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/actions/workflows/healthchecks_aws_sqs_ci.yml/badge.svg)](https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/actions/workflows/healthchecks_aws_sqs_ci.yml)
 [![Aws SystemsManager Build status](https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/actions/workflows/healthchecks_aws_systemsmanager_ci.yml/badge.svg)](https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/actions/workflows/healthchecks_aws_systemsmanager_ci.yml)
 [![Azure IoTHub Build status](https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/actions/workflows/healthchecks_azure_iothub_ci.yml/badge.svg)](https://github.com/Xabaril/AspNetCore.Diagnostics.HealthChecks/actions/workflows/healthchecks_azure_iothub_ci.yml)
@@ -99,7 +100,8 @@ HealthChecks packages include health checks for:
 | ArangoDB               | [![Nuget](https://img.shields.io/nuget/dt/AspNetCore.HealthChecks.ArangoDb)](https://www.nuget.org/packages/AspNetCore.HealthChecks.ArangoDb)                       |
 | Amazon S3              | [![Nuget](https://img.shields.io/nuget/dt/AspNetCore.HealthChecks.Aws.S3)](https://www.nuget.org/packages/AspNetCore.HealthChecks.Aws.S3)                           |
 | Amazon Secrets Manager | [![Nuget](https://img.shields.io/nuget/dt/AspNetCore.HealthChecks.Aws.SecretsManager)](https://www.nuget.org/packages/AspNetCore.HealthChecks.Aws.SecretsManager)   |
-| Amazon SQS | [![Nuget](https://img.shields.io/nuget/dt/AspNetCore.HealthChecks.Aws.Sqs)](https://www.nuget.org/packages/AspNetCore.HealthChecks.Aws.Sqs)   |
+| Amazon SNS             | [![Nuget](https://img.shields.io/nuget/dt/AspNetCore.HealthChecks.Aws.Sns)](https://www.nuget.org/packages/AspNetCore.HealthChecks.Aws.Sns)                         |
+| Amazon SQS             | [![Nuget](https://img.shields.io/nuget/dt/AspNetCore.HealthChecks.Aws.Sqs)](https://www.nuget.org/packages/AspNetCore.HealthChecks.Aws.Sqs)                         |
 | Amazon Systems Manager | [![Nuget](https://img.shields.io/nuget/dt/AspNetCore.HealthChecks.Aws.SystemsManager)](https://www.nuget.org/packages/AspNetCore.HealthChecks.Aws.SystemsManager)   |
 | Azure IoT Hub          | [![Nuget](https://img.shields.io/nuget/dt/AspNetCore.HealthChecks.Azure.IoTHub)](https://www.nuget.org/packages/AspNetCore.HealthChecks.Azure.IoTHub)               |
 | Azure DigitalTwin      | [![Nuget](https://img.shields.io/nuget/dt/AspNetCore.HealthChecks.AzureDigitalTwin)](https://www.nuget.org/packages/AspNetCore.HealthChecks.AzureDigitalTwin)       | Subscription status, models and instances                              |
@@ -142,6 +144,8 @@ HealthChecks packages include health checks for:
 Install-Package AspNetCore.HealthChecks.ArangoDb
 Install-Package AspNetCore.HealthChecks.Aws.S3
 Install-Package AspNetCore.HealthChecks.Aws.SecretsManager
+Install-Package AspNetCore.HealthChecks.Aws.Sns
+Install-Package AspNetCore.HealthChecks.Aws.Sqs
 Install-Package AspNetCore.HealthChecks.Aws.SystemsManager
 Install-Package AspNetCore.HealthChecks.Azure.IoTHub
 Install-Package AspNetCore.HealthChecks.AzureDigitalTwin

build.ps1

@@ -117,6 +117,7 @@ if ($suffix -eq "") {
     exec { & dotnet pack .\src\HealthChecks.AzureDigitalTwin\HealthChecks.AzureDigitalTwin.csproj -c Release -o .\artifacts --include-symbols --no-build }
     exec { & dotnet pack .\src\HealthChecks.Aws.SecretsManager\HealthChecks.Aws.SecretsManager.csproj -c Release -o .\artifacts --include-symbols --no-build }
     exec { & dotnet pack .\src\HealthChecks.Aws.SystemsManager\HealthChecks.Aws.SystemsManager.csproj -c Release -o .\artifacts --include-symbols --no-build }
+    exec { & dotnet pack .\src\HealthChecks.Aws.Sns\HealthChecks.Aws.Sns.csproj -c Release -o .\artifacts --include-symbols --no-build }
     exec { & dotnet pack .\src\HealthChecks.Aws.Sqs\HealthChecks.Aws.Sqs.csproj -c Release -o .\artifacts --include-symbols --no-build }
 }
 
@@ -172,5 +173,6 @@ else {
     exec { & dotnet pack .\src\HealthChecks.AzureDigitalTwin\HealthChecks.AzureDigitalTwin.csproj -c Release -o .\artifacts --include-symbols --no-build --version-suffix=$suffix }
     exec { & dotnet pack .\src\HealthChecks.Aws.SecretsManager\HealthChecks.Aws.SecretsManager.csproj -c Release -o .\artifacts --include-symbols --no-build --version-suffix=$suffix }
     exec { & dotnet pack .\src\HealthChecks.Aws.SystemsManager\HealthChecks.Aws.SystemsManager.csproj -c Release -o .\artifacts --include-symbols --no-build --version-suffix=$suffix }
+    exec { & dotnet pack .\src\HealthChecks.Aws.Sns\HealthChecks.Aws.Sns.csproj -c Release -o .\artifacts --include-symbols --no-build --version-suffix=$suffix }
     exec { & dotnet pack .\src\HealthChecks.Aws.Sqs\HealthChecks.Aws.Sqs.csproj -c Release -o .\artifacts --include-symbols --no-build --version-suffix=$suffix }
 }

build/dependencies.props

@@ -9,6 +9,7 @@
     <HealthCheckArangoDb>6.0.2</HealthCheckArangoDb>
     <HealthCheckAWSS3>6.0.2</HealthCheckAWSS3>
     <HealthCheckAWSSecretsManager>6.0.0</HealthCheckAWSSecretsManager>
+    <HealthCheckAWSSns>6.0.0</HealthCheckAWSSns>
     <HealthCheckAWSSqs>6.0.0</HealthCheckAWSSqs>
     <HealthCheckAWSSystemsManager>6.0.0</HealthCheckAWSSystemsManager>
     <HealthCheckAzureDigitalTwin>6.0.0</HealthCheckAzureDigitalTwin>

src/HealthChecks.Aws.Sns/DependencyInjection/SnsHealthCheckBuilderExtensions.cs

@@ -0,0 +1,79 @@
+using HealthChecks.Aws.Sns;
+using Microsoft.Extensions.Diagnostics.HealthChecks;
+
+namespace Microsoft.Extensions.DependencyInjection
+{
+    /// <summary>
+    /// Extension methods to configure <see cref="SnsTopicHealthCheck"/> and <see cref="SnsSubscriptionHealthCheck"/>.
+    /// </summary>
+    public static class SnsHealthCheckBuilderExtensions
+    {
+        private const string AWS_NAME_SNS = "aws sns";
+
+        private const string AWS_NAME_SNS_SUBS = "aws sns subs";
+
+        /// <summary>
+        /// Add a health check for AWS SNS Topic.
+        /// </summary>
+        /// <param name="builder">The <see cref="IHealthChecksBuilder"/>.</param>
+        /// <param name="setup">The action to configure the SNS connection parameters.</param>
+        /// <param name="name">The health check name. Optional. If <c>null</c> the type name 'aws sns' will be used for the name.</param>
+        /// <param name="failureStatus">
+        /// The <see cref="HealthStatus"/> that should be reported when the health check fails. Optional. If <c>null</c> then
+        /// the default status of <see cref="HealthStatus.Unhealthy"/> will be reported.
+        /// </param>
+        /// <param name="tags">A list of tags that can be used to filter sets of health checks. Optional.</param>
+        /// <param name="timeout">An optional <see cref="TimeSpan"/> representing the timeout of the check.</param>
+        /// <returns>The specified <paramref name="builder"/>.</returns>
+        public static IHealthChecksBuilder AddSnsTopics(
+            this IHealthChecksBuilder builder,
+            Action<SnsOptions>? setup,
+            string? name = default,
+            HealthStatus? failureStatus = default,
+            IEnumerable<string>? tags = default,
+            TimeSpan? timeout = default)
+        {
+            var options = new SnsOptions();
+            setup?.Invoke(options);
+
+            return builder.Add(new HealthCheckRegistration(
+                name ?? AWS_NAME_SNS,
+                sp => new SnsTopicHealthCheck(options),
+                failureStatus,
+                tags,
+                timeout));
+        }
+
+        /// <summary>
+        /// Add a health check for AWS SNS Subscription.
+        /// </summary>
+        /// <param name="builder">The <see cref="IHealthChecksBuilder"/>.</param>
+        /// <param name="setup">The action to configure the SNS connection parameters.</param>
+        /// <param name="name">The health check name. Optional. If <c>null</c> the type name 'aws sns' will be used for the name.</param>
+        /// <param name="failureStatus">
+        /// The <see cref="HealthStatus"/> that should be reported when the health check fails. Optional. If <c>null</c> then
+        /// the default status of <see cref="HealthStatus.Unhealthy"/> will be reported.
+        /// </param>
+        /// <param name="tags">A list of tags that can be used to filter sets of health checks. Optional.</param>
+        /// <param name="timeout">An optional <see cref="TimeSpan"/> representing the timeout of the check.</param>
+        /// <returns>The specified <paramref name="builder"/>.</returns>
+        public static IHealthChecksBuilder AddSnsSubscriptions(
+            this IHealthChecksBuilder builder,
+            Action<SnsOptions>? setup,
+            string? name = default,
+            HealthStatus? failureStatus = default,
+            IEnumerable<string>? tags = default,
+            TimeSpan? timeout = default)
+        {
+            var options = new SnsOptions();
+            setup?.Invoke(options);
+
+            return builder.Add(new HealthCheckRegistration(
+                name ?? AWS_NAME_SNS_SUBS,
+                sp => new SnsSubscriptionHealthCheck(options),
+                failureStatus,
+                tags,
+                timeout));
+        }
+    }
+}

src/HealthChecks.Aws.Sns/HealthChecks.Aws.Sns.csproj

@@ -0,0 +1,15 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <TargetFrameworks>$(NetFrameworkVersion);$(NetStandardVersion)</TargetFrameworks>
+    <PackageTags>HealthCheck;AWS;SNS;Amazon Simple Notification Service</PackageTags>
+    <Description>HealthChecks.Aws.Sns is the health check package for Amazon Simple Notification Service.</Description>
+    <Version>$(HealthCheckAWSSns)</Version>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="AWSSDK.SimpleNotificationService" Version="3.7.3.50" />
+    <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks" Version="6.0.3" />
+  </ItemGroup>
+
+</Project>