Exposing Stub Solver domain config (#601)

* refactoring

* adjusting test

* fixed test

* implementing solver stub json config

* adjsting test

* adjusting tests

* adjusting field

* fixing typo

* testing config mapper

* fixing bug

* creating docs

* implementing env

* fixing tests

* fixing bug

* implementing and testing config flag

* release notes

* [Gradle Release Plugin] - new version commit:  '3.32.2-snapshot'.

Author: mageddo

RELEASE-NOTES.md

@@ -1,3 +1,6 @@
+## 3.32.2
+* Exposing Stub Solver domain config, see the docs. #545
+
 ## 3.32.1
 * Configuring Stub Solver. #545
 

docs/content/2-features/stub-solver/_index.en.md

@@ -38,11 +38,12 @@ ${name}[.-]${ip_address}.stub
 
 ### Customize the domain name
 
-<tbd>
+See the [config reference][2].
 
 ## Refs
 
 * [Stub Solver #545][1]
 
 
 [1]: https://github.com/mageddo/dns-proxy-server/issues/545
+[2]: {{%relref "3-configuration/_index.en.md" %}}

docs/content/3-configuration/_index.en.md

@@ -129,6 +129,16 @@ Default: true
 |-----------------------------------------------|-----------------------------------------|-----------|
 | MG_DOCKER_SOLVER_HOST_MACHINE_FALLBACK_ACTIVE | `dockerSolverHostMachineFallbackActive` | See -help |
 
+### Stub Solver
+
+#### Stub Solver - Domain Name
+
+The domain name used for stub solver resolved hostnames. Default: `stub`.
+
+| Env                        | JSON                    | Terminal  |
+|----------------------------|-------------------------|-----------|
+| MG_STUB_SOLVER_DOMAIN_NAME | `solverStub.domainName` | See -help |
+
 ## Config File Path
 
 The location of the external config file (as the JSON file) can be changed by setting two variables:

gradle.properties

@@ -1 +1 @@
-version=3.32.1-snapshot
+version=3.32.2-snapshot

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

@@ -71,6 +71,8 @@ public class Config {
 
   private Boolean dockerSolverHostMachineFallbackActive;
 
+  private SolverStub solverStub;
+
   private SolverRemote solverRemote;
 
   @NonNull
@@ -100,6 +102,14 @@ public CircuitBreakerStrategyConfig getSolverRemoteCircuitBreakerStrategy() {
     return this.solverRemote.getCircuitBreaker();
   }
 
+  @JsonIgnore
+  public String getSolverStubDomainName() {
+    if (this.solverStub == null) {
+      return null;
+    }
+    return this.solverStub.getDomainName();
+  }
+
   public enum Source {
     JSON,
     FLAG,

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

@@ -0,0 +1,10 @@
+package com.mageddo.dnsproxyserver.config;
+
+import lombok.Builder;
+import lombok.Value;
+
+@Value
+@Builder
+public class SolverStub {
+  private String domainName;
+}

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

@@ -1,10 +1,8 @@
 package com.mageddo.dnsproxyserver.config.dataprovider;
 
 import com.mageddo.dnsproxyserver.config.Config;
-import com.mageddo.dnsproxyserver.config.SolverRemote;
-import com.mageddo.dnsproxyserver.config.dataprovider.mapper.ConfigFieldsValuesMapper;
+import com.mageddo.dnsproxyserver.config.dataprovider.mapper.ConfigEnvMapper;
 import com.mageddo.dnsproxyserver.config.dataprovider.vo.ConfigEnv;
-import com.mageddo.dnsproxyserver.utils.Booleans;
 import lombok.RequiredArgsConstructor;
 
 import javax.inject.Inject;
@@ -16,7 +14,7 @@ public class ConfigDAOEnv implements ConfigDAO {
 
   @Override
   public Config find() {
-    return toConfig(this.findRaw());
+    return ConfigEnvMapper.toConfig(this.findRaw());
   }
 
   public ConfigEnv findRaw() {
@@ -28,26 +26,4 @@ public int priority() {
     return 1;
   }
 
-  static Config toConfig(ConfigEnv config) {
-    return Config.builder()
-      .registerContainerNames(config.getRegisterContainerNames())
-      .domain(config.getDomain())
-      .logFile(config.getLogFile())
-      .logLevel(ConfigFieldsValuesMapper.mapLogLevelFrom(config.getLogLevel()))
-      .dockerHost(config.getDockerHost())
-      .hostMachineHostname(config.getHostMachineHostname())
-      .dpsNetworkAutoConnect(config.getDpsNetworkAutoConnect())
-      .noEntriesResponseCode(config.getNoEntriesResponseCode())
-      .dockerSolverHostMachineFallbackActive(config.getDockerSolverHostMachineFallbackActive())
-      .resolvConfOverrideNameServers(config.getResolvConfOverrideNameServers())
-      .mustConfigureDpsNetwork(config.getDpsNetwork())
-      .resolvConfPaths(config.getResolvConfPath())
-      .solverRemote(SolverRemote
-        .builder()
-        .active(Booleans.reverseWhenNotNull(config.getNoRemoteServers()))
-        .build())
-      .source(Config.Source.ENV)
-      .build();
-  }
-
 }

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

@@ -0,0 +1,37 @@
+package com.mageddo.dnsproxyserver.config.dataprovider.mapper;
+
+import com.mageddo.dnsproxyserver.config.Config;
+import com.mageddo.dnsproxyserver.config.SolverRemote;
+import com.mageddo.dnsproxyserver.config.SolverStub;
+import com.mageddo.dnsproxyserver.config.dataprovider.vo.ConfigEnv;
+import com.mageddo.dnsproxyserver.utils.Booleans;
+
+public class ConfigEnvMapper {
+  public static Config toConfig(ConfigEnv config) {
+    return Config.builder()
+      .registerContainerNames(config.getRegisterContainerNames())
+      .domain(config.getDomain())
+      .logFile(config.getLogFile())
+      .logLevel(ConfigFieldsValuesMapper.mapLogLevelFrom(config.getLogLevel()))
+      .dockerHost(config.getDockerHost())
+      .hostMachineHostname(config.getHostMachineHostname())
+      .dpsNetworkAutoConnect(config.getDpsNetworkAutoConnect())
+      .noEntriesResponseCode(config.getNoEntriesResponseCode())
+      .dockerSolverHostMachineFallbackActive(config.getDockerSolverHostMachineFallbackActive())
+      .resolvConfOverrideNameServers(config.getResolvConfOverrideNameServers())
+      .mustConfigureDpsNetwork(config.getDpsNetwork())
+      .resolvConfPaths(config.getResolvConfPath())
+      .solverRemote(SolverRemote
+        .builder()
+        .active(Booleans.reverseWhenNotNull(config.getNoRemoteServers()))
+        .build()
+      )
+      .solverStub(SolverStub
+        .builder()
+        .domainName(config.getSolverStubDomainName())
+        .build()
+      )
+      .source(Config.Source.ENV)
+      .build();
+  }
+}

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

@@ -2,6 +2,7 @@
 
 import com.mageddo.dnsproxyserver.config.Config;
 import com.mageddo.dnsproxyserver.config.SolverRemote;
+import com.mageddo.dnsproxyserver.config.SolverStub;
 import com.mageddo.dnsproxyserver.config.dataprovider.vo.ConfigFlag;
 import com.mageddo.dnsproxyserver.utils.Booleans;
 import com.mageddo.utils.Files;
@@ -29,6 +30,11 @@ public static Config toConfig(ConfigFlag config) {
         .active(Booleans.reverseWhenNotNull(config.getNoRemoteServers()))
         .build()
       )
+      .solverStub(SolverStub
+        .builder()
+        .domainName(config.getStubSolverDomainName())
+        .build()
+      )
       .source(Config.Source.FLAG)
       .build();
   }

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

@@ -4,6 +4,7 @@
 import com.mageddo.dnsproxyserver.config.CircuitBreakerStrategyConfig;
 import com.mageddo.dnsproxyserver.config.Config;
 import com.mageddo.dnsproxyserver.config.SolverRemote;
+import com.mageddo.dnsproxyserver.config.SolverStub;
 import com.mageddo.dnsproxyserver.config.StaticThresholdCircuitBreakerStrategyConfig;
 import com.mageddo.dnsproxyserver.config.dataprovider.vo.ConfigJson;
 import com.mageddo.dnsproxyserver.config.dataprovider.vo.ConfigJsonV2;
@@ -38,12 +39,23 @@ public static Config toConfig(ConfigJson json, Path configFileAbsolutePath) {
       .dockerSolverHostMachineFallbackActive(json.getDockerSolverHostMachineFallbackActive())
       .configPath(configFileAbsolutePath)
       .solverRemote(toSolverRemote(json))
+      .solverStub(toSolverStub(json.getSolverStub()))
       .source(Config.Source.JSON)
       .build();
   }
 
+  private static SolverStub toSolverStub(ConfigJsonV2.SolverStub solverStub) {
+    if (solverStub == null) {
+      return null;
+    }
+    return SolverStub
+      .builder()
+      .domainName(solverStub.getDomainName())
+      .build();
+  }
+
   static SolverRemote toSolverRemote(ConfigJson json) {
-    if(nothingIsSet(json)){
+    if (nothingIsSet(json)) {
       return null;
     } else if (isPossibleToBuildComplete(json)) {
       return buildCompleteSolverRemote(json, json.getSolverRemoteCircuitBreaker());
@@ -76,9 +88,10 @@ static SolverRemote buildCompleteSolverRemote(ConfigJson json, ConfigJsonV2.Circ
 
   private static CircuitBreakerStrategyConfig mapCircuitBreaker(ConfigJsonV2.CircuitBreaker circuitBreaker) {
     log.debug("circuitBreakerConfigStrategy={}", circuitBreaker.strategy());
-    return switch (circuitBreaker.strategy()){
+    return switch (circuitBreaker.strategy()) {
       case STATIC_THRESHOLD -> mapFromStaticCircuitBreaker((StaticThresholdCircuitBreaker) circuitBreaker);
-      case CANARY_RATE_THRESHOLD -> mapFromCanaryRateThresholdCircuitBreaker((CanaryRateThresholdCircuitBreaker) circuitBreaker);
+      case CANARY_RATE_THRESHOLD ->
+        mapFromCanaryRateThresholdCircuitBreaker((CanaryRateThresholdCircuitBreaker) circuitBreaker);
       default -> throw new UnsupportedOperationException("Unrecognized circuit breaker: " + circuitBreaker.strategy());
     };
   }