]> gitweb.michael.orlitzky.com - hath.git/blobdiff - src/IPv4Address.hs
Switch from test-framework to tasty.
[hath.git] / src / IPv4Address.hs
index 15e69665e7ab8e22c4bd027b401860d579cf3727..d262a5c0537ea47092d0255ab417b6516d1cdab8 100644 (file)
@@ -1,20 +1,23 @@
 module IPv4Address(
+  IPv4Address(..),
   ipv4address_properties,
   ipv4address_tests,
-  IPv4Address(..),
-  most_sig_bit_different,
-) where
+  most_sig_bit_different )
+where
+
 
-import Data.Maybe (fromJust)
-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.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 Maskable
-import Maskbits
-import Octet
+import Maskable (Maskable(..))
+import Maskbits (Maskbits(..))
+import Octet (Octet(..))
 
 data IPv4Address =
   IPv4Address { octet1 :: Octet,
@@ -174,55 +177,40 @@ instance Bounded IPv4Address where
 
 
 
--- | Convert @addr@ to an 'Int' by converting each octet to an 'Int'
---   and shifting the result to the left by 0,8.16, or 24 bits.
-ipv4address_to_int :: IPv4Address -> Int
-ipv4address_to_int addr =
-  (shifted_oct1) + (shifted_oct2) + (shifted_oct3) + oct4
-  where
-    oct1 = fromEnum (octet1 addr)
-    oct2 = fromEnum (octet2 addr)
-    oct3 = fromEnum (octet3 addr)
-    oct4 = fromEnum (octet4 addr)
-
-    shifted_oct1 = oct1 * 2^(24 :: Integer)
-    shifted_oct2 = oct2 * 2^(16 :: Integer)
-    shifted_oct3 = oct3 * 2^(8 :: Integer)
-
-
-
--- | Convert an 'Int' @x@ to an 'IPv4Address'. Each octet of @x@ is
---   right-shifted by the appropriate number of bits, and the fractional
---   part is dropped.
-ipv4address_from_int :: Int -> Maybe IPv4Address
-ipv4address_from_int x
-  | (x < 0) || (x > 2^(32 :: Integer) - 1) = Nothing
-  | otherwise = do
-      -- If the algebra is right, none of these octet_from_int calls
-      -- below can fail since 0 <= x <= 2^32 - 1.
-      oct1 <- octet_from_int shifted_x1
-      oct2 <- octet_from_int shifted_x2
-      oct3 <- octet_from_int shifted_x3
-      oct4 <- octet_from_int x4
-      return $ IPv4Address oct1 oct2 oct3 oct4
-      where
-        -- Chop off the higher octets. x1 = x `mod` 2^32, would be
-        -- redundant.
-        x2 = x `mod` 2^(24 :: Integer)
-        x3 = x `mod` 2^(16 :: Integer)
-        x4 = x `mod` 2^(8  :: Integer)
-        -- Perform right-shifts. x4 doesn't need a shift.
-        shifted_x1 = x `quot` 2^(24 :: Integer)
-        shifted_x2 = x2 `quot` 2^(16 :: Integer)
-        shifted_x3 = x3 `quot` 2^(8 :: Integer)
-
 
 instance Enum IPv4Address where
-  -- We're supposed to throw a runtime error if you call (succ
-  -- maxBound), so the fromJust here doesn't introduce any additional
-  -- badness.
-  toEnum   = fromJust . ipv4address_from_int
-  fromEnum = ipv4address_to_int
+  -- | Convert an 'Int' @x@ to an 'IPv4Address'. Each octet of @x@ is
+  --   right-shifted by the appropriate number of bits, and the fractional
+  --   part is dropped.
+  toEnum x =
+    IPv4Address oct1 oct2 oct3 oct4
+    where
+      -- Chop off the higher octets. x1 = x `mod` 2^32, would be
+      -- redundant.
+      x2 = x `mod` 2^(24 :: Integer)
+      x3 = x `mod` 2^(16 :: Integer)
+      x4 = x `mod` 2^(8  :: Integer)
+      -- Perform right-shifts. x4 doesn't need a shift.
+      shifted_x1 = x `quot` 2^(24 :: Integer)
+      shifted_x2 = x2 `quot` 2^(16 :: Integer)
+      shifted_x3 = x3 `quot` 2^(8 :: Integer)
+      oct1 = toEnum shifted_x1
+      oct2 = toEnum shifted_x2
+      oct3 = toEnum shifted_x3
+      oct4 = toEnum x4
+
+  -- | Convert @addr@ to an 'Int' by converting each octet to an 'Int'
+  --   and shifting the result to the left by 0,8.16, or 24 bits.
+  fromEnum addr =
+    (shifted_oct1) + (shifted_oct2) + (shifted_oct3) + oct4
+    where
+      oct1 = fromEnum (octet1 addr)
+      oct2 = fromEnum (octet2 addr)
+      oct3 = fromEnum (octet3 addr)
+      oct4 = fromEnum (octet4 addr)
+      shifted_oct1 = oct1 * 2^(24 :: Integer)
+      shifted_oct2 = oct2 * 2^(16 :: Integer)
+      shifted_oct3 = oct3 * 2^(8 :: Integer)
 
 -- | Given two addresses, find the number of the most significant bit
 --   where they differ. If the addresses are the same, return
@@ -339,7 +327,7 @@ most_sig_bit_different addr1 addr2
 
 
 -- Test lists.
-ipv4address_tests :: Test
+ipv4address_tests :: TestTree
 ipv4address_tests =
   testGroup "IPv4 Address Tests" [
     test_enum,
@@ -349,49 +337,54 @@ ipv4address_tests =
     test_most_sig_bit_different2,
     test_to_enum ]
 
-ipv4address_properties :: Test
+ipv4address_properties :: TestTree
 ipv4address_properties =
   testGroup
     "IPv4 Address Properties "
-    [ testProperty
-        "fromEnum/toEnum are inverses"
-        prop_from_enum_to_enum_inverses ]
+    [ prop_from_enum_to_enum_inverses ]
 
 -- QuickCheck properties
-prop_from_enum_to_enum_inverses :: Int -> Property
-prop_from_enum_to_enum_inverses x =
-  (0 <= x) && (x <= 2^(32 :: Integer) - 1) ==>
-    fromEnum (toEnum x :: IPv4Address) == x
+prop_from_enum_to_enum_inverses :: TestTree
+prop_from_enum_to_enum_inverses =
+  testProperty "fromEnum and toEnum are inverses" prop
+  where
+    prop :: Int -> Property
+    prop x =
+      (0 <= x) && (x <= 2^(32 :: Integer) - 1) ==>
+        fromEnum (toEnum x :: IPv4Address) == x
 
 -- HUnit Tests
 mk_testaddr :: Int -> Int -> Int -> Int -> IPv4Address
 mk_testaddr a b c d =
   IPv4Address oct1 oct2 oct3 oct4
   where
-    oct1 = fromJust $ octet_from_int a
-    oct2 = fromJust $ octet_from_int b
-    oct3 = fromJust $ octet_from_int c
-    oct4 = fromJust $ octet_from_int d
+    oct1 = toEnum a
+    oct2 = toEnum b
+    oct3 = toEnum c
+    oct4 = toEnum d
+
 
-test_minBound :: Test
+test_minBound :: TestTree
 test_minBound =
-  testCase desc $ assertEqual desc expected actual
+  testCase desc $ actual @?= expected
   where
     desc = "minBound should be 0.0.0.0"
     expected = mk_testaddr 0 0 0 0
     actual = minBound :: IPv4Address
 
-test_maxBound :: Test
+
+test_maxBound :: TestTree
 test_maxBound =
-  testCase desc $ assertEqual desc expected actual
+  testCase desc $ actual @?= expected
   where
     desc = "maxBound should be 255.255.255.255"
     expected = mk_testaddr 255 255 255 255
     actual = maxBound :: IPv4Address
 
-test_enum :: Test
+
+test_enum :: TestTree
 test_enum =
-  testCase desc $ assertEqual desc expected actual
+  testCase desc $ actual @?= expected
   where
     desc = "enumerating a /24 gives the correct addresses"
     expected = ["192.168.0." ++ (show x) | x <- [0..255::Int] ]
@@ -399,34 +392,33 @@ test_enum =
     ub = mk_testaddr 192 168 0 255
     actual = map show [lb..ub]
 
-test_most_sig_bit_different1 :: Test
+
+test_most_sig_bit_different1 :: TestTree
 test_most_sig_bit_different1 =
-  testCase desc $ assertEqual desc
-             TwentyFour
-             bit
+  testCase desc $ actual @?= expected
   where
     desc = "10.1.1.0 and 10.1.0.0 differ in bit 24"
     addr1 = mk_testaddr 10 1 1 0
     addr2 = (mk_testaddr 10 1 0 0)
-    bit = most_sig_bit_different addr1 addr2
+    expected = TwentyFour
+    actual = most_sig_bit_different addr1 addr2
 
 
 
-test_most_sig_bit_different2 :: Test
+test_most_sig_bit_different2 :: TestTree
 test_most_sig_bit_different2 =
-  testCase desc $ assertEqual desc
-               TwentyThree
-               bit
+  testCase desc $ actual @?= expected
   where
     desc = "10.1.2.0 and 10.1.1.0 differ in bit 23"
     addr1 = mk_testaddr 10 1 2 0
     addr2 = mk_testaddr 10 1 1 0
-    bit = most_sig_bit_different addr1 addr2
+    expected = TwentyThree
+    actual = most_sig_bit_different addr1 addr2
 
 
-test_to_enum :: Test
+test_to_enum :: TestTree
 test_to_enum =
-  testCase desc $ assertEqual desc expected actual
+  testCase desc $ actual @?= expected
   where
     desc     = "192.168.0.0 in base-10 is 3232235520"
     expected = mk_testaddr 192 168 0 0