Test files

A test is a JSON file in an extension’s tests/ folder. orb test runs them all, in name order. Testing explains how to use them.

tests/stops-at-the-daily-limit.json

{
  "name": "Stops at the daily limit and says how far it got",
  "preferences": { "apiKey": "test-key" },
  "download": {
    "name": "Pack",
    "files": [
      { "path": "Pack/setup.exe", "size": 5000000, "sha256": "aaaa…" },
      { "path": "Pack/extras.zip", "size": 9000000, "sha256": "bbbb…" }
    ]
  },
  "mocks": {
    "fetch": [
      { "url": "https://www.virustotal.com/api/v3/files/aaaa…", "json": { "data": { "attributes": { "last_analysis_stats": { "malicious": 0, "suspicious": 0, "undetected": 60, "harmless": 10 } } } } },
      { "url": "https://www.virustotal.com/api/v3/files/bbbb…", "status": 429, "json": { "error": { "code": "QuotaExceededError" } } }
    ]
  },
  "expect": { "status": "skipped", "summaryIncludes": "Checked 1 of 2 files, then VirusTotal's daily limit was reached" }
}

Fields

Field	Default	Meaning
name	The file’s name	What the test checks, shown when it runs.
hook	The only hook	The hook to run. Needed when the extension has more than one.
verify	false	true runs the settings check, verify, with preferences, instead of a hook.
download		The download the hook gets. See below.
preferences	The defaults	Settings. Any left out take their defaults.
storage	{}	What the extension’s storage holds before the run.
mocks.fetch	[]	Answers to the hook’s requests. See below.
timeout	10000	Milliseconds of real time the test may take.
expect		What the result should be. Without it, the test passes if the hook doesn’t throw.

download

Field	Default	Meaning
name	"Download"	The download’s name.
id	A made-up info hash	Its info hash.
isPrivate	false	Whether it’s from a private tracker.
files	[]	Its files, in order: each path, size (0 unless given), wanted (true unless given), sha256, which files.sha256 returns for it, and isNew (true unless given, once it’s finished).
alsoOnDisk	[]	Other files already next to its files, as paths like theirs, such as subtitles the user added. files.save won’t replace them.
checks	[]	For an afterChecks hook: other extensions’ results, as CheckResult. extension, hook and event can be left out, and their files named by path alone.
held	false	For an afterChecks hook: true for a download a check is holding, so none of its files are on disk.

The download’s size is the sum of its wanted files’ sizes. Each file’s index is its place in the list, from 0. As in OrbTorrent, a hook can only use the files that are wanted, and only once the download has finished.

The result is checked as OrbTorrent checks it: its files must name files of the download, and it counts as no better than its worst file, with the same warning in the test’s logs.

Files a hook adds with files.save aren’t written anywhere: the test keeps them, for saved and savedIncludes to check.

mocks.fetch

Each mock answers requests that match it:

Field	Default	Meaning
url		The address to match. * matches any text.
method	GET	The method to match.
status	200	The status to answer with.
json		A body to answer with, as JSON. Sets content-type: application/json.
text	""	A body to answer with, as text.
base64		A body of bytes to answer with, in Base64, such as an image or a zip file.
headers		Headers to answer with.
times	Any number	How many requests this mock answers. After that, the next matching mock takes over.

A request takes the first mock that matches. A request with no mock throws, and the test says which request needs one.

expect

Key	Passes when
status	The result’s status is this.
summaryIncludes	The summary includes this text, ignoring case.
summaryMatches	The summary matches this regular expression.
detailsIncludes	The details include this text.
fetched	Each of these URLs was requested. * matches any text.
saved	Each of these files was added with files.save, by its path. * matches any text.
savedIncludes	Each file it added includes this text.
notify	Whether the result asks to be a notification, with notify: true.
files	Each file the result names has this status, by path: { "Pack/setup.exe": "failed" }. * matches any text, and "none" means the result says nothing about it.
throws	The hook threw an error that includes this text. The rest of expect is then ignored.
ok	For verify: whether it accepted the settings.
messageIncludes	For verify: its message includes this text.
not	The expectation inside it doesn’t pass, such as { "not": { "fetched": ["https://…"] } }.