Create IntTests suite, they are comp tests which can be run within native image #480 (#537)

* upgrading rest assured due groovy error with nativeTest task

Error encountered while parsing java.lang.invoke.MutableCallSite.setTarget(MutableCallSite.java:155)
Parsing context:
   at java.lang.invoke.SwitchPoint.invalidateAll(SwitchPoint.java:225)
   at org.codehaus.groovy.vmplugin.v8.IndyInterface.invalidateSwitchPoints(IndyInterface.java:186)
   at org.codehaus.groovy.vmplugin.v8.IndyInterface$$Lambda/0x00000007c2399648.updateConstantMetaClass(Unknown Source)
�

* ignoring rest assured error and leaving it fail at tests if the problematic code will be used anyway

* int test it's working

* clean code

* fixing bug

* configuring native test at the same source set as test

* enabling native image test

* adjusting reflection generation

* adjusts

* test is working

* adjusting conf path

* print test logs to console

* trying to get logs to check why test is failing

* finding 'stream closed' cause

* handling fatal errors

* testing fatal error handling

* delete hello world int test

* re-enabling restassured

* reverting restassured feature disabling

* clean code

* updating the docs about native image test

* refactoring

* refactoring

* refactoring

* refactoring

* explaining about the kind of tests

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

* fixing test

* release notes

* refactoring the docs

* unnecessary path

* clean code

* make test repeatable

* testing test class and refactoring

* refactoring class

* fixing test

* caching

* testing

* creating flags

* wasn't using the default config when file was empty

* make test repeatable

* hostnames list must be changable

* refactoring

* refactoring

* troubleshooting

* refactorings

* testing

* refactoring

* testing

* finally fixing bug which gets the wrong list

* leading with methods

* fixing field parsing

* reverting

* clean code

Author: mageddo

RELEASE-NOTES.md

@@ -1,3 +1,7 @@
+## 3.25.10
+* Create `IntTests` suite, they are comp tests which can be run within native image, see the docs #480
+* Upgrading necessary deps
+
 ## 3.25.9
 * Handling and logging fatal errors #480
 

build.gradle

@@ -35,9 +35,8 @@ sourceSets {
     compileClasspath += sourceSets.test.runtimeClasspath
     runtimeClasspath += sourceSets.test.runtimeClasspath
   }
-}
-
 
+}
 
 dependencies {
 
@@ -47,6 +46,9 @@ dependencies {
   compileOnly('com.mageddo.nativeimage:reflection-config-generator:2.4.4')
   annotationProcessor('com.mageddo.nativeimage:reflection-config-generator:2.4.4')
 
+  testCompileOnly('com.mageddo.nativeimage:reflection-config-generator:2.4.4')
+  testAnnotationProcessor('com.mageddo.nativeimage:reflection-config-generator:2.4.4')
+
   annotationProcessor("com.google.dagger:dagger-compiler:2.45")
   implementation("com.google.dagger:dagger:2.45")
 
@@ -67,7 +69,7 @@ dependencies {
   implementation('com.github.docker-java:docker-java-core:3.3.4')
   implementation('com.github.docker-java:docker-java-transport-httpclient5:3.3.4')
 
-  implementation('info.picocli:picocli:4.7.1')
+  implementation('info.picocli:picocli:4.7.6')
   implementation('com.fasterxml.jackson.datatype:jackson-datatype-jsr310:2.17.1')
 
   implementation('com.github.ben-manes.caffeine:caffeine:3.1.8')
@@ -82,8 +84,8 @@ dependencies {
 
   testImplementation("org.junit.jupiter:junit-jupiter:5.10.+")
   testImplementation('org.mockito:mockito-junit-jupiter:5.12.+')
-  testImplementation('io.rest-assured:rest-assured:5.3.0')
-
+  testImplementation ('org.hamcrest:hamcrest:3.0')
+  testImplementation('io.rest-assured:rest-assured:5.5.0')
 
 }
 
@@ -93,15 +95,33 @@ test {
   testLogging {
     events "passed", "skipped", "failed"
   }
+  testLogging {
+    showStandardStreams = true
+  }
+}
+
+def compTest = tasks.register("compTest", Test) {
+  useJUnitPlatform()
+  include "**/*CompTest.class", "**/*IntTest.class"
+  failFast = true
+  testLogging {
+    events "passed", "skipped", "failed"
+  }
+  testLogging {
+    showStandardStreams = true
+  }
 }
 
-task compTest(type: Test) {
+def intTest = tasks.register("intTest", Test) {
   useJUnitPlatform()
-  include "**/*CompTest.class"
+  include "**/*IntTest.class"
   failFast = true
   testLogging {
     events "passed", "skipped", "failed"
   }
+  testLogging {
+    showStandardStreams = true
+  }
 }
 
 task stressTest(type: Test) {
@@ -115,6 +135,9 @@ task stressTest(type: Test) {
   testLogging {
     events "passed", "skipped", "failed"
   }
+  testLogging {
+    showStandardStreams = true
+  }
 }
 
 compileJava {
@@ -162,7 +185,6 @@ tasks.register('nativeImageJar', ShadowJar) {
   exclude("/META-INF/*.SF")
   exclude("/META-INF/*.DSA")
   exclude("/META-INF/*.RSA")
-
 }
 
 shadowJar {
@@ -184,6 +206,11 @@ graalvmNative {
       buildArgs.add('-J-Xmx5G')
 
     }
+
+  }
+  registerTestBinary("intTest") {
+    usingSourceSet(sourceSets.test)
+    forTestTask(intTest)
   }
 }
 
@@ -200,15 +227,11 @@ release {
 
 }
 
-// don't create tags as github-cli will do that
-preTagCommit.enabled = false
-createReleaseTag.enabled = false
-
-confirmReleaseVersion {
-  doLast {
-    // codigo com a versao atual...
-  }
+def dontCreateTagsAsTheCdWill(){
+  preTagCommit.enabled = false
+  createReleaseTag.enabled = false
 }
+dontCreateTagsAsTheCdWill()
 
 tasks.register("updateNewVersion") {
   doLast {

docs/content/4-developing/_index.en.md

@@ -42,4 +42,37 @@ $ docker-compose -f docker-compose-dev.yml run --rm -it backend bash
 $ java -jar dns-proxy-server-*-all.jar
 ```
 
+## Automated Tests
+
+### Unit Tests
+
+Verify the functionality of individual components or units of code, typically functions or methods, 
+to ensure they work as expected.
+
+### Comp Tests
+
+Verify the functionality of entire flows but can mock some parts, example is an endpoint
+which changes some setting at config file, etc.
+
+### Int Tests
+
+Are like Comp Test but used to test native-image compiling, for that reason they
+can't mock using frameworks like Mockito, this kind of test need to evict mocks and when do,
+use flags instead of stubs/mocks.
+
+Tests ending with `IntTest.java` can be run within the native image binary to check if
+the native-image compilation produces a working binary version.
+
+Run Int Tests within the Native Image
+
+```bash
+$ ./gradlew clean nativeIntTest
+```
+
+Run Int Tests within the jar version
+
+```bash
+$ ./gradlew clean intTest
+```
+
 [1]: {{%relref "1-getting-started/requirements/_index.en.md" %}}

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

@@ -11,14 +11,10 @@ public class Configs {
   private static final Context context = Context.create();
 
   public static Config getInstance() {
-    final Config v = Singletons.get(Config.class);
-    if (v != null) {
-      return v;
-    } else {
-      return Singletons.createOrGet(Config.class, () -> {
-        return context.configService().findCurrentConfig();
-      });
-    }
+    return Singletons.createOrGet(Config.class, () -> {
+      log.trace("status=cacheHotLoading");
+      return context.configService().findCurrentConfig();
+    });
   }
 
   public static void clear() {

src/main/java/com/mageddo/dnsproxyserver/di/StartupEvent.java

@@ -1,22 +1,5 @@
 package com.mageddo.dnsproxyserver.di;
 
-import java.util.Collection;
-import java.util.Objects;
-
 public interface StartupEvent {
-
-  static boolean exists(Collection<StartupEvent> events, Class<?> clazz) {
-    return lookup(events, clazz) != null;
-  }
-
-  static <T> T lookup(Collection<StartupEvent> events, Class<T> clazz) {
-    return (T) events
-      .stream()
-      .filter(it -> Objects.equals(clazz, it.getClass()))
-      .findFirst()
-      .orElse(null)
-      ;
-  }
-
   void onStart();
 }

src/main/java/com/mageddo/dnsproxyserver/di/StartupEvents.java

@@ -0,0 +1,23 @@
+package com.mageddo.dnsproxyserver.di;
+
+import lombok.extern.slf4j.Slf4j;
+
+import java.util.Collection;
+import java.util.Objects;
+
+@Slf4j
+public class StartupEvents {
+  public static boolean exists(Collection<StartupEvent> events, Class<?> classToFind) {
+    return lookup(events, classToFind) != null;
+  }
+
+  public static <T> T lookup(Collection<StartupEvent> events, Class<T> classToFind) {
+    final var found = events
+      .stream()
+      .filter(it -> Objects.equals(classToFind, it.getClass()))
+      .findFirst()
+      .orElse(null);
+    log.trace("found={}, classToFind={}", found, classToFind);
+    return (T) found;
+  }
+}

src/native-test/java/com/mageddo/dnsproxyserver/server/dns/solver/SolverSystemIT.java

@@ -0,0 +1,63 @@
+package com.mageddo.dnsproxyserver;
+
+import com.mageddo.commons.concurrent.Threads;
+import com.mageddo.dns.utils.Messages;
+import com.mageddo.dnsproxyserver.config.application.Configs;
+import com.mageddo.dnsproxyserver.server.Starter;
+import com.mageddo.dnsproxyserver.solver.SimpleResolver;
+import com.mageddo.dnsproxyserver.utils.Ips;
+import com.mageddo.utils.Executors;
+import lombok.SneakyThrows;
+import lombok.extern.slf4j.Slf4j;
+import org.junit.jupiter.api.AfterAll;
+import org.junit.jupiter.api.BeforeEach;
+import org.junit.jupiter.api.Test;
+import org.xbill.DNS.Message;
+import testing.templates.ConfigFlagArgsTemplates;
+
+import java.time.Duration;
+
+import static org.junit.jupiter.api.Assertions.assertTrue;
+
+@Slf4j
+public class AppIntTest {
+
+  @BeforeEach
+  void beforeEach() {
+    Starter.setMustStartFlagActive(true);
+    Configs.clear();
+  }
+
+  @AfterAll
+  static void afterAll(){
+    Starter.setMustStartFlagActive(false);
+  }
+
+  @Test
+  void appMustStartAndQuerySampleWithSuccess() {
+
+    final var hostToQuery = "dps-sample.dev";
+    final var args = ConfigFlagArgsTemplates.withRandomPortsAndNotAsDefaultDns();
+    final var app = new App(args);
+
+    try (final var executor = Executors.newThreadExecutor()) {
+
+      executor.submit(app::start);
+
+      Threads.sleep(Duration.ofSeconds(2));
+
+      final var port = app.getDnsServerPort();
+      final var res = queryStartedServer(port, hostToQuery);
+      assertTrue(Messages.isSuccess(res));
+
+    }
+
+  }
+
+  @SneakyThrows
+  static Message queryStartedServer(Integer port, String host) {
+    final var dnsServerAddress = Ips.getAnyLocalAddress(port);
+    final var dnsClient = new SimpleResolver(dnsServerAddress);
+    return dnsClient.send(Messages.aQuestion(host));
+  }
+}

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

@@ -2,6 +2,7 @@
 
 import com.mageddo.dnsproxyserver.di.Context;
 import com.mageddo.dnsproxyserver.di.StartupEvent;
+import com.mageddo.dnsproxyserver.di.StartupEvents;
 import dagger.sheath.junit.DaggerTest;
 import org.junit.jupiter.api.Test;
 
@@ -22,7 +23,7 @@ void mustConfigureNetworkEventListener(){
     // arrange
 
     // act
-    final var found = StartupEvent.exists(this.events, EventListener.class);
+    final var found = StartupEvents.exists(this.events, EventListener.class);
 
     // assert
     assertTrue(found);

src/test/java/com/mageddo/dnsproxyserver/solver/docker/entrypoint/EventListenerCompTest.java

@@ -0,0 +1,17 @@
+package testing.templates;
+
+import com.mageddo.net.SocketUtils;
+
+public class ConfigFlagArgsTemplates {
+  public static String[] withRandomPortsAndNotAsDefaultDns() {
+    final var webServerPort = SocketUtils.findRandomFreePort();
+    final var dnsServerPort = SocketUtils.findRandomFreePort();
+
+    return new String[]{
+      "--default-dns=false",
+      "--web-server-port=" + webServerPort,
+      "--server-port=" + dnsServerPort,
+      "--log-level=TRACE",
+    };
+  }
+}