diff --git a/nuget.config b/nuget.config new file mode 100644 index 000000000..93fd0dac6 --- /dev/null +++ b/nuget.config @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/src/Dapr.Common/DaprDefaults.cs b/src/Dapr.Common/DaprDefaults.cs index 1cc384df2..6d4f01192 100644 --- a/src/Dapr.Common/DaprDefaults.cs +++ b/src/Dapr.Common/DaprDefaults.cs @@ -15,23 +15,57 @@ namespace Dapr; -internal static class DaprDefaults +/// +/// Provides access to the default and computed values for accessing the Dapr runtime. +/// +public static class DaprDefaults { - private static string httpEndpoint = string.Empty; - private static string grpcEndpoint = string.Empty; - private static string daprApiToken = string.Empty; - private static string appApiToken = string.Empty; - - public const string DaprApiTokenName = "DAPR_API_TOKEN"; - public const string AppApiTokenName = "APP_API_TOKEN"; - public const string DaprHttpEndpointName = "DAPR_HTTP_ENDPOINT"; - public const string DaprHttpPortName = "DAPR_HTTP_PORT"; - public const string DaprGrpcEndpointName = "DAPR_GRPC_ENDPOINT"; - public const string DaprGrpcPortName = "DAPR_GRPC_PORT"; + // Configured values + private static string _httpEndpoint = string.Empty; + private static string _grpcEndpoint = string.Empty; + private static string _daprApiToken = string.Empty; + private static string _appApiToken = string.Empty; + /// + /// The name of the environment variable containing the Dapr API token. + /// + public const string DaprApiTokenEnvironmentVariableName = "DAPR_API_TOKEN"; + /// + /// The name of the environment variable containing the App API token. + /// + public const string AppApiTokenEnvironmentVariableName = "APP_API_TOKEN"; + /// + /// The name of the environment variable containing the Dapr HTTP endpoint value. + /// + public const string DaprHttpEndpointEnvironmentVariableName = "DAPR_HTTP_ENDPOINT"; + /// + /// The name of the environment variable containing the Dapr HTTP port value. + /// + public const string DaprHttpPortEnvironmentVariableName = "DAPR_HTTP_PORT"; + /// + /// The name of the environment variable containing the Dapr GRPC endpoint value. + /// + public const string DaprGrpcEndpointEnvironmentVariableName = "DAPR_GRPC_ENDPOINT"; + /// + /// The name of the environment variable containing the Dapr GRPC port value. + /// + public const string DaprGrpcPortEnvironmentVariableName = "DAPR_GRPC_PORT"; + + /// + /// The default scheme to use for HTTP communication with the Dapr runtime. + /// public const string DefaultDaprScheme = "http"; + /// + /// The default hostname to use for HTTP communication with the Dapr runtime. + /// public const string DefaultDaprHost = "localhost"; + /// + /// The default port to use for HTTP communication with the Dapr runtime. + /// public const int DefaultHttpPort = 3500; + /// + /// The default port to use for GRPC communication with the Dapr runtime. + /// public const int DefaultGrpcPort = 50001; /// @@ -40,7 +74,7 @@ internal static class DaprDefaults /// The optional to pull the value from. /// The value of environment variable DAPR_API_TOKEN public static string GetDefaultDaprApiToken(IConfiguration? configuration) => - GetResourceValue(configuration, DaprApiTokenName) ?? string.Empty; + GetResourceValue(configuration, DaprApiTokenEnvironmentVariableName) ?? string.Empty; /// /// Creates an configured to communicate with the default Dapr HTTP endpoint. @@ -70,7 +104,7 @@ public static HttpClient CreateDefaultHttpClient(IHttpClientFactory httpClientFa /// The optional to pull the value from. /// The value of environment variable APP_API_TOKEN public static string GetDefaultAppApiToken(IConfiguration? configuration) => - GetResourceValue(configuration, AppApiTokenName) ?? string.Empty; + GetResourceValue(configuration, AppApiTokenEnvironmentVariableName) ?? string.Empty; /// /// Get the value of HTTP endpoint based off environment variables @@ -80,8 +114,8 @@ public static string GetDefaultAppApiToken(IConfiguration? configuration) => public static string GetDefaultHttpEndpoint(IConfiguration? configuration = null) { //Prioritize pulling from the IConfiguration and fallback to the environment variable if not populated - var endpoint = GetResourceValue(configuration, DaprHttpEndpointName); - var port = GetResourceValue(configuration, DaprHttpPortName); + var endpoint = GetResourceValue(configuration, DaprHttpEndpointEnvironmentVariableName); + var port = GetResourceValue(configuration, DaprHttpPortEnvironmentVariableName); //Use the default HTTP port if we're unable to retrieve/parse the provided port int? parsedGrpcPort = string.IsNullOrWhiteSpace(port) ? DefaultHttpPort : int.Parse(port); @@ -97,8 +131,8 @@ public static string GetDefaultHttpEndpoint(IConfiguration? configuration = null public static string GetDefaultGrpcEndpoint(IConfiguration? configuration = null) { //Prioritize pulling from the IConfiguration and fallback to the environment variable if not populated - var endpoint = GetResourceValue(configuration, DaprGrpcEndpointName); - var port = GetResourceValue(configuration, DaprGrpcPortName); + var endpoint = GetResourceValue(configuration, DaprGrpcEndpointEnvironmentVariableName); + var port = GetResourceValue(configuration, DaprGrpcPortEnvironmentVariableName); //Use the default gRPC port if we're unable to retrieve/parse the provided port int? parsedGrpcPort = string.IsNullOrWhiteSpace(port) ? DefaultGrpcPort : int.Parse(port); diff --git a/test/Dapr.Common.Test/DaprDefaultTest.cs b/test/Dapr.Common.Test/DaprDefaultTest.cs index ef4d0da3c..a144bf140 100644 --- a/test/Dapr.Common.Test/DaprDefaultTest.cs +++ b/test/Dapr.Common.Test/DaprDefaultTest.cs @@ -316,8 +316,8 @@ public void ShouldBuildGrpcEndpointAndPortUsingPrefixedConfiguration() [Fact] public void ShouldBuildGrpcEndpointAndPortUsingConfiguration() { - const string endpointVarName = DaprDefaults.DaprGrpcEndpointName; - const string portVarName = DaprDefaults.DaprGrpcPortName; + const string endpointVarName = DaprDefaults.DaprGrpcEndpointEnvironmentVariableName; + const string portVarName = DaprDefaults.DaprGrpcPortEnvironmentVariableName; var original_GrpcEndpoint = Environment.GetEnvironmentVariable(endpointVarName); var original_GrpcPort = Environment.GetEnvironmentVariable(portVarName); @@ -452,8 +452,8 @@ public void ShouldBuildGrpcEndpointUsingEnvVarValues() [Fact] public void ShouldBuildGrpcEndpointDefaultToLocalhostWithPort() { - const string endpointVarName = DaprDefaults.DaprGrpcEndpointName; - const string portVarName = DaprDefaults.DaprGrpcPortName; + const string endpointVarName = DaprDefaults.DaprGrpcEndpointEnvironmentVariableName; + const string portVarName = DaprDefaults.DaprGrpcPortEnvironmentVariableName; var original_grpcEndpoint = Environment.GetEnvironmentVariable(endpointVarName); var original_grpcPort = Environment.GetEnvironmentVariable(portVarName); @@ -479,8 +479,8 @@ public void ShouldBuildGrpcEndpointDefaultToLocalhostWithPort() [Fact] public void ShouldBuildGrpcEndpointDefaultToLocalhostWithDefaultPort() { - const string endpointVarName = DaprDefaults.DaprGrpcEndpointName; - const string portVarName = DaprDefaults.DaprGrpcPortName; + const string endpointVarName = DaprDefaults.DaprGrpcEndpointEnvironmentVariableName; + const string portVarName = DaprDefaults.DaprGrpcPortEnvironmentVariableName; var original_grpcEndpoint = Environment.GetEnvironmentVariable(endpointVarName); var original_grpcPort = Environment.GetEnvironmentVariable(portVarName); @@ -506,7 +506,7 @@ public void ShouldBuildGrpcEndpointDefaultToLocalhostWithDefaultPort() [Fact] public void ShouldBuildApiTokenUsingConfiguration() { - const string envVarName = DaprDefaults.DaprApiTokenName; + const string envVarName = DaprDefaults.DaprApiTokenEnvironmentVariableName; var original_ApiToken = Environment.GetEnvironmentVariable(envVarName); try @@ -532,7 +532,7 @@ public void ShouldBuildApiTokenUsingConfiguration() public void ShouldBuildApiTokenUsingPrefixedConfiguration() { - const string envVarName = $"test_{DaprDefaults.DaprApiTokenName}"; + const string envVarName = $"test_{DaprDefaults.DaprApiTokenEnvironmentVariableName}"; var original_ApiToken = Environment.GetEnvironmentVariable(envVarName); try @@ -559,7 +559,7 @@ public void ShouldBuildApiTokenUsingPrefixedConfiguration() [Fact] public void ShouldBuildApiTokenWithEnvVarWhenConfigurationNotAvailable() { - const string envVarName = DaprDefaults.DaprApiTokenName; + const string envVarName = DaprDefaults.DaprApiTokenEnvironmentVariableName; var original_ApiToken = Environment.GetEnvironmentVariable(envVarName); const string apiToken = "abc123"; Environment.SetEnvironmentVariable(envVarName, apiToken);