1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
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
202
203
204
205
206
207
208
209
210
211
212
213
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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
|
{- git-annex test suite framework
-
- Copyright 2010-2023 Joey Hess <id@joeyh.name>
-
- Licensed under the GNU AGPL version 3 or higher.
-}
{-# LANGUAGE CPP #-}
module Test.Framework where
import Test.Tasty
import Test.Tasty.Runners
import Test.Tasty.HUnit
import Test.Tasty.Options
import Test.Tasty.Ingredients.Rerun
import Test.Tasty.Ingredients.ConsoleReporter
import qualified Test.Tasty.Patterns.Types as TP
import Options.Applicative.Types
import Control.Concurrent
import Control.Concurrent.Async
import Control.Concurrent.STM
import System.Environment (getArgs)
import System.Console.Concurrent
import System.Console.ANSI
import GHC.Conc
import System.IO.Unsafe (unsafePerformIO)
import System.PosixCompat.Files (isSymbolicLink, isRegularFile, fileMode, unionFileModes, ownerWriteMode)
import Common
import Types.Test
import Types.Concurrency
import qualified Utility.RawFilePath as R
import qualified Annex
import qualified Annex.UUID
import qualified Types.RepoVersion
import qualified Backend
import qualified Git.CurrentRepo
import qualified Git.Construct
import qualified Git.Types
import qualified Git.Branch
import qualified Git.Ref
import qualified Types.KeySource
import qualified Types.Backend
import qualified Types
import qualified Remote
import qualified Key
import qualified Types.Key
import qualified Types.Messages
import qualified Config
import qualified Annex.WorkTree
import qualified Annex.Link
import qualified Annex.Path
import qualified Annex.Action
import qualified Annex.AdjustedBranch
import qualified Annex.Init
import qualified Utility.Process
import qualified Utility.Process.Transcript
import qualified Utility.Env
import qualified Utility.Env.Set
import qualified Utility.Exception
import qualified Utility.ThreadScheduler
import qualified Utility.Tmp.Dir
import qualified Utility.Metered
import qualified Command.Uninit
-- Run a process. The output and stderr is captured, and is only
-- displayed if the process does not return the expected value.
--
-- In debug mode, the output is allowed to pass through.
-- So the output does not get checked in debug mode.
testProcess :: String -> [String] -> Maybe [(String, String)] -> (Bool -> Bool) -> (String -> Bool) -> String -> Assertion
testProcess command params environ expectedret expectedtranscript faildesc = do
let p = (proc command params) { env = environ }
debug <- testDebug . testOptions <$> getTestMode
if debug
then do
ret <- withCreateProcess p $ \_ _ _ pid ->
waitForProcess pid
(expectedret (ret == ExitSuccess)) @? (faildesc ++ " failed with unexpected exit code")
else do
(transcript, ret) <- Utility.Process.Transcript.processTranscript' p Nothing
(expectedret ret) @? (faildesc ++ " failed with unexpected exit code (transcript follows)\n" ++ transcript)
(expectedtranscript transcript) @? (faildesc ++ " failed with unexpected output (transcript follows)\n" ++ transcript)
-- Run git. (Do not use to run git-annex as the one being tested
-- may not be in path.)
git :: String -> [String] -> String -> Assertion
git command params = testProcess "git" (command:params) Nothing (== True) (const True)
-- For when git is expected to fail.
git_shouldfail :: String -> [String] -> String -> Assertion
git_shouldfail command params = testProcess "git" (command:params) Nothing (== False) (const True)
-- Run git-annex.
git_annex :: String -> [String] -> String -> Assertion
git_annex command params faildesc = git_annex' command params Nothing faildesc
-- Runs git-annex with some environment.
git_annex' :: String -> [String] -> Maybe [(String, String)] -> String -> Assertion
git_annex' = git_annex'' (== True) (const True)
-- For when git-annex is expected to fail.
git_annex_shouldfail :: String -> [String] -> String -> Assertion
git_annex_shouldfail command params faildesc = git_annex_shouldfail' command params Nothing faildesc
git_annex_shouldfail' :: String -> [String] -> Maybe [(String, String)] -> String -> Assertion
git_annex_shouldfail' = git_annex'' (== False) (const True)
git_annex'' :: (Bool -> Bool) -> (String -> Bool) -> String -> [String] -> Maybe [(String, String)] -> String -> Assertion
git_annex'' expectedret expectedtranscript command params environ faildesc = do
pp <- Annex.Path.programPath
debug <- testDebug . testOptions <$> getTestMode
let params' = if debug
then "--debug":params
else params
testProcess pp (command:params') environ expectedret expectedtranscript faildesc
{- Runs git-annex and returns its standard output. -}
git_annex_output :: String -> [String] -> IO String
git_annex_output command params = do
pp <- Annex.Path.programPath
Utility.Process.readProcess pp (command:params)
git_annex_expectoutput :: String -> [String] -> [String] -> Assertion
git_annex_expectoutput command params expected = do
got <- lines <$> git_annex_output command params
got == expected @? ("unexpected value running " ++ command ++ " " ++ show params ++ " -- got: " ++ show got ++ " expected: " ++ show expected)
-- Runs an action in the current annex. Note that shutdown actions
-- are not run; this should only be used for actions that query state.
annexeval :: Types.Annex a -> IO a
annexeval a = do
s <- Annex.new =<< Git.CurrentRepo.get
Annex.eval s $ do
Annex.setOutput Types.Messages.QuietOutput
a `finally` Annex.Action.stopCoProcesses
innewrepo :: IO () -> IO ()
innewrepo a = withgitrepo $ \r -> indir r a
inmainrepo :: IO a -> IO a
inmainrepo a = do
d <- mainrepodir
indir d a
with_ssh_origin :: (Assertion -> Assertion) -> (Assertion -> Assertion)
with_ssh_origin cloner a = cloner $ do
let k = Git.Types.ConfigKey (encodeBS config)
let v = Git.Types.ConfigValue (toRawFilePath "/dev/null")
origindir <- absPath . Git.Types.fromConfigValue
=<< annexeval (Config.getConfig k v)
let originurl = "localhost:" ++ fromRawFilePath origindir
git "config" [config, originurl] "git config failed"
a
where
config = "remote.origin.url"
intmpclonerepo :: Assertion -> Assertion
intmpclonerepo a = withtmpclonerepo $ \r -> indir r a
checkRepo :: Types.Annex a -> FilePath -> IO a
checkRepo getval d = do
s <- Annex.new =<< Git.Construct.fromPath (toRawFilePath d)
Annex.eval s $
getval `finally` Annex.Action.stopCoProcesses
intmpbareclonerepo :: Assertion -> Assertion
intmpbareclonerepo a = withtmpclonerepo' (newCloneRepoConfig { bareClone = True } ) $
\r -> indir r a
intmpsharedclonerepo :: Assertion -> Assertion
intmpsharedclonerepo a = withtmpclonerepo' (newCloneRepoConfig { sharedClone = True } ) $
\r -> indir r a
withtmpclonerepo :: (FilePath -> Assertion) -> Assertion
withtmpclonerepo = withtmpclonerepo' newCloneRepoConfig
withtmpclonerepo' :: CloneRepoConfig -> (FilePath -> Assertion) -> Assertion
withtmpclonerepo' cfg a = do
dir <- tmprepodir
maindir <- mainrepodir
clone <- clonerepo maindir dir cfg
r <- tryNonAsync (a clone)
case r of
Right () -> return ()
Left e -> do
whenM (keepFailuresOption . testOptions <$> getTestMode) $
putStrLn $ "** Preserving repo for failure analysis in " ++ clone
throwM e
disconnectOrigin :: Assertion
disconnectOrigin = git "remote" ["rm", "origin"] "remote rm"
withgitrepo :: (FilePath -> Assertion) -> Assertion
withgitrepo a = do
maindir <- mainrepodir
bracket (setuprepo maindir) return a
indir :: FilePath -> IO a -> IO a
indir dir a = do
currdir <- getCurrentDirectory
-- Assertion failures throw non-IO errors; catch
-- any type of error and change back to currdir before
-- rethrowing.
r <- bracket_
(changeToTopDir dir)
(setCurrentDirectory currdir)
(tryNonAsync a)
case r of
Right v -> return v
Left e -> throwM e
adjustedbranchsupported :: FilePath -> IO Bool
adjustedbranchsupported repo = indir repo $ Annex.AdjustedBranch.isGitVersionSupported
setuprepo :: FilePath -> IO FilePath
setuprepo dir = do
cleanup dir
git "init" ["-q", dir] "git init"
configrepo dir
return dir
data CloneRepoConfig = CloneRepoConfig
{ bareClone :: Bool
, sharedClone :: Bool
}
newCloneRepoConfig :: CloneRepoConfig
newCloneRepoConfig = CloneRepoConfig
{ bareClone = False
, sharedClone = False
}
-- clones are always done as local clones; we cannot test ssh clones
clonerepo :: FilePath -> FilePath -> CloneRepoConfig -> IO FilePath
clonerepo old new cfg = do
cleanup new
let cloneparams = catMaybes
[ Just "-q"
, if bareClone cfg then Just "--bare" else Nothing
, if sharedClone cfg then Just "--shared" else Nothing
, Just old
, Just new
]
git "clone" cloneparams "git clone"
configrepo new
indir new $ do
ver <- annexVersion <$> getTestMode
git_annex "init"
[ "-q"
, new, "--version"
, show (Types.RepoVersion.fromRepoVersion ver)
]
"git annex init"
unless (bareClone cfg) $
indir new $
setupTestMode
return new
configrepo :: FilePath -> IO ()
configrepo dir = indir dir $ do
-- ensure git is set up to let commits happen
git "config" ["user.name", "Test User"]
"git config"
git "config" ["user.email", "test@example.com"]
"git config"
-- avoid signed commits by test suite
git "config" ["commit.gpgsign", "false"]
"git config"
-- tell git-annex to not annex the ingitfile
git "config" ["annex.largefiles", "exclude=" ++ ingitfile]
"git config annex.largefiles"
-- set any additional git configs the user wants to test with
gc <- testGitConfig . testOptions <$> getTestMode
forM_ gc $ \case
(Git.Types.ConfigKey k, Git.Types.ConfigValue v) ->
git "config" [decodeBS k, decodeBS v]
"git config from test options"
(Git.Types.ConfigKey _, Git.Types.NoConfigValue) -> noop
ensuredir :: FilePath -> IO ()
ensuredir d = do
e <- doesDirectoryExist d
unless e $
createDirectory d
{- This is the only place in the test suite that can use setEnv.
- Using it elsewhere can conflict with tasty's use of getEnv, which can
- happen concurrently with a test case running, and would be a problem
- since setEnv is not thread safe. This is run before tasty. -}
setTestEnv :: IO a -> IO a
setTestEnv a = Utility.Tmp.Dir.withTmpDir "testhome" $ \tmphome -> do
tmphomeabs <- fromRawFilePath <$> absPath (toRawFilePath tmphome)
{- Prevent global git configs from affecting the test suite. -}
Utility.Env.Set.setEnv "HOME" tmphomeabs True
Utility.Env.Set.setEnv "XDG_CONFIG_HOME" tmphomeabs True
Utility.Env.Set.setEnv "GIT_CONFIG_NOSYSTEM" "1" True
-- Ensure that the same git-annex binary that is running
-- git-annex test is at the front of the PATH.
p <- Utility.Env.getEnvDefault "PATH" ""
pp <- Annex.Path.programPath
Utility.Env.Set.setEnv "PATH" (takeDirectory pp ++ [searchPathSeparator] ++ p) True
-- Avoid git complaining if it cannot determine the user's
-- email address, or exploding if it doesn't know the user's name.
Utility.Env.Set.setEnv "GIT_AUTHOR_EMAIL" "test@example.com" True
Utility.Env.Set.setEnv "GIT_AUTHOR_NAME" "git-annex test" True
Utility.Env.Set.setEnv "GIT_COMMITTER_EMAIL" "test@example.com" True
Utility.Env.Set.setEnv "GIT_COMMITTER_NAME" "git-annex test" True
-- force gpg into batch mode for the tests
Utility.Env.Set.setEnv "GPG_BATCH" "1" True
-- Make git and git-annex access ssh remotes on the local
-- filesystem, without using ssh at all.
Utility.Env.Set.setEnv "GIT_SSH_COMMAND" "git-annex test --fakessh --" True
Utility.Env.Set.setEnv "GIT_ANNEX_USE_GIT_SSH" "1" True
-- Record top directory.
currdir <- getCurrentDirectory
Utility.Env.Set.setEnv "TOPDIR" currdir True
a
removeDirectoryForCleanup :: FilePath -> IO ()
#if MIN_VERSION_directory(1,2,7)
removeDirectoryForCleanup = removePathForcibly
#else
removeDirectoryForCleanup = removeDirectoryRecursive
#endif
cleanup :: FilePath -> IO ()
cleanup dir = whenM (doesDirectoryExist dir) $ do
Command.Uninit.prepareRemoveAnnexDir' dir
-- This can fail if files in the directory are still open by a
-- subprocess.
void $ tryIO $ removeDirectoryForCleanup dir
finalCleanup :: IO ()
finalCleanup = whenM (doesDirectoryExist tmpdir) $ do
Command.Uninit.prepareRemoveAnnexDir' tmpdir
catchIO (removeDirectoryForCleanup tmpdir) $ \e -> do
print e
putStrLn "sleeping 10 seconds and will retry directory cleanup"
Utility.ThreadScheduler.threadDelaySeconds $
Utility.ThreadScheduler.Seconds 10
whenM (doesDirectoryExist tmpdir) $
removeDirectoryForCleanup tmpdir
checklink :: FilePath -> Assertion
checklink f = ifM (annexeval Config.crippledFileSystem)
( (isJust <$> annexeval (Annex.Link.getAnnexLinkTarget (toRawFilePath f)))
@? f ++ " is not a (crippled) symlink"
, do
s <- R.getSymbolicLinkStatus (toRawFilePath f)
isSymbolicLink s @? f ++ " is not a symlink"
)
checkregularfile :: FilePath -> Assertion
checkregularfile f = do
s <- R.getSymbolicLinkStatus (toRawFilePath f)
isRegularFile s @? f ++ " is not a normal file"
return ()
checkdoesnotexist :: FilePath -> Assertion
checkdoesnotexist f =
(either (const True) (const False) <$> Utility.Exception.tryIO (R.getSymbolicLinkStatus (toRawFilePath f)))
@? f ++ " exists unexpectedly"
checkexists :: FilePath -> Assertion
checkexists f =
(either (const False) (const True) <$> Utility.Exception.tryIO (R.getSymbolicLinkStatus (toRawFilePath f)))
@? f ++ " does not exist"
checkcontent :: FilePath -> Assertion
checkcontent f = do
c <- Utility.Exception.catchDefaultIO "could not read file" $ readFile f
assertEqual ("checkcontent " ++ f) (content f) c
checkunwritable :: FilePath -> Assertion
checkunwritable f = do
-- Look at permissions bits rather than trying to write or
-- using fileAccess because if run as root, any file can be
-- modified despite permissions.
s <- R.getFileStatus (toRawFilePath f)
let mode = fileMode s
when (mode == mode `unionFileModes` ownerWriteMode) $
assertFailure $ "able to modify annexed file's " ++ f ++ " content"
checkwritable :: FilePath -> Assertion
checkwritable f = do
s <- R.getFileStatus (toRawFilePath f)
let mode = fileMode s
unless (mode == mode `unionFileModes` ownerWriteMode) $
assertFailure $ "unable to modify " ++ f
checkdangling :: FilePath -> Assertion
checkdangling f = ifM (annexeval Config.crippledFileSystem)
( return () -- probably no real symlinks to test
, do
r <- tryIO $ readFile f
case r of
Left _ -> return () -- expected; dangling link
Right _ -> assertFailure $ f ++ " was not a dangling link as expected"
)
checklocationlog :: FilePath -> Bool -> Assertion
checklocationlog f expected = do
thisuuid <- annexeval Annex.UUID.getUUID
r <- annexeval $ Annex.WorkTree.lookupKey (toRawFilePath f)
case r of
Just k -> do
uuids <- annexeval $ Remote.keyLocations k
assertEqual ("bad content in location log for " ++ f ++ " key " ++ Key.serializeKey k ++ " uuid " ++ show thisuuid)
expected (thisuuid `elem` uuids)
_ -> assertFailure $ f ++ " failed to look up key"
checkbackend :: FilePath -> Types.Backend -> Assertion
checkbackend file expected = do
b <- annexeval $ maybe (return Nothing) (Backend.getBackend file)
=<< Annex.WorkTree.lookupKey (toRawFilePath file)
assertEqual ("backend for " ++ file) (Just expected) b
checkispointerfile :: FilePath -> Assertion
checkispointerfile f = unlessM (isJust <$> Annex.Link.isPointerFile (toRawFilePath f)) $
assertFailure $ f ++ " is not a pointer file"
inlocationlog :: FilePath -> Assertion
inlocationlog f = checklocationlog f True
notinlocationlog :: FilePath -> Assertion
notinlocationlog f = checklocationlog f False
runchecks :: [FilePath -> Assertion] -> FilePath -> Assertion
runchecks [] _ = return ()
runchecks (a:as) f = do
a f
runchecks as f
annexed_notpresent :: FilePath -> Assertion
annexed_notpresent f = ifM (hasUnlockedFiles <$> getTestMode)
( annexed_notpresent_unlocked f
, annexed_notpresent_locked f
)
annexed_notpresent_locked :: FilePath -> Assertion
annexed_notpresent_locked = runchecks [checklink, checkdangling, notinlocationlog]
annexed_notpresent_unlocked :: FilePath -> Assertion
annexed_notpresent_unlocked = runchecks [checkregularfile, checkispointerfile, notinlocationlog]
annexed_present :: FilePath -> Assertion
annexed_present f = ifM (hasUnlockedFiles <$> getTestMode)
( annexed_present_unlocked f
, annexed_present_locked f
)
annexed_present_locked :: FilePath -> Assertion
annexed_present_locked f = ifM (annexeval Config.crippledFileSystem)
( runchecks [checklink, inlocationlog] f
, runchecks [checklink, checkcontent, checkunwritable, inlocationlog] f
)
annexed_present_unlocked :: FilePath -> Assertion
annexed_present_unlocked = runchecks
[checkregularfile, checkcontent, checkwritable, inlocationlog]
annexed_present_imported :: FilePath -> Assertion
annexed_present_imported f = ifM (annexeval Config.crippledFileSystem)
( annexed_present_unlocked f
, ifM (adjustedUnlockedBranch <$> getTestMode)
( annexed_present_unlocked f
, annexed_present_locked f
)
)
annexed_notpresent_imported :: FilePath -> Assertion
annexed_notpresent_imported f = ifM (annexeval Config.crippledFileSystem)
( annexed_notpresent_unlocked f
, ifM (adjustedUnlockedBranch <$> getTestMode)
( annexed_notpresent_unlocked f
, annexed_notpresent_locked f
)
)
unannexed :: FilePath -> Assertion
unannexed = runchecks [checkregularfile, checkcontent, checkwritable]
-- Check that a file is unannexed, but also that what's recorded in git
-- is not an annexed file.
unannexed_in_git :: FilePath -> Assertion
unannexed_in_git f = do
unannexed f
r <- annexeval $ Annex.WorkTree.lookupKey (toRawFilePath f)
case r of
Just _k -> assertFailure $ f ++ " is annexed in git"
Nothing -> return ()
add_annex :: FilePath -> String -> Assertion
add_annex f faildesc = ifM (unlockedFiles <$> getTestMode)
( git "add" [f] faildesc
, git_annex "add" [f] faildesc
)
data TestMode = TestMode
{ unlockedFiles :: Bool
, adjustedUnlockedBranch :: Bool
, annexVersion :: Types.RepoVersion.RepoVersion
, testOptions :: TestOptions
}
testMode :: TestOptions -> Types.RepoVersion.RepoVersion -> TestMode
testMode opts v = TestMode
{ unlockedFiles = False
, adjustedUnlockedBranch = False
, annexVersion = v
, testOptions = opts
}
hasUnlockedFiles :: TestMode -> Bool
hasUnlockedFiles m = unlockedFiles m || adjustedUnlockedBranch m
withTestMode :: TestMode -> TestTree -> TestTree
withTestMode testmode = withResource prepare release . const
where
prepare = setTestMode testmode
release _ = noop
{- The current test mode is stored here while a test is running.
-
- Only one test can be running at a time by a process; running a
- test also involves chdir into a test repository.
-}
{-# NOINLINE currentTestMode #-}
currentTestMode :: TMVar TestMode
currentTestMode = unsafePerformIO newEmptyTMVarIO
currentMainRepoDir :: TMVar FilePath
currentMainRepoDir = unsafePerformIO newEmptyTMVarIO
setTestMode :: TestMode -> IO ()
setTestMode testmode = do
atomically $ do
_ <- tryTakeTMVar currentTestMode
putTMVar currentTestMode testmode
setmainrepodir =<< newmainrepodir
getTestMode :: IO TestMode
getTestMode = atomically (tryReadTMVar currentTestMode) >>= \case
Just tm -> return tm
Nothing -> error "getTestMode without setTestMode"
setupTestMode :: IO ()
setupTestMode = do
testmode <- getTestMode
when (adjustedUnlockedBranch testmode) $ do
git "commit" ["--allow-empty", "-m", "empty"] "git commit failed"
git_annex "adjust" ["--unlock"] "git annex adjust failed"
changeToTopDir :: FilePath -> IO ()
changeToTopDir t = do
topdir <- Utility.Env.getEnvDefault "TOPDIR" (error "TOPDIR not set")
setCurrentDirectory $ topdir ++ "/" ++ t
tmpdir :: String
tmpdir = ".t"
setmainrepodir :: FilePath -> IO ()
setmainrepodir mrd = atomically $ do
_ <- tryTakeTMVar currentMainRepoDir
putTMVar currentMainRepoDir mrd
mainrepodir :: IO FilePath
mainrepodir = atomically (tryReadTMVar currentMainRepoDir) >>= \case
Just tm -> return tm
Nothing -> error "mainrepodir without setmainrepodir"
newmainrepodir :: IO FilePath
newmainrepodir = go (0 :: Int)
where
go n = do
let d = "main" ++ show n
ifM (doesDirectoryExist d)
( go $ n + 1
, do
createDirectory d
return d
)
tmprepodir :: IO FilePath
tmprepodir = go (0 :: Int)
where
go n = do
let d = "tmprepo" ++ show n
ifM (doesDirectoryExist d)
( go $ n + 1
, return d
)
annexedfile :: String
annexedfile = "foo"
annexedfiledup :: String
annexedfiledup = "foodup"
wormannexedfile :: String
wormannexedfile = "apple"
sha1annexedfile :: String
sha1annexedfile = "sha1foo"
sha1annexedfiledup :: String
sha1annexedfiledup = "sha1foodup"
ingitfile :: String
ingitfile = "bar.c"
content :: FilePath -> String
content f
| f == annexedfile = "annexed file content"
| f == ingitfile = "normal file content"
| f == sha1annexedfile ="sha1 annexed file content"
| f == annexedfiledup = content annexedfile
| f == sha1annexedfiledup = content sha1annexedfile
| f == wormannexedfile = "worm annexed file content"
| "import" `isPrefixOf` f = "imported content"
| otherwise = "unknown file " ++ f
-- Writes new content to a file, and makes sure that it has a different
-- mtime than it did before
writecontent :: FilePath -> String -> IO ()
writecontent f c = go (10000000 :: Integer)
where
go ticsleft = do
oldmtime <- catchMaybeIO $ getModificationTime f
writeFile f c
newmtime <- getModificationTime f
if Just newmtime == oldmtime
then do
threadDelay 100000
let ticsleft' = ticsleft - 100000
if ticsleft' > 0
then go ticsleft'
else do
hPutStrLn stderr "file mtimes do not seem to be changing (tried for 10 seconds)"
hFlush stderr
return ()
else return ()
changecontent :: FilePath -> IO ()
changecontent f = writecontent f $ changedcontent f
changedcontent :: FilePath -> String
changedcontent f = content f ++ " (modified)"
backendSHA1 :: Types.Backend
backendSHA1 = backend_ "SHA1"
backendSHA256 :: Types.Backend
backendSHA256 = backend_ "SHA256"
backendSHA256E :: Types.Backend
backendSHA256E = backend_ "SHA256E"
backendWORM :: Types.Backend
backendWORM = backend_ "WORM"
backend_ :: String -> Types.Backend
backend_ = Backend.lookupBuiltinBackendVariety . Types.Key.parseKeyVariety . encodeBS
getKey :: Types.Backend -> FilePath -> IO Types.Key
getKey b f = case Types.Backend.genKey b of
Just a -> annexeval $ a ks Utility.Metered.nullMeterUpdate
Nothing -> error "internal"
where
ks = Types.KeySource.KeySource
{ Types.KeySource.keyFilename = toRawFilePath f
, Types.KeySource.contentLocation = toRawFilePath f
, Types.KeySource.inodeCache = Nothing
}
{- Get the name of the original branch, eg the current branch, or
- if in an adjusted branch, the parent branch. -}
origBranch :: Types.Annex String
origBranch = maybe "foo"
(Git.Types.fromRef . Git.Ref.base . Annex.AdjustedBranch.fromAdjustedBranch)
<$> Annex.inRepo Git.Branch.current
{- Set up repos as remotes of each other. -}
pair :: FilePath -> FilePath -> Assertion
pair r1 r2 = forM_ [r1, r2] $ \r -> indir r $ do
when (r /= r1) $
git "remote" ["add", "r1", "../" ++ r1] "remote add"
when (r /= r2) $
git "remote" ["add", "r2", "../" ++ r2] "remote add"
{- Runs a query in the current repository, but first makes the repository
- read-only. The write bit is added back at the end, so when possible,
- include multiple tests within a single call for efficiency. -}
readonly_query :: Assertion -> Assertion
readonly_query = bracket_ (make_readonly ".") (make_writeable ".")
{- Not guaranteed to do anything:
- chmod may fail, or not be available, or the filesystem not support
- permissions. -}
make_readonly :: FilePath -> IO ()
make_readonly d = void $
Utility.Process.Transcript.processTranscript
"chmod" ["-R", "-w", d] Nothing
{- The write bit is added back for the current user, but not for other
- users, even though make_readonly removes any other user's write bits. -}
make_writeable :: FilePath -> IO ()
make_writeable d = void $
Utility.Process.Transcript.processTranscript
"chmod" ["-R", "u+w", d] Nothing
runFakeSsh :: [String] -> IO ()
runFakeSsh ("-n":ps) = runFakeSsh ps
runFakeSsh (_host:cmd:[]) =
withCreateProcess (shell cmd) $
\_ _ _ pid -> exitWith =<< waitForProcess pid
runFakeSsh ps = error $ "fake ssh option parse error: " ++ show ps
{- Tests each TestTree in parallel, and exits with success/failure.
-
- Tasty supports parallel tests, but this does not use it, because
- many tests need to be run in test repos, and chdir would not be
- thread safe. Instead, this starts one child process for each TestTree.
-
- An added benefit of using child processes is that any files they may
- leave open are closed before finalCleanup is run at the end. This
- prevents some failures to clean up after the test suite.
-}
parallelTestRunner :: TestOptions -> (Int -> Bool -> Bool -> TestOptions -> [TestTree]) -> IO ()
parallelTestRunner opts mkts = do
numjobs <- case concurrentJobs opts of
Just NonConcurrent -> pure 1
Just (Concurrent n) -> pure n
Just ConcurrentPerCpu -> getNumProcessors
Nothing -> getNumProcessors
parallelTestRunner' numjobs opts mkts
parallelTestRunner' :: Int -> TestOptions -> (Int -> Bool -> Bool -> TestOptions -> [TestTree]) -> IO ()
parallelTestRunner' numjobs opts mkts
| fakeSsh opts = runFakeSsh (internalData opts)
| otherwise = go =<< Utility.Env.getEnv subenv
where
subenv = "GIT_ANNEX_TEST_SUBPROCESS"
-- Make more parts than there are jobs, because some parts
-- are larger, and this allows the smaller parts to be packed
-- in more efficiently, speeding up the test suite overall.
--
-- When there is a pattern, splitting into parts will cause
-- extra work.
numparts = if haspattern
then 1
else numjobs * 2
worker rs nvar a = do
(n, m) <- atomically $ do
(n, m) <- readTVar nvar
writeTVar nvar (n+1, m)
return (n, m)
if n > m
then return rs
else do
r <- a n
worker (r:rs) nvar a
go Nothing = withConcurrentOutput $ do
ensuredir tmpdir
crippledfilesystem <- fst <$> Annex.Init.probeCrippledFileSystem'
(toRawFilePath tmpdir)
Nothing Nothing False
adjustedbranchok <- Annex.AdjustedBranch.isGitVersionSupported
let ts = mkts numparts crippledfilesystem adjustedbranchok opts
let warnings = fst (tastyParser ts)
unless (null warnings) $ do
hPutStrLn stderr "warnings from tasty:"
mapM_ (hPutStrLn stderr) warnings
environ <- Utility.Env.getEnvironment
args <- getArgs
pp <- Annex.Path.programPath
termcolor <- hSupportsANSIColor stdout
let ps = if useColor (lookupOption tastyopts) termcolor
then "--color=always":args
else "--color=never":args
let runone n = do
let subdir = tmpdir </> show n
ensuredir subdir
let p = (proc pp ps)
{ env = Just ((subenv, show (n, crippledfilesystem, adjustedbranchok)):environ)
, cwd = Just subdir
}
(_, _, _, pid) <- createProcessConcurrent p
waitForProcess pid
nvar <- newTVarIO (1, length ts)
exitcodes <- forConcurrently [1..numjobs] $ \_ ->
worker [] nvar runone
unless (keepFailuresOption opts) finalCleanup
case nub (filter (/= ExitSuccess) (concat exitcodes)) of
[] -> exitSuccess
[ExitFailure 1] -> do
putStrLn " (Failures above could be due to a bug in git-annex, or an incompatibility"
putStrLn " with utilities, such as git, installed on this system.)"
exitFailure
_ -> do
putStrLn $ " Test subprocesses exited with unexpected exit codes: " ++ show (concat exitcodes)
exitFailure
go (Just subenvval) = case readish subenvval of
Nothing -> error ("Bad " ++ subenv)
Just (n, crippledfilesystem, adjustedbranchok) -> setTestEnv $ do
let ts = mkts numparts crippledfilesystem adjustedbranchok opts
let t = topLevelTestGroup [ ts !! (n - 1) ]
case tryIngredients ingredients tastyopts t of
Nothing -> error "No tests found!?"
Just act -> ifM act
( exitSuccess
, exitFailure
)
(haspattern, tastyopts) = case lookupOption (tastyOptionSet opts) of
-- Work around limitation of tasty; when tests to run
-- are limited to a pattern, it does not include their
-- dependencies. So, add another pattern including the
-- init tests, which are a dependency of most tests.
TestPattern (Just p) ->
(True, setOption (TestPattern (Just (TP.Or p (TP.ERE initTestsName))))
(tastyOptionSet opts))
TestPattern Nothing ->
(False, tastyOptionSet opts)
topLevelTestGroup :: [TestTree] -> TestTree
topLevelTestGroup = testGroup "Tests"
initTestsName :: String
initTestsName = "Init Tests"
tastyParser :: [TestTree] -> ([String], Parser Test.Tasty.Options.OptionSet)
#if MIN_VERSION_tasty(1,3,0)
tastyParser ts = go
#else
tastyParser ts = ([], go)
#endif
where
go = suiteOptionParser ingredients (topLevelTestGroup ts)
ingredients :: [Ingredient]
ingredients =
[ listingTests
, rerunningTests [consoleTestReporter]
]
|