feat(ConfigurationReader): FromEnvironmentVariables(prefix), FromMicrosoftConfiguration #308
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,19 @@ | ||
| <Project Sdk="Microsoft.NET.Sdk"> | ||
| <PropertyGroup> | ||
| <TargetFramework>netstandard2.0</TargetFramework> | ||
| <GenerateDocumentationFile>true</GenerateDocumentationFile> | ||
| <GenerateAssemblyInfo>true</GenerateAssemblyInfo> | ||
| <Description>Microsoft.Extensions.Configuration adapter for Argu — exposes any IConfiguration source as an Argu IConfigurationReader.</Description> | ||
| <PackageTags>F#, argument, commandline, parser, configuration</PackageTags> | ||
| </PropertyGroup> | ||
| <ItemGroup> | ||
| <Compile Include="ConfigurationReader.fs"/> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <ProjectReference Include="..\Argu\Argu.fsproj"/> | ||
| </ItemGroup> | ||
| <ItemGroup> | ||
| <PackageReference Include="FSharp.Core"/> | ||
| <PackageReference Include="Microsoft.Extensions.Configuration.Abstractions"/> | ||
| </ItemGroup> | ||
| </Project> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
| namespace Argu.Extensions.Configuration | ||
|
|
||
| open Microsoft.Extensions.Configuration | ||
|
|
||
| open Argu | ||
|
|
||
| /// <summary> | ||
| /// Argu <see cref="IConfigurationReader"/> backed by a | ||
| /// <see cref="Microsoft.Extensions.Configuration.IConfiguration"/>. | ||
| /// The reader returns <c>null</c> when a key is missing, matching the | ||
| /// contract of every other Argu configuration reader. | ||
| /// </summary> | ||
| type MicrosoftExtensionsConfigurationReader(configuration : IConfiguration, ?name : string) = | ||
| let name = defaultArg name "Microsoft.Extensions.Configuration reader" | ||
| interface IConfigurationReader with | ||
| member _.Name = name | ||
| member _.GetValue(key : string) = | ||
| // IConfiguration[key] returns null for missing keys, which matches Argu's expectation. | ||
| configuration[key] | ||
|
|
||
| /// Factory helpers mirroring the shape of <see cref="ConfigurationReader"/>. | ||
| [<AbstractClass; Sealed>] | ||
| type ConfigurationReader = | ||
| /// Create an Argu <see cref="IConfigurationReader"/> over an <see cref="IConfiguration"/>. | ||
| static member FromMicrosoftConfiguration(configuration : IConfiguration, ?name : string) : IConfigurationReader = | ||
| MicrosoftExtensionsConfigurationReader(configuration, ?name = name) :> _ | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,48 +1,49 @@ | ||
| namespace Argu | ||
|
|
||
| open System | ||
| open System.Configuration | ||
| open System.Collections.Generic | ||
| open System.IO | ||
| open System.Reflection | ||
|
|
||
| /// Abstract key/value configuration reader | ||
| type IConfigurationReader = | ||
| /// Configuration reader identifier | ||
| abstract Name : string | ||
| /// Gets value corresponding to supplied key | ||
| abstract GetValue : key : string -> string | null | ||
|
|
||
| /// Configuration reader that never returns a value | ||
| type NullConfigurationReader () = | ||
| interface IConfigurationReader with | ||
| member _.Name = "Null Configuration Reader" | ||
| member _.GetValue _ = null | ||
|
|
||
| /// Environment variable-based configuration reader | ||
| type EnvironmentVariableConfigurationReader () = | ||
| // order of environment variable target lookup | ||
| let targets = | ||
| [| EnvironmentVariableTarget.Process | ||
| EnvironmentVariableTarget.User | ||
| EnvironmentVariableTarget.Machine |] | ||
|
|
||
| interface IConfigurationReader with | ||
| member _.Name = "Environment Variables Configuration Reader" | ||
| member _.GetValue(key : string) = | ||
| // NOTE this logic varies from a targetless Get in that it will pick up changes that a given process tree | ||
|
Member
There was a problem hiding this comment. @nojaf @dimension-zero I feel this is a misfeature; while its useful for local testing scenarios etc, it feels to me like it introduces a suprising potential attack vector (yes I know if you can override machine level config all bets are off, but e.g. being able to effectively inject config into a running process tree by manipulating user level config seems like bad news) Am I missing something, or does anyone feel we should log an issue and remove the behavior in V7 flagging it as a small breaking change in behavior? cc @eiriktsarpalis who doubtless has a good reason for this! |
||
| // has yet to propagate. A fresh shell should include machine and user level vars in the process env from the off | ||
| let folder curr (target : EnvironmentVariableTarget) = | ||
| match curr with | ||
| | null -> Environment.GetEnvironmentVariable(key, target) | ||
| | value -> value | ||
| (null, targets) ||> Array.fold folder | ||
|
|
||
| /// Configuration reader dictionary proxy | ||
| type DictionaryConfigurationReader (keyValueDictionary : IDictionary<string, string>, ?name : string) = | ||
| let name = defaultArg name "Dictionary configuration reader." | ||
| interface IConfigurationReader with | ||
| member _.Name = name | ||
| member _.GetValue(key : string) = | ||
| let ok,value = keyValueDictionary.TryGetValue key | ||
| if ok then value else null | ||
|
|
||
|
|
@@ -51,61 +52,71 @@ type FunctionConfigurationReader (configFunc : string -> string option, ?name : | |
| let name = defaultArg name "Function configuration reader." | ||
| interface IConfigurationReader with | ||
| member _.Name = name | ||
| member _.GetValue(key : string) = configFunc key |> Option.toObj | ||
|
|
||
| /// AppSettings XML configuration reader | ||
| type AppSettingsConfigurationReader () = | ||
| interface IConfigurationReader with | ||
| member _.Name = "AppSettings configuration reader" | ||
| member _.GetValue(key : string) = ConfigurationManager.AppSettings[key] | ||
|
|
||
| /// AppSettings XML configuration reader | ||
| type AppSettingsConfigurationFileReader private (xmlPath : string, kv : KeyValueConfigurationCollection) = | ||
| member _.Path = xmlPath | ||
| interface IConfigurationReader with | ||
| member _.Name = $"App.config configuration reader: %s{xmlPath}" | ||
| member _.GetValue(key : string) = | ||
| match kv[key] with | ||
| | null -> null | ||
| | entry -> entry.Value | ||
|
|
||
| /// Create used supplied XML file path | ||
| static member Create(path : string) = | ||
| if not <| File.Exists path then raise <| FileNotFoundException(path) | ||
| let fileMap = ExeConfigurationFileMap(ExeConfigFilename = path) | ||
| let config = ConfigurationManager.OpenMappedExeConfiguration(fileMap, ConfigurationUserLevel.None) | ||
| AppSettingsConfigurationFileReader(path, config.AppSettings.Settings) | ||
|
|
||
| /// Configuration reader implementations | ||
| [<AbstractClass; Sealed>] | ||
| type ConfigurationReader = | ||
|
|
||
| /// Create a configuration reader that always returns null | ||
| static member NullReader : IConfigurationReader = NullConfigurationReader() | ||
|
|
||
| /// Create a configuration reader instance using an IDictionary instance | ||
| static member FromDictionary(keyValueDictionary : IDictionary<string,string>, ?name : string) : IConfigurationReader = | ||
| DictionaryConfigurationReader(keyValueDictionary, ?name = name) | ||
|
|
||
| /// Create a configuration reader instance using an F# function | ||
| static member FromFunction(reader : string -> string option, ?name : string) : IConfigurationReader = | ||
| FunctionConfigurationReader(reader, ?name = name) | ||
|
|
||
| /// Create a configuration reader instance using environment variables. | ||
| /// Reads Process variables, falling back to latest User or latest Machine targets if not found. | ||
| static member FromEnvironmentVariables() : IConfigurationReader = EnvironmentVariableConfigurationReader() | ||
|
|
||
| /// <summary> | ||
| /// Create a configuration reader that reads environment variables with a fixed prefix prepended to the requested key.<br/> | ||
| /// Maps <c>--foo-bar</c> arguments onto <c>MYAPP_FOO_BAR</c> environment variables.<br/> | ||
| /// As per <c>FromEnvironmentVariables()</c>, reads Process variables, falling back to latest User or latest Machine targets if not found. | ||
| /// </summary> | ||
| /// <param name="prefix">String prepended to each requested key (e.g. <c>"MYAPP_"</c>).</param> | ||
| static member FromEnvironmentVariables(prefix : string) : IConfigurationReader = | ||
| if isNull prefix then nullArg (nameof prefix) | ||
| let inner = EnvironmentVariableConfigurationReader() :> IConfigurationReader | ||
| let read (key : string) = inner.GetValue(prefix + key) |> Option.ofObj | ||
| FunctionConfigurationReader(read, name = $"Environment Variables (prefix=%s{prefix})") | ||
|
|
||
| /// Create a configuration reader instance using the application's resident AppSettings configuration | ||
| static member FromAppSettings() : IConfigurationReader = AppSettingsConfigurationReader() | ||
|
|
||
| /// Create a configuration reader instance using a local xml App.Config file | ||
| static member FromAppSettingsFile(path : string) : IConfigurationReader = AppSettingsConfigurationFileReader.Create path | ||
|
|
||
| /// Create a configuration reader instance using the location of an assembly file | ||
| static member FromAppSettings(assembly : Assembly) : IConfigurationReader = | ||
| let path = assembly.Location | ||
| if String.IsNullOrEmpty path then | ||
| invalidArg assembly.FullName $"Assembly location for '{assembly.Location}' is null or empty." | ||
| AppSettingsConfigurationFileReader.Create(path + ".config") :> IConfigurationReader | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| module Argu.Tests.EnvVarTests | ||
|
|
||
| open Swensen.Unquote | ||
| open System | ||
| open Xunit | ||
|
|
||
| open Argu | ||
|
|
||
| type Args = | ||
| | [<CustomAppSettings("HOST")>] HostName of string | ||
| | [<CustomAppSettings("PORT")>] Port of int | ||
| interface IArgParserTemplate with member this.Usage = "x" | ||
|
|
||
| /// Sets an environment variable and restores its prior value on Dispose, | ||
| /// so a test can scope the override with `use _ = envOverride key value`. | ||
| let envOverride (key : string) (value : string) : IDisposable = | ||
| let prior = Environment.GetEnvironmentVariable key | ||
| Environment.SetEnvironmentVariable(key, value) | ||
| { new IDisposable with member _.Dispose() = Environment.SetEnvironmentVariable(key, prior) } | ||
|
|
||
| [<Fact>] | ||
| let ``No-arg FromEnvironmentVariables works without prefix`` () = | ||
| use _ = envOverride "ARGU_TEST_PLAIN" "value" | ||
| let reader = ConfigurationReader.FromEnvironmentVariables() | ||
| test <@ reader.GetValue("ARGU_TEST_PLAIN") = "value" @> | ||
|
|
||
| module Prefixed = | ||
|
|
||
| [<Fact>] | ||
| let ``FromEnvironmentVariables(prefix) prepends prefix to key`` () = | ||
| let reader = ConfigurationReader.FromEnvironmentVariables(prefix = "MYAPP_") | ||
| use _ = envOverride "MYAPP_HOST" "example.com" | ||
| test <@ reader.GetValue("HOST") = "example.com" @> | ||
|
|
||
| [<Fact>] | ||
| let ``FromEnvironmentVariables(prefix) returns null for missing keys`` () = | ||
| let reader = ConfigurationReader.FromEnvironmentVariables(prefix = "ARGU_TEST_MISSING_") | ||
| // Ensure no stray env var; SetEnvironmentVariable(null) clears it. | ||
| Environment.SetEnvironmentVariable("ARGU_TEST_MISSING_NOPE", null) | ||
| test <@ reader.GetValue("NOPE") = null @> | ||
|
|
||
| [<Fact>] | ||
| let ``FromEnvironmentVariables(prefix) parses round-trip through ArgumentParser`` () = | ||
| use _ = envOverride "DEMO_HOST" "host.local" | ||
| use _ = envOverride "DEMO_PORT" "443" | ||
| let parser = ArgumentParser.Create<Args>(programName = "demo") | ||
| let reader = ConfigurationReader.FromEnvironmentVariables(prefix = "DEMO_") | ||
| let results = parser.ParseConfiguration(reader, ignoreMissing = true) | ||
| test <@ results.GetResult(HostName) = "host.local" @> | ||
| test <@ results.GetResult(Port) = 443 @> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@Numpsy in #234 this should become a type augmentation and the namespace on L1 should become Argu so Autocomplete experience can be consistent?