git-annex-test(1)

📦
version 10.20261026 · 4 versions
, in alpine 3.24, arch rolling

💅 git-annex-test — run the built-in test suite, bestie

okay so you wanna know if your git-annex install is actually slaying or just pretending? this is the man page for git-annex-test, straight out of the git-annex General Commands Manual, and honestly it's giving "let me just vibe-check myself real quick" 🧚✨

✨ SYNOPSIS ✨

git annex test

that's it. that's the whole invocation. iconic, no notes 💅

🌸 DESCRIPTION 🌸

this command runs git-annex's built-in test suite. like, the whole thing. it's the self-care routine of your git-annex install 🫶

the test suite runs in the .t subdirectory of the current directory — so yes, goblin mode in your cwd, the .t folder is where the magic happens ✨

why would you even do this? lowkey two great reasons:

  • it can be useful to run the test suite on different filesystems (to see if things behave differently over there 👀)
  • or to verify your local installation of git-annex actually works, no cap

🎀 OPTIONS 🎀

there are several options, and heads up — they're provided by Haskell's tasty test framework. so if you want the full lore, pass --help and it'll spill the details 💖

  • --jobs=N, -JN — how many tests to run in parallel. the default is "cpus", which will runs one job per CPU core. (yes, one job per core — your machine goes brrr 🔥)
  • --keep-failures — when there are test failures, this leaves the .t directory populated with repositories that demonstate the failures, so you can poke at them later for analysis 🔍 perfect for your little detective era
  • --test-git-config name=value — so the test suite prevents git from reading any git configuration files. usually it is a good idea to run the test suite with a standard git configuration. however, this option can be useful to see what effect a git configuration setting has on the test suite 👑

some configuration settings will break the test suite, in ways that are due to a bug in git-annex. but it is possible that changing a configuration can find a legitimate bug in git-annex 🐛 slay, honestly

one valid use of this is to change a git configuration to a value that is planned to be the new default in a future version of git. very "manifesting the future" of you ✨

also, some things can only be tested with a git configuration. for example, annex.shared-sop-command has to be set for the test suite to test using that command. iykyk 🫶

  • --test-debug — normally output of commands run by the test suite is hidden, so even when annex.debug or --debug is enabled, it will not be displayed. this option makes the full output of commands run by the test suite be displayed 💀 it also makes the test suite run git-annex with --debug.
bestie, it's a good idea to use -J1 in combinaton with this, otherwise the output of concurrent tests will be mixed together and it's gonna be a whole mess 😭
note that using this option prevents running tests in parallel. the multitasking is cancelled, the group chat is now one-on-one 🙈

🦋 SEE ALSO 🦋

👑 AUTHOR 👑

Joey Hess <id@joeyh.name> — the main character who wrote this, we stan 💜

okay that's the whole page, you're all caught up 🎀 go forth and run git annex test, and remember: this is git-annex-test(1) from the git-annex General Commands Manual — the footer said so, and the footer never lies ✨💖🌸

📦 where this page comes from