Config module domain refactoring (#470)

mageddo · web-flow · commit 68a4758c3b9f · 2024-06-10T15:55:56.000-03:00
* refactoring model entity

* refactoring noRemoteServers entity model

* tests adjustments

* setup validations

* fixing tests

* fixing test

* fixing test

* release notes

* [Gradle Release Plugin] - new version commit:  '3.19.2-snapshot'.
diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
@@ -1,3 +1,6 @@
+## 3.19.2
+* Config module domain refactoring, see #470
+
 ## 3.19.1
 * Resources usage optimization identified at #455
 
diff --git a/gradle.properties b/gradle.properties
@@ -1 +1 @@
-version=3.19.1-snapshot
+version=3.19.2-snapshot
diff --git a/src/main/java/com/mageddo/dnsproxyserver/config/CircuitBreaker.java b/src/main/java/com/mageddo/dnsproxyserver/config/CircuitBreaker.java
@@ -25,4 +25,8 @@ public class CircuitBreaker {
    * @see dev.failsafe.CircuitBreakerBuilder#withDelay(Duration)
    */
   private Duration testDelay;
+
+  public static CircuitBreaker empty() {
+    return CircuitBreaker.builder().build();
+  }
 }
diff --git a/src/main/java/com/mageddo/dnsproxyserver/config/Config.java b/src/main/java/com/mageddo/dnsproxyserver/config/Config.java
@@ -1,5 +1,6 @@
 package com.mageddo.dnsproxyserver.config;
 
+import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.mageddo.dnsserver.SimpleServer;
 import com.mageddo.net.IP;
 import com.mageddo.net.IpAddr;
@@ -25,7 +26,6 @@
 import static com.mageddo.commons.lang.Objects.mapOrNull;
 
 /**
- *
  * @see com.mageddo.dnsproxyserver.config.application.ConfigService
  */
 @Value
@@ -67,8 +67,6 @@ public class Config {
 
   private Boolean resolvConfOverrideNameServers;
 
-  private Boolean noRemoteServers;
-
   private Integer noEntriesResponseCode;
 
   private Boolean dockerSolverHostMachineFallbackActive;
@@ -79,6 +77,14 @@ public class Config {
 
   private SolverRemote solverRemote;
 
+  @JsonIgnore
+  public Boolean isSolverRemoteActive() {
+    if (this.solverRemote == null) {
+      return null;
+    }
+    return this.solverRemote.getActive();
+  }
+
   public void resetConfigFile() {
     try {
       Files.deleteIfExists(this.getConfigPath());
@@ -87,6 +93,14 @@ public void resetConfigFile() {
     }
   }
 
+  @JsonIgnore
+  public CircuitBreaker getSolverRemoteCircuitBreaker() {
+    if (this.solverRemote == null) {
+      return null;
+    }
+    return this.solverRemote.getCircuitBreaker();
+  }
+
   @Value
   public static class Env {
 
diff --git a/src/main/java/com/mageddo/dnsproxyserver/config/SolverRemote.java b/src/main/java/com/mageddo/dnsproxyserver/config/SolverRemote.java
@@ -1,12 +1,13 @@
 package com.mageddo.dnsproxyserver.config;
 
 import lombok.Builder;
-import lombok.NonNull;
 import lombok.Value;
 
 @Value
 @Builder
 public class SolverRemote {
-  @NonNull
+
+  private Boolean active;
+
   private CircuitBreaker circuitBreaker;
 }
diff --git a/src/main/java/com/mageddo/dnsproxyserver/config/dataprovider/ConfigDAOCmdArgs.java b/src/main/java/com/mageddo/dnsproxyserver/config/dataprovider/ConfigDAOCmdArgs.java
@@ -1,8 +1,10 @@
 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.vo.ConfigFlag;
+import com.mageddo.dnsproxyserver.utils.Booleans;
 import com.mageddo.utils.Files;
 import lombok.RequiredArgsConstructor;
 
@@ -42,7 +44,6 @@ static Config toConfig(ConfigFlag config) {
       .logLevel(ConfigFieldsValuesMapper.mapLogLevelFrom(config.getLogLevel()))
       .dockerHost(config.getDockerHost())
       .hostMachineHostname(config.getHostMachineHostname())
-      .noRemoteServers(config.getNoRemoteServers())
       .dpsNetworkAutoConnect(config.getDpsNetworkAutoConnect())
       .noEntriesResponseCode(config.getNoEntriesResponseCode())
       .dockerSolverHostMachineFallbackActive(config.getDockerSolverHostMachineFallbackActive())
@@ -51,6 +52,11 @@ static Config toConfig(ConfigFlag config) {
       .webServerPort(config.getWebServerPort())
       .dnsServerPort(config.getDnsServerPort())
       .defaultDns(config.getDefaultDns())
+      .solverRemote(SolverRemote
+        .builder()
+        .active(Booleans.reverseWhenNotNull(config.getNoRemoteServers()))
+        .build()
+      )
       .build();
   }
 
diff --git a/src/main/java/com/mageddo/dnsproxyserver/config/dataprovider/ConfigDAOEnv.java b/src/main/java/com/mageddo/dnsproxyserver/config/dataprovider/ConfigDAOEnv.java
@@ -1,8 +1,10 @@
 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.vo.ConfigEnv;
+import com.mageddo.dnsproxyserver.utils.Booleans;
 import lombok.RequiredArgsConstructor;
 
 import javax.inject.Inject;
@@ -34,13 +36,16 @@ static Config toConfig(ConfigEnv config) {
       .logLevel(ConfigFieldsValuesMapper.mapLogLevelFrom(config.getLogLevel()))
       .dockerHost(config.getDockerHost())
       .hostMachineHostname(config.getHostMachineHostname())
-      .noRemoteServers(config.getNoRemoteServers())
       .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())
       .build();
   }
 
diff --git a/src/main/java/com/mageddo/dnsproxyserver/config/dataprovider/ConfigDAOJson.java b/src/main/java/com/mageddo/dnsproxyserver/config/dataprovider/ConfigDAOJson.java
@@ -5,6 +5,7 @@
 import com.mageddo.dnsproxyserver.config.SolverRemote;
 import com.mageddo.dnsproxyserver.config.dataprovider.mapper.ConfigFieldsValuesMapper;
 import com.mageddo.dnsproxyserver.config.dataprovider.vo.ConfigJson;
+import com.mageddo.dnsproxyserver.utils.Booleans;
 import com.mageddo.utils.Files;
 import com.mageddo.utils.Runtime;
 import com.mageddo.utils.Tests;
@@ -80,7 +81,6 @@ Config toConfig(ConfigJson json, Path configFileAbsolutePath) {
       .serverProtocol(json.getServerProtocol())
       .dockerHost(json.getDockerHost())
       .resolvConfOverrideNameServers(json.getResolvConfOverrideNameServers())
-      .noRemoteServers(json.getNoRemoteServers())
       .noEntriesResponseCode(json.getNoEntriesResponseCode())
       .dockerSolverHostMachineFallbackActive(json.getDockerSolverHostMachineFallbackActive())
       .configPath(configFileAbsolutePath)
@@ -99,6 +99,7 @@ static SolverRemote toSolverRemote(ConfigJson json) {
     }
     return SolverRemote
       .builder()
+      .active(Booleans.reverseWhenNotNull(json.getNoRemoteServers()))
       .circuitBreaker(CircuitBreaker
         .builder()
         .failureThreshold(circuitBreaker.getFailureThreshold())
diff --git a/src/main/java/com/mageddo/dnsproxyserver/config/mapper/ConfigMapper.java b/src/main/java/com/mageddo/dnsproxyserver/config/mapper/ConfigMapper.java
@@ -4,11 +4,11 @@
 import com.mageddo.dnsproxyserver.config.Config;
 import com.mageddo.dnsproxyserver.config.SolverRemote;
 import com.mageddo.dnsproxyserver.config.dataprovider.ConfigPropDAO;
-import com.mageddo.dnsserver.SimpleServer;
+import com.mageddo.dnsproxyserver.config.validator.ConfigValidator;
 import com.mageddo.dnsproxyserver.utils.Numbers;
+import com.mageddo.dnsserver.SimpleServer;
 import com.mageddo.net.IpAddr;
 import org.apache.commons.lang3.SystemUtils;
-import org.apache.commons.lang3.Validate;
 
 import java.net.URI;
 import java.time.Duration;
@@ -46,12 +46,16 @@ private static Config mapFrom0(List<Config> configs) {
       .serverProtocol(firstNonNullRequiring(mapField(Config::getServerProtocol, configs)))
       .dockerHost(firstNonNullRequiring(mapField(Config::getDockerHost, configs)))
       .resolvConfOverrideNameServers(firstNonNullRequiring(mapField(Config::getResolvConfOverrideNameServers, configs)))
-      .noRemoteServers(firstNonNullRequiring(mapField(Config::getNoRemoteServers, configs)))
       .noEntriesResponseCode(firstNonNullRequiring(mapField(Config::getNoEntriesResponseCode, configs)))
       .dockerSolverHostMachineFallbackActive(firstNonNullRequiring(mapField(Config::getDockerSolverHostMachineFallbackActive, configs)))
-      .solverRemote(firstNonNullRequiring(mapField(Config::getSolverRemote, configs)))
+      .solverRemote(SolverRemote
+        .builder()
+        .active(firstNonNullRequiring(mapField(Config::isSolverRemoteActive, configs)))
+        .circuitBreaker(firstNonNullRequiring(mapField(Config::getSolverRemoteCircuitBreaker, configs)))
+        .build()
+      )
       .build();
-    validate(config);
+    ConfigValidator.validate(config);
     return config;
   }
 
@@ -63,6 +67,7 @@ private static Config buildDefault() {
       .remoteDnsServers(Collections.singletonList(IpAddr.of("8.8.8.8:53")))
       .solverRemote(SolverRemote
         .builder()
+        .active(true)
         .circuitBreaker(defaultCircuitBreaker())
         .build()
       )
@@ -79,25 +84,6 @@ public static CircuitBreaker defaultCircuitBreaker() {
       .build();
   }
 
-  private static void validate(Config config) {
-    Validate.notNull(config.getVersion());
-    Validate.notNull(config.getRemoteDnsServers());
-    Validate.isTrue(config.getWebServerPort() != null && config.getWebServerPort() > 0);
-    Validate.isTrue(config.getDnsServerPort() != null && config.getDnsServerPort() > 0);
-    Validate.notNull(config.getLogFile());
-    Validate.notNull(config.getRegisterContainerNames());
-    Validate.notNull(config.getHostMachineHostname());
-    Validate.notNull(config.getDomain());
-    Validate.notNull(config.getMustConfigureDpsNetwork());
-    Validate.notNull(config.getDpsNetworkAutoConnect());
-    Validate.notNull(config.getResolvConfPaths());
-    Validate.notNull(config.getSolverRemote());
-    Validate.notNull(config.getDockerSolverHostMachineFallbackActive());
-    Validate.notNull(config.getNoRemoteServers());
-    Validate.notNull(config.getServerProtocol());
-    Validate.notNull(config.getResolvConfOverrideNameServers());
-  }
-
   private static URI buildDefaultDockerHost() {
     if (SystemUtils.IS_OS_LINUX || SystemUtils.IS_OS_MAC) {
       return URI.create("unix:///var/run/docker.sock");
diff --git a/src/main/java/com/mageddo/dnsproxyserver/config/validator/CircuitBreakerValidator.java b/src/main/java/com/mageddo/dnsproxyserver/config/validator/CircuitBreakerValidator.java
@@ -0,0 +1,19 @@
+package com.mageddo.dnsproxyserver.config.validator;
+
+import com.mageddo.dnsproxyserver.config.CircuitBreaker;
+import org.apache.commons.lang3.Validate;
+
+import static com.mageddo.dnsproxyserver.utils.Numbers.positiveOrNull;
+
+public class CircuitBreakerValidator {
+  public static void validate(CircuitBreaker circuit) {
+    Validate.notNull(positiveOrNull(circuit.getFailureThreshold()), genMsg("failure theshold must be a positive number"));
+    Validate.notNull(positiveOrNull(circuit.getSuccessThreshold()), genMsg("success theshold must be positive number"));
+    Validate.notNull(positiveOrNull(circuit.getFailureThresholdCapacity()), genMsg("success theshold capacity must be positive number"));
+    Validate.notNull(circuit.getTestDelay(), genMsg("test delay must be not null"));
+  }
+
+  private static String genMsg(String msg) {
+    return "Circuit Breaker: " + msg;
+  }
+}
diff --git a/src/main/java/com/mageddo/dnsproxyserver/config/validator/ConfigValidator.java b/src/main/java/com/mageddo/dnsproxyserver/config/validator/ConfigValidator.java
@@ -0,0 +1,28 @@
+package com.mageddo.dnsproxyserver.config.validator;
+
+import com.mageddo.dnsproxyserver.config.Config;
+import org.apache.commons.lang3.Validate;
+
+public class ConfigValidator {
+  public static void validate(Config config) {
+    Validate.notNull(config.getVersion(), "version");
+    Validate.notNull(config.getRemoteDnsServers(), "remote dns servers");
+    Validate.isTrue(config.getWebServerPort() != null && config.getWebServerPort() > 0, "web server port");
+    Validate.isTrue(config.getDnsServerPort() != null && config.getDnsServerPort() > 0, "dns server port");
+    Validate.notNull(config.getLogFile(), "log file");
+    Validate.notNull(config.getRegisterContainerNames(), "register container names");
+    Validate.notNull(config.getHostMachineHostname(), "host machine hostname");
+    Validate.notNull(config.getDomain(), "domain");
+    Validate.notNull(config.getMustConfigureDpsNetwork(), "must configure dps network");
+    Validate.notNull(config.getDpsNetworkAutoConnect(), "DPS network auto connect");
+    Validate.notNull(config.getResolvConfPaths(), "Resolvconf paths");
+    Validate.notNull(config.getResolvConfOverrideNameServers(), "Resolvconf override name servers");
+    Validate.notNull(config.getDockerSolverHostMachineFallbackActive(), "Docker solver host machine fallback active");
+    Validate.notNull(config.getServerProtocol(), "Server Protocol");
+
+    Validate.notNull(config.getSolverRemote(), "Solver Remote");
+    Validate.notNull(config.isSolverRemoteActive(), "Solver remote active");
+
+    CircuitBreakerValidator.validate(config.getSolverRemoteCircuitBreaker());
+  }
+}
diff --git a/src/main/java/com/mageddo/dnsproxyserver/solver/SolverProvider.java b/src/main/java/com/mageddo/dnsproxyserver/solver/SolverProvider.java
@@ -33,11 +33,15 @@ public SolverProvider(Instance<Solver> solvers, Config config) {
     this.solvers = solvers
       .stream()
       .sorted(Priorities.comparator(Solver::name, solversOrder))
-      .filter(it -> !(config.getNoRemoteServers() && it.is(SolverCachedRemote.NAME)))
+      .filter(it -> !isSolverRemoteWhenItsDisabled(config, it))
       .toList()
     ;
   }
 
+  private static boolean isSolverRemoteWhenItsDisabled(Config config, Solver solver) {
+    return !config.isSolverRemoteActive() && solver.is(SolverCachedRemote.NAME);
+  }
+
   public List<Solver> getSolvers() {
     return this.solvers;
   }
diff --git a/src/main/java/com/mageddo/dnsproxyserver/utils/Booleans.java b/src/main/java/com/mageddo/dnsproxyserver/utils/Booleans.java
@@ -0,0 +1,18 @@
+package com.mageddo.dnsproxyserver.utils;
+
+public class Booleans {
+
+  public static boolean getOrDefault(Boolean value, boolean def) {
+    if (value == null) {
+      return def;
+    }
+    return value;
+  }
+
+  public static Boolean reverseWhenNotNull(Boolean value) {
+    if (value == null) {
+      return null;
+    }
+    return !value;
+  }
+}
diff --git a/src/main/java/com/mageddo/dnsproxyserver/utils/ObjectUtils.java b/src/main/java/com/mageddo/dnsproxyserver/utils/ObjectUtils.java
@@ -4,6 +4,7 @@
 
 import java.util.List;
 import java.util.Optional;
+import java.util.function.Predicate;
 import java.util.function.Supplier;
 
 import static org.apache.commons.lang3.ObjectUtils.firstNonNull;
@@ -37,6 +38,15 @@ public static <T> T firstNonNullRequiring(T... args) {
       ;
   }
 
+  public static <T> T firstMatchRequiring(List<T> args, Predicate<T> predicate) {
+    return args
+      .stream()
+      .filter(predicate)
+      .findFirst()
+      .orElseThrow(() -> new IllegalArgumentException("At least one argument should match the predicate!"))
+      ;
+  }
+
   static Supplier<IllegalArgumentException> throwError() {
     return () -> new IllegalArgumentException("At least one argument shouldn't be null!");
   }
diff --git a/src/test/java/com/mageddo/dnsproxyserver/solver/SolverProviderTest.java b/src/test/java/com/mageddo/dnsproxyserver/solver/SolverProviderTest.java
@@ -1,16 +1,12 @@
 package com.mageddo.dnsproxyserver.solver;
 
-import com.mageddo.dnsproxyserver.config.application.Configs;
 import com.mageddo.dnsproxyserver.quarkus.Instances;
-import com.mageddo.dnsproxyserver.solver.Solver;
-import com.mageddo.dnsproxyserver.solver.SolverMock;
-import com.mageddo.dnsproxyserver.solver.SolverProvider;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.ExtendWith;
 import org.mockito.junit.jupiter.MockitoExtension;
+import testing.templates.ConfigTemplates;
 
 import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.mockito.Mockito.doReturn;
 import static org.mockito.Mockito.spy;
 
 @ExtendWith(MockitoExtension.class)
@@ -19,11 +15,7 @@ class SolverProviderTest {
   @Test
   void mustDisableRemoteSolversWhenNoRemoteServersOptionIsEnabled() {
     // arrange
-    final var config = spy(Configs.getInstance());
-
-    doReturn(true)
-      .when(config)
-      .getNoRemoteServers();
+    final var config = ConfigTemplates.withSolverRemoteDisabled();
 
     final var solvers = Instances.<Solver>of(
       new SolverMock("SolverSystem"),
diff --git a/src/test/java/testing/templates/ConfigTemplates.java b/src/test/java/testing/templates/ConfigTemplates.java
diff --git a/src/test/resources/configs-test/001.json b/src/test/resources/configs-test/001.json
diff --git a/src/test/resources/configs-test/004.json b/src/test/resources/configs-test/004.json

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-version=3.19.1-snapshot`
	`1`	`+version=3.19.2-snapshot`
Original file line number	Diff line number	Diff line change
`@@ -25,4 +25,8 @@ public class CircuitBreaker {`
`25`	`25`	`* @see dev.failsafe.CircuitBreakerBuilder#withDelay(Duration)`
`26`	`26`	`*/`
`27`	`27`	`private Duration testDelay;`
	`28`	`+`
	`29`	`+ public static CircuitBreaker empty() {`
	`30`	`+ return CircuitBreaker.builder().build();`
	`31`	`+ }`
`28`	`32`	`}`