Rohkhann/run time config constructor (#1587)

## Why make this change?

Different users of dataapi builder may have different ways in which they
want to load in runtimeconfig. For example: There is a scenario where
one might want to create the runtimeconfig object dynamically without
having a runtime json ready.

## What is this change?

- Summary of how your changes work to give reviewers context of your
intent.
In this pr, we create an abstract class BaseRunTimeConfigLoader that has
certain common methods that all derived classes can use. The main
TryLoadconfig method will be implemented differently by different
classes. The RunTimeConfigProvider by dab loads config from the
filesystem. Depending on use case this can be done differently by
different consumers.
- Also made some name simplifications in test files.

## How was this tested?

- [x] Integration Tests
yes
- [x] Unit Tests
yes

---------

Co-authored-by: Aaron Powell <me@aaron-powell.com>

Author: rohkhann

src/Cli.Tests/ConfigGeneratorTests.cs

@@ -10,14 +10,14 @@ namespace Cli.Tests;
 public class ConfigGeneratorTests
 {
     private IFileSystem? _fileSystem;
-    private RuntimeConfigLoader? _runtimeConfigLoader;
+    private FileSystemRuntimeConfigLoader? _runtimeConfigLoader;
 
     [TestInitialize]
     public void TestInitialize()
     {
         _fileSystem = FileSystemUtils.ProvisionMockFileSystem();
 
-        _runtimeConfigLoader = new RuntimeConfigLoader(_fileSystem);
+        _runtimeConfigLoader = new FileSystemRuntimeConfigLoader(_fileSystem);
 
         ILoggerFactory loggerFactory = TestLoggerSupport.ProvisionLoggerFactory();
 
@@ -49,9 +49,9 @@ public void TryGenerateConfig_WithUserProvidedConfig(
 
         // Mocking logger to assert on logs
         Mock<ILogger<ConfigGenerator>> loggerMock = new();
-        ConfigGenerator.SetLoggerForCliConfigGenerator(loggerMock.Object);
+        SetLoggerForCliConfigGenerator(loggerMock.Object);
 
-        Assert.AreEqual(isConfigGenerationSuccessful, ConfigGenerator.TryGenerateConfig(options, _runtimeConfigLoader!, _fileSystem!));
+        Assert.AreEqual(isConfigGenerationSuccessful, TryGenerateConfig(options, _runtimeConfigLoader!, _fileSystem!));
 
         if (!isConfigFilePresent)
         {
@@ -96,9 +96,9 @@ public void TryGenerateConfig_UsingEnvironmentVariable(
 
         // Mocking logger to assert on logs
         Mock<ILogger<ConfigGenerator>> loggerMock = new();
-        ConfigGenerator.SetLoggerForCliConfigGenerator(loggerMock.Object);
+        SetLoggerForCliConfigGenerator(loggerMock.Object);
 
-        Assert.AreEqual(isConfigGenerationSuccessful, ConfigGenerator.TryGenerateConfig(options, _runtimeConfigLoader!, _fileSystem!));
+        Assert.AreEqual(isConfigGenerationSuccessful, TryGenerateConfig(options, _runtimeConfigLoader!, _fileSystem!));
         if (!isConfigFilePresent)
         {
             Assert.AreEqual(isConfigGenerationSuccessful, _fileSystem!.File.Exists(configFileName));

src/Cli.Tests/EndToEndTests.cs

@@ -13,7 +13,7 @@ public class EndToEndTests
     : VerifyBase
 {
     private IFileSystem? _fileSystem;
-    private RuntimeConfigLoader? _runtimeConfigLoader;
+    private FileSystemRuntimeConfigLoader? _runtimeConfigLoader;
     private ILogger<Program>? _cliLogger;
 
     [TestInitialize]
@@ -26,7 +26,7 @@ public void TestInitialize()
 
         _fileSystem = fileSystem;
 
-        _runtimeConfigLoader = new RuntimeConfigLoader(_fileSystem);
+        _runtimeConfigLoader = new FileSystemRuntimeConfigLoader(_fileSystem);
 
         ILoggerFactory loggerFactory = TestLoggerSupport.ProvisionLoggerFactory();
 

src/Cli.Tests/InitTests.cs

@@ -11,14 +11,14 @@ public class InitTests
         : VerifyBase
     {
         private IFileSystem? _fileSystem;
-        private RuntimeConfigLoader? _runtimeConfigLoader;
+        private FileSystemRuntimeConfigLoader? _runtimeConfigLoader;
 
         [TestInitialize]
         public void TestInitialize()
         {
             _fileSystem = FileSystemUtils.ProvisionMockFileSystem();
 
-            _runtimeConfigLoader = new RuntimeConfigLoader(_fileSystem);
+            _runtimeConfigLoader = new FileSystemRuntimeConfigLoader(_fileSystem);
 
             ILoggerFactory loggerFactory = TestLoggerSupport.ProvisionLoggerFactory();
 

src/Cli.Tests/Usings.cs

@@ -13,7 +13,7 @@
 global using Microsoft.VisualStudio.TestTools.UnitTesting;
 global using Moq;
 global using Newtonsoft.Json.Linq;
-global using static Azure.DataApiBuilder.Config.RuntimeConfigLoader;
+global using static Azure.DataApiBuilder.Config.FileSystemRuntimeConfigLoader;
 global using static Cli.ConfigGenerator;
 global using static Cli.Tests.TestHelper;
 global using static Cli.Utils;

src/Cli.Tests/UtilsTests.cs

@@ -107,8 +107,8 @@ public void ConstructGraphQLOptionsWithSingularAndPluralWillSetSingularAndPlural
     [DataTestMethod]
     [DataRow("", "my-config.json", "my-config.json", DisplayName = "user provided the config file and environment variable was not set.")]
     [DataRow("Test", "my-config.json", "my-config.json", DisplayName = "user provided the config file and environment variable was set.")]
-    [DataRow("Test", null, $"{RuntimeConfigLoader.CONFIGFILE_NAME}.Test{RuntimeConfigLoader.CONFIG_EXTENSION}", DisplayName = "config not provided, but environment variable was set.")]
-    [DataRow("", null, $"{RuntimeConfigLoader.CONFIGFILE_NAME}{RuntimeConfigLoader.CONFIG_EXTENSION}", DisplayName = "neither config was provided, nor environment variable was set.")]
+    [DataRow("Test", null, $"{CONFIGFILE_NAME}.Test{CONFIG_EXTENSION}", DisplayName = "config not provided, but environment variable was set.")]
+    [DataRow("", null, $"{CONFIGFILE_NAME}{CONFIG_EXTENSION}", DisplayName = "neither config was provided, nor environment variable was set.")]
     public void TestConfigSelectionBasedOnCliPrecedence(
         string? environmentValue,
         string? userProvidedConfigFile,
@@ -117,13 +117,13 @@ public void TestConfigSelectionBasedOnCliPrecedence(
         MockFileSystem fileSystem = new();
         fileSystem.AddFile(expectedRuntimeConfigFile, new MockFileData(""));
 
-        RuntimeConfigLoader loader = new(fileSystem);
+        FileSystemRuntimeConfigLoader loader = new(fileSystem);
 
-        string? envValueBeforeTest = Environment.GetEnvironmentVariable(RuntimeConfigLoader.RUNTIME_ENVIRONMENT_VAR_NAME);
-        Environment.SetEnvironmentVariable(RuntimeConfigLoader.RUNTIME_ENVIRONMENT_VAR_NAME, environmentValue);
+        string? envValueBeforeTest = Environment.GetEnvironmentVariable(RUNTIME_ENVIRONMENT_VAR_NAME);
+        Environment.SetEnvironmentVariable(RUNTIME_ENVIRONMENT_VAR_NAME, environmentValue);
         Assert.IsTrue(TryGetConfigFileBasedOnCliPrecedence(loader, userProvidedConfigFile, out string? actualRuntimeConfigFile));
         Assert.AreEqual(expectedRuntimeConfigFile, actualRuntimeConfigFile);
-        Environment.SetEnvironmentVariable(RuntimeConfigLoader.RUNTIME_ENVIRONMENT_VAR_NAME, envValueBeforeTest);
+        Environment.SetEnvironmentVariable(RUNTIME_ENVIRONMENT_VAR_NAME, envValueBeforeTest);
     }
 
     /// <summary>
@@ -239,14 +239,14 @@ public void TestValidateAudienceAndIssuerForAuthenticationProvider(
     public void TestMergeConfig()
     {
         MockFileSystem fileSystem = new();
-        fileSystem.AddFile(RuntimeConfigLoader.DEFAULT_CONFIG_FILE_NAME, new MockFileData(BASE_CONFIG));
+        fileSystem.AddFile(DEFAULT_CONFIG_FILE_NAME, new MockFileData(BASE_CONFIG));
         fileSystem.AddFile("dab-config.Test.json", new MockFileData(ENV_BASED_CONFIG));
 
-        RuntimeConfigLoader loader = new(fileSystem);
+        FileSystemRuntimeConfigLoader loader = new(fileSystem);
 
-        Environment.SetEnvironmentVariable(RuntimeConfigLoader.RUNTIME_ENVIRONMENT_VAR_NAME, "Test");
+        Environment.SetEnvironmentVariable(RUNTIME_ENVIRONMENT_VAR_NAME, "Test");
 
-        Assert.IsTrue(Cli.ConfigMerger.TryMergeConfigsIfAvailable(fileSystem, loader, new StringLogger(), out string? mergedConfig), "Failed to merge config files");
+        Assert.IsTrue(ConfigMerger.TryMergeConfigsIfAvailable(fileSystem, loader, new StringLogger(), out string? mergedConfig), "Failed to merge config files");
         Assert.AreEqual(mergedConfig, "dab-config.Test.merged.json");
         Assert.IsTrue(fileSystem.File.Exists(mergedConfig));
         Assert.IsTrue(JToken.DeepEquals(JObject.Parse(MERGED_CONFIG), JObject.Parse(fileSystem.File.ReadAllText(mergedConfig))));
@@ -282,7 +282,7 @@ public void TestMergeConfigAvailability(
         MockFileSystem fileSystem = new();
 
         // Setting up the test scenarios
-        Environment.SetEnvironmentVariable(RuntimeConfigLoader.RUNTIME_ENVIRONMENT_VAR_NAME, environmentValue);
+        Environment.SetEnvironmentVariable(RUNTIME_ENVIRONMENT_VAR_NAME, environmentValue);
         string baseConfig = "dab-config.json";
         string envBasedConfig = "dab-config.Test.json";
 
@@ -296,15 +296,15 @@ public void TestMergeConfigAvailability(
             fileSystem.AddFile(envBasedConfig, new("{}"));
         }
 
-        RuntimeConfigLoader loader = new(fileSystem);
+        FileSystemRuntimeConfigLoader loader = new(fileSystem);
 
         Assert.AreEqual(
             expectedIsMergedConfigAvailable,
             ConfigMerger.TryMergeConfigsIfAvailable(fileSystem, loader, new StringLogger(), out string? mergedConfigFile),
             "Availability of merge config should match");
         Assert.AreEqual(expectedMergedConfigFileName, mergedConfigFile, "Merge config file name should match expected");
 
-        Environment.SetEnvironmentVariable(RuntimeConfigLoader.RUNTIME_ENVIRONMENT_VAR_NAME, null);
+        Environment.SetEnvironmentVariable(RUNTIME_ENVIRONMENT_VAR_NAME, null);
     }
 }
 

src/Cli/Commands/AddOptions.cs

@@ -56,7 +56,7 @@ public AddOptions(
         [Option("permissions", Required = true, Separator = ':', HelpText = "Permissions required to access the source table or container.")]
         public IEnumerable<string> Permissions { get; }
 
-        public void Handler(ILogger logger, RuntimeConfigLoader loader, IFileSystem fileSystem)
+        public void Handler(ILogger logger, FileSystemRuntimeConfigLoader loader, IFileSystem fileSystem)
         {
             logger.LogInformation($"{PRODUCT_NAME} {ProductInfo.GetProductVersion()}");
             if (!IsEntityProvided(Entity, logger, command: "add"))

src/Cli/Commands/InitOptions.cs

@@ -103,7 +103,7 @@ public InitOptions(
         [Option("graphql.disabled", Default = false, Required = false, HelpText = "Disables GraphQL endpoint for all entities.")]
         public bool GraphQLDisabled { get; }
 
-        public void Handler(ILogger logger, RuntimeConfigLoader loader, IFileSystem fileSystem)
+        public void Handler(ILogger logger, FileSystemRuntimeConfigLoader loader, IFileSystem fileSystem)
         {
             logger.LogInformation($"{PRODUCT_NAME} {ProductInfo.GetProductVersion()}");
             bool isSuccess = ConfigGenerator.TryGenerateConfig(this, loader, fileSystem);

src/Cli/Commands/StartOptions.cs

@@ -35,7 +35,7 @@ public StartOptions(bool verbose, LogLevel? logLevel, bool isHttpsRedirectionDis
         [Option("no-https-redirect", Required = false, HelpText = "Disables automatic https redirects.")]
         public bool IsHttpsRedirectionDisabled { get; }
 
-        public void Handler(ILogger logger, RuntimeConfigLoader loader, IFileSystem fileSystem)
+        public void Handler(ILogger logger, FileSystemRuntimeConfigLoader loader, IFileSystem fileSystem)
         {
             logger.LogInformation($"{PRODUCT_NAME} {ProductInfo.GetProductVersion()}");
             bool isSuccess = ConfigGenerator.TryStartEngineWithOptions(this, loader, fileSystem);

src/Cli/Commands/UpdateOptions.cs

@@ -96,7 +96,7 @@ public UpdateOptions(
         [Option('m', "map", Separator = ',', Required = false, HelpText = "Specify mappings between database fields and GraphQL and REST fields. format: --map \"backendName1:exposedName1,backendName2:exposedName2,...\".")]
         public IEnumerable<string>? Map { get; }
 
-        public void Handler(ILogger logger, RuntimeConfigLoader loader, IFileSystem fileSystem)
+        public void Handler(ILogger logger, FileSystemRuntimeConfigLoader loader, IFileSystem fileSystem)
         {
             logger.LogInformation($"{PRODUCT_NAME} {ProductInfo.GetProductVersion()}");
             if (!IsEntityProvided(Entity, logger, command: "update"))

src/Cli/ConfigGenerator.cs

@@ -35,21 +35,21 @@ public static void SetLoggerForCliConfigGenerator(
         /// <summary>
         /// This method will generate the initial config with databaseType and connection-string.
         /// </summary>
-        public static bool TryGenerateConfig(InitOptions options, RuntimeConfigLoader loader, IFileSystem fileSystem)
+        public static bool TryGenerateConfig(InitOptions options, FileSystemRuntimeConfigLoader loader, IFileSystem fileSystem)
         {
-            string runtimeConfigFile = RuntimeConfigLoader.DEFAULT_CONFIG_FILE_NAME;
+            string runtimeConfigFile = FileSystemRuntimeConfigLoader.DEFAULT_CONFIG_FILE_NAME;
             if (!string.IsNullOrWhiteSpace(options.Config))
             {
                 _logger.LogInformation("Generating user provided config file with name: {configFileName}", options.Config);
                 runtimeConfigFile = options.Config;
             }
             else
             {
-                string? environmentValue = Environment.GetEnvironmentVariable(RuntimeConfigLoader.RUNTIME_ENVIRONMENT_VAR_NAME);
+                string? environmentValue = Environment.GetEnvironmentVariable(FileSystemRuntimeConfigLoader.RUNTIME_ENVIRONMENT_VAR_NAME);
                 if (!string.IsNullOrWhiteSpace(environmentValue))
                 {
-                    _logger.LogInformation("The environment variable {variableName} has a value of {variableValue}", RuntimeConfigLoader.RUNTIME_ENVIRONMENT_VAR_NAME, environmentValue);
-                    runtimeConfigFile = RuntimeConfigLoader.GetEnvironmentFileName(RuntimeConfigLoader.CONFIGFILE_NAME, environmentValue);
+                    _logger.LogInformation("The environment variable {variableName} has a value of {variableValue}", FileSystemRuntimeConfigLoader.RUNTIME_ENVIRONMENT_VAR_NAME, environmentValue);
+                    runtimeConfigFile = FileSystemRuntimeConfigLoader.GetEnvironmentFileName(FileSystemRuntimeConfigLoader.CONFIGFILE_NAME, environmentValue);
                     _logger.LogInformation("Generating environment config file: {configPath}", fileSystem.Path.GetFullPath(runtimeConfigFile));
                 }
                 else
@@ -81,7 +81,7 @@ public static bool TryGenerateConfig(InitOptions options, RuntimeConfigLoader lo
         /// <param name="options">Init options</param>
         /// <param name="runtimeConfig">Output runtime config json.</param>
         /// <returns>True on success. False otherwise.</returns>
-        public static bool TryCreateRuntimeConfig(InitOptions options, RuntimeConfigLoader loader, IFileSystem fileSystem, [NotNullWhen(true)] out RuntimeConfig? runtimeConfig)
+        public static bool TryCreateRuntimeConfig(InitOptions options, FileSystemRuntimeConfigLoader loader, IFileSystem fileSystem, [NotNullWhen(true)] out RuntimeConfig? runtimeConfig)
         {
             runtimeConfig = null;
 
@@ -225,7 +225,7 @@ public static bool TryCreateRuntimeConfig(InitOptions options, RuntimeConfigLoad
         /// This method will add a new Entity with the given REST and GraphQL endpoints, source, and permissions.
         /// It also supports fields that needs to be included or excluded for a given role and operation.
         /// </summary>
-        public static bool TryAddEntityToConfigWithOptions(AddOptions options, RuntimeConfigLoader loader, IFileSystem fileSystem)
+        public static bool TryAddEntityToConfigWithOptions(AddOptions options, FileSystemRuntimeConfigLoader loader, IFileSystem fileSystem)
         {
             if (!TryGetConfigFileBasedOnCliPrecedence(loader, options.Config, out string runtimeConfigFile))
             {
@@ -455,7 +455,7 @@ public static bool TryCreateSourceObjectForNewEntity(
         /// This method will update an existing Entity with the given REST and GraphQL endpoints, source, and permissions.
         /// It also supports updating fields that need to be included or excluded for a given role and operation.
         /// </summary>
-        public static bool TryUpdateEntityWithOptions(UpdateOptions options, RuntimeConfigLoader loader, IFileSystem fileSystem)
+        public static bool TryUpdateEntityWithOptions(UpdateOptions options, FileSystemRuntimeConfigLoader loader, IFileSystem fileSystem)
         {
             if (!TryGetConfigFileBasedOnCliPrecedence(loader, options.Config, out string runtimeConfigFile))
             {
@@ -951,7 +951,7 @@ public static bool VerifyCanUpdateRelationship(RuntimeConfig runtimeConfig, stri
         /// overrides < environmentConfig < defaultConfig
         /// Also preforms validation to check connection string is not null or empty.
         /// </summary>
-        public static bool TryStartEngineWithOptions(StartOptions options, RuntimeConfigLoader loader, IFileSystem fileSystem)
+        public static bool TryStartEngineWithOptions(StartOptions options, FileSystemRuntimeConfigLoader loader, IFileSystem fileSystem)
         {
             string? configToBeUsed = options.Config;
             if (string.IsNullOrEmpty(configToBeUsed) && ConfigMerger.TryMergeConfigsIfAvailable(fileSystem, loader, _logger, out configToBeUsed))