Option to disable a specific container to be resolved from DPS (#672)

mageddo · web-flow · commit 4133461498a8 · 2025-12-25T22:56:49.000-03:00
diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md
@@ -1,5 +1,6 @@
-## 5.7.0 Alpha
+## 5.8.0
 * DNS over HTTPS, see #138
+* Option to disable a specific container to be resolved from DPS, see #596.
 
 ## 5.6.2
 * Fixing Getting Non-authoritative answer when unexpected, see #608.
diff --git a/gradle.properties b/gradle.properties
@@ -1 +1 @@
-version=5.7.0-snapshot
+version=5.8.0-snapshot
diff --git a/src/main/java/com/mageddo/dataformat/env/EnvMapper.java b/src/main/java/com/mageddo/dataformat/env/EnvMapper.java
@@ -169,7 +169,7 @@ private Object convertValue(final String rawValue) {
     if ("null".equalsIgnoreCase(value)) {
       return null;
     }
-    if ("true".equalsIgnoreCase(value) || "false".equalsIgnoreCase(value)) {
+    if ("true".equalsIgnoreCase(value) || "false".equalsIgnoreCase(value) || "1".equals(value)) {
       return Boolean.valueOf(value);
     }
 
diff --git a/src/main/java/com/mageddo/dnsproxyserver/docker/ContainerPredicates.java b/src/main/java/com/mageddo/dnsproxyserver/docker/ContainerPredicates.java
@@ -0,0 +1,13 @@
+package com.mageddo.dnsproxyserver.docker;
+
+import com.github.dockerjava.api.model.Container;
+import com.mageddo.dnsproxyserver.docker.application.Labels;
+import com.mageddo.dnsproxyserver.solver.docker.Label;
+
+public class ContainerPredicates {
+
+  public static boolean isEnabledForDPS(Container c) {
+    return Labels.findBoolean(c, Label.DPS_CONTAINER_ENABLED, true);
+  }
+
+}
diff --git a/src/main/java/com/mageddo/dnsproxyserver/docker/application/Labels.java b/src/main/java/com/mageddo/dnsproxyserver/docker/application/Labels.java
@@ -1,23 +1,44 @@
 package com.mageddo.dnsproxyserver.docker.application;
 
 import java.util.Map;
+import java.util.Objects;
 
 import com.github.dockerjava.api.command.InspectContainerResponse;
+import com.github.dockerjava.api.model.Container;
 import com.github.dockerjava.api.model.ContainerConfig;
+import com.mageddo.dnsproxyserver.utils.Booleans;
 
 public class Labels {
 
   public static final String SERVICE_NAME_LABEL = "com.docker.compose.service";
 
-  public static String findLabelValue(ContainerConfig c, String label) {
-    return findLabelValue(c.getLabels(), label);
+  public static String findValue(Container c, String label) {
+    if (c == null) {
+      return null;
+    }
+    return findValue(c.getLabels(), label);
+  }
+
+  public static boolean findBoolean(Container c, String label) {
+    return findBoolean(c, label, false);
+  }
+
+  public static boolean findBoolean(Container c, String label, boolean defaultValue) {
+    return Objects.requireNonNullElse(
+        Booleans.parse(findValue(c, label)),
+        defaultValue
+    );
+  }
+
+  public static String findValue(ContainerConfig c, String label) {
+    return findValue(c.getLabels(), label);
   }
 
-  public static String findLabelValue(InspectContainerResponse inspect, String label) {
-    return findLabelValue(inspect.getConfig(), label);
+  public static String findValue(InspectContainerResponse inspect, String label) {
+    return findValue(inspect.getConfig(), label);
   }
 
-  public static String findLabelValue(Map<String, String> labels, String label) {
+  public static String findValue(Map<String, String> labels, String label) {
     if (labels == null) {
       return null;
     }
diff --git a/src/main/java/com/mageddo/dnsproxyserver/docker/dataprovider/ContainerFacade.java b/src/main/java/com/mageddo/dnsproxyserver/docker/dataprovider/ContainerFacade.java
@@ -17,4 +17,5 @@ public interface ContainerFacade {
   InspectContainerResponse safeInspect(String id);
 
   Stream<InspectContainerResponse> inspectFilteringValidContainers(List<Container> containers);
+
 }
diff --git a/src/main/java/com/mageddo/dnsproxyserver/docker/dataprovider/ContainerFacadeDefault.java b/src/main/java/com/mageddo/dnsproxyserver/docker/dataprovider/ContainerFacadeDefault.java
@@ -39,13 +39,12 @@ public Container findById(String containerId) {
 
   @Override
   public List<Container> findActiveContainers() {
-    final var activeContainers = this.dockerClient
+    return this.dockerClient
         .listContainersCmd()
         .withStatusFilter(Containers.RUNNING_STATUS_LIST)
         .withLimit(1024)
 //      .withNetworkFilter()
         .exec();
-    return activeContainers;
   }
 
   @Override
@@ -72,9 +71,10 @@ public InspectContainerResponse safeInspect(String id) {
   public Stream<InspectContainerResponse> inspectFilteringValidContainers(List<Container> containers) {
     return containers
         .stream()
-        .map(com.github.dockerjava.api.model.Container::getId)
+        .map(Container::getId)
         .map(this::safeInspect)
         .filter(Objects::nonNull)
         ;
   }
+
 }
diff --git a/src/main/java/com/mageddo/dnsproxyserver/solver/docker/ContainerCompact.java b/src/main/java/com/mageddo/dnsproxyserver/solver/docker/ContainerCompact.java
@@ -12,13 +12,13 @@
 public class ContainerCompact {
 
   @NonNull
-  private String id;
+  String id;
 
   @NonNull
-  private String name;
+  String name;
 
   @NonNull
-  private Boolean dpsContainer;
+  Boolean dpsContainer;
 
   public boolean isNotDpsContainer() {
     return !this.dpsContainer;
diff --git a/src/main/java/com/mageddo/dnsproxyserver/solver/docker/Label.java b/src/main/java/com/mageddo/dnsproxyserver/solver/docker/Label.java
@@ -0,0 +1,7 @@
+package com.mageddo.dnsproxyserver.solver.docker;
+
+public class Label {
+  public static final String DPS_DEFAULT_NETWORK = "dps.network";
+  public static final String DPS_CONTAINER = "dps.container";
+  public static final String DPS_CONTAINER_ENABLED = "dps.container.enabled";
+}
diff --git a/src/main/java/com/mageddo/dnsproxyserver/solver/docker/application/DockerNetworkService.java b/src/main/java/com/mageddo/dnsproxyserver/solver/docker/application/DockerNetworkService.java
@@ -38,10 +38,17 @@ public List<String> disconnectContainers(String id) {
 
   public void connectContainerTo(String networkName, String containerId) {
     if (this.dpsContainerDAO.isDpsContainer(containerId)) {
-      log.info("status=won't connect dps container using conventional mode, containerId={}",
+      log.info(
+          "status=won't connect dps container using conventional mode, containerId={}",
           containerId
       );
       return;
+    } else if (!this.containerDAO.isEnabledForDPS(containerId)) {
+      log.info(
+          "status=wontConnectToNetwork, reason=disabledForDps, network={}, containerId={}",
+          networkName, containerId
+      );
+      return;
     }
     final var status = this.networkDAO.connect(networkName, containerId);
     log.info("status={}, networkName={}, containerId={}", status, networkName, containerId);
diff --git a/src/main/java/com/mageddo/dnsproxyserver/solver/docker/dataprovider/ContainerDAO.java b/src/main/java/com/mageddo/dnsproxyserver/solver/docker/dataprovider/ContainerDAO.java
@@ -12,4 +12,5 @@ public interface ContainerDAO {
 
   List<Container> findActiveContainersMatching(HostnameQuery query);
 
+  boolean isEnabledForDPS(String containerId);
 }
diff --git a/src/main/java/com/mageddo/dnsproxyserver/solver/docker/dataprovider/ContainerDAODefault.java b/src/main/java/com/mageddo/dnsproxyserver/solver/docker/dataprovider/ContainerDAODefault.java
@@ -7,6 +7,7 @@
 import javax.inject.Singleton;
 
 import com.github.dockerjava.api.DockerClient;
+import com.mageddo.dnsproxyserver.docker.ContainerPredicates;
 import com.mageddo.dnsproxyserver.docker.dataprovider.ContainerFacade;
 import com.mageddo.dnsproxyserver.solver.HostnameQuery;
 import com.mageddo.dnsproxyserver.solver.docker.Container;
@@ -18,8 +19,8 @@
 import lombok.extern.slf4j.Slf4j;
 
 @Slf4j
-@Singleton
 @Default
+@Singleton
 @RequiredArgsConstructor(onConstructor_ = @Inject)
 public class ContainerDAODefault implements ContainerDAO {
 
@@ -28,8 +29,8 @@ public class ContainerDAODefault implements ContainerDAO {
 
   @Override
   public List<Container> findActiveContainersMatching(HostnameQuery query) {
-    final var containersToFilter = this.containerFacade.findActiveContainers();
-    return this.containerFacade.inspectFilteringValidContainers(containersToFilter)
+    final var containers = this.findActiveContainers();
+    return this.containerFacade.inspectFilteringValidContainers(containers)
         .filter(ContainerHostnameMatcher.buildPredicate(query))
         .map(ContainerMapper::of)
         .toList();
@@ -41,8 +42,22 @@ public List<ContainerCompact> findNetworkContainers(String networkId) {
         .withNetworkFilter(List.of(networkId))
         .exec()
         .stream()
+        .filter(ContainerPredicates::isEnabledForDPS)
         .map(ContainerCompactMapper::of)
         .toList();
   }
 
+  List<com.github.dockerjava.api.model.Container> findActiveContainers() {
+    return this.containerFacade.findActiveContainers()
+        .stream()
+        .filter(ContainerPredicates::isEnabledForDPS)
+        .toList()
+        ;
+  }
+
+  @Override
+  public boolean isEnabledForDPS(String containerId) {
+    return ContainerPredicates.isEnabledForDPS(this.containerFacade.findById(containerId));
+  }
+
 }
diff --git a/src/main/java/com/mageddo/dnsproxyserver/solver/docker/dataprovider/Docker.java b/src/main/java/com/mageddo/dnsproxyserver/solver/docker/dataprovider/Docker.java
@@ -42,7 +42,7 @@ static Set<Hostname> buildHostnamesFromServiceOrContainerNames(InspectContainerR
   }
 
   static String buildFromServiceName(InspectContainerResponse container, String domain) {
-    final var serviceName = Labels.findLabelValue(container, Labels.SERVICE_NAME_LABEL);
+    final var serviceName = Labels.findValue(container, Labels.SERVICE_NAME_LABEL);
     log.trace("status=serviceFindResult, service={}", serviceName);
     if (StringUtils.isBlank(serviceName)) {
       return null;
diff --git a/src/main/java/com/mageddo/dnsproxyserver/solver/docker/dataprovider/DpsContainerDAODefault.java b/src/main/java/com/mageddo/dnsproxyserver/solver/docker/dataprovider/DpsContainerDAODefault.java
@@ -12,6 +12,7 @@
 import com.mageddo.dnsproxyserver.docker.application.Containers;
 import com.mageddo.dnsproxyserver.docker.dataprovider.ContainerFacade;
 import com.mageddo.dnsproxyserver.solver.docker.Container;
+import com.mageddo.dnsproxyserver.solver.docker.Label;
 import com.mageddo.dnsproxyserver.solver.docker.Network;
 import com.mageddo.dnsproxyserver.solver.docker.dataprovider.mapper.ContainerMapper;
 import com.mageddo.dnsproxyserver.solver.docker.dataprovider.mapper.IpamMapper;
@@ -47,7 +48,7 @@ public Container findDPSContainer() {
     final var containers = this.dockerClient
         .listContainersCmd()
         .withStatusFilter(Collections.singletonList("running"))
-        .withLabelFilter(Collections.singletonList("dps.container=true"))
+            .withLabelFilter(Collections.singletonList(Label.DPS_CONTAINER + "=true"))
         .exec();
 
     if (containers.size() > 1) {
diff --git a/src/main/java/com/mageddo/dnsproxyserver/solver/docker/dataprovider/DpsContainerUtils.java b/src/main/java/com/mageddo/dnsproxyserver/solver/docker/dataprovider/DpsContainerUtils.java
@@ -3,23 +3,22 @@
 import java.util.Arrays;
 import java.util.Collections;
 import java.util.LinkedHashSet;
-import java.util.Objects;
 import java.util.Set;
 import java.util.stream.Collectors;
 
 import com.github.dockerjava.api.model.Container;
 import com.mageddo.dns.Hostname;
+import com.mageddo.dnsproxyserver.docker.application.Labels;
 import com.mageddo.dnsproxyserver.utils.Splits;
 
+import static com.mageddo.dnsproxyserver.solver.docker.Label.DPS_CONTAINER;
+
 public class DpsContainerUtils {
 
   public static final String HOSTNAME_ENV = "HOSTNAMES=";
-  public static final String DPS_CONTAINER_LABEL = "dps.container";
 
   public static boolean isDpsContainer(Container c) {
-    final var lbl = c.getLabels()
-        .get(DPS_CONTAINER_LABEL);
-    return Objects.equals(lbl, "true");
+    return Labels.findBoolean(c, DPS_CONTAINER);
   }
 
   public static boolean isNotDpsContainer(Container container) {
diff --git a/src/main/java/com/mageddo/dnsproxyserver/solver/docker/dataprovider/mapper/ContainerMapper.java b/src/main/java/com/mageddo/dnsproxyserver/solver/docker/dataprovider/mapper/ContainerMapper.java
@@ -15,6 +15,7 @@
 import com.mageddo.dnsproxyserver.config.application.Configs;
 import com.mageddo.dnsproxyserver.docker.application.Labels;
 import com.mageddo.dnsproxyserver.solver.docker.Container;
+import com.mageddo.dnsproxyserver.solver.docker.Label;
 import com.mageddo.dnsproxyserver.solver.docker.Network;
 import com.mageddo.net.IP;
 import com.mageddo.net.Networks;
@@ -23,8 +24,6 @@
 
 public class ContainerMapper {
 
-  public static final String DEFAULT_NETWORK_LABEL = "dps.network";
-
   public static Container of(InspectContainerResponse inspect) {
     return of(inspect, findPreferred());
   }
@@ -111,7 +110,7 @@ private static LinkedHashSet<String> buildDefaultWithPrincipal(InspectContainerR
   }
 
   private static String mapPrincipalNetworkName(InspectContainerResponse c) {
-    return Labels.findLabelValue(c.getConfig(), DEFAULT_NETWORK_LABEL);
+    return Labels.findValue(c, Label.DPS_DEFAULT_NETWORK);
   }
 
   private static LinkedHashSet<String> buildDefault(String principalNetworkName) {
diff --git a/src/main/java/com/mageddo/dnsproxyserver/solver/docker/entrypoint/EventListener.java b/src/main/java/com/mageddo/dnsproxyserver/solver/docker/entrypoint/EventListener.java
@@ -24,6 +24,7 @@
 @AllArgsConstructor(onConstructor_ = @Inject)
 public class EventListener implements StartupEvent {
 
+  public static final String START_EVENT = "start";
   private final DockerClient dockerClient;
   private final DpsDockerEnvironmentSetupService dpsDockerEnvironmentSetupService;
   private final DockerNetworkService networkService;
@@ -53,7 +54,7 @@ public void onNext(Event event) {
               "status=event, id={}, action={}, type={}, status={}, event={}",
               event.getId(), event.getAction(), event.getType(), event.getStatus(), event
           );
-          if (StringUtils.equals(event.getAction(), "start")) {
+          if (StringUtils.equals(event.getAction(), START_EVENT)) {
             networkService.connectContainerTo(Network.Name.DPS.lowerCaseName(), event.getId());
             return;
           }
@@ -73,7 +74,7 @@ public void onComplete() {
     };
     this.dockerClient
         .eventsCmd()
-        .withEventFilter("start")
+        .withEventFilter(START_EVENT)
         .exec(callback);
   }
 
diff --git a/src/main/java/com/mageddo/dnsproxyserver/utils/Booleans.java b/src/main/java/com/mageddo/dnsproxyserver/utils/Booleans.java
@@ -1,5 +1,10 @@
 package com.mageddo.dnsproxyserver.utils;
 
+import java.util.Objects;
+
+import org.apache.commons.lang3.StringUtils;
+import org.apache.commons.lang3.Strings;
+
 public class Booleans {
 
   public static boolean getOrDefault(Boolean value, boolean def) {
@@ -15,4 +20,11 @@ public static Boolean reverseWhenNotNull(Boolean value) {
     }
     return !value;
   }
+
+    public static Boolean parse(String v) {
+      if (StringUtils.isBlank(v)) {
+        return null;
+      }
+      return Objects.equals(v, "1") || Strings.CI.equals(v, "true");
+    }
 }
diff --git a/src/main/java/com/mageddo/dnsproxyserver/utils/Envs.java b/src/main/java/com/mageddo/dnsproxyserver/utils/Envs.java
@@ -2,7 +2,6 @@
 
 import java.nio.file.Path;
 import java.nio.file.Paths;
-import java.util.Objects;
 import java.util.Optional;
 
 import org.apache.commons.lang3.StringUtils;
@@ -33,14 +32,7 @@ public static String getStringOrNull(String env) {
 
   public static Boolean getBooleanOrNull(String env) {
     final var v = StringUtils.trimToEmpty(System.getenv(env));
-    return parseBoolean(v);
-  }
-
-  static Boolean parseBoolean(String v) {
-    if (StringUtils.isBlank(v)) {
-      return null;
-    }
-    return Objects.equals(v, "1") || StringUtils.equalsIgnoreCase(v, "true");
+    return Booleans.parse(v);
   }
 
   public static String getStringOrDefault(String env, String def) {
diff --git a/src/test/java/com/mageddo/dnsproxyserver/docker/application/LabelsTest.java b/src/test/java/com/mageddo/dnsproxyserver/docker/application/LabelsTest.java
diff --git a/src/test/java/com/mageddo/dnsproxyserver/utils/EnvsTest.java b/src/test/java/com/mageddo/dnsproxyserver/utils/EnvsTest.java

Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-version=5.7.0-snapshot`
	`1`	`+version=5.8.0-snapshot`
Original file line number	Diff line number	Diff line change
`@@ -169,7 +169,7 @@ private Object convertValue(final String rawValue) {`
`169`	`169`	`if ("null".equalsIgnoreCase(value)) {`
`170`	`170`	`return null;`
`171`	`171`	`}`
`172`		`- if ("true".equalsIgnoreCase(value) \|\| "false".equalsIgnoreCase(value)) {`
	`172`	`+ if ("true".equalsIgnoreCase(value) \|\| "false".equalsIgnoreCase(value) \|\| "1".equals(value)) {`
`173`	`173`	`return Boolean.valueOf(value);`
`174`	`174`	`}`
`175`	`175`
Original file line number	Diff line number	Diff line change
`@@ -17,4 +17,5 @@ public interface ContainerFacade {`
`17`	`17`	`InspectContainerResponse safeInspect(String id);`
`18`	`18`
`19`	`19`	`Stream<InspectContainerResponse> inspectFilteringValidContainers(List<Container> containers);`
	`20`	`+`
`20`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -39,13 +39,12 @@ public Container findById(String containerId) {`
`39`	`39`
`40`	`40`	`@Override`
`41`	`41`	`public List<Container> findActiveContainers() {`
`42`		`- final var activeContainers = this.dockerClient`
	`42`	`+ return this.dockerClient`
`43`	`43`	`.listContainersCmd()`
`44`	`44`	`.withStatusFilter(Containers.RUNNING_STATUS_LIST)`
`45`	`45`	`.withLimit(1024)`
`46`	`46`	`// .withNetworkFilter()`
`47`	`47`	`.exec();`
`48`		`- return activeContainers;`
`49`	`48`	`}`
`50`	`49`
`51`	`50`	`@Override`
`@@ -72,9 +71,10 @@ public InspectContainerResponse safeInspect(String id) {`
`72`	`71`	`public Stream<InspectContainerResponse> inspectFilteringValidContainers(List<Container> containers) {`
`73`	`72`	`return containers`
`74`	`73`	`.stream()`
`75`		`- .map(com.github.dockerjava.api.model.Container::getId)`
	`74`	`+ .map(Container::getId)`
`76`	`75`	`.map(this::safeInspect)`
`77`	`76`	`.filter(Objects::nonNull)`
`78`	`77`	`;`
`79`	`78`	`}`
	`79`	`+`
`80`	`80`	`}`