Added extra tests and prevented accidental instantiation of classes

Author: stealthcopter

library/build.gradle

@@ -19,8 +19,7 @@ android {
 }
 
 dependencies {
-  compile fileTree(dir: 'libs', include: ['*.jar'])
   testCompile 'junit:junit:4.12'
-  testCompile 'org.mockito:mockito-core:1.9.5'
+  testCompile 'org.mockito:mockito-core:1.10.19'
   provided 'com.android.support:appcompat-v7:24.2.0'
 }

library/src/main/java/com/stealthcopter/networktools/ARPInfo.java

@@ -21,6 +21,11 @@
  */
 public class ARPInfo {
 
+    // This class is not to be instantiated
+    private ARPInfo() {
+    }
+
+
     /**
      * Try to extract a hardware MAC address from a given IP address using the
      * ARP cache (/proc/net/arp).

library/src/main/java/com/stealthcopter/networktools/IPTools.java

@@ -7,19 +7,9 @@
  */
 public class IPTools {
 
-//    public void findDevicesOnSubnet(){
-//        // TODO: provide Ip address
-//
-//        // TODO: Cheat by looking at ARP Cache for a headstart.
-//
-//        // TODO: Ping devices on network
-//
-//        // TODO Results.
-//    }
-//
-//    public void getLocalIpAddress(){
-//
-//    }
+    // This class is not to be instantiated
+    private IPTools() {
+    }
 
 
     /**

library/src/main/java/com/stealthcopter/networktools/Ping.java

@@ -14,6 +14,10 @@
  */
 public class Ping {
 
+    // This class is not to be instantiated
+    private Ping() {
+    }
+
     public interface PingListener{
         void onResult(PingResult pingResult);
         void onFinished(PingStats pingStats);

library/src/main/java/com/stealthcopter/networktools/PortScan.java

@@ -13,6 +13,10 @@
  */
 public class PortScan {
 
+    // This class is not to be instantiated
+    private PortScan() {
+    }
+
     public interface PortListener{
         void onResult(int portNo, boolean open);
         void onFinished(ArrayList<Integer> openPorts);

library/src/main/java/com/stealthcopter/networktools/WakeOnLan.java

@@ -20,6 +20,10 @@ public class WakeOnLan {
     public static final int DEFAULT_TIMEOUT_MILLIS = 10000;
     public static final int DEFAULT_NO_PACKETS = 5;
 
+    // This class is not to be instantiated
+    private WakeOnLan() {
+    }
+
     /**
      * Send a Wake-On-Lan packet to port 9 using default timeout of 10s
      * @param ipStr - IP String to send to

library/src/main/java/com/stealthcopter/networktools/ping/PingTools.java

@@ -10,16 +10,23 @@
  */
 public class PingTools {
 
+    // This class is not to be instantiated
+    private PingTools() {
+    }
+
+
     /**
-     * This will perform a ping using the native ping tool and fall back to using a java style
-     * request on failure.
+     * Perform a ping using the native ping tool and fall back to using java echo request
+     * on failure.
+     * @param ia - address to ping
+     * @param timeOutMillis - timeout in millisecdonds
+     * @return - the ping results
      */
     public static PingResult doPing(InetAddress ia, int timeOutMillis){
 
         // Try native ping first
         try{
-            PingResult result = PingTools.doNativePing(ia, timeOutMillis);
-            return result;
+            return PingTools.doNativePing(ia, timeOutMillis);
         } catch (InterruptedException e){
             PingResult pingResult = new PingResult(ia);
             pingResult.isReachable = false;
@@ -36,6 +43,14 @@ public static PingResult doPing(InetAddress ia, int timeOutMillis){
     }
 
 
+    /**
+     * Perform a ping using the native ping binary
+     * @param ia - address to ping
+     * @param timeOutMillis - timeout in millisecdonds
+     * @return - the ping results
+     * @throws IOException
+     * @throws InterruptedException
+     */
     public static PingResult doNativePing(InetAddress ia, int timeOutMillis) throws IOException, InterruptedException {
         return PingNative.ping(ia, timeOutMillis);
     }
@@ -44,6 +59,10 @@ public static PingResult doNativePing(InetAddress ia, int timeOutMillis) throws
      * Tries to reach this {@code InetAddress}. This method first tries to use
      * ICMP <i>(ICMP ECHO REQUEST)</i>, falling back to a TCP connection
      * on port 7 (Echo) of the remote host.
+     *
+     * @param ia - address to ping
+     * @param timeOutMillis - timeout in millisecdonds
+     * @return - the ping results
      */
     public static PingResult doJavaPing(InetAddress ia, int timeOutMillis){
         PingResult pingResult = new PingResult(ia);

library/src/main/java/com/stealthcopter/networktools/portscanning/PortScanTCP.java

@@ -10,6 +10,10 @@
  */
 public class PortScanTCP {
 
+    // This class is not to be instantiated
+    private PortScanTCP() {
+    }
+
     public static boolean scanAddress(InetAddress ia, int portNo, int timeoutMillis){
         Socket s = null;
         try {

library/src/test/java/com/stealthcopter/networktools/ARPInfoUnitTest.java renamed to library/src/test/java/com/stealthcopter/networktools/ARPInfoTest.java

@@ -11,7 +11,7 @@
 /**
  * To work on unit tests, switch the Test Artifact in the Build Variants view.
  */
-public class ARPInfoUnitTest {
+public class ARPInfoTest {
 
     @Test
     public void nullIPsandMacsReturnNull() throws Exception {

library/src/test/java/com/stealthcopter/networktools/IPToolsTest.java

@@ -0,0 +1,57 @@
+package com.stealthcopter.networktools;
+
+import org.junit.Test;
+
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
+
+/**
+ * Created by matthew on 03/11/17.
+ */
+
+public class IPToolsTest {
+
+
+    String[] getInvalidIpAddresses(){
+        return new String[]{"beepbeep", "nope", "hello"};
+    }
+
+    String[] getIPv4Addresses(){
+        return new String[]{"192.168.0.1", "127.0.0.1", "10.0.0.1",};
+    }
+
+    String[] getIPv6Addresses(){
+        return new String[]{"2001:0db8:85a3:0000:0000:8a2e:0370:7334"};
+    }
+
+    @Test
+    public void testIsIPv4Address() throws Exception {
+
+        for (String address: getIPv4Addresses()) {
+            assertTrue(IPTools.isIPv4Address(address));
+        }
+
+        for (String address: getIPv6Addresses()) {
+            assertFalse(IPTools.isIPv4Address(address));
+        }
+
+        for (String address: getInvalidIpAddresses()) {
+            assertFalse(IPTools.isIPv4Address(address));
+        }
+    }
+
+    @Test
+    public void testIsIPv6Address() throws Exception {
+        for (String address: getIPv4Addresses()) {
+            assertFalse(IPTools.isIPv6Address(address));
+        }
+
+        for (String address: getIPv6Addresses()) {
+            assertTrue(IPTools.isIPv6Address(address));
+        }
+
+        for (String address: getInvalidIpAddresses()) {
+            assertFalse(IPTools.isIPv6Address(address));
+        }
+    }
+}