X-Git-Url: http://gitweb.michael.orlitzky.com/?a=blobdiff_plain;f=src%2FCidr.hs;h=6e759660486a1dffc5e1967c147ac7ff1b4d464d;hb=eee156f562f9c1c1194a67cef12f146304d88ce9;hp=826c8622819775cfb8976950eca3f1cb9c5d97f2;hpb=e8b41784eaa68049f7a7354916c9c9920050db70;p=hath.git diff --git a/src/Cidr.hs b/src/Cidr.hs index 826c862..6e75966 100644 --- a/src/Cidr.hs +++ b/src/Cidr.hs @@ -1,10 +1,13 @@ +-- | The CIDR modules contains most of the functions used for working +-- with the CIDR type. module Cidr ( Cidr(..), - cidr_from_string, + cidr_properties, cidr_tests, combine_all, contains, contains_proper, + enumerate, max_octet1, max_octet2, max_octet3, @@ -13,28 +16,33 @@ module Cidr min_octet2, min_octet3, min_octet4, - prop_all_cidrs_contain_themselves, - prop_contains_proper_intransitive ) where import Data.List (nubBy) -import Data.Maybe (catMaybes, fromJust) -import Test.HUnit -import Test.QuickCheck - -import qualified Bit as B -import IPv4Address -import ListUtils -import Maskable -import Maskbits -import Octet +import Data.List.Split (splitOneOf) +import Data.Maybe (catMaybes, mapMaybe) + +import Test.QuickCheck ( Gen ) -- Not re-exported by tasty +import Test.Tasty ( TestTree, testGroup ) +import Test.Tasty.HUnit ( (@?=), testCase ) +import Test.Tasty.QuickCheck ( + Arbitrary(..), + Property, + (==>), + 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(..)) data Cidr = Cidr { ipv4address :: IPv4Address, maskbits :: Maskbits } - instance Show Cidr where show cidr = (show (ipv4address cidr)) ++ "/" ++ (show (maskbits cidr)) @@ -50,72 +58,91 @@ instance Eq Cidr where cidr1 == cidr2 = (cidr1 `equivalent` cidr2) --- Two CIDR ranges are equivalent if they have the same network bits --- and the masks are the same. +-- | 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)) --- Returns the mask portion of a CIDR address. That is, everything --- after the trailing slash. +-- | Returns the mask portion of a CIDR address. That is, everything +-- after the trailing slash. maskbits_from_cidr_string :: String -> Maybe Maskbits maskbits_from_cidr_string s - | length partlist == 2 = maskbits_from_string (partlist !! 1) + | length partlist == 2 = readMaybe (partlist !! 1) | otherwise = Nothing where - partlist = (splitWith (`elem` "/") s) + partlist = splitOneOf "/" s -- | Takes an IP address String in CIDR notation, and returns a list -- of its octets (as Ints). octets_from_cidr_string :: String -> [Octet] octets_from_cidr_string s = - catMaybes $ map octet_from_string (take 4 (splitWith (`elem` "./") s)) - - --- | Return Nothing if we can't parse both maskbits and octets from --- the string. -cidr_from_string :: String -> Maybe Cidr -cidr_from_string s = - case (octets_from_cidr_string s) of - [oct1, oct2, oct3, oct4] -> - case (maskbits_from_cidr_string s) of - Just mbits -> - Just $ Cidr (IPv4Address oct1 oct2 oct3 oct4) mbits - _ -> Nothing - _ -> Nothing - - - + case parts of + (p1:p2:p3:p4:_) -> mapMaybe readMaybe [p1,p2,p3,p4] + _ -> [] + where + parts = splitOneOf "./" s + +instance Read Cidr where + -- | Parse everything or nothing. + readsPrec _ s = + case (octets_from_cidr_string s) of + [oct1, oct2, oct3, oct4] -> + case (maskbits_from_cidr_string s) of + Just mbits -> + [(Cidr (IPv4Address oct1 oct2 oct3 oct4) mbits, "")] + _ -> [] + _ -> [] + + +-- | Given a CIDR, return the minimum valid IPv4 address contained +-- within it. min_host :: Cidr -> IPv4Address min_host (Cidr addr mask) = apply_mask addr mask B.Zero - +-- | Given a CIDR, return the maximum valid IPv4 address contained +-- within it. max_host :: Cidr -> IPv4Address max_host (Cidr addr mask) = apply_mask addr mask B.One - +-- | Given a CIDR, return the first octet of the minimum valid IPv4 +-- address contained within it. min_octet1 :: Cidr -> Octet min_octet1 cidr = octet1 (min_host cidr) +-- | Given a CIDR, return the second octet of the minimum valid IPv4 +-- address contained within it. min_octet2 :: Cidr -> Octet min_octet2 cidr = octet2 (min_host cidr) +-- | Given a CIDR, return the third octet of the minimum valid IPv4 +-- address contained within it. min_octet3 :: Cidr -> Octet min_octet3 cidr = octet3 (min_host cidr) +-- | Given a CIDR, return the fourth octet of the minimum valid IPv4 +-- address contained within it. min_octet4 :: Cidr -> Octet min_octet4 cidr = octet4 (min_host cidr) +-- | Given a CIDR, return the first octet of the maximum valid IPv4 +-- address contained within it. max_octet1 :: Cidr -> Octet max_octet1 cidr = octet1 (max_host cidr) +-- | Given a CIDR, return the second octet of the maximum valid IPv4 +-- address contained within it. max_octet2 :: Cidr -> Octet max_octet2 cidr = octet2 (max_host cidr) +-- | Given a CIDR, return the third octet of the maximum valid IPv4 +-- address contained within it. max_octet3 :: Cidr -> Octet max_octet3 cidr = octet3 (max_host cidr) +-- | Given a CIDR, return the fourth octet of the maximum valid IPv4 +-- address contained within it. max_octet4 :: Cidr -> Octet max_octet4 cidr = octet4 (max_host cidr) @@ -140,7 +167,7 @@ max_octet4 cidr = octet4 (max_host cidr) -- cidr1, then at least mbits1 of an address in cidr2 will match -- cidr1. For example, -- --- cidr1 = 192.168.1.0/23, cidr2 = 192.168.1.100/24 +-- cidr1 = 192.168.1.0\/23, cidr2 = 192.168.1.100\/24 -- -- Here, cidr2 contains all of 192.168.1.0 through -- 192.168.1.255. However, cidr1 contains BOTH 192.168.0.0 through @@ -162,6 +189,7 @@ contains (Cidr addr1 mbits1) (Cidr addr2 mbits2) addr2masked = apply_mask addr2 mbits1 B.Zero +-- | Contains but is not equal to. contains_proper :: Cidr -> Cidr -> Bool contains_proper cidr1 cidr2 = (cidr1 `contains` cidr2) && (not (cidr2 `contains` cidr1)) @@ -208,7 +236,7 @@ combine_adjacent :: Cidr -> Cidr -> Maybe Cidr combine_adjacent cidr1 cidr2 | not (adjacent cidr1 cidr2) = Nothing | (maskbits cidr1 == Zero) = Nothing - | otherwise = Just $ cidr1 { maskbits = decrement (maskbits cidr1) } + | otherwise = Just $ cidr1 { maskbits = pred (maskbits cidr1) } @@ -228,238 +256,247 @@ adjacent cidr1 cidr2 mbits2 = maskbits cidr2 - +enumerate :: Cidr -> [IPv4Address] +enumerate cidr = [(min_host cidr)..(max_host cidr)] + +-- Test lists. +cidr_tests :: TestTree +cidr_tests = + testGroup "CIDR Tests" [ + test_enumerate, + test_min_host1, + test_max_host1, + 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, + test_combine_all1, + test_combine_all2, + test_combine_all3 ] + +cidr_properties :: TestTree +cidr_properties = + testGroup "CIDR Properties" [ + prop_all_cidrs_contain_themselves, + prop_contains_proper_antisymmetric ] -- HUnit Tests - -test_min_host1 :: Test +test_enumerate :: TestTree +test_enumerate = + testCase desc $ actual @?= expected + where + desc = "192.168.0.240/30 is enumerated correctly" + oct1 = toEnum 192 + oct2 = toEnum 168 + oct3 = minBound + 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" + +test_min_host1 :: TestTree test_min_host1 = - TestCase $ assertEqual "The minimum host in 10.0.0.0/24 is 10.0.0.0" - expected - actual + testCase desc $ actual @?= expected where - actual = show $ min_host (fromJust $ cidr_from_string "10.0.0.0/24") + 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") expected = "10.0.0.0" -test_max_host1 :: Test +test_max_host1 :: TestTree test_max_host1 = - TestCase $ assertEqual "The maximum host in 10.0.0.0/24 is 10.0.0.255" - expected - actual + testCase desc $ actual @?= expected where - actual = show $ max_host (fromJust $ cidr_from_string "10.0.0.0/24") + 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") expected = "10.0.0.255" -test_equality1 :: Test +test_equality1 :: TestTree test_equality1 = - TestCase $ - assertEqual - "10.1.1.0/23 equals itself" - True - (cidr1 == cidr1) + testCase desc $ actual @?= expected where - cidr1 = fromJust $ cidr_from_string "10.1.1.0/23" + desc = "10.1.1.0/23 equals itself" + 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 $ - assertEqual - "10.1.1.0/23 contains 10.1.1.0/24" - True - (cidr1 `contains` cidr2) + testCase desc $ actual @?= expected where - cidr1 = fromJust $ cidr_from_string "10.1.1.0/23" - cidr2 = fromJust $ cidr_from_string "10.1.1.0/24" + 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" + expected = True + actual = cidr1 `contains` cidr2 -test_contains2 :: Test +test_contains2 :: TestTree test_contains2 = - TestCase $ - assertEqual - "10.1.1.0/23 contains itself" - True - (cidr1 `contains` cidr1) + testCase desc $ actual @?= expected where - cidr1 = fromJust $ cidr_from_string "10.1.1.0/23" + desc = "10.1.1.0/23 contains itself" + cidr1 = read "10.1.1.0/23" + expected = True + actual = cidr1 `contains` cidr1 -test_contains_proper1 :: Test +test_contains_proper1 :: TestTree test_contains_proper1 = - TestCase $ - assertEqual - "10.1.1.0/23 contains 10.1.1.0/24 properly" - True - (cidr1 `contains_proper` cidr2) + testCase desc $ actual @?= expected where - cidr1 = fromJust $ cidr_from_string "10.1.1.0/23" - cidr2 = fromJust $ cidr_from_string "10.1.1.0/24" + 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" + expected = True + actual = cidr1 `contains_proper` cidr2 -test_contains_proper2 :: Test +test_contains_proper2 :: TestTree test_contains_proper2 = - TestCase $ - assertEqual - "10.1.1.0/23 does not contain itself properly" - False - (cidr1 `contains_proper` cidr1) + testCase desc $ actual @?= expected where - cidr1 = fromJust $ cidr_from_string "10.1.1.0/23" + desc = "10.1.1.0/23 does not contain itself properly" + cidr1 = read "10.1.1.0/23" + expected = False + actual = cidr1 `contains_proper` cidr1 -test_adjacent1 :: Test +test_adjacent1 :: TestTree test_adjacent1 = - TestCase $ - assertEqual - "10.1.0.0/24 is adjacent to 10.1.1.0/24" - True - (cidr1 `adjacent` cidr2) + testCase desc $ actual @?= expected where - cidr1 = fromJust $ cidr_from_string "10.1.0.0/24" - cidr2 = fromJust $ cidr_from_string "10.1.1.0/24" + 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" + expected = True + actual = cidr1 `adjacent` cidr2 -test_adjacent2 :: Test +test_adjacent2 :: TestTree test_adjacent2 = - TestCase $ - assertEqual - "10.1.0.0/23 is not adjacent to 10.1.0.0/24" - False - (cidr1 `adjacent` cidr2) + testCase desc $ actual @?= expected where - cidr1 = fromJust $ cidr_from_string "10.1.0.0/23" - cidr2 = fromJust $ cidr_from_string "10.1.0.0/24" + 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" + expected = False + actual = cidr1 `adjacent` cidr2 -test_adjacent3 :: Test +test_adjacent3 :: TestTree test_adjacent3 = - TestCase $ - assertEqual - "10.1.0.0/24 is not adjacent to 10.2.5.0/24" - False - (cidr1 `adjacent` cidr2) + testCase desc $ actual @?= expected where - cidr1 = fromJust $ cidr_from_string "10.1.0.0/24" - cidr2 = fromJust $ cidr_from_string "10.2.5.0/24" + 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" + expected = False + actual = cidr1 `adjacent` cidr2 -test_adjacent4 :: Test +test_adjacent4 :: TestTree test_adjacent4 = - TestCase $ - assertEqual - "10.1.1.0/24 is not adjacent to 10.1.2.0/24" - False - (cidr1 `adjacent` cidr2) + testCase desc $ actual @?= expected where - cidr1 = fromJust $ cidr_from_string "10.1.1.0/24" - cidr2 = fromJust $ cidr_from_string "10.1.2.0/24" - + 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" + expected = False + actual = cidr1 `adjacent` cidr2 -test_combine_contained1 :: Test +test_combine_contained1 :: TestTree 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_contained test_cidrs) + testCase desc $ actual @?= expected where - cidr1 = fromJust $ cidr_from_string "10.0.0.0/8" - cidr2 = fromJust $ cidr_from_string "10.1.0.0/16" - cidr3 = fromJust $ cidr_from_string "10.1.1.0/24" - expected_cidrs = [cidr1] + 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" test_cidrs = [cidr1, cidr2, cidr3] + expected = [cidr1] + actual = combine_contained test_cidrs - -test_combine_contained2 :: Test +test_combine_contained2 :: TestTree test_combine_contained2 = - TestCase $ - assertEqual - "192.168.3.0/23 does not contain 192.168.1.0/24" - [cidr1, cidr2] - (combine_contained [cidr1, cidr2]) + testCase desc $ actual @?= expected where - cidr1 = fromJust $ cidr_from_string "192.168.3.0/23" - cidr2 = fromJust $ cidr_from_string "192.168.1.0/24" + 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" + expected = [cidr1, cidr2] + actual = combine_contained [cidr1, cidr2] -test_combine_all1 :: Test +test_combine_all1 :: TestTree test_combine_all1 = - TestCase $ - assertEqual - "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" - expected_cidrs - (combine_all test_cidrs) + testCase desc $ actual @?= expected where - cidr1 = fromJust $ cidr_from_string "10.0.0.0/24" - cidr2 = fromJust $ cidr_from_string "10.0.1.0/24" - cidr3 = fromJust $ cidr_from_string "10.0.2.0/24" - cidr4 = fromJust $ cidr_from_string "10.0.3.0/23" - cidr5 = fromJust $ cidr_from_string "10.0.0.0/23" - expected_cidrs = [fromJust $ cidr_from_string "10.0.0.0/22"] + 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" test_cidrs = [cidr1, cidr2, cidr3, cidr4, cidr5] + expected = [read "10.0.0.0/22"] + actual = combine_all test_cidrs -test_combine_all2 :: Test +test_combine_all2 :: TestTree test_combine_all2 = - TestCase $ - assertEqual - "127.0.0.1/32 combines with itself recursively" - expected_cidrs - (combine_all test_cidrs) - where - cidr1 = fromJust $ cidr_from_string "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" + 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 $ - assertEqual - "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" - expected_cidrs - (combine_all test_cidrs) + testCase desc $ actual @?= expected where - cidr1 = fromJust $ cidr_from_string "10.0.0.16/32" - cidr2 = fromJust $ cidr_from_string "10.0.0.17/32" - - cidr3 = fromJust $ cidr_from_string "10.0.0.18/32" - cidr4 = fromJust $ cidr_from_string "10.0.0.19/32" - expected_cidrs = [fromJust $ cidr_from_string "10.0.0.16/30"] + 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" test_cidrs = [cidr1, cidr2, cidr3, cidr4] - - -cidr_tests :: [Test] -cidr_tests = [ test_min_host1, - test_max_host1, - 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, - test_combine_all1, - test_combine_all2, - test_combine_all3 - ] - + expected = [read "10.0.0.16/30"] + actual = combine_all test_cidrs -- 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))