Refactoring to fix #31 (#32)

* Migrated to the latest version of VaultSharp. Migrated to System.Text.Json. Fixed issue #31

* changed year in copyright

* added logs to the integration tests

Author: MrZoidberg

.github/workflows/build.yml

@@ -30,6 +30,9 @@ jobs:
       uses: actions/setup-dotnet@v2
       with:
         dotnet-version: '6.0.x'
+    - name: 'Fix permissions'
+      run: chmod +x ./Tests/VaultSharp.Extensions.Configuration.Test/approle.sh && chmod +x ./Tests/VaultSharp.Extensions.Configuration.Test/approle_nolist.sh
+      shell: bash
     - name: 'Dotnet Tool Restore'
       run: dotnet tool restore
       shell: pwsh

Directory.Build.props

@@ -7,7 +7,7 @@
   <PropertyGroup Label="Package">
     <Authors>Mikhail Merkulov</Authors>
     <Company>Mikhail Merkulov</Company>
-    <Copyright>Copyright 2022 © Mikhail Merkulov. All rights Reserved</Copyright>
+    <Copyright>Copyright 2023 © Mikhail Merkulov. All rights Reserved</Copyright>
     <PackageRequireLicenseAcceptance>true</PackageRequireLicenseAcceptance>
     <PackageLicenseExpression>MIT</PackageLicenseExpression>
     <PackageProjectUrl>https://github.com/MrZoidberg/VaultSharp.Extensions.Configuration</PackageProjectUrl>

Source/VaultSharp.Extensions.Configuration/VaultConfigurationProvider.cs

@@ -19,7 +19,7 @@ public sealed class VaultConfigurationSource : IConfigurationSource
         /// </summary>
         internal const string DefaultVaultToken = "root";
 
-        private readonly ILogger? _logger;
+        private readonly ILogger? logger;
 
         /// <summary>
         /// Initializes a new instance of the <see cref="VaultConfigurationSource"/> class.
@@ -30,7 +30,7 @@ public sealed class VaultConfigurationSource : IConfigurationSource
         /// <param name="logger">Logger instance.</param>
         public VaultConfigurationSource(VaultOptions options, string basePath, string? mountPoint = null, ILogger? logger = null)
         {
-            this._logger = logger;
+            this.logger = logger;
             this.Options = options;
             this.BasePath = basePath;
             this.MountPoint = mountPoint ?? SecretsEngineMountPoints.Defaults.KeyValueV2;
@@ -56,6 +56,6 @@ public VaultConfigurationSource(VaultOptions options, string basePath, string? m
         /// </summary>
         /// <param name="builder">Configuration builder.</param>
         /// <returns>Instance of <see cref="IConfigurationProvider"/>.</returns>
-        public IConfigurationProvider Build(IConfigurationBuilder builder) => new VaultConfigurationProvider(this, this._logger);
+        public IConfigurationProvider Build(IConfigurationBuilder builder) => new VaultConfigurationProvider(this, this.logger);
     }
 }

Source/VaultSharp.Extensions.Configuration/VaultConfigurationSource.cs

@@ -21,6 +21,7 @@ public class VaultOptions
         /// <param name="omitVaultKeyName">Omit Vault Key Name in Configuration Keys.</param>
         /// <param name="additionalCharactersForConfigurationPath">Additional characters for the Configuration path.</param>
         /// <param name="namespace">Vault namespace.</param>
+        /// <param name="alwaysAddTrailingSlashToBasePath">Should a trailing slash be added to the base path. See AlwaysAddTrailingSlashToBasePath property for details </param>
         public VaultOptions(
             string vaultAddress,
             string? vaultToken,
@@ -30,7 +31,8 @@ public VaultOptions(
             int reloadCheckIntervalSeconds = 300,
             bool omitVaultKeyName = false,
             IEnumerable<char>? additionalCharactersForConfigurationPath = null,
-            string? @namespace = null)
+            string? @namespace = null,
+            bool alwaysAddTrailingSlashToBasePath = true)
         {
             this.VaultAddress = vaultAddress;
             this.VaultToken = vaultToken;
@@ -41,6 +43,7 @@ public VaultOptions(
             this.OmitVaultKeyName = omitVaultKeyName;
             this.AdditionalCharactersForConfigurationPath = additionalCharactersForConfigurationPath ?? Array.Empty<char>();
             this.Namespace = @namespace;
+            this.AlwaysAddTrailingSlashToBasePath = alwaysAddTrailingSlashToBasePath;
         }
 
         /// <summary>
@@ -53,14 +56,16 @@ public VaultOptions(
         /// <param name="omitVaultKeyName">Omit Vault Key Name in Configuration Keys.</param>
         /// <param name="additionalCharactersForConfigurationPath">Additional characters for the Configuration path.</param>
         /// <param name="namespace">Vault namespace.</param>
+        /// <param name="alwaysAddTrailingSlashToBasePath">Should a trailing slash be added to the base path. See AlwaysAddTrailingSlashToBasePath property for details </param>
         public VaultOptions(
             string vaultAddress,
             IAuthMethodInfo authMethod,
             bool reloadOnChange = false,
             int reloadCheckIntervalSeconds = 300,
             bool omitVaultKeyName = false,
             IEnumerable<char>? additionalCharactersForConfigurationPath = null,
-            string? @namespace = null)
+            string? @namespace = null,
+            bool alwaysAddTrailingSlashToBasePath = true)
         {
             this.VaultAddress = vaultAddress;
             this.AuthMethod = authMethod;
@@ -69,6 +74,7 @@ public VaultOptions(
             this.OmitVaultKeyName = omitVaultKeyName;
             this.AdditionalCharactersForConfigurationPath = additionalCharactersForConfigurationPath ?? Array.Empty<char>();
             this.Namespace = @namespace;
+            this.AlwaysAddTrailingSlashToBasePath = alwaysAddTrailingSlashToBasePath;
         }
 
         /// <summary>
@@ -121,5 +127,12 @@ public VaultOptions(
         /// Gets Vault namespace.
         /// </summary>
         public string? Namespace { get; }
+
+        /// <summary>
+        /// Gets the value indicating whether to always add a trailing slash to the base path.
+        /// If it is true, the base path is considered to be a "folder" with nested keys, otherwise the base path is considered to be a key itself.
+        /// It is true by default. Set to false if you don't have permissions to list keys in the base path.
+        /// </summary>
+        public bool AlwaysAddTrailingSlashToBasePath { get; }
     }
 }

Source/VaultSharp.Extensions.Configuration/VaultOptions.cs

@@ -41,9 +41,10 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.Extensions.Configuration" Version="6.0.1" />
     <PackageReference Include="Microsoft.Extensions.Hosting.Abstractions" Version="6.0.0" />
-    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="6.0.1" />
+    <PackageReference Include="Microsoft.Extensions.Logging.Abstractions" Version="6.0.3" />
     <PackageReference Include="Microsoft.VisualStudio.Threading" Version="17.2.32" />
-    <PackageReference Include="VaultSharp" Version="1.7.0.4" />
+    <PackageReference Include="System.Text.Json" Version="7.0.2" />
+    <PackageReference Include="VaultSharp" Version="1.13.0.1" />
     <PackageReference Include="MinVer" Version="4.1.0" />
   </ItemGroup>