Feature/net 6

dotnet-tools.json → .config/dotnet-tools.json

@@ -3,10 +3,10 @@
   "isRoot": true,
   "tools": {
     "cake.tool": {
-      "version": "1.3.0",
+      "version": "2.2.0",
       "commands": [
         "dotnet-cake"
       ]
     }
   }
-}
+}

.github/SECURITY.md

@@ -6,4 +6,4 @@ This project supports only the latest version with security updates. However, we
 
 ## Reporting a Vulnerability
 
-Contact [user@example.com|@ExampleUser] to report a security vulnerability. You will be thanked!
+Contact mihail.merkulov@gmail.com to report a security vulnerability. You will be thanked!

.github/workflows/build.yml

@@ -19,17 +19,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
       with:
         lfs: true
         fetch-depth: 0
     - name: 'Git Fetch Tags'
       run: git fetch --tags
       shell: pwsh
     - name: 'Install .NET Core SDK'
-      uses: actions/setup-dotnet@v1
+      uses: actions/setup-dotnet@v2
       with:
-        dotnet-version: 3.1.x
+        dotnet-version: '6.0.x'
     - name: 'Dotnet Tool Restore'
       run: dotnet tool restore
       shell: pwsh
@@ -38,17 +38,38 @@ jobs:
       shell: pwsh
     - name: 'Dotnet Cake Test'
       run: dotnet cake --target=Test
-      shell: pwsh
-    - name: 'Dotnet Cake Pack'
-      run: dotnet cake --target=Pack
-      shell: pwsh
+      shell: pwsh    
+    - name: Copy Coverage To Predictable Location
+      if: github.event_name == 'pull_request'
+      run: cp coverage/*/coverage.opencover.xml coverage/coverage.opencover.xml
     - name: 'Publish Code Coverage'
       uses: actions/upload-artifact@v2
       with:
         name: tests
-        path: './Artefacts/**/coverage.opencover.xml'
+        path: './coverage/coverage.opencover.xml'
     - name: 'Publish Test Results'
       uses: actions/upload-artifact@v2
       with:
         name: tests
-        path: './Artefacts/VaultSharp.Extensions.Configuration.Test.html'
+        path: './coverage/VaultSharp.Extensions.Configuration.Test.html'
+    # - name: Code Coverage Summary Report
+    #   if: github.event_name == 'pull_request'
+    #   uses: irongut/CodeCoverageSummary@v1.2.0
+    #   with:
+    #     filename: coverage/coverage.opencover.xml
+    #     badge: true
+    #     fail_below_min: true
+    #     format: markdown
+    #     hide_branch_rate: false
+    #     hide_complexity: true
+    #     indicators: true
+    #     output: both
+    # - name: Add Coverage PR Comment
+    #   uses: marocchino/sticky-pull-request-comment@v2
+    #   if: github.event_name == 'pull_request'
+    #   with:
+    #     recreate: true
+    #     path: code-coverage-results.md
+    - name: 'Dotnet Cake Pack'
+      run: dotnet cake --target=Pack
+      shell: pwsh

.github/workflows/release.yml

@@ -11,17 +11,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
     - name: Checkout
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
       with:
         lfs: true
         fetch-depth: 0
     - name: 'Git Fetch Tags'
       run: git fetch --tags
       shell: pwsh
     - name: 'Install .NET Core SDK'
-      uses: actions/setup-dotnet@v1
+      uses: actions/setup-dotnet@v2
       with:
-        dotnet-version: 3.1.x
+        dotnet-version: '6.0.x'
     - name: 'Dotnet Tool Restore'
       run: dotnet tool restore
       shell: pwsh

.gitignore

@@ -354,3 +354,4 @@ MigrationBackup/
 .ionide/
 
 Artefacts/
+coverage/

Directory.Build.props

@@ -7,18 +7,16 @@
   <PropertyGroup Label="Package">
     <Authors>Mikhail Merkulov</Authors>
     <Company>Mikhail Merkulov</Company>
-    <Copyright>Copyright 2020 © Mikhail Merkulov. All rights Reserved</Copyright>
+    <Copyright>Copyright 2022 © Mikhail Merkulov. All rights Reserved</Copyright>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageProjectUrl>https://github.com/MrZoidberg/VaultSharp.Extensions.Configuration</PackageProjectUrl>
     <RepositoryUrl>https://github.com/MrZoidberg/VaultSharp.Extensions.Configuration.git</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <PackageReleaseNotes>https://github.com/MrZoidberg/VaultSharp.Extensions.Configuration/releases</PackageReleaseNotes>
   </PropertyGroup>
-  <ItemGroup Label="Package References">
-    <PackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" PrivateAssets="All" Version="5.0.3" />
-    <PackageReference Include="Microsoft.VisualStudio.Threading.Analyzers" PrivateAssets="All" Version="16.10.56" />
-    <PackageReference Include="MinVer" PrivateAssets="All" Version="2.5.0" />
-    <PackageReference Include="StyleCop.Analyzers" PrivateAssets="All" Version="1.1.118" />
-  </ItemGroup>
-</Project>
+
+  <PropertyGroup Condition="'$(GITHUB_ACTIONS)' == 'true'">
+    <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
+  </PropertyGroup>
+</Project>

LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 Project Author
+Copyright (c) 2022 Mikhail Merkulov
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -4,6 +4,8 @@
 
 VaultSharp.Extensions.Configuration is an extension to [VaultSharp](https://github.com/rajanadar/VaultSharp) that allows reading configuration options from Vault.
 
+VaultSharp.Extensions.Configuration is a .NET Standard 2.1 and .NET 6.0 based cross-platform C# Library.
+
 ## Get Started
 
 VaultSharp.Extensions.Configuration can be installed using the Nuget package manager or the dotnet CLI.
@@ -67,8 +69,10 @@ Keep in mind that your service should be registered as scoped or transient to re
 Also `IOptionsSnapshot` can return empty value in some cases ([it's .net core bug](https://github.com/dotnet/runtime/issues/37860))
 
 ## Configuration using additional characters for a configuration path
+
 This will be helpful when you want to flatten the structure of the secrets.
-For example the following two secret objects will evaluate to the same configuration if for the second object the `additionalCharactersForConfigurationPath` option is used with `new []{'.'}` value: 
+For example the following two secret objects will evaluate to the same configuration if for the second object the `additionalCharactersForConfigurationPath` option is used with `new []{'.'}` value:
+
 ```json
 {
     "secrets":
@@ -80,6 +84,7 @@ For example the following two secret objects will evaluate to the same configura
     }
 }
 ```
+
 ```json
 {
     "secrets":
@@ -128,7 +133,7 @@ All parameters are grouped and arranged in folders and can be managed within the
 
 There are two ways to create nested parameters.
 
-1. Description of nesting directly in Json format:
+1. Description of nesting directly in Json format (preferred approach):
 
 ```json
 {

Source/Directory.Build.props

@@ -20,8 +20,4 @@
     <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
   </PropertyGroup>
 
-  <ItemGroup Label="Package References">
-    <PackageReference Include="Microsoft.SourceLink.GitHub" PrivateAssets="All" Version="1.0.0" />
-  </ItemGroup>
-
 </Project>

Source/SampleWebApp/Controllers/HelloController.cs

@@ -0,0 +1,13 @@
+namespace SampleWebApp.Controllers;
+
+using Microsoft.AspNetCore.Mvc;
+using Microsoft.Extensions.Options;
+using Options;
+
+[Route("hello")]
+[ApiController]
+public class HelloController
+{
+    [HttpGet("")]
+    public IActionResult GetValue([FromServices] IOptionsSnapshot<TestOptions> testOptions) => new OkObjectResult(testOptions.Value);
+}

Source/SampleWebApp/Dockerfile

@@ -1,17 +1,17 @@
-FROM mcr.microsoft.com/dotnet/core/sdk:3.1 AS build-env
+FROM mcr.microsoft.com/dotnet/sdk:6.0 AS build-env
 WORKDIR /app
 
 # Copy csproj and restore as distinct layers
-COPY /SampleWebApp/SampleWebApp.csproj ./SampleWebApp/
-COPY /VaultSharp.Extensions.Configuration/VaultSharp.Extensions.Configuration.csproj ./VaultSharp.Extensions.Configuration/
-RUN dotnet restore ./SampleWebApp/SampleWebApp.csproj
+COPY /Source/SampleWebApp/SampleWebApp.csproj ./Source/SampleWebApp/
+COPY /Source/VaultSharp.Extensions.Configuration/VaultSharp.Extensions.Configuration.csproj ./Source/VaultSharp.Extensions.Configuration/
+RUN dotnet restore ./Source/SampleWebApp/SampleWebApp.csproj
 
 # Copy everything else and build
 COPY . ./
-RUN dotnet publish ./SampleWebApp/SampleWebApp.csproj -c Release -o out
+RUN dotnet publish ./Source/SampleWebApp/SampleWebApp.csproj -c Release -o out
 
 # Build runtime image
-FROM mcr.microsoft.com/dotnet/core/aspnet:3.1
+FROM mcr.microsoft.com/dotnet/aspnet:6.0
 WORKDIR /app
 COPY --from=build-env /app/out .
 ENTRYPOINT ["dotnet", "SampleWebApp.dll"]

Source/SampleWebApp/Options/TestOptions.cs

@@ -0,0 +1,8 @@
+namespace SampleWebApp.Options;
+
+public class TestOptions
+{
+    public const string Test = "Test";
+
+    public string ValueA { get; set; }
+}

Source/SampleWebApp/Program.cs

@@ -1,39 +1,49 @@
-namespace SampleWebApp
+namespace SampleWebApp;
+
+using System;
+using Microsoft.AspNetCore.Hosting;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Logging;
+using VaultSharp.Extensions.Configuration;
+
+public class Program
 {
-    using System;
-    using Microsoft.AspNetCore.Hosting;
-    using Microsoft.Extensions.Configuration;
-    using Microsoft.Extensions.Hosting;
-    using VaultSharp.Extensions.Configuration;
+    public static ILogger Logger { get; private set; }
+
+    public static void Main(string[] args) => CreateHostBuilder(args).Build().Run();
 
-    public class Program
-    {
-        public static void Main(string[] args)
-        {
-            CreateHostBuilder(args).Build().Run();
-        }
+    private static IHostBuilder CreateHostBuilder(string[] args) =>
+        Host.CreateDefaultBuilder(args)
+            .ConfigureLogging((hostingContext, logging) =>
+            {
+                logging.AddConfiguration(hostingContext.Configuration.GetSection("Logging"));
+                logging.AddConsole();
+                logging.AddDebug();
+            })
+            .ConfigureAppConfiguration((hostingContext, config) =>
+            {
+                using var loggerFactory = LoggerFactory.Create(builder =>
+                    builder.AddConsole(c => c.LogToStandardErrorThreshold = LogLevel.Debug).AddDebug());
+                Logger = loggerFactory.CreateLogger<Program>();
 
-        public static IHostBuilder CreateHostBuilder(string[] args) =>
-            Host.CreateDefaultBuilder(args)
-                .ConfigureAppConfiguration((hostingContext, config) =>
-                {
-                    config.AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
-                        .AddJsonFile(
-                            $"appsettings.{Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT") ?? "Development"}.json",
-                            optional: true)
-                        .AddEnvironmentVariables()
-                        .AddVaultConfiguration(
-                            () => new VaultOptions(
-                                "http://localhost:8200",
-                                "root",
-                                reloadOnChange: true,
-                                reloadCheckIntervalSeconds: 60),
-                            "sampleapp",
-                            "secret");
-                })
-                .ConfigureWebHostDefaults(webBuilder =>
-                {
-                    webBuilder.UseStartup<Startup>();
-                });
-    }
+                config.AddJsonFile("appsettings.json", optional: false, reloadOnChange: true)
+                    .AddJsonFile(
+                        $"appsettings.{Environment.GetEnvironmentVariable("ASPNETCORE_ENVIRONMENT") ?? "Development"}.json",
+                        optional: true)
+                    .AddEnvironmentVariables()
+                    .AddVaultConfiguration(
+                        () => new VaultOptions(
+                            "http://vault:8200", // Change this to "http://localhost:8200" if you are working locally without Docker
+                            "root",
+                            reloadOnChange: true,
+                            reloadCheckIntervalSeconds: 60),
+                        "sampleapp",
+                        "secret",
+                        Logger);
+            })
+            .ConfigureWebHostDefaults(webBuilder =>
+            {
+                webBuilder.UseStartup<Startup>();
+            });
 }

Source/SampleWebApp/SampleWebApp.csproj

@@ -1,16 +1,26 @@
 <Project Sdk="Microsoft.NET.Sdk.Web">
 
     <PropertyGroup>
-        <TargetFramework>netcoreapp3.1</TargetFramework>
+        <TargetFramework>net6.0</TargetFramework>
         <TreatWarningsAsErrors>False</TreatWarningsAsErrors>
+        <IsPackable>false</IsPackable>
     </PropertyGroup>
 
     <ItemGroup>
       <ProjectReference Include="..\VaultSharp.Extensions.Configuration\VaultSharp.Extensions.Configuration.csproj" />
     </ItemGroup>
 
     <ItemGroup>
-      <Folder Include="Controllers" />
+      <PackageReference Include="Microsoft.CodeAnalysis.NetAnalyzers" Version="6.0.0">
+        <PrivateAssets>all</PrivateAssets>
+        <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
+      </PackageReference>
+      <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" />
+      <PackageReference Include="Microsoft.VisualStudio.Threading.Analyzers" Version="17.2.32">
+        <PrivateAssets>all</PrivateAssets>
+        <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+      </PackageReference>
+      <PackageReference Include="MinVer" Version="4.1.0" />
     </ItemGroup>