]> gitweb.michael.orlitzky.com - hath.git/blobdiff - src/IPv4Address.hs
Update for QuickCheck 2.
[hath.git] / src / IPv4Address.hs
index 31ad7bd43965a56f7d243ab932ddbb4dc79dac33..e72dd592ee1c2f1ad8a3fe5dad6fe26fc43701b1 100644 (file)
@@ -1,23 +1,20 @@
 module IPv4Address
 ( ipv4address_from_octets,
+  ipv4address_tests,
   IPv4Address(None),
-  max_octet1,
-  max_octet2,
-  max_octet3,
-  max_octet4,
-  min_octet1,
-  min_octet2,
-  min_octet3,
-  min_octet4,
+  max_address,
+  min_address,
   most_sig_bit_different,
   octet1,
   octet2,
   octet3,
   octet4
-)
-  where
+) where
+
+import Test.HUnit
+import Test.QuickCheck
 
-import qualified Bit as B
+import Maskable
 import Maskbits
 import Octet
 
@@ -41,6 +38,108 @@ instance Show IPv4Address where
           oct4 = (octet4 addr)
 
 
+instance Arbitrary IPv4Address where
+    arbitrary = do
+      oct1 <- arbitrary :: Gen Octet
+      oct2 <- arbitrary :: Gen Octet
+      oct3 <- arbitrary :: Gen Octet
+      oct4 <- arbitrary :: Gen Octet
+      return (IPv4Address oct1 oct2 oct3 oct4)
+
+
+
+instance Maskable IPv4Address where
+    apply_mask _ Maskbits.None _ = IPv4Address.None
+    apply_mask addr mask bit
+        | mask == ThirtyTwo = addr
+        | mask == ThirtyOne = addr { octet4 = (apply_mask oct4 Seven bit) }
+        | mask == Thirty = addr { octet4 = (apply_mask oct4 Six bit) }
+        | mask == TwentyNine = addr { octet4 = (apply_mask oct4 Five bit) }
+        | mask == TwentyEight = addr { octet4 = (apply_mask oct4 Four bit) }
+        | mask == TwentySeven = addr { octet4 = (apply_mask oct4 Three bit) }
+        | mask == TwentySix = addr { octet4 = (apply_mask oct4 Two bit) }
+        | mask == TwentyFive = addr { octet4 = (apply_mask oct4 One bit) }
+        | mask == TwentyFour = addr { octet4 = (apply_mask oct4 Zero bit) }
+        | mask == TwentyThree = addr { octet3 = (apply_mask oct3 Seven bit),
+                                       octet4 = (apply_mask oct4 Zero bit) }
+        | mask == TwentyTwo = addr { octet3 = (apply_mask oct3 Six bit),
+                                     octet4 = (apply_mask oct4 Zero bit) }
+        | mask == TwentyOne = addr { octet3 = (apply_mask oct3 Five bit),
+                                     octet4 = (apply_mask oct4 Zero bit) }
+        | mask == Twenty = addr { octet3 = (apply_mask oct3 Four bit),
+                                  octet4 = (apply_mask oct4 Zero bit) }
+        | mask == Nineteen = addr { octet3 = (apply_mask oct3 Three bit),
+                                    octet4 = (apply_mask oct4 Zero bit) }
+        | mask == Eighteen = addr { octet3 = (apply_mask oct3 Two bit),
+                                    octet4 = (apply_mask oct4 Zero bit) }
+        | mask == Seventeen = addr { octet3 = (apply_mask oct3 One bit),
+                                     octet4 = (apply_mask oct4 Zero bit) }
+        | mask == Sixteen = addr { octet3 = (apply_mask oct3 Zero bit),
+                                   octet4 = (apply_mask oct4 Zero bit) }
+        | mask == Fifteen = addr { octet2 = (apply_mask oct2 Seven bit),
+                                   octet3 = (apply_mask oct3 Zero bit),
+                                   octet4 = (apply_mask oct4 Zero bit) }
+        | mask == Fourteen = addr { octet2 = (apply_mask oct2 Six bit),
+                                    octet3 = (apply_mask oct3 Zero bit),
+                                    octet4 = (apply_mask oct4 Zero bit)}
+        | mask == Thirteen = addr { octet2 = (apply_mask oct2 Five bit),
+                                    octet3 = (apply_mask oct3 Zero bit),
+                                    octet4 = (apply_mask oct4 Zero bit)}
+        | mask == Twelve = addr { octet2 = (apply_mask oct2 Four bit),
+                                  octet3 = (apply_mask oct3 Zero bit),
+                                  octet4 = (apply_mask oct4 Zero bit)}
+        | mask == Eleven = addr { octet2 = (apply_mask oct2 Three bit),
+                                  octet3 = (apply_mask oct3 Zero bit),
+                                  octet4 = (apply_mask oct4 Zero bit)}
+        | mask == Ten = addr { octet2 = (apply_mask oct2 Two bit),
+                               octet3 = (apply_mask oct3 Zero bit),
+                               octet4 = (apply_mask oct4 Zero bit)}
+        | mask == Nine = addr { octet2 = (apply_mask oct2 One bit),
+                                octet3 = (apply_mask oct3 Zero bit),
+                                octet4 = (apply_mask oct4 Zero bit)}
+        | mask == Eight = addr { octet2 = (apply_mask oct2 Zero bit),
+                                 octet3 = (apply_mask oct3 Zero bit),
+                                 octet4 = (apply_mask oct4 Zero bit)}
+        | mask == Seven = addr { octet1 = (apply_mask oct1 Seven bit),
+                                 octet2 = (apply_mask oct2 Zero bit),
+                                 octet3 = (apply_mask oct3 Zero bit),
+                                 octet4 = (apply_mask oct4 Zero bit)}
+        | mask == Six = addr { octet1 = (apply_mask oct1 Six bit),
+                               octet2 = (apply_mask oct2 Zero bit),
+                               octet3 = (apply_mask oct3 Zero bit),
+                               octet4 = (apply_mask oct4 Zero bit)}
+        | mask == Five = addr { octet1 = (apply_mask oct1 Five bit),
+                                octet2 = (apply_mask oct2 Zero bit),
+                                octet3 = (apply_mask oct3 Zero bit),
+                                octet4 = (apply_mask oct4 Zero bit)}
+        | mask == Four = addr { octet1 = (apply_mask oct1 Four bit),
+                                octet2 = (apply_mask oct2 Zero bit),
+                                octet3 = (apply_mask oct3 Zero bit),
+                                octet4 = (apply_mask oct4 Zero bit)}
+        | mask == Three = addr { octet1 = (apply_mask oct1 Three bit),
+                                 octet2 = (apply_mask oct2 Zero bit),
+                                 octet3 = (apply_mask oct3 Zero bit),
+                                 octet4 = (apply_mask oct4 Zero bit)}
+        | mask == Two = addr { octet1 = (apply_mask oct1 Two bit),
+                               octet2 = (apply_mask oct2 Zero bit),
+                               octet3 = (apply_mask oct3 Zero bit),
+                               octet4 = (apply_mask oct4 Zero bit)}
+        | mask == One = addr { octet1 = (apply_mask oct1 One bit),
+                               octet2 = (apply_mask oct2 Zero bit),
+                               octet3 = (apply_mask oct3 Zero bit),
+                               octet4 = (apply_mask oct4 Zero bit)}
+        | mask == Zero = addr { octet1 = (apply_mask oct1 Zero bit),
+                                octet2 = (apply_mask oct2 Zero bit),
+                                octet3 = (apply_mask oct3 Zero bit),
+                                octet4 = (apply_mask oct4 Zero bit)}
+        | otherwise = IPv4Address.None
+        where
+          oct1 = (octet1 addr)
+          oct2 = (octet2 addr)
+          oct3 = (octet3 addr)
+          oct4 = (octet4 addr)
+
+
 -- We don't export our constructor so this function is the only
 -- way to construct an address from octets. As a result, we can
 -- return IPv4Address.None in response to being passed one of more
@@ -54,177 +153,14 @@ ipv4address_from_octets oct1 oct2 oct3 oct4
     | otherwise = IPv4Address oct1 oct2 oct3 oct4
 
 
-min_address :: IPv4Address -> Maskbits -> IPv4Address
-min_address IPv4Address.None _ = IPv4Address.None
-min_address _ Maskbits.None = IPv4Address.None
-min_address addr mask
-    | mask == ThirtyTwo = IPv4Address oct1 oct2 oct3 oct4
-    | mask == ThirtyOne = IPv4Address oct1 oct2 oct3 (Octet a25 a26 a27 a28 a29 a30 a31 B.Zero)
-    | mask == Thirty = IPv4Address oct1 oct2 oct3 (Octet a25 a26 a27 a28 a29 a30 B.Zero B.Zero)
-    | mask == TwentyNine = IPv4Address oct1 oct2 oct3 (Octet a25 a26 a27 a28 a29 B.Zero B.Zero B.Zero)
-    | mask == TwentyEight = IPv4Address oct1 oct2 oct3 (Octet a25 a26 a27 a28 B.Zero B.Zero B.Zero B.Zero)
-    | mask == TwentySeven = IPv4Address oct1 oct2 oct3 (Octet a25 a26 a27 B.Zero B.Zero B.Zero B.Zero B.Zero)
-    | mask == TwentySix = IPv4Address oct1 oct2 oct3 (Octet a25 a26 B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero)
-    | mask == TwentyFive = IPv4Address oct1 oct2 oct3 (Octet a25 B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero)
-    | mask == TwentyFour = IPv4Address oct1 oct2 oct3 (min_octet)
-    | mask == TwentyThree = IPv4Address oct1 oct2 (Octet a17 a18 a19 a20 a21 a22 a23 B.Zero) (min_octet)
-    | mask == TwentyTwo = IPv4Address oct1 oct2 (Octet a17 a18 a19 a20 a21 a22 B.Zero B.Zero) (min_octet)
-    | mask == TwentyOne = IPv4Address oct1 oct2 (Octet a17 a18 a19 a20 a21 B.Zero B.Zero B.Zero) (min_octet)
-    | mask == Twenty = IPv4Address oct1 oct2 (Octet a17 a18 a19 a20 B.Zero B.Zero B.Zero B.Zero) (min_octet)
-    | mask == Nineteen = IPv4Address oct1 oct2 (Octet a17 a18 a19 B.Zero B.Zero B.Zero B.Zero B.Zero) (min_octet)
-    | mask == Eighteen = IPv4Address oct1 oct2 (Octet a17 a18 B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero) (min_octet)
-    | mask == Seventeen = IPv4Address oct1 oct2 (Octet a17 B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero) (min_octet)
-    | mask == Sixteen = IPv4Address oct1 oct2 (min_octet) (min_octet)
-    | mask == Fifteen = IPv4Address oct1 (Octet a9 a10 a11 a12 a13 a14 a15 B.Zero) (min_octet) (min_octet)
-    | mask == Fourteen = IPv4Address oct1 (Octet a9 a10 a11 a12 a13 a14 B.Zero B.Zero) (min_octet) (min_octet)
-    | mask == Thirteen = IPv4Address oct1 (Octet a9 a10 a11 a12 a13 B.Zero B.Zero B.Zero) (min_octet) (min_octet)
-    | mask == Twelve = IPv4Address oct1 (Octet a9 a10 a11 a12 B.Zero B.Zero B.Zero B.Zero) (min_octet) (min_octet)
-    | mask == Eleven = IPv4Address oct1 (Octet a9 a10 a11 B.Zero B.Zero B.Zero B.Zero B.Zero) (min_octet) (min_octet)
-    | mask == Ten = IPv4Address oct1 (Octet a9 a10 B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero) (min_octet) (min_octet)
-    | mask == Nine = IPv4Address oct1 (Octet a9 B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero) (min_octet) (min_octet)
-    | mask == Eight = IPv4Address oct1 (min_octet) (min_octet) (min_octet)
-    | mask == Seven = IPv4Address (Octet a1 a2 a3 a4 a5 a6 a7 B.Zero) (min_octet) (min_octet) (min_octet)
-    | mask == Six = IPv4Address (Octet a1 a2 a3 a4 a5 a6 B.Zero B.Zero) (min_octet) (min_octet) (min_octet)
-    | mask == Five = IPv4Address (Octet a1 a2 a3 a4 a5 B.Zero B.Zero B.Zero) (min_octet) (min_octet) (min_octet)
-    | mask == Four = IPv4Address (Octet a1 a2 a3 a4 B.Zero B.Zero B.Zero B.Zero) (min_octet) (min_octet) (min_octet)
-    | mask == Three = IPv4Address (Octet a1 a2 a3 B.Zero B.Zero B.Zero B.Zero B.Zero) (min_octet) (min_octet) (min_octet)
-    | mask == Two = IPv4Address (Octet a1 a2 B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero) (min_octet) (min_octet) (min_octet)
-    | mask == One = IPv4Address (Octet a1 B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero B.Zero) (min_octet) (min_octet) (min_octet)
-    | mask == Zero = IPv4Address (min_octet) (min_octet) (min_octet) (min_octet)
-    | otherwise = addr
-    where
-      a1  = (b1 oct1)
-      a2  = (b2 oct1)
-      a3  = (b3 oct1)
-      a4  = (b4 oct1)
-      a5  = (b5 oct1)
-      a6  = (b6 oct1)
-      a7  = (b7 oct1)
-      a9  = (b1 oct2)
-      a10 = (b2 oct2)
-      a11 = (b3 oct2)
-      a12 = (b4 oct2)
-      a13 = (b5 oct2)
-      a14 = (b6 oct2)
-      a15 = (b7 oct2)
-      a17 = (b1 oct3)
-      a18 = (b2 oct3)
-      a19 = (b3 oct3)
-      a20 = (b4 oct3)
-      a21 = (b5 oct3)
-      a22 = (b6 oct3)
-      a23 = (b7 oct3)
-      a25 = (b1 oct4)
-      a26 = (b2 oct4)
-      a27 = (b3 oct4)
-      a28 = (b4 oct4)
-      a29 = (b5 oct4)
-      a30 = (b6 oct4)
-      a31 = (b7 oct4)
-      oct1 = (octet1 addr)
-      oct2 = (octet2 addr)
-      oct3 = (octet3 addr)
-      oct4 = (octet4 addr)
-
-
-
-max_address :: IPv4Address -> Maskbits -> IPv4Address
-max_address IPv4Address.None _ = IPv4Address.None
-max_address _ Maskbits.None = IPv4Address.None
-max_address addr mask
-    | mask == ThirtyTwo = IPv4Address oct1 oct2 oct3 oct4
-    | mask == ThirtyOne = IPv4Address oct1 oct2 oct3 (Octet a25 a26 a27 a28 a29 a30 a31 B.One)
-    | mask == Thirty = IPv4Address oct1 oct2 oct3 (Octet a25 a26 a27 a28 a29 a30 B.One B.One)
-    | mask == TwentyNine = IPv4Address oct1 oct2 oct3 (Octet a25 a26 a27 a28 a29 B.One B.One B.One)
-    | mask == TwentyEight = IPv4Address oct1 oct2 oct3 (Octet a25 a26 a27 a28 B.One B.One B.One B.One)
-    | mask == TwentySeven = IPv4Address oct1 oct2 oct3 (Octet a25 a26 a27 B.One B.One B.One B.One B.One)
-    | mask == TwentySix = IPv4Address oct1 oct2 oct3 (Octet a25 a26 B.One B.One B.One B.One B.One B.One)
-    | mask == TwentyFive = IPv4Address oct1 oct2 oct3 (Octet a25 B.One B.One B.One B.One B.One B.One B.One)
-    | mask == TwentyFour = IPv4Address oct1 oct2 oct3 (max_octet)
-    | mask == TwentyThree = IPv4Address oct1 oct2 (Octet a17 a18 a19 a20 a21 a22 a23 B.One) (max_octet)
-    | mask == TwentyTwo = IPv4Address oct1 oct2 (Octet a17 a18 a19 a20 a21 a22 B.One B.One) (max_octet)
-    | mask == TwentyOne = IPv4Address oct1 oct2 (Octet a17 a18 a19 a20 a21 B.One B.One B.One) (max_octet)
-    | mask == Twenty = IPv4Address oct1 oct2 (Octet a17 a18 a19 a20 B.One B.One B.One B.One) (max_octet)
-    | mask == Nineteen = IPv4Address oct1 oct2 (Octet a17 a18 a19 B.One B.One B.One B.One B.One) (max_octet)
-    | mask == Eighteen = IPv4Address oct1 oct2 (Octet a17 a18 B.One B.One B.One B.One B.One B.One) (max_octet)
-    | mask == Seventeen = IPv4Address oct1 oct2 (Octet a17 B.One B.One B.One B.One B.One B.One B.One) (max_octet)
-    | mask == Sixteen = IPv4Address oct1 oct2 (max_octet) (max_octet)
-    | mask == Fifteen = IPv4Address oct1 (Octet a9 a10 a11 a12 a13 a14 a15 B.One) (max_octet) (max_octet)
-    | mask == Fourteen = IPv4Address oct1 (Octet a9 a10 a11 a12 a13 a14 B.One B.One) (max_octet) (max_octet)
-    | mask == Thirteen = IPv4Address oct1 (Octet a9 a10 a11 a12 a13 B.One B.One B.One) (max_octet) (max_octet)
-    | mask == Twelve = IPv4Address oct1 (Octet a9 a10 a11 a12 B.One B.One B.One B.One) (max_octet) (max_octet)
-    | mask == Eleven = IPv4Address oct1 (Octet a9 a10 a11 B.One B.One B.One B.One B.One) (max_octet) (max_octet)
-    | mask == Ten = IPv4Address oct1 (Octet a9 a10 B.One B.One B.One B.One B.One B.One) (max_octet) (max_octet)
-    | mask == Nine = IPv4Address oct1 (Octet a9 B.One B.One B.One B.One B.One B.One B.One) (max_octet) (max_octet)
-    | mask == Eight = IPv4Address oct1 (max_octet) (max_octet) (max_octet)
-    | mask == Seven = IPv4Address (Octet a1 a2 a3 a4 a5 a6 a7 B.One) (max_octet) (max_octet) (max_octet)
-    | mask == Six = IPv4Address (Octet a1 a2 a3 a4 a5 a6 B.One B.One) (max_octet) (max_octet) (max_octet)
-    | mask == Five = IPv4Address (Octet a1 a2 a3 a4 a5 B.One B.One B.One) (max_octet) (max_octet) (max_octet)
-    | mask == Four = IPv4Address (Octet a1 a2 a3 a4 B.One B.One B.One B.One) (max_octet) (max_octet) (max_octet)
-    | mask == Three = IPv4Address (Octet a1 a2 a3 B.One B.One B.One B.One B.One) (max_octet) (max_octet) (max_octet)
-    | mask == Two = IPv4Address (Octet a1 a2 B.One B.One B.One B.One B.One B.One) (max_octet) (max_octet) (max_octet)
-    | mask == One = IPv4Address (Octet a1 B.One B.One B.One B.One B.One B.One B.One) (max_octet) (max_octet) (max_octet)
-    | mask == Zero = IPv4Address (max_octet) (max_octet) (max_octet) (max_octet)
-    | otherwise = addr
-    where
-      a1  = (b1 oct1)
-      a2  = (b2 oct1)
-      a3  = (b3 oct1)
-      a4  = (b4 oct1)
-      a5  = (b5 oct1)
-      a6  = (b6 oct1)
-      a7  = (b7 oct1)
-      a9  = (b1 oct2)
-      a10 = (b2 oct2)
-      a11 = (b3 oct2)
-      a12 = (b4 oct2)
-      a13 = (b5 oct2)
-      a14 = (b6 oct2)
-      a15 = (b7 oct2)
-      a17 = (b1 oct3)
-      a18 = (b2 oct3)
-      a19 = (b3 oct3)
-      a20 = (b4 oct3)
-      a21 = (b5 oct3)
-      a22 = (b6 oct3)
-      a23 = (b7 oct3)
-      a25 = (b1 oct4)
-      a26 = (b2 oct4)
-      a27 = (b3 oct4)
-      a28 = (b4 oct4)
-      a29 = (b5 oct4)
-      a30 = (b6 oct4)
-      a31 = (b7 oct4)
-      oct1 = (octet1 addr)
-      oct2 = (octet2 addr)
-      oct3 = (octet3 addr)
-      oct4 = (octet4 addr)
-
+-- The minimum possible IPv4 address, 0.0.0.0.
+min_address :: IPv4Address
+min_address = IPv4Address min_octet min_octet min_octet min_octet
 
 
-min_octet1 :: IPv4Address -> Maskbits -> Octet
-min_octet1 addr mask = octet1 (min_address addr mask)
-
-min_octet2 :: IPv4Address -> Maskbits -> Octet
-min_octet2 addr mask = octet2 (min_address addr mask)
-
-min_octet3 :: IPv4Address -> Maskbits -> Octet
-min_octet3 addr mask = octet3 (min_address addr mask)
-
-min_octet4 :: IPv4Address -> Maskbits -> Octet
-min_octet4 addr mask = octet4 (min_address addr mask)
-
-max_octet1 :: IPv4Address -> Maskbits -> Octet
-max_octet1 addr mask = octet1 (max_address addr mask)
-
-max_octet2 :: IPv4Address -> Maskbits -> Octet
-max_octet2 addr mask = octet2 (max_address addr mask)
-
-max_octet3 :: IPv4Address -> Maskbits -> Octet
-max_octet3 addr mask = octet3 (max_address addr mask)
-
-max_octet4 :: IPv4Address -> Maskbits -> Octet
-max_octet4 addr mask = octet4 (max_address addr mask)
+-- The maximum possible IPv4 address, 255.255.255.255.
+max_address :: IPv4Address
+max_address = IPv4Address max_octet max_octet max_octet max_octet
 
 
 -- Given two addresses, find the number of the most significant bit
@@ -339,3 +275,30 @@ most_sig_bit_different addr1 addr2
     oct2b = (octet2 addr2)
     oct3b = (octet3 addr2)
     oct4b = (octet4 addr2)
+
+
+
+-- HUnit Tests
+mk_testaddr :: Int -> Int -> Int -> Int -> IPv4Address
+mk_testaddr a b c d =
+    IPv4Address oct1 oct2 oct3 oct4
+    where
+      oct1 = octet_from_int a
+      oct2 = octet_from_int b
+      oct3 = octet_from_int c
+      oct4 = octet_from_int d
+
+
+test_most_sig_bit_different1 :: Test
+test_most_sig_bit_different1 =
+    TestCase $ assertEqual "10.1.1.0 and 10.1.0.0 differ in bit 24" TwentyFour (most_sig_bit_different (mk_testaddr 10 1 1 0) (mk_testaddr 10 1 0 0))
+
+
+test_most_sig_bit_different2 :: Test
+test_most_sig_bit_different2 =
+    TestCase $ assertEqual "10.1.2.0 and 10.1.1.0 differ in bit 23" TwentyThree (most_sig_bit_different (mk_testaddr 10 1 2 0) (mk_testaddr 10 1 1 0))
+
+
+ipv4address_tests :: [Test]
+ipv4address_tests = [ test_most_sig_bit_different1,
+                      test_most_sig_bit_different2 ]