git-annex/Command/Test.hs

{- git-annex command
 -
 - Copyright 2013 Joey Hess <id@joeyh.name>
 -
 - Licensed under the GNU GPL version 3 or higher.
 -}

module Command.Test where

import Common
import Command
import Messages

cmd :: [Command]
cmd = [ noRepo startIO $ dontCheck repoExists $
	command "test" paramNothing seek SectionTesting
		"run built-in test suite"]

seek :: CommandSeek
seek = withWords start

{- We don't actually run the test suite here because of a dependency loop.
 - The main program notices when the command is test and runs it; this
 - function is never run if that works.
 -
 - However, if git-annex is built without the test suite, just print a
 - warning, and do not exit nonzero. This is so git-annex test can be run
 - in debian/rules despite some architectures not being able to build the
 - test suite.
 -}
start :: [String] -> CommandStart
start ps = do
	liftIO $ startIO ps
	stop

startIO :: CmdParams -> IO ()
startIO _ = warningIO "git-annex was built without its test suite; not testing"
embed test suite into git annex; available by running: git annex test I have seen some other programs do this, and think it's pretty cool. Means you can test wherever it's deployed, as well as at build time. My other reason for doing it is less happy. Cabal's handling of test suites sucks, requiring duplicated info, and even when that's done, it fails to preprocess hsc files here. Building it in avoids that and avoids having to explicitly tell cabal to enable test suites, which would then make it link the test executable every time, which is unnecessarily slow. This also has the benefit that now "make fast test" does a max speed build and tests it. 2013-02-27 19:35:07 +00:00			`{- git-annex command`
			`-`
update my email address and homepage url 2015-01-21 16:50:09 +00:00			`- Copyright 2013 Joey Hess <id@joeyh.name>`
embed test suite into git annex; available by running: git annex test I have seen some other programs do this, and think it's pretty cool. Means you can test wherever it's deployed, as well as at build time. My other reason for doing it is less happy. Cabal's handling of test suites sucks, requiring duplicated info, and even when that's done, it fails to preprocess hsc files here. Building it in avoids that and avoids having to explicitly tell cabal to enable test suites, which would then make it link the test executable every time, which is unnecessarily slow. This also has the benefit that now "make fast test" does a max speed build and tests it. 2013-02-27 19:35:07 +00:00			`-`
			`- Licensed under the GNU GPL version 3 or higher.`
			`-}`

			`module Command.Test where`

Really fix FTBFS on mipsel and sparc due to test suite not being available on those architectures. 2014-01-17 18:48:56 +00:00			`import Common`
embed test suite into git annex; available by running: git annex test I have seen some other programs do this, and think it's pretty cool. Means you can test wherever it's deployed, as well as at build time. My other reason for doing it is less happy. Cabal's handling of test suites sucks, requiring duplicated info, and even when that's done, it fails to preprocess hsc files here. Building it in avoids that and avoids having to explicitly tell cabal to enable test suites, which would then make it link the test executable every time, which is unnecessarily slow. This also has the benefit that now "make fast test" does a max speed build and tests it. 2013-02-27 19:35:07 +00:00			`import Command`
Fix FTBFS on mipsel and sparc due to test suite not being available on those architectures. 2014-01-15 16:49:56 +00:00			`import Messages`
embed test suite into git annex; available by running: git annex test I have seen some other programs do this, and think it's pretty cool. Means you can test wherever it's deployed, as well as at build time. My other reason for doing it is less happy. Cabal's handling of test suites sucks, requiring duplicated info, and even when that's done, it fails to preprocess hsc files here. Building it in avoids that and avoids having to explicitly tell cabal to enable test suites, which would then make it link the test executable every time, which is unnecessarily slow. This also has the benefit that now "make fast test" does a max speed build and tests it. 2013-02-27 19:35:07 +00:00
doh't use "def" for command definitions, it conflicts with Data.Default.def 2014-10-14 18:20:10 +00:00			`cmd :: [Command]`
			`cmd = [ noRepo startIO $ dontCheck repoExists $`
add new section for testing commands 2014-08-01 16:49:26 +00:00			`command "test" paramNothing seek SectionTesting`
add section metadata to all commands Not yet used .. mindless train work. 2013-03-24 22:28:21 +00:00			`"run built-in test suite"]`
embed test suite into git annex; available by running: git annex test I have seen some other programs do this, and think it's pretty cool. Means you can test wherever it's deployed, as well as at build time. My other reason for doing it is less happy. Cabal's handling of test suites sucks, requiring duplicated info, and even when that's done, it fails to preprocess hsc files here. Building it in avoids that and avoids having to explicitly tell cabal to enable test suites, which would then make it link the test executable every time, which is unnecessarily slow. This also has the benefit that now "make fast test" does a max speed build and tests it. 2013-02-27 19:35:07 +00:00
fix inversion of control in CommandSeek (no behavior changes) I've been disliking how the command seek actions were written for some time, with their inversion of control and ugly workarounds. The last straw to fix it was sync --content, which didn't fit the Annex [CommandStart] interface well at all. I have not yet made it take advantage of the changed interface though. The crucial change, and probably why I didn't do it this way from the beginning, is to make each CommandStart action be run with exceptions caught, and if it fails, increment a failure counter in annex state. So I finally remove the very first code I wrote for git-annex, which was before I had exception handling in the Annex monad, and so ran outside that monad, passing state explicitly as it ran each CommandStart action. This was a real slog from 1 to 5 am. Test suite passes. Memory usage is lower than before, sometimes by a couple of megabytes, and remains constant, even when running in a large repo, and even when repeatedly failing and incrementing the error counter. So no accidental laziness space leaks. Wall clock speed is identical, even in large repos. This commit was sponsored by an anonymous bitcoiner. 2014-01-20 08:11:42 +00:00			`seek :: CommandSeek`
			`seek = withWords start`
embed test suite into git annex; available by running: git annex test I have seen some other programs do this, and think it's pretty cool. Means you can test wherever it's deployed, as well as at build time. My other reason for doing it is less happy. Cabal's handling of test suites sucks, requiring duplicated info, and even when that's done, it fails to preprocess hsc files here. Building it in avoids that and avoids having to explicitly tell cabal to enable test suites, which would then make it link the test executable every time, which is unnecessarily slow. This also has the benefit that now "make fast test" does a max speed build and tests it. 2013-02-27 19:35:07 +00:00
break dependency cycle by special casing running of test command 2013-02-27 19:48:26 +00:00			`{- We don't actually run the test suite here because of a dependency loop.`
			`- The main program notices when the command is test and runs it; this`
Fix FTBFS on mipsel and sparc due to test suite not being available on those architectures. 2014-01-15 16:49:56 +00:00			`- function is never run if that works.`
			`-`
			`- However, if git-annex is built without the test suite, just print a`
			`- warning, and do not exit nonzero. This is so git-annex test can be run`
			`- in debian/rules despite some architectures not being able to build the`
			`- test suite.`
			`-}`
embed test suite into git annex; available by running: git annex test I have seen some other programs do this, and think it's pretty cool. Means you can test wherever it's deployed, as well as at build time. My other reason for doing it is less happy. Cabal's handling of test suites sucks, requiring duplicated info, and even when that's done, it fails to preprocess hsc files here. Building it in avoids that and avoids having to explicitly tell cabal to enable test suites, which would then make it link the test executable every time, which is unnecessarily slow. This also has the benefit that now "make fast test" does a max speed build and tests it. 2013-02-27 19:35:07 +00:00			`start :: [String] -> CommandStart`
Really fix FTBFS on mipsel and sparc due to test suite not being available on those architectures. 2014-01-17 18:48:56 +00:00			`start ps = do`
			`liftIO $ startIO ps`
Fix FTBFS on mipsel and sparc due to test suite not being available on those architectures. 2014-01-15 16:49:56 +00:00			`stop`
Really fix FTBFS on mipsel and sparc due to test suite not being available on those architectures. 2014-01-17 18:48:56 +00:00
			`startIO :: CmdParams -> IO ()`
expose tasty test suite's option parser 2014-01-21 04:08:43 +00:00			`startIO _ = warningIO "git-annex was built without its test suite; not testing"`