Specifying config source (#563)

* specifying config source

* adjusting tests

* updating test config files

* release notes

Author: mageddo

RELEASE-NOTES.md

@@ -1,3 +1,6 @@
+## 3.28.0
+* Specify from which source the config is coming to facilitate troubleshooting. #533
+
 ## 3.27.0
 * Commandline module upgrade to be able to execute new usecases when creating new native int tests. #533
 

src/main/java/com/mageddo/dnsproxyserver/config/Config.java

@@ -73,6 +73,9 @@ public class Config {
 
   private SolverRemote solverRemote;
 
+  @NonNull
+  private Source source;
+
   @JsonIgnore
   public Boolean isSolverRemoteActive() {
     if (this.solverRemote == null) {
@@ -97,6 +100,21 @@ public CircuitBreakerStrategyConfig getSolverRemoteCircuitBreakerStrategy() {
     return this.solverRemote.getCircuitBreaker();
   }
 
+  public enum Source {
+    JSON,
+    FLAG,
+    DEFAULT,
+    MERGED,
+    ENV,
+
+    /**
+     * Used for testing only;
+     */
+    @Deprecated
+    TESTS_TEMPLATE,
+
+  }
+
   @Value
   public static class Env {
 

src/main/java/com/mageddo/dnsproxyserver/config/application/ConfigService.java

@@ -5,6 +5,7 @@
 import com.mageddo.dnsproxyserver.config.SolverRemote;
 import com.mageddo.dnsproxyserver.config.dataprovider.ConfigDAO;
 import com.mageddo.dnsproxyserver.config.mapper.ConfigMapper;
+import lombok.extern.slf4j.Slf4j;
 import org.apache.commons.lang3.ClassUtils;
 
 import javax.enterprise.inject.Instance;
@@ -14,6 +15,7 @@
 import java.util.List;
 import java.util.stream.Stream;
 
+@Slf4j
 @Singleton
 public class ConfigService {
 
@@ -28,7 +30,9 @@ public ConfigService(Instance<ConfigDAO> configDAOS) {
   }
 
   public Config findCurrentConfig() {
-    return ConfigMapper.mapFrom(this.findConfigs());
+    final var configs = this.findConfigs();
+    log.trace("baseConfigs={}", configs);
+    return ConfigMapper.mapFrom(configs);
   }
 
   public SolverRemote findCurrentConfigRemote(){

src/main/java/com/mageddo/dnsproxyserver/config/dataprovider/ConfigDAOEnv.java

@@ -46,6 +46,7 @@ static Config toConfig(ConfigEnv config) {
         .builder()
         .active(Booleans.reverseWhenNotNull(config.getNoRemoteServers()))
         .build())
+      .source(Config.Source.ENV)
       .build();
   }
 

src/main/java/com/mageddo/dnsproxyserver/config/dataprovider/mapper/ConfigFlagMapper.java

@@ -29,6 +29,7 @@ public static Config toConfig(ConfigFlag config) {
         .active(Booleans.reverseWhenNotNull(config.getNoRemoteServers()))
         .build()
       )
+      .source(Config.Source.FLAG)
       .build();
   }
 }

src/main/java/com/mageddo/dnsproxyserver/config/dataprovider/mapper/ConfigJsonV2Mapper.java

@@ -32,6 +32,7 @@ public static Config toConfig(ConfigJson json, Path configFileAbsolutePath) {
       .dockerSolverHostMachineFallbackActive(json.getDockerSolverHostMachineFallbackActive())
       .configPath(configFileAbsolutePath)
       .solverRemote(toSolverRemote(json))
+      .source(Config.Source.JSON)
       .build();
   }
 

src/main/java/com/mageddo/dnsproxyserver/config/dataprovider/vo/ConfigEnv.java

@@ -41,13 +41,13 @@ public class ConfigEnv {
 
   public static final String MG_RESOLVCONF_OVERRIDE_NAMESERVERS = "MG_RESOLVCONF_OVERRIDE_NAMESERVERS";
 
-  private static final String MG_NO_REMOTE_SERVERS = "MG_NO_REMOTE_SERVERS";
+  public static final String MG_NO_REMOTE_SERVERS = "MG_NO_REMOTE_SERVERS";
 
-  private static final String MG_NO_ENTRIES_RESPONSE_CODE = "MG_NO_ENTRIES_RESPONSE_CODE";
+  public static final String MG_NO_ENTRIES_RESPONSE_CODE = "MG_NO_ENTRIES_RESPONSE_CODE";
 
-  private static final String MG_DOCKER_SOLVER_HOST_MACHINE_FALLBACK_ACTIVE = "MG_DOCKER_SOLVER_HOST_MACHINE_FALLBACK_ACTIVE";
+  public static final String MG_DOCKER_SOLVER_HOST_MACHINE_FALLBACK_ACTIVE = "MG_DOCKER_SOLVER_HOST_MACHINE_FALLBACK_ACTIVE";
 
-  private static final String MG_CONFIG_FILE_PATH = "MG_CONFIG_FILE_PATH";
+  public static final String MG_CONFIG_FILE_PATH = "MG_CONFIG_FILE_PATH";
 
   private Path workingDir;
   private String resolvConfPath;

src/main/java/com/mageddo/dnsproxyserver/config/mapper/ConfigMapper.java

@@ -54,6 +54,7 @@ private static Config mapFrom0(List<Config> configs) {
         .circuitBreaker(firstNonNullRequiring(mapField(Config::getSolverRemoteCircuitBreakerStrategy, configs)))
         .build()
       )
+      .source(Config.Source.MERGED)
       .build();
     ConfigValidator.validate(config);
     return config;
@@ -71,6 +72,7 @@ private static Config buildDefault() {
         .circuitBreaker(defaultCircuitBreaker())
         .build()
       )
+      .source(Config.Source.DEFAULT)
       .build();
   }
 

src/test/java/com/mageddo/dnsproxyserver/AppSettingsTest.java

@@ -9,7 +9,7 @@
 
 class AppSettingsTest {
   @Test
-  void mustLogLevelInSl4jConvetion(){
+  void mustLogLevelInSl4jConversion(){
     // arrange
     final var config = ConfigTemplates.defaultWithoutId();
 

src/test/java/testing/templates/ConfigTemplates.java

@@ -40,6 +40,7 @@ private static Config.ConfigBuilder defaultBuilder() {
       )
       .noEntriesResponseCode(3)
       .dockerSolverHostMachineFallbackActive(true)
+      .source(Config.Source.TESTS_TEMPLATE)
       ;
   }