Duration timeout parameter added to NetworkTester methods

Author: Oli B.

CHANGELOG.md

@@ -8,6 +8,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+* Duration timeout parameter added to NetworkTester methods
+
+
 ### Changed
 
 * update to JUnit 6

patterntesting-rt/src/main/java/patterntesting/runtime/junit/NetworkTester.java

@@ -25,6 +25,7 @@
 
 import java.io.IOException;
 import java.net.*;
+import java.time.Duration;
 import java.util.List;
 import java.util.Observable;
 import java.util.Observer;
@@ -81,6 +82,18 @@ public static void assertOnline(String host, int time, TimeUnit unit) {
         assertTrue(isOnline(host, time, unit), host + " is offline");
     }
 
+    /**
+     * Asserts, that the given host is online. The given time is the maximal
+     * time we try to connect to the given host.
+     *
+     * @param host    hostname or ip address
+     * @param timeout how long should we try to connect to host?
+     * @since 2.6
+     */
+    public static void assertOnline(String host, Duration timeout) {
+        assertTrue(isOnline(host, timeout), host + " is offline");
+    }
+
     /**
      * Checks if the given host is online. The given time is the maximal
      * time we try to connect to the given host.
@@ -96,6 +109,19 @@ public static boolean isOnline(String host, int time, TimeUnit unit) {
         return scanner.openPortDetected();
     }
 
+    /**
+     * Checks if the given host is online. The given time is the maximal
+     * time we try to connect to the given host.
+     *
+     * @param host    hostname or ip address
+     * @param timeout how long should we try to connect to host?
+     * @return true if host is online
+     * @since 2.6
+     */
+    public static boolean isOnline(String host, Duration timeout) {
+        return isOnline(host, (int) timeout.toMillis(), TimeUnit.MILLISECONDS);
+    }
+
     private static PortScanner scanPortsOf(String host, int timeout, TimeUnit unit) {
         PortScanner scanner = new PortScanner(host);
         scanner.scanPorts(timeout, unit);
@@ -142,6 +168,17 @@ public static void assertOnline(InetAddress host, int time, TimeUnit unit) {
         assertOnline(host.getHostName(), time, unit);
     }
 
+    /**
+     * Asserts, that the given host is online. The given time is the maximal
+     * time we try to connect to the given host.
+     *
+     * @param host    hostname or ip address
+     * @param timeout how long should we try to connect to host?
+     * @since 2.6
+     */
+    public static void assertOnline(InetAddress host, Duration timeout) {
+        assertOnline(host.getHostName(), timeout);
+    }
 
     /**
      * Asserts, that the given host is online at the given port.
@@ -209,6 +246,19 @@ public static boolean isOnline(String host, int port, long timeout, TimeUnit uni
         }
     }
 
+    /**
+     * Checks if the given host is online in the given time distance.
+     *
+     * @param host the hostname or IP address
+     * @param port the port between 0 and 0xFFFF
+     * @param timeout timeout
+     * @return true if host is online
+     * @since 2.6
+     */
+    public static boolean isOnline(String host, int port, Duration timeout) {
+        return isOnline(host, port, timeout.toMillis(),  TimeUnit.MILLISECONDS);
+    }
+
     /**
      * Checks if the given URI is online. In contrast to {@link #exists(URI)}
      * it is not checked if the URI is present but if the service behind the
@@ -229,27 +279,27 @@ private static int getPortOf(URI uri) {
         if (port > 0) {
             return port;
         }
-        switch (uri.getScheme().toLowerCase()) {
-            case "ftp":    return 21;
-            case "ssh":    return 22;
-            case "telnet": return 23;
-            case "http":   return 80;
-            case "auth":   return 113;
-            case "sftp":   return 115;
-            case "ntp":    return 123;
-            case "snmp":   return 161;
-            case "irc":    return 194;
-            case "ldap":   return 389;
-            case "https":  return 443;
-            case "rtsp":   return 554;
-            case "ipp":    return 631;
-            case "ldaps":  return 636;
-            case "ftps":   return 990;
-            case "ircs":   return 994;
-            case "nfs":    return 2049;
-            case "svn":    return 3690;
-            default:       return port;
-        }
+        return switch (uri.getScheme().toLowerCase()) {
+            case "ftp" -> 21;
+            case "ssh" -> 22;
+            case "telnet" -> 23;
+            case "http" -> 80;
+            case "auth" -> 113;
+            case "sftp" -> 115;
+            case "ntp" -> 123;
+            case "snmp" -> 161;
+            case "irc" -> 194;
+            case "ldap" -> 389;
+            case "https" -> 443;
+            case "rtsp" -> 554;
+            case "ipp" -> 631;
+            case "ldaps" -> 636;
+            case "ftps" -> 990;
+            case "ircs" -> 994;
+            case "nfs" -> 2049;
+            case "svn" -> 3690;
+            default -> port;
+        };
     }
 
     /**
@@ -290,6 +340,20 @@ public static void assertOffline(String host, int time, TimeUnit unit) {
         assertFalse(scanner.openPortDetected(), host + " is online");
     }
 
+    /**
+     * Asserts, that the given host is offline. The given time is the maximal
+     * time we try to connect to the given host. Normally it takes about at
+     * least 8 minutes to realize that a host is offline. So if you want to
+     * wait a shorter time use this method.
+     *
+     * @param host    hostname or ip address
+     * @param timeout how long should we try to connect to host?
+     * @since 2.6
+     */
+    public static void assertOffline(String host, Duration timeout) {
+        assertOffline(host, (int) timeout.toMillis(), TimeUnit.MILLISECONDS);
+    }
+
     /**
      * Asserts, that the port of the given host is offline.
      *

patterntesting-rt/src/test/java/patterntesting/runtime/junit/NetworkTesterIT.java

@@ -26,6 +26,7 @@
 import java.io.File;
 import java.io.IOException;
 import java.net.*;
+import java.time.Duration;
 import java.util.concurrent.*;
 
 import static org.junit.jupiter.api.Assertions.assertFalse;
@@ -170,4 +171,9 @@ public void testAssertOnlineURI() {
         NetworkTester.assertOnline(URI.create("https://github.com/oboehm/PatternTesting2"));
     }
 
+    @Test
+    public void testAssertOnlineHost() {
+        NetworkTester.assertOnline("localhost", Duration.ofMillis(100));
+    }
+
 }