X-Git-Url: http://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=src%2FCidr.hs;h=af9c9e8ba55a6c9aaaa5190baf4800599a1623cc;hb=a8c2d85d8611f7f56eaa0c3406ec423d68f81f96;hp=dc2b556361f759904c453d5896390f292df72d71;hpb=a5dfa1fd4dde2d79f42c606a56b4aea303d273e8;p=hath.git diff --git a/src/Cidr.hs b/src/Cidr.hs index dc2b556..af9c9e8 100644 --- a/src/Cidr.hs +++ b/src/Cidr.hs @@ -16,26 +16,31 @@ module Cidr min_octet2, min_octet3, min_octet4, - prop_all_cidrs_contain_themselves, - prop_contains_proper_intransitive + normalize ) where -import Data.List (nubBy) +import Data.List (nub) import Data.List.Split (splitOneOf) import Data.Maybe (catMaybes, mapMaybe) -import Test.HUnit (assertEqual) -import Test.Framework (Test, testGroup) -import Test.Framework.Providers.HUnit (testCase) -import Test.Framework.Providers.QuickCheck2 (testProperty) -import Test.QuickCheck (Arbitrary(..), Gen, Property, (==>)) +import Test.Tasty ( TestTree, localOption, testGroup ) +import Test.Tasty.HUnit ( (@?=), testCase ) +import Test.Tasty.QuickCheck ( + Arbitrary( arbitrary ), + Gen, + Property, + QuickCheckTests( QuickCheckTests ), + (==>), + testProperty ) import Text.Read (readMaybe) import qualified Bit as B (Bit(..)) -import IPv4Address (IPv4Address(..), most_sig_bit_different) -import Maskable (Maskable(..)) -import Maskbits (Maskbits(..)) -import Octet (Octet(..)) +import IPv4Address ( + IPv4Address( IPv4Address, octet1, octet2, octet3, octet4 ), + most_sig_bit_different ) +import Maskable (Maskable(apply_mask)) +import Maskbits ( Maskbits(Zero) ) +import Octet (Octet()) data Cidr = Cidr { ipv4address :: IPv4Address, @@ -54,14 +59,16 @@ instance Arbitrary Cidr where instance Eq Cidr where - cidr1 == cidr2 = (cidr1 `equivalent` cidr2) + -- | Two CIDRs are equal if they have the same network bits and if + -- their masks are the same. In other words, if they are the same + -- after normalization. + cidr1 == cidr2 = (cidr1 <= cidr2) && (cidr2 <= cidr1) - --- | Two CIDR ranges are equivalent if they have the same network bits --- and the masks are the same. -equivalent :: Cidr -> Cidr -> Bool -equivalent (Cidr addr1 mbits1) (Cidr addr2 mbits2) = - (mbits1 == mbits2) && ((apply_mask addr1 mbits1 B.Zero) == (apply_mask addr2 mbits2 B.Zero)) +instance Ord Cidr where + cidr1 <= cidr2 = if addr1 == addr2 then mask1 <= mask2 else addr1 <= addr2 + where + Cidr addr1 mask1 = normalize cidr1 + Cidr addr2 mask2 = normalize cidr2 -- | Returns the mask portion of a CIDR address. That is, everything -- after the trailing slash. @@ -85,7 +92,7 @@ octets_from_cidr_string s = instance Read Cidr where -- | Parse everything or nothing. - readsPrec _ = \s -> + readsPrec _ s = case (octets_from_cidr_string s) of [oct1, oct2, oct3, oct4] -> case (maskbits_from_cidr_string s) of @@ -216,7 +223,7 @@ combine_all cidrs | cidrs == (combine_contained unique_cidrs) = cidrs | otherwise = combine_all (combine_contained unique_cidrs) where - unique_cidrs = nubBy equivalent cidr_combinations + unique_cidrs = nub cidr_combinations cidr_combinations = cidrs ++ (catMaybes [ (combine_adjacent x y) | x <- cidrs, y <- cidrs ]) @@ -258,8 +265,16 @@ adjacent cidr1 cidr2 enumerate :: Cidr -> [IPv4Address] enumerate cidr = [(min_host cidr)..(max_host cidr)] + +-- | Replace any masked bits in this CIDR's IPv4Address with zeros. +normalize :: Cidr -> Cidr +normalize (Cidr addr mask) = + Cidr nrml_addr mask + where + nrml_addr = apply_mask addr mask B.Zero + -- Test lists. -cidr_tests :: Test +cidr_tests :: TestTree cidr_tests = testGroup "CIDR Tests" [ test_enumerate, @@ -278,264 +293,303 @@ cidr_tests = test_combine_contained2, test_combine_all1, test_combine_all2, - test_combine_all3 ] + test_combine_all3, + test_normalize1, + test_normalize2, + test_normalize3 ] -cidr_properties :: Test +cidr_properties :: TestTree cidr_properties = testGroup "CIDR Properties" [ - testProperty - "All CIDRs contain themselves" prop_all_cidrs_contain_themselves, - - testProperty - "contains_proper is intransitive" - prop_contains_proper_intransitive - ] + prop_contains_proper_antisymmetric, + prop_normalize_idempotent, + prop_normalize_preserves_equality, + prop_ord_instance_antisymmetric, + prop_ord_instance_reflexive, + prop_ord_instance_transitive ] -- HUnit Tests -test_enumerate :: Test +test_enumerate :: TestTree test_enumerate = - testCase desc $ assertEqual desc expected actual + testCase desc $ actual @?= expected where desc = "192.168.0.240/30 is enumerated correctly" - oct1 = toEnum 192 - oct2 = toEnum 168 - oct3 = minBound + oct1 = toEnum 192 :: Octet + oct2 = toEnum 168 :: Octet + oct3 = minBound :: Octet mk_ip = IPv4Address oct1 oct2 oct3 addr1 = mk_ip $ toEnum 240 addr2 = mk_ip $ toEnum 241 addr3 = mk_ip $ toEnum 242 addr4 = mk_ip $ toEnum 243 expected = [addr1, addr2, addr3, addr4] - actual = enumerate $ read "192.168.0.240/30" + actual = enumerate (read "192.168.0.240/30" :: Cidr) -test_min_host1 :: Test +test_min_host1 :: TestTree test_min_host1 = - testCase desc $ - assertEqual desc - expected - actual + testCase desc $ actual @?= expected where desc = "The minimum host in 10.0.0.0/24 is 10.0.0.0" - actual = show $ min_host (read "10.0.0.0/24") + actual = show $ min_host (read "10.0.0.0/24" :: Cidr) expected = "10.0.0.0" -test_max_host1 :: Test +test_max_host1 :: TestTree test_max_host1 = - testCase desc $ - assertEqual desc - expected - actual + testCase desc $ actual @?= expected where desc = "The maximum host in 10.0.0.0/24 is 10.0.0.255" - actual = show $ max_host (read "10.0.0.0/24") + actual = show $ max_host (read "10.0.0.0/24" :: Cidr) expected = "10.0.0.255" -test_equality1 :: Test +test_equality1 :: TestTree test_equality1 = - testCase desc $ - assertEqual - desc - True - (cidr1 == cidr1) + testCase desc $ actual @?= expected where desc = "10.1.1.0/23 equals itself" - cidr1 = read "10.1.1.0/23" :: Cidr + actual = read "10.1.1.0/23" :: Cidr + expected = read "10.1.1.0/23" :: Cidr -test_contains1 :: Test +test_contains1 :: TestTree test_contains1 = - testCase desc $ - assertEqual - desc - True - (cidr1 `contains` cidr2) + testCase desc $ actual @?= expected where desc = "10.1.1.0/23 contains 10.1.1.0/24" - cidr1 = read "10.1.1.0/23" - cidr2 = read "10.1.1.0/24" + cidr1 = read "10.1.1.0/23" :: Cidr + cidr2 = read "10.1.1.0/24" :: Cidr + expected = True + actual = cidr1 `contains` cidr2 -test_contains2 :: Test +test_contains2 :: TestTree test_contains2 = - testCase desc $ - assertEqual - desc - True - (cidr1 `contains` cidr1) + testCase desc $ actual @?= expected where desc = "10.1.1.0/23 contains itself" - cidr1 = read "10.1.1.0/23" + cidr1 = read "10.1.1.0/23" :: Cidr + expected = True + actual = cidr1 `contains` cidr1 -test_contains_proper1 :: Test +test_contains_proper1 :: TestTree test_contains_proper1 = - testCase desc $ - assertEqual - desc - True - (cidr1 `contains_proper` cidr2) + testCase desc $ actual @?= expected where desc = "10.1.1.0/23 contains 10.1.1.0/24 properly" - cidr1 = read "10.1.1.0/23" - cidr2 = read "10.1.1.0/24" + cidr1 = read "10.1.1.0/23" :: Cidr + cidr2 = read "10.1.1.0/24" :: Cidr + expected = True + actual = cidr1 `contains_proper` cidr2 -test_contains_proper2 :: Test +test_contains_proper2 :: TestTree test_contains_proper2 = - testCase desc $ - assertEqual - desc - False - (cidr1 `contains_proper` cidr1) + testCase desc $ actual @?= expected where desc = "10.1.1.0/23 does not contain itself properly" - cidr1 = read "10.1.1.0/23" + cidr1 = read "10.1.1.0/23" :: Cidr + expected = False + actual = cidr1 `contains_proper` cidr1 -test_adjacent1 :: Test +test_adjacent1 :: TestTree test_adjacent1 = - testCase desc $ - assertEqual - desc - True - (cidr1 `adjacent` cidr2) + testCase desc $ actual @?= expected where desc = "10.1.0.0/24 is adjacent to 10.1.1.0/24" - cidr1 = read "10.1.0.0/24" - cidr2 = read "10.1.1.0/24" + cidr1 = read "10.1.0.0/24" :: Cidr + cidr2 = read "10.1.1.0/24" :: Cidr + expected = True + actual = cidr1 `adjacent` cidr2 -test_adjacent2 :: Test +test_adjacent2 :: TestTree test_adjacent2 = - testCase desc $ - assertEqual - desc - False - (cidr1 `adjacent` cidr2) + testCase desc $ actual @?= expected where desc = "10.1.0.0/23 is not adjacent to 10.1.0.0/24" - cidr1 = read "10.1.0.0/23" - cidr2 = read "10.1.0.0/24" + cidr1 = read "10.1.0.0/23" :: Cidr + cidr2 = read "10.1.0.0/24" :: Cidr + expected = False + actual = cidr1 `adjacent` cidr2 -test_adjacent3 :: Test +test_adjacent3 :: TestTree test_adjacent3 = - testCase desc $ - assertEqual - desc - False - (cidr1 `adjacent` cidr2) + testCase desc $ actual @?= expected where desc = "10.1.0.0/24 is not adjacent to 10.2.5.0/24" - cidr1 = read "10.1.0.0/24" - cidr2 = read "10.2.5.0/24" + cidr1 = read "10.1.0.0/24" :: Cidr + cidr2 = read "10.2.5.0/24" :: Cidr + expected = False + actual = cidr1 `adjacent` cidr2 -test_adjacent4 :: Test +test_adjacent4 :: TestTree test_adjacent4 = - testCase desc $ - assertEqual - desc - False - (cidr1 `adjacent` cidr2) + testCase desc $ actual @?= expected where desc = "10.1.1.0/24 is not adjacent to 10.1.2.0/24" - cidr1 = read "10.1.1.0/24" - cidr2 = read "10.1.2.0/24" - + cidr1 = read "10.1.1.0/24" :: Cidr + cidr2 = read "10.1.2.0/24" :: Cidr + expected = False + actual = cidr1 `adjacent` cidr2 -test_combine_contained1 :: Test +test_combine_contained1 :: TestTree test_combine_contained1 = - testCase desc $ - assertEqual - desc - expected_cidrs - (combine_contained test_cidrs) + testCase desc $ actual @?= expected where desc = "10.0.0.0/8, 10.1.0.0/16, and 10.1.1.0/24 combine to 10.0.0.0/8" - cidr1 = read "10.0.0.0/8" - cidr2 = read "10.1.0.0/16" - cidr3 = read "10.1.1.0/24" - expected_cidrs = [cidr1] + cidr1 = read "10.0.0.0/8" :: Cidr + cidr2 = read "10.1.0.0/16" :: Cidr + cidr3 = read "10.1.1.0/24" :: Cidr test_cidrs = [cidr1, cidr2, cidr3] + expected = [cidr1] + actual = combine_contained test_cidrs - -test_combine_contained2 :: Test +test_combine_contained2 :: TestTree test_combine_contained2 = - testCase desc $ - assertEqual - desc - [cidr1, cidr2] - (combine_contained [cidr1, cidr2]) + testCase desc $ actual @?= expected where desc = "192.168.3.0/23 does not contain 192.168.1.0/24" - cidr1 = read "192.168.3.0/23" - cidr2 = read "192.168.1.0/24" + cidr1 = read "192.168.3.0/23" :: Cidr + cidr2 = read "192.168.1.0/24" :: Cidr + expected = [cidr1, cidr2] + actual = combine_contained [cidr1, cidr2] -test_combine_all1 :: Test +test_combine_all1 :: TestTree test_combine_all1 = - testCase desc $ - assertEqual - desc - expected_cidrs - (combine_all test_cidrs) + testCase desc $ actual @?= expected where desc = "10.0.0.0/24 is adjacent to 10.0.1.0/24 " ++ "and 10.0.3.0/23 contains 10.0.2.0/24" - cidr1 = read "10.0.0.0/24" - cidr2 = read "10.0.1.0/24" - cidr3 = read "10.0.2.0/24" - cidr4 = read "10.0.3.0/23" - cidr5 = read "10.0.0.0/23" - expected_cidrs = [read "10.0.0.0/22"] + cidr1 = read "10.0.0.0/24" :: Cidr + cidr2 = read "10.0.1.0/24" :: Cidr + cidr3 = read "10.0.2.0/24" :: Cidr + cidr4 = read "10.0.3.0/23" :: Cidr + cidr5 = read "10.0.0.0/23" :: Cidr test_cidrs = [cidr1, cidr2, cidr3, cidr4, cidr5] + expected = [read "10.0.0.0/22" :: Cidr] + actual = combine_all test_cidrs -test_combine_all2 :: Test +test_combine_all2 :: TestTree test_combine_all2 = - testCase desc $ - assertEqual - desc - expected_cidrs - (combine_all test_cidrs) - where - desc = "127.0.0.1/32 combines with itself recursively" - cidr1 = read "127.0.0.1/32" - expected_cidrs = [cidr1] - test_cidrs = [cidr1, cidr1, cidr1, cidr1, cidr1] + testCase desc $ actual @?= expected + where + desc = "127.0.0.1/32 combines with itself recursively" + cidr1 = read "127.0.0.1/32" :: Cidr + test_cidrs = [cidr1, cidr1, cidr1, cidr1, cidr1] + expected = [cidr1] + actual = combine_all test_cidrs -test_combine_all3 :: Test +test_combine_all3 :: TestTree test_combine_all3 = - testCase desc $ - assertEqual - desc - expected_cidrs - (combine_all test_cidrs) + testCase desc $ actual @?= expected where desc = "10.0.0.16, 10.0.0.17, 10.0.0.18, and " ++ "10.0.0.19 get combined into 10.0.0.16/30" - cidr1 = read "10.0.0.16/32" - cidr2 = read "10.0.0.17/32" - cidr3 = read "10.0.0.18/32" - cidr4 = read "10.0.0.19/32" - expected_cidrs = [read "10.0.0.16/30"] + cidr1 = read "10.0.0.16/32" :: Cidr + cidr2 = read "10.0.0.17/32" :: Cidr + cidr3 = read "10.0.0.18/32" :: Cidr + cidr4 = read "10.0.0.19/32" :: Cidr test_cidrs = [cidr1, cidr2, cidr3, cidr4] + expected = [read "10.0.0.16/30" :: Cidr] + actual = combine_all test_cidrs + +test_normalize1 :: TestTree +test_normalize1 = + testCase desc $ actual @?= expected + where + desc = "127.0.0.1/8 normalized is 127.0.0.0/8" + expected = read "127.0.0.0/8" :: Cidr + actual = normalize (read "127.0.0.1/8" :: Cidr) +test_normalize2 :: TestTree +test_normalize2 = + testCase desc $ actual @?= expected + where + desc = "192.168.1.101/24 normalized is 192.168.1.0/24" + expected = read "192.168.1.0/24" :: Cidr + actual = normalize (read "192.168.1.101/24" :: Cidr) + +test_normalize3 :: TestTree +test_normalize3 = + testCase desc $ actual @?= expected + where + desc = "10.10.10.10/22 normalized is 10.10.8.0/22" + expected = read "10.10.8.0/22" :: Cidr + actual = normalize (read "10.10.10.10/22" :: Cidr) + -- QuickCheck Tests -prop_all_cidrs_contain_themselves :: Cidr -> Bool -prop_all_cidrs_contain_themselves cidr1 = cidr1 `contains` cidr1 +prop_all_cidrs_contain_themselves :: TestTree +prop_all_cidrs_contain_themselves = + testProperty "All CIDRs contain themselves" prop + where + prop :: Cidr -> Bool + prop 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)) +prop_contains_proper_antisymmetric :: TestTree +prop_contains_proper_antisymmetric = + testProperty "CIDR proper containment is an antisymmetric relation" prop + where + prop :: Cidr -> Cidr -> Property + prop cidr1 cidr2 = + (cidr1 `contains_proper` cidr2) ==> + (not (cidr2 `contains_proper` cidr1)) + + +-- Running "normalize" a second time shouldn't do anything. +prop_normalize_idempotent :: TestTree +prop_normalize_idempotent = + testProperty "The CIDR \"normalize\" function is idempotent" prop + where + prop :: Cidr -> Bool + prop cidr = (normalize cidr) == (normalize (normalize cidr)) + +-- Normalization should not affect equality of two CIDRs. +prop_normalize_preserves_equality :: TestTree +prop_normalize_preserves_equality = + testProperty "The CIDR \"normalize\" function preserves equality" prop + where + prop :: Cidr -> Cidr -> Bool + prop cidr1 cidr2 = (cidr1 == cidr2) == (normalize cidr1 == normalize cidr2) + + +prop_ord_instance_reflexive :: TestTree +prop_ord_instance_reflexive = + testProperty "The CIDR order is reflexive" prop + where + prop :: Cidr -> Bool + prop cidr = cidr <= cidr + + +prop_ord_instance_transitive :: TestTree +prop_ord_instance_transitive = + testProperty "The CIDR order is transitive" prop + where + prop :: Cidr -> Cidr -> Cidr -> Property + prop cidr1 cidr2 cidr3 = + (cidr1 <= cidr2 && cidr2 <= cidr3) ==> cidr1 <= cidr3 + +-- This is how Eq is currently implemented, but it is useful to have +-- around in case that changes. Try fewer instances of this than usual +-- because it's a rare condition. +prop_ord_instance_antisymmetric :: TestTree +prop_ord_instance_antisymmetric = + localOption (QuickCheckTests 500) $ + testProperty "The CIDR order is antisymmetric" prop + where + prop :: Cidr -> Cidr -> Property + prop cidr1 cidr2 = + (cidr1 <= cidr2 && cidr2 <= cidr1) ==> cidr1 == cidr2