makecleantest.icl 11.9 KB
Newer Older
Camil Staps's avatar
Camil Staps committed
1 2 3 4
module makecleantest

import _SystemArray
import StdBool
5
import StdEnum
Camil Staps's avatar
Camil Staps committed
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
import StdFile
from StdFunc import o
import StdOrdList
import StdString
import StdTuple

import Control.Monad => qualified join
import Data.Error
from Data.Func import $, mapSt, on, `on`, seqSt
import Data.Functor
import Data.List
import Data.Maybe
import Data.Tuple
import System.CommandLine
import System.Directory
import System.Environment
import System.File
import System.FilePath
import System.Options
import System.Process
import Text
27
import Text.Language
Camil Staps's avatar
Camil Staps committed
28

29 30 31
import Clean.Doc
import Clean.Types.Util
import Cloogle.DB.Factory
Camil Staps's avatar
Camil Staps committed
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201

:: Options =
	{ directory        :: !FilePath
	, modules          :: ![FilePath]
	, output_directory :: !FilePath
	, output_prefix    :: !String
	, includes         :: ![FilePath]
	, library_includes :: ![String]
	, clean_home       :: !FilePath
	, print_options    :: ![String]
	, test_options     :: ![String]
	, compile          :: !Bool
	, clm_args         :: ![String]
	, run              :: !Bool
	, verbosity        :: !Int
	, color            :: !Bool
	}

defaultOptions :: Options
defaultOptions =
	{ directory        = "."
	, modules          = []
	, output_directory = "."
	, output_prefix    = "_Tests"
	, includes         = []
	, library_includes = ["Gast","Platform"]
	, clean_home       = "/opt/clean"
	, print_options    = []
	, test_options     = []
	, compile          = False
	, clm_args         = []
	, run              = False
	, verbosity        = SUCCESS
	, color            = True
	}

Start w
// Command line
# ([prog:args],w) = getCommandLine w
# (clean_home,w) = appFst (fromMaybe "") $ getEnvironmentVariable "CLEAN_HOME" w
# opts = parseOptions optionDescription args {defaultOptions & clean_home=clean_home}
| isError opts = exit (join "\n" $ fromError opts) {defaultOptions & color=False} w
# opts = fromOk opts
# (modules,w) = case opts.modules of
	[_:_] -> (Ok [opts.Options.directory </> replaceSubString "." {pathSeparator} mod +++ ".dcl" \\ mod <- opts.modules], w)
	[]    -> findModules opts.Options.directory w
| isError modules = exit (snd (fromError modules) +++ " while finding modules") opts w
# w = seqSt (handleModule opts) (fromOk modules) w
= w
where
	optionDescription :: Option Options
	optionDescription = WithHelp True $ Options
		[ Shorthand "-d" "--directory" $ Option
			"--directory"
			(\dir opts -> Ok {Options | opts & directory=dir})
			"DIR"
			"The directory to test modules from (default: .)"
		, Shorthand "-m" "--module" $ Option
			"--module"
			(\mod opts -> Ok {opts & modules=opts.modules ++ [mod]})
			"MOD"
			"Add MOD to the to-test modules -- when no modules are given, all modules from --directory are used"
		, Shorthand "-D" "--output-directory" $ Option
			"--output-directory"
			(\dir opts -> Ok {opts & output_directory=dir})
			"DIR"
			"Use DIR as directory for test modules (default: .)"
		, Shorthand "-p" "--prefix" $ Option
			"--prefix"
			(\p opts -> Ok {opts & output_prefix=p})
			"PREFIX"
			"The prefix for test module names (default: _Tests, i.e., Data.Set goes to _Tests.Data.Set)"
		, Shorthand "-I" "--include" $ Option
			"--include"
			(\dir opts -> Ok {opts & includes=opts.includes ++ [dir]})
			"DIR"
			"Add DIR to the include path"
		, Shorthand "-IL" "--include-library" $ Option
			"--include-library"
			(\lib opts -> Ok {opts & library_includes=opts.library_includes ++ [lib]})
			"LIB"
			"Add CLEAN_HOME/lib/LIB to the include path"
		, Shorthand "-H" "--clean-home" $ Option
			"--clean-home"
			(\h opts -> Ok {opts & clean_home=h})
			"PATH"
			"Set CLEAN_HOME to PATH (used to find libraries)"
		, Shorthand "-P" "--print-option" $ Option
			"--print-option"
			(\po opts -> Ok {opts & print_options=opts.print_options ++ [po]})
			"OPT"
			"Add OPT to the print options (see Gast's PrintOption type)"
		, Shorthand "-T" "--test-option" $ Option
			"--test-option"
			(\po opts -> Ok {opts & test_options=opts.test_options ++ [po]})
			"OPT"
			"Add OPT to the test options (see Gast's Testoption type)"
		, Shorthand "-c" "--compile" $ Flag
			"--compile"
			(\opts -> Ok {opts & compile=True})
			"Compile the tests after generation"
		, Shorthand "-C" "--clm-arg" $ Option
			"--clm-arg"
			(\arg opts -> Ok {opts & clm_args=opts.clm_args ++ [arg]})
			"ARG"
			"Add ARG to the command line arguments for clm"
		, Shorthand "-r" "--run" $ Flag
			"--run"
			(\opts -> Ok {opts & compile=True, run=True})
			"Run the tests after generation (implies --compile)"
		, Shorthand "-v" "--verbose" $ Flag
			"--verbose"
			(\opts -> Ok {opts & verbosity=inc opts.verbosity})
			"Increase verbosity (can be given multiple times)"
		, Shorthand "-q" "--quiet" $ Flag
			"--quiet"
			(\opts -> Ok {opts & verbosity=dec opts.verbosity})
			"Decrease verbosity (can be given multiple times)"
		, Flag "--no-color"
			(\opts -> Ok {opts & color=False})
			"Turn off color in output"
		]

exit :: !String !Options !*World -> *World
exit error opts w = setReturnCode 1 $ output ERROR error opts w

DEBUG   :== 5
SUCCESS :== 4
INFO    :== 3
WARNING :== 2
ERROR   :== 1

output :: !Int !String !Options !*World -> *World
output level s opts w
| level > opts.verbosity = w
# (io,w) = stdio w
= snd $ fclose (io <<< color <<< s <<< newline) w
where
	color
	| opts.color = case level of
		DEBUG   -> "\033[0;36m"
		INFO    -> "\033[0;34m"
		SUCCESS -> "\033[0;32m"
		WARNING -> "\033[0;33m"
		ERROR   -> "\033[0;31m"
	| otherwise = ""

	newline = if opts.color "\033[0m\n" "\n"

findModules :: !FilePath !*World -> *(!MaybeOSError [FilePath], !*World)
findModules dir w
# (files,w) = readDirectory dir w
| isError files = (Error (fromError files), w)
= appFst (fmap flatten o sequence) $ mapSt recurse [fp \\ fp <- fromOk files | not $ isMember fp [".",".."]] w
where
	recurse :: !FilePath !*World -> *(!MaybeOSError [FilePath], !*World)
	recurse fp w
	# fp = dir </> fp
	# (info,w) = getFileInfo fp w
	| isError info = (Error (fromError info), w)
	| (fromOk info).FileInfo.directory = findModules fp w
	| otherwise = (Ok (if (endsWith ".dcl" fp) [fp] []), w)

handleModule :: !Options !FilePath !*World -> *World
handleModule opts fp w
# w = output DEBUG ("Checking " +++ fp +++ "...") opts w
// Find properties
# (funs,macros,_,_,_,_,_,_,(modname,mod,_),w) = findModuleContents False (dropExtension fp) w
# output_modname = opts.output_prefix +++ "." +++ modname
# output_filename = opts.output_directory </> replaceSubString "." {pathSeparator} output_modname +++ ".icl"
Camil Staps's avatar
Camil Staps committed
202
# (nprops,coverage,props) = generatePropertyModule
203
	output_modname modname
Camil Staps's avatar
Camil Staps committed
204 205 206
	opts.print_options
	opts.test_options
	mod
207
	[(loc,f) \\ (loc,f,_) <- funs ++ macros]
Camil Staps's avatar
Camil Staps committed
208 209
// Write properties
| nprops == 0 = w
Camil Staps's avatar
Camil Staps committed
210 211 212 213
# w = output INFO
	("Found " +++ pluralisen English nprops "test case" +++
		" in module " +++ modname +++
		"; " <+ entier (coverage * 100.0) <+ "% coverage") opts w
Camil Staps's avatar
Camil Staps committed
214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
# (dir,_) = splitFileName output_filename
# (ok,w) = assertDirectory dir w
| isError ok = exit (snd (fromError ok) <+ " " +++ output_filename) opts w
# (ok,w) = writeFile output_filename props w
| isError ok = exit (fromError ok <+ " " +++ output_filename) opts w
// Compile tests
| not opts.compile = w
# w = output INFO ("Compiling " +++ output_modname +++ "...") opts w
# output_exename = opts.output_directory </> output_modname
# (ok,w) = callProcess "clm"
	(opts.clm_args ++
		interleave "-I" [opts.Options.directory:opts.includes] ++
		interleave "-IL" opts.library_includes ++
		["-nr", output_modname, "-o", output_exename]) Nothing w
| isError ok = exit (snd (fromError ok) <+ " during compilation") opts w
| fromOk ok <> 0 = exit "Compilation finished with non-zero exit code" opts w
// Run tests
| not opts.run = w
# w = output INFO ("Running " +++ output_modname +++ "...") opts w
# (ok,w) = callProcess output_exename [] Nothing w
| isError ok = exit (snd (fromError ok) <+ " while running the tests") opts w
| fromOk ok <> 0 = exit "Test finished with non-zero exit code" opts w
= output SUCCESS (output_modname +++ " passed") opts w
where
	assertDirectory :: !FilePath !*World -> *(!MaybeOSError (), !*World)
	assertDirectory "" w = (Ok (), w)
	assertDirectory fp w
	# (ex,w) = fileExists fp w
	| ex = (Ok (), w)
	# (base,_) = splitFileName fp
	# (err,w) = assertDirectory base w
	| isError err = (err, w)
	= createDirectory fp w

	interleave :: a [a] -> [a]
	interleave _ []     = []
	interleave g [x:xs] = [g,x:interleave g xs]

252 253
generatePropertyModule :: !String !String ![String] ![String] !ModuleEntry
	![(LocationInModule,FunctionEntry)] -> (!Int, !Real, !String)
254
generatePropertyModule testmodname modname print_options test_options me fes
Camil Staps's avatar
Camil Staps committed
255
	= (length props, coverage, tests)
Camil Staps's avatar
Camil Staps committed
256
where
Camil Staps's avatar
Camil Staps committed
257 258 259
	n_props = length props
	coverage = toReal (length (filter (not o isEmpty) propsets)) / toReal (length fes)
	tests = join "\n\n"
260
		[ "module " +++ testmodname
Camil Staps's avatar
Camil Staps committed
261
		, "import Gast, Gast.CommandLine"
262
		, "from StdString import instance toString {#Char}"
263
		, "from Data.Func import $" // TODO: would be nice if property generation did not require this
264
		, "import Control.GenBimap"
265
		, "import " +++ modname
Camil Staps's avatar
Camil Staps committed
266 267 268 269 270 271
		, bootstrap
		, generators_string
		, start
		: [gp.gp_implementation \\ gp <- props]
		]

272
	propsets = map (uncurry $ generateProperties pvis generators) fes
Camil Staps's avatar
Camil Staps committed
273
	where pvis = fromMaybe [] $ docPropertyTestWith <$> me.me_documentation
Camil Staps's avatar
Camil Staps committed
274
	props = flatten propsets
Camil Staps's avatar
Camil Staps committed
275

276 277 278 279 280 281 282 283 284 285 286
	bootstrap = fromMaybe "" (docPropertyBootstrap =<< me.me_documentation)

	generators = [("gast_generator_" <+ i,type,imp) \\ i <- [0..]
		& PropertyTestGenerator type imp <- fromMaybe [] (docPropertyTestGenerators <$> me.me_documentation)]
	generators_string = join "\n\n" $ map makeGenerator $ generators
	where
		makeGenerator :: NamedTestGenerator -> String
		makeGenerator (name, t, imp) = join "\n"
			[ name +++ " :: " <+ t
			, name +++ imp % (3, size imp - 1)
			]
Camil Staps's avatar
Camil Staps committed
287 288 289 290 291 292 293 294 295 296 297 298 299 300

	start = join "\n\t"
		[ "Start w = exposeProperties"
		, "[" +++ join "," print_options +++ "]"
		, "[" +++ join "," test_options +++ "]"
		, "[ EP " +++ join "\n\t, EP " [gp.gp_name \\ gp <- props]
		, "] w"
		]

:: GeneratedProperty =
	{ gp_name           :: !String
	, gp_implementation :: !String
	}

301 302
:: NamedTestGenerator :== (String, Type, String)

303 304 305 306
generateProperties :: ![PropertyVarInstantiation] ![NamedTestGenerator]
	!LocationInModule !FunctionEntry -> [GeneratedProperty]
generateProperties pvis generators loc fe=:{fe_documentation=Just doc} =
	[gen i (fromJust loc.LocationInModule.name) p config
Camil Staps's avatar
Camil Staps committed
307 308 309 310 311 312 313 314 315 316 317
		\\ p <- doc.properties
		, config <- configurations $ groupInstantiations $ pvis ++ docPropertyTestWith doc
		& i <- [1..]]
where
	groupInstantiations :: [PropertyVarInstantiation] -> [[(String,Type)]]
	groupInstantiations pvis = groupBy ((==) `on` fst) $ sortBy ((<) `on` fst) [vi \\ PropertyVarInstantiation vi <- pvis]

	configurations :: [[(String,Type)]] -> [[(String,Type)]]
	configurations [vis:viss] = [[vi`:vis`] \\ vi` <- vis, vis` <- configurations viss]
	configurations [] = [[]]

318 319 320
	gen :: !Int !String !Property ![(String,Type)] -> GeneratedProperty
	gen i fname (ForAll name ts imp) vis =
		{ gp_name = tname
Camil Staps's avatar
Camil Staps committed
321
		, gp_implementation = join "\n"
322 323
			[ tname +++ " :: Property"
			, tname +++ " = name \"" +++ fname +++ ": " +++ name` +++ "\""
324
			, "\t(" +++ lambda +++ join " " [name`` +++ "`":map snd3 ts`] +++ ")"
325
			, "where"
326 327
			, "\t" +++ name`` +++ "` :: " +++ toString type`
			, "\t" +++ join " " [name`` +++ "`":map fst3 ts`] +++ " = prop $\n\t\t" +++ replaceSubString "\n" "\n\t\t" imp
Camil Staps's avatar
Camil Staps committed
328 329 330
			]
		}
	where
331 332
		tname = fname +++ "_" +++ name``
		name`` = fixname name`
Camil Staps's avatar
Camil Staps committed
333
		name` = if (i == 1) name (name +++ "_" +++ toString i)
334 335
		type  = fromJust $ assignAll vis $ Func (map thd3 ts`) (Type "Property" []) []
		type` = fromJust $ assignAll vis $ Func (map snd ts) (Type "Property" []) []
336 337

		ts` = map resolveGenerators ts
338 339 340
		lambda = case ts` of
			[] -> ""
			_  -> "\\" +++ join " " (map fst3 ts`) +++ " -> "
341 342 343 344 345

		resolveGenerators :: (String,Type) -> (String,String,Type)
		resolveGenerators (arg,t) = case [(n,i) \\ (n,Func [i] r _,_) <- generators | r == t] of
			[(n,i):_] -> (arg,"(" +++ n +++ " " +++ arg +++ ")",i)
			[]        -> (arg,arg,t)
346 347 348

		fixname :: String -> String
		fixname s = {if (isAlphanum c) c '_' \\ c <-: s}
349
generateProperties _ _ _ _ = []