git-annex-testremote(1)

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

✨ git-annex-testremote(1) ✨

okay bestie, so this is from the General Commands Manual and it's literally about testing your git-annex remotes 💅

🌸 NAME 🌸

git-annex-testremote — test transfers to/from a remote

🦋 SYNOPSIS 🦋

git annex testremote remote

💖 DESCRIPTION 💖

So this command tests a remote by sending objects to it, downloading objects from it, like the whole vibe check of remote transfers, etc. ✨

It's safe to run in an existing repository (the repository contents are not altered), although ngl it may perform expensive data transfers 😭

Bestie, it's best to make a new remote for testing purposes. While the test tries to clean up after itself, if the remote being tested had a bug, the cleanup might fail, leaving test data in the remote. Also, some special remotes don't support removal of data that has been stored in them, so test data won't be able to be cleaned up when testing those. 🙈

Testing will use the remote's configuration, automatically varying the chunk sizes, and with simple shared encryption disabled and enabled, and exporttree disabled and enabled. If the remote is readonly, testing is limited to checking various properties of downloading from it. slay 🔥

🎀 OPTIONS 🎀

  • --fast — Perform a smaller set of tests. iykyk, less work but still a vibe check ✨
  • --test-readonly=file — Normally, random objects are generated for the test and are sent to the remote. When a readonly remote is being tested, that cannot be done, and so you need to specify some annexed files to use in the testing, using this option. Their content needs to be present in the readonly remote being tested, and in the local repository. 🫶

This option can be repeated.

When this option is used, testremote will avoid changing the remote in any way, even if it is not usually limited to readonly access. no cap 💅

  • --ensure-readonly=file — This tests that a remote only supports read access, by trying to send content to it and remove content from it, both of which should not be allowed by the remote's configuration. If it allows any writes, the test will fail. 💀

The file you specify must be present in the remote being tested, and in the local repository.

  • --size=NUnits — Tune the base size of generated objects. The default is 1MiB. 📏
  • --tap — Use TAP output (see https://testanything.org/). 🎯

Also the git-annex-common-options(1) can be used. fr fr 🌈

⭐ SEE ALSO ⭐

👑 AUTHOR 👑

Joey Hess <id@joeyh.name>

okay bestie, that's the whole page! go forth and test those remotes, you absolute icon 🧚💜

✨ much love from the git-annex-testremote(1) manual, General Commands Manual edition, brought to you by Joey Hess and the date/version vibes at the bottom of the page ✨

📦 where this page comes from