Added the prop_contains_proper_intransitive QuickCheck property, and fixed the defini...

[hath.git] / src / Cidr.hs

diff --git a/src/Cidr.hs b/src/Cidr.hs
index 77f1ae41fe42569d5801c50158aef48f1a595ce7..94de1234c4ae9616f7b9d351a5b9a0f6ba434bc7 100644 (file)
--- a/src/Cidr.hs
+++ b/src/Cidr.hs
@@ -2,11 +2,16 @@ module Cidr
 ( Cidr(..),
   cidr_from_string,
   cidr_tests,
-  combine_all
+  combine_all,
+  contains,
+  contains_proper,
+  prop_all_cidrs_contain_themselves,
+  prop_contains_proper_intransitive
 ) where
 
 import Data.List (nubBy)
 import Test.HUnit
+import Test.QuickCheck
 
 import IPv4Address
 import ListUtils
@@ -25,6 +30,15 @@ instance Show Cidr where
     show cidr = (show (ipv4address cidr)) ++ "/" ++ (show (maskbits cidr))
 
 
+instance Arbitrary Cidr where
+    arbitrary = do
+      ipv4 <- arbitrary :: Gen IPv4Address
+      mask <- arbitrary :: Gen Maskbits
+      return (Cidr ipv4 mask)
+
+    coarbitrary _ = variant 0
+
+
 -- Two CIDR ranges are equivalent if they have the same network bits
 -- and the masks are the same.
 equivalent :: Cidr -> Cidr -> Bool
@@ -113,7 +127,7 @@ contains (Cidr addr1 mbits1) (Cidr addr2 mbits2)
 
 contains_proper :: Cidr -> Cidr -> Bool
 contains_proper cidr1 cidr2 =
-    (cidr1 `contains` cidr2) && (not (cidr1 == cidr2))
+    (cidr1 `contains` cidr2) && (not (cidr2 `contains` cidr1))
 
 
 -- A CIDR range is redundant (with respect to the given list) if
@@ -179,13 +193,116 @@ adjacent cidr1 cidr2
 
 -- HUnit Tests
 
-test_contains :: Test
-test_contains =
-    TestCase $ assertEqual "10.1.1.0/23 contains 10.1.1.0/24" (cidr1 `contains` cidr2) True
+test_equality1 :: Test
+test_equality1 =
+    TestCase $ assertEqual "10.1.1.0/23 equals itself" True (cidr1 == cidr1)
+    where
+      cidr1 = cidr_from_string "10.1.1.0/23"
+
+
+test_contains1 :: Test
+test_contains1 =
+    TestCase $ assertEqual "10.1.1.0/23 contains 10.1.1.0/24" True (cidr1 `contains` cidr2)
+    where
+      cidr1 = cidr_from_string "10.1.1.0/23"
+      cidr2 = cidr_from_string "10.1.1.0/24"
+
+
+test_contains2 :: Test
+test_contains2 =
+    TestCase $ assertEqual "10.1.1.0/23 contains itself" True (cidr1 `contains` cidr1)
+    where
+      cidr1 = cidr_from_string "10.1.1.0/23"
+
+
+test_contains_proper1 :: Test
+test_contains_proper1 =
+    TestCase $ assertEqual "10.1.1.0/23 contains 10.1.1.0/24 properly" True (cidr1 `contains_proper` cidr2)
     where
       cidr1 = cidr_from_string "10.1.1.0/23"
       cidr2 = cidr_from_string "10.1.1.0/24"
 
 
+test_contains_proper2 :: Test
+test_contains_proper2 =
+    TestCase $ assertEqual "10.1.1.0/23 does not contain itself properly" False (cidr1 `contains_proper` cidr1)
+    where
+      cidr1 = cidr_from_string "10.1.1.0/23"
+
+
+test_adjacent1 :: Test
+test_adjacent1 =
+    TestCase $ assertEqual "10.1.0.0/24 is adjacent to 10.1.1.0/24" True (cidr1 `adjacent` cidr2)
+    where
+      cidr1 = cidr_from_string "10.1.0.0/24"
+      cidr2 = cidr_from_string "10.1.1.0/24"
+
+
+test_adjacent2 :: Test
+test_adjacent2 =
+    TestCase $ assertEqual "10.1.0.0/23 is not adjacent to 10.1.0.0/24" False (cidr1 `adjacent` cidr2)
+    where
+      cidr1 = cidr_from_string "10.1.0.0/23"
+      cidr2 = cidr_from_string "10.1.0.0/24"
+
+
+test_adjacent3 :: Test
+test_adjacent3 =
+    TestCase $ assertEqual "10.1.0.0/24 is not adjacent to 10.2.5.0/24" False (cidr1 `adjacent` cidr2)
+    where
+      cidr1 = cidr_from_string "10.1.0.0/24"
+      cidr2 = cidr_from_string "10.2.5.0/24"
+
+
+test_adjacent4 :: Test
+test_adjacent4 =
+    TestCase $ assertEqual "10.1.1.0/24 is not adjacent to 10.1.2.0/24" False (cidr1 `adjacent` cidr2)
+    where
+      cidr1 = cidr_from_string "10.1.1.0/24"
+      cidr2 = cidr_from_string "10.1.2.0/24"
+
+
+test_combine_contained1 :: Test
+test_combine_contained1 =
+    TestCase $ assertEqual "10.0.0.0/8, 10.1.0.0/16, and 10.1.1.0/24 combine to 10.0.0.0/8" expected_cidrs (combine_all test_cidrs)
+    where
+      cidr1 = cidr_from_string "10.0.0.0/8"
+      cidr2 = cidr_from_string "10.1.0.0/16"
+      cidr3 = cidr_from_string "10.1.1.0/24"
+      expected_cidrs = [cidr1]
+      test_cidrs = [cidr1, cidr2, cidr3]
+
+
+test_combine_contained2 :: Test
+test_combine_contained2 =
+    TestCase $ assertEqual "192.168.1.0/24 combines with itself" [cidr1] (combine_all [cidr1, cidr1])
+    where
+      cidr1 = cidr_from_string "192.168.1.0/24"
+
+
 cidr_tests :: [Test]
-cidr_tests = [ test_contains ]
+cidr_tests = [ test_equality1,
+               test_contains1,
+               test_contains2,
+               test_contains_proper1,
+               test_contains_proper2,
+               test_adjacent1,
+               test_adjacent2,
+               test_adjacent3,
+               test_adjacent4,
+               test_combine_contained1,
+               test_combine_contained2
+             ]
+
+
+-- QuickCheck Tests
+prop_all_cidrs_contain_themselves :: Cidr -> Bool
+prop_all_cidrs_contain_themselves cidr1 = cidr1 `contains` cidr1
+
+
+-- If cidr1 properly contains cidr2, then by definition cidr2
+-- does not properly contain cidr1.
+prop_contains_proper_intransitive :: Cidr -> Cidr -> Property
+prop_contains_proper_intransitive cidr1 cidr2 =
+    (cidr1 `contains_proper` cidr2) ==>
+      (not (cidr2 `contains_proper` cidr1))