diff --git a/LICENSE b/LICENSE new file mode 100644 --- /dev/null +++ b/LICENSE @@ -0,0 +1,165 @@ + GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may +differ in detail to address new problems or concerns. + + Each version is given a distinguishing version number. If the +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. diff --git a/Setup.hs b/Setup.hs new file mode 100644 --- /dev/null +++ b/Setup.hs @@ -0,0 +1,2 @@ +import Distribution.Simple +main = defaultMain diff --git a/Test/QuickCheck/Assertions.hs b/Test/QuickCheck/Assertions.hs new file mode 100644 --- /dev/null +++ b/Test/QuickCheck/Assertions.hs @@ -0,0 +1,141 @@ +{- | Module provides convenient functions to do some assertions in QuickCheck properties with pretty printed reasons. +For example you can do something like that: + +> module Main where +> +> import Test.Hspec +> import Test.Hspec.QuickCheck +> import Test.QuickCheck.Assertions +> import Test.QuickCheck.Property +> +> someProp :: Int -> Int -> Result +> someProp a b = (a ?> b) +> +> someOtherProp :: Double -> Double -> Result +> someOtherProp a b = (a ?== b) +> +> main = hspec $ describe "failing test" $ do +> prop "must fail" $ someProp +> prop "must fail again" $ someOtherProp + +And receive pretty printed fail message when testing: + +> failing test +> - must fail FAILED [1] +> - must fail again FAILED [2] +> +> 1) failing test must fail FAILED +> *** Failed! (after 1 test): +> >>>>>>>>>>>>>> the value +> 0 +> >>>>>>>>>>>>>> should be greater than value +> 0 +> 0 +> 0 +> +> +> 2) failing test must fail again FAILED +> *** Failed! (after 2 tests and 4 shrinks): +> >>>>>>>>>>>>>> expected +> 0.0 +> >>>>>>>>>>>>>> but got +> 1.0 +> 0.0 +> 1.0 + +Ok, not very well printed, but better than nothing. +-} +module Test.QuickCheck.Assertions ( + binAsrt + , (?==) + , (==?) + , (/=?) + , (?/=) + , (>?) + , () + , (?<) + , (>=?) + , (<=?) + , (?>=) + , (?<=) + , (~==?) + , (?~==) + ) where + +import Test.QuickCheck.Property +import Data.AEq + + + +binAsrt :: String -- ^ The reason of fail + -> Bool -- ^ If True then test pass + -> Result -- ^ The result with fail reason +binAsrt fmt pre = if pre + then succeeded + else failed {reason = fmt} + + +(==?), (?==) :: (Eq a, Show a) => a -> a -> Result +(?==) a b = binAsrt s (a == b) + where + s = ">>>>>>>>>>>>>> expected\n" -- very stupid formater for now + ++ show a ++ + "\n>>>>>>>>>>>>>> but got\n" + ++ show b + +(==?) = flip (?==) + +(?/=), (/=?) :: (Eq a, Show a) => a -> a -> Result +(?/=) a b = binAsrt s (a /= b) + where + s = ">>>>>>>>>>>>>> expected the value\n" + ++ show a ++ + "\n>>>>>>>>>>>>>> should not equal to\n" + ++ show b + +(/=?) = flip (?/=) + + +binOrdering :: (Show a, Ord a) + => (Ordering -> Bool) -- ^ Check if comparsion is good + -> String -- ^ Human-readable representation of operation + -> a + -> a + -> Result +binOrdering pre fmt a b = binAsrt s (pre $ compare a b) + where + s = ">>>>>>>>>>>>>> the value\n" + ++ show a ++ + "\n>>>>>>>>>>>>>> should be " ++ fmt ++ " than value\n" + ++ show b + +(>?), (), (?<), (>=?), (<=?), (?>=), (?<=) :: (Show a, Ord a) => a -> a -> Result + +-- | Left argument is greater than right +(?>) a b = binOrdering (== GT) "greater" a b +-- | Left argument is less then right +(?<) a b = binOrdering (== LT) "less" a b +-- | Right argument is less then left +(>?) = flip (?<) +-- | Right argument is greater than left +() +-- | Left argument is greater or equal to right +(?>=) a b = binOrdering (\x -> x == EQ || x == GT) "greater or equal" a b +-- | Left argument is less or equal to right +(?<=) a b = binOrdering (\x -> x == EQ || x == LT) "less or equal" a b +-- | Right argument is less or equal to left +(>=?) = flip (?<=) +-- | Right argument is greater or equal to left +(<=?) = flip (?>=) + +(?~==), (~==?) :: (AEq a, Show a) => a -> a -> Result +-- | Left value is almost equal to right +(?~==) a b = binAsrt s (a ~== b) + where + s = ">>>>>>>>>>>>>> The value\n" + ++ show a ++ + "\n>>>>>>>>>>>>>> should be almost equal to\n" + ++ show b +-- | Right value is almost equal to left +(~==?) = flip (?~==) diff --git a/quickcheck-assertions.cabal b/quickcheck-assertions.cabal new file mode 100644 --- /dev/null +++ b/quickcheck-assertions.cabal @@ -0,0 +1,39 @@ +-- Initial quickcheck-assertions.cabal generated by cabal init. For +-- further documentation, see http://haskell.org/cabal/users-guide/ + +name: quickcheck-assertions +version: 0.1.0 +synopsis: HUnit like assertions for QuickCheck +description: Library with convenient assertions for QuickCheck properties like in HUnit +license: LGPL-3 +license-file: LICENSE +author: Aleksey Uymanov +maintainer: s9gf4ult@gmail.com +-- copyright: +category: Testing +build-type: Simple +cabal-version: >=1.8 +homepage: https://github.com/s9gf4ult/quickcheck-assertions +source-repository head + type: git + location: git://github.com/s9gf4ult/quickcheck-assertions.git + + +library + exposed-modules: Test.QuickCheck.Assertions + -- other-modules: + build-depends: base == 4.* + , QuickCheck >= 2.3 + , ieee754 + ghc-options: -Wall + +test-suite main + type: exitcode-stdio-1.0 + build-depends: base == 4.* + , QuickCheck >= 2.3 + , hspec + , quickcheck-assertions + , ieee754 + ghc-options: -Wall -rtsopts + hs-source-dirs: tests + main-is: main.hs diff --git a/tests/main.hs b/tests/main.hs new file mode 100644 --- /dev/null +++ b/tests/main.hs @@ -0,0 +1,41 @@ +module Main where + +import Test.Hspec +import Test.Hspec.QuickCheck +import Test.QuickCheck.Property +import Test.QuickCheck.Assertions +import Data.AEq +import Numeric.IEEE + +check, check2 :: (Double -> Double -> Result) -> (Double -> Double -> Result) -> (Double -> Double -> Bool) -> Double -> Double -> Property +check ck1 ck2 pre a b = pre a b ==> + (ck1 a b) .&&. (ck2 a b) + +check2 ck1 ck2 pre a b = (not $ pre a b) ==> + (expectFailure $ (ck1 a b .&&. ck2 a b)) + + +main :: IO () +main = hspec $ describe "QC asserts" $ do + describe ">" $ do + prop "must pass" $ check (?>) (>?) (>) + prop "must fail" $ check2 (?>) (>?) (>) + describe "<" $ do + prop "must pass" $ check (?<) ( check (==?) (?==) (==) a a + prop "must fail" $ check2 (==?) (?==) (==) + describe "/=" $ do + prop "must pass" $ check (/=?) (?/=) (/=) + prop "must fail" $ \a -> check2 (/=?) (?/=) (/=) a a + describe ">=" $ do + prop "must pass" $ check (>=?) (?>=) (>=) + prop "must fail" $ check2 (>=?) (?>=) (>=) + describe "<=" $ do + prop "must pass" $ check (<=?) (?<=) (<=) + prop "must fail" $ check2 (<=?) (?<=) (<=) + describe "~==" $ do + prop "must pass" $ \a -> check (?~==) (~==?) (~==) a (succIEEE a) + prop "must pass" $ \a -> check (?~==) (~==?) (~==) a (predIEEE a) + prop "must fail" $ check2 (?~==) (~==?) (~==)