NamespaceSystemLibrary.Common.Net SystemLibrary.Common.Net.dll

Class to load and read configuration files (xml, json or config) as a Class with transformations if exist and with decrypting encrypted properties

Configurations can be placed in either:

~/*.json, ~/*.xml, ~/Configs/**.[json|xml], or ~/Configurations/**.[json|xml]

Or appended to your existing 'appSettings.json' file

Transformations are ran based on the 'ASPNETCORE_ENVIRONMENT' variable passed to your application

Recommended places to set ASPNETCORE_ENVIRONMENT:

- launchSettings.json when using IIS Express

- web.config if you use IIS

- mstest.runsettings if you run transformations in unit tests

- commandline with --configuration if running as 'exe'

Remarks

X

The Current instance on the Config object is a Singleton and only loaded once

Read the example of 'EnvironmentConfig.Name' property, it gives details on where/how to set environment per application type

Encrypted properties such as "ApiToken {get;set;}" can be decrypted auto by creating a "ApiTokenDecrypt {get;set;}"

must be string, public, and marked with get;set;

convention by specifying suffix "Decrypt" or "Decrypted" or use attribute [Decrypt] on a property

Environment variables like 'UserName' is only added to 'appSettings' reads not your custom configuration files

WARNING: The generic T cannot be a nested class

Config<T>

public abstract class Config<T> where T : class

Inheritance

System.Object

Config<T>

EnvironmentConfig<T, TEnvironmentNameEnum>

Type Parameters

Name	Description
T	T is the class inheriting Config<>, also referenced as 'self'. Note that T cannot be a nested class

Examples

X

• Create new file '~/TestConfig.json'
• Can also be placed under ~/Configs/ or ~/Configurations/

{
    "Name": "Hello World",
    "Number": 1234,

    "Options": {
        "Url": "https://....",
    },
    "ValidPhoneNumbers": [0,1,2,3]
    "password": "/HjLI26feCvCwaBOmXfu6ZFK1KLR33YbAdDZIlzuM5I=",
}

• Create C# class with same name as your newly created json file and inherit Config<>:

public class TestConfig : Config<TestConfig> 
{
   public string Name { get; set; }

   public int Number { get; set;}

   public ApiOptions Options { get; set; }

   public int[] ValidPhoneNumbers { get; set; }

   public class Password { get; set; } // Contains encrypted value
   public class PasswordDecrypted { get; set; } // Contains decrypted Password at runtime
}

public class ApiOptions 
{
    public string Url { get; set; }
}

Usage:

var testConfig = TestConfig.Current;
var name = testConfig.Name;
// name is now Hello World

Add transformation per 'environmnet' to our newly created TestConfig.json

• Add transformation for an environment, lets call it 'dev'

• Create TestConfig.dev.json file, place it in same folder as TestConfig.json

  • Visual Studio should mark the new file as 'IsTransformFile=true' and 'DependentUpon=TestConfig.json'
    • If not, try dragging "TestConfig.dev.json" in under "TestConfig.json" via Solution Explorer

• Define only variables that we want to transform:

{
    "Name": "Hello Dev!",
}

Here are three ways of specifying the environment, by either launchSettings.json, web.config or mstest.runsettings.

1 launchSettings.json with IIS:

{ 
	...
	{
		"profiles": {
			"IIS": {
				"environmentVariables": {
					"ASPNETCORE_ENVIRONMENT": "Dev",
				}
			}
		}
	}
	...
}

2 web.config with IIS or IISExpress:

<configuration>
  <location path = "." inheritInChildApplications="false">
	</system.webServer>
	  <aspNetCore processPath = "bin\Demo.exe" arguments="" stdoutLogEnabled="false" hostingModel="inprocess">
        <environmentVariables>
          <environmentVariable name = "ASPNETCORE_ENVIRONMENT" value="Dev" />
        </environmentVariables>
      </aspNetCore>
    </system.webServer>
  </location>
</configuration>

3 mstest.runsettings if running through Test Explorer (unit tests):

• Note: add mstest.runsettings to your csproj-variable: 'RunSettingsFilePath'
• Tip: View source code of SystemLibrary.Common.Net.Tests inside the repo SystemLibrary.Common.Net on github

<RunSettings>
  <RunConfiguration>
      <EnvironmentVariables>
          <ASPNETCORE_ENVIRONMENT>Dev</ASPNETCORE_ENVIRONMENT>

Usage:

• Assume IISExpress and web.config setup above:

var testConfig = TestConfig.Current;
var name = testConfig.Name;
// name is now equal to 'Hello Dev!', which is our transformed value

Arguments

X

Generic types

Name	Description
T	T is the class inheriting Config<>, also referenced as 'self'. Note that T cannot be a nested class

Properties

Get the current configuration as a singleton object, always instantiated

public static T Current { get; }

X

Property Value

Type	Description
T

Extension Methods

ObjectExtensions.Json(Object, Boolean)

ObjectExtensions.Json(Object, JsonSerializerOptions, Boolean, JsonConverter[])

ObjectExtensions.Json(Object, JsonConverter[])

}