tasty-th-0.1.4/0000755000000000000000000000000012660603736011470 5ustar0000000000000000tasty-th-0.1.4/BSD3.txt0000644000000000000000000000300012660603736012715 0ustar0000000000000000Copyright (c) 2010, Oscar Finnsson Copyright (c) 2013-2016, Benno Fünfstück All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of Oscar Finnsson nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL Oscar Finnsson BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. tasty-th-0.1.4/Setup.lhs0000644000000000000000000000015612660603736013302 0ustar0000000000000000#!/usr/bin/runhaskell > module Main where > import Distribution.Simple > main :: IO () > main = defaultMain tasty-th-0.1.4/tasty-th.cabal0000644000000000000000000000130112660603736014224 0ustar0000000000000000name: tasty-th version: 0.1.4 cabal-version: >= 1.6 build-type: Simple license: BSD3 license-file: BSD3.txt maintainer: Benno Fünfstück homepage: http://github.com/bennofs/tasty-th synopsis: Automatic tasty test case discovery using TH description: Generate tasty TestTrees automatically with TemplateHaskell. See the README for example usage. category: Testing author: Oscar Finnsson & Emil Nordling & Benno Fünfstück library exposed-modules: Test.Tasty.TH build-depends: base >= 4 && < 5, tasty, template-haskell hs-source-dirs: src other-extensions: TemplateHaskell source-repository head type: git location: https://github.com/bennofs/tasty-th.git tasty-th-0.1.4/src/0000755000000000000000000000000012660603736012257 5ustar0000000000000000tasty-th-0.1.4/src/Test/0000755000000000000000000000000012660603736013176 5ustar0000000000000000tasty-th-0.1.4/src/Test/Tasty/0000755000000000000000000000000012660603736014302 5ustar0000000000000000tasty-th-0.1.4/src/Test/Tasty/TH.hs0000644000000000000000000001045212660603736015153 0ustar0000000000000000----------------------------------------------------------------------------- -- -- Module : Test.Tasty.TH -- Copyright : Oscar Finnsson, Benno Fünfstück -- License : BSD3 -- -- Maintainer : Benno Fünfstück -- Stability : -- Portability : -- -- ----------------------------------------------------------------------------- {-# LANGUAGE TemplateHaskell #-} -- | This module provides TemplateHaskell functions to automatically generate -- tasty TestTrees from specially named functions. See the README of the package -- for examples. -- -- Important: due to to the GHC staging restriction, you must put any uses of these -- functions at the end of the file, or you may get errors due to missing definitions. module Test.Tasty.TH ( testGroupGenerator , defaultMainGenerator , testGroupGeneratorFor , defaultMainGeneratorFor , extractTestFunctions , locationModule ) where import Control.Monad (join) import Control.Applicative import Language.Haskell.TH import Data.List import Data.Maybe import Test.Tasty import Prelude -- | Convenience function that directly generates an `IO` action that may be used as the -- main function. It's just a wrapper that applies 'defaultMain' to the 'TestTree' generated -- by 'testGroupGenerator'. -- -- Example usage: -- -- @ -- -- properties, test cases, .... -- -- main :: IO () -- main = $('defaultMainGenerator') -- @ defaultMainGenerator :: ExpQ defaultMainGenerator = [| defaultMain $(testGroupGenerator) |] -- | This function generates a 'TestTree' from functions in the current module. -- The test tree is named after the current module. -- -- The following definitions are collected by `testGroupGenerator`: -- -- * a test_something definition in the current module creates a sub-testGroup with the name "something" -- * a prop_something definition in the current module is added as a QuickCheck property named "something" -- * a case_something definition leads to a HUnit-Assertion test with the name "something" -- -- Example usage: -- -- @ -- prop_example :: Int -> Int -> Bool -- prop_example a b = a + b == b + a -- -- tests :: 'TestTree' -- tests = $('testGroupGenerator') -- @ testGroupGenerator :: ExpQ testGroupGenerator = join $ testGroupGeneratorFor <$> fmap loc_module location <*> testFunctions where testFunctions = location >>= runIO . extractTestFunctions . loc_filename -- | Retrieves all function names from the given file that would be discovered by 'testGroupGenerator'. extractTestFunctions :: FilePath -> IO [String] extractTestFunctions filePath = do file <- readFile filePath let functions = map fst . concatMap lex . lines $ file filtered pat = filter (pat `isPrefixOf`) functions return . nub $ concat [filtered "prop_", filtered "case_", filtered "test_"] -- | Extract the name of the current module. locationModule :: ExpQ locationModule = do loc <- location return $ LitE $ StringL $ loc_module loc -- | Like 'testGroupGenerator', but generates a test group only including the specified function names. -- The function names still need to follow the pattern of starting with one of @prop_@, @case_@ or @test_@. testGroupGeneratorFor :: String -- ^ The name of the test group itself -> [String] -- ^ The names of the functions which should be included in the test group -> ExpQ testGroupGeneratorFor name functionNames = [| testGroup name $(listE (mapMaybe test functionNames)) |] where testFunctions = [("prop_", "testProperty"), ("case_", "testCase"), ("test_", "testGroup")] getTestFunction fname = snd <$> find ((`isPrefixOf` fname) . fst) testFunctions test fname = do fn <- getTestFunction fname return $ appE (appE (varE $ mkName fn) (stringE (fixName fname))) (varE (mkName fname)) -- | Like 'defaultMainGenerator', but only includes the specific function names in the test group. -- The function names still need to follow the pattern of starting with one of @prop_@, @case_@ or @test_@. defaultMainGeneratorFor :: String -- ^ The name of the top-level test group -> [String] -- ^ The names of the functions which should be included in the test group -> ExpQ defaultMainGeneratorFor name fns = [| defaultMain $(testGroupGeneratorFor name fns) |] fixName :: String -> String fixName = replace '_' ' ' . tail . dropWhile (/= '_') replace :: Eq a => a -> a -> [a] -> [a] replace b v = map (\i -> if b == i then v else i)