Warm tip: This article is reproduced from stackoverflow.com, please click
haskell shake-build-system

How can I write "unit" tests for Shake rules or actions?

发布于 2020-04-04 10:15:49

I am writing specialised rules and oracles for Shake and I would like to write tests for those functions. How can I do that in Shake? I did not find any simple to use actionToIO function that could do the job.

For example, I would like to test the behaviour of the following : 

checkGitWorkDirIsClean = do
  Stdout out <- cmd "git" [ "status", "-s", "-uno" ]
  pure $ null $ filter (/= "") (lines out)

so I could create prepare directories containing minimalistic git data and test the function against those directories.

Questioner
insitu
Viewed
77
分享
Neil Mitchell 2020-02-03 00:34

Generally speaking, testing build systems is hard. Shake has various linting related features that are probably the best way to the the entirety of the build system.

For testing small fragments, it's best if you can make them in IO rather than Action. In the above case, cmd can be run in both the Action and IO monads, so testing it in IO is probably much easier.

If you do have fragments in Action the only way to drive that through a Shake build system is using something like the shake function. If you want to do so in a consistent way, often setting shakeFiles to /dev/null can be useful, as that will cause Shake not to write to a database, so every run will be as though Shake was starting from a clean slate.

insitu 2020-02-03 04:09:56

Thanks a lot Neil! I have had a look at Shake's (impressive) set of tests and tried the later approach, but working in a per-test temporary directory, as I am using also git which needs a prepared directory. The /dev/null trick sounds interesting though. The tests are a bit clunky and verbose but at least they provide some safety.

Related issues

1
Pushing applicative effects into HKD fields with Barbies or Higgledy
2
How to chain the use of maybe argument in haskell?
3
How can I get nth element from a list?
4
How do you state a regex pattern in Haskell?
5
Force static compilation in stack
6
Finding the type of a composition function in Haskell
7
'gcc.exe' failed in phase 'Assembler' while running Haskell code
8
Hamlet html not registering or tags correctly for my home route handler
9
Haskell + Persistent: parse error possibly incorrect indentation or mismatched brackets
10
How to capitalize the first letter of a string and lowercase the rest in Haskell