Mercurial > hg
view tests/test-extdata.t @ 39772:ae531f5e583c
testing: add interface unit tests for file storage
Our strategy for supporting alternate storage backends is to define
interfaces for everything then "code to the interface."
We already have interfaces for various primitives, including file
and manifest storage.
What we don't have is generic unit tests for those interfaces. Up
to this point we've been relying on high-level integration tests
(mainly in the form of existing .t tests) to test alternate storage
backends. And my experience with developing the "simple store" test
extension is that such testing is very tedious: it takes several
minutes to run all tests and when you find a failure, it is often
non-trivial to debug.
This commit starts to change that.
This commit introduces the mercurial.testing.storage module. It
contains testing code for storage. Currently, it defines some
unittest.TestCase classes for testing the file storage interfaces.
It also defines some factory functions that allow a caller to easily
spawn a custom TestCase "bound" to a specific file storage backend
implementation.
A new .py test has been added. It simply defines a callable to produce
filelog and transaction instances on demand and then "registers" the
various test classes so the filelog class can be tested with the
storage interface unit tests.
As part of writing the tests, I identified a couple of apparent
bugs in revlog.py and filelog.py! These are tracked with inline
TODO comments.
Writing the tests makes it more obvious where the storage interface
is lacking. For example, we raise either IndexError or
error.LookupError for missing revisions depending on whether we
use an integer revision or a node. Also, we raise error.RevlogError
in various places when we should be raising a storage-agnostic
error type.
The storage interfaces are currently far from perfect and there is much
work to be done to improve them. But at least with this commit we
finally have the start of unit tests that can be used to "qualify"
the behavior of a storage backend. And when implementing and debugging
new storage backends, we now have an obvious place to define new
tests and have obvious places to insert breakpoints to facilitate
debugging. This should be invaluable when implementing new storage
backends.
I added the mercurial.testing package because these interface
conformance tests are generic and need to be usable by all storage
backends. Having the code live in tests/ would make it difficult for
storage backends implemented in extensions to test their interface
conformance. First, it would require obtaining a copy of Mercurial's
storage test code in order to test. Second, it would make testing
against multiple Mercurial versions difficult, as you would need to
import N copies of the storage testing code in order to achieve test
coverage. By making the test code part of the Mercurial distribution
itself, extensions can `import mercurial.testing.*` to access and run
the test code. The test will run against whatever Mercurial version
is active.
FWIW I've always wanted to move parts of run-tests.py into the
mercurial.* package to make the testing story simpler (e.g. imagine an
`hg debugruntests` command that could invoke the test harness). While I
have no plans to do that in the near future, establishing the
mercurial.testing package does provide a natural home for that code
should someone do this in the future.
Differential Revision: https://phab.mercurial-scm.org/D4650
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Tue, 18 Sep 2018 16:52:11 -0700 |
parents | faa41fd282d1 |
children | eec65b706caf |
line wrap: on
line source
$ hg init repo $ cd repo $ for n in 0 1 2 3 4 5 6 7 8 9 10 11; do > echo $n > $n > hg ci -qAm $n > done test revset support $ cat <<'EOF' >> .hg/hgrc > [extdata] > filedata = file:extdata.txt > notes = notes.txt > shelldata = shell:cat extdata.txt | grep 2 > emptygrep = shell:cat extdata.txt | grep empty > EOF $ cat <<'EOF' > extdata.txt > 2 another comment on 2 > 3 > EOF $ cat <<'EOF' > notes.txt > f6ed this change is great! > e834 this is buggy :( > 0625 first post > bogusnode gives no error > a ambiguous node gives no error > EOF $ hg log -qr "extdata(filedata)" 2:f6ed99a58333 3:9de260b1e88e $ hg log -qr "extdata(shelldata)" 2:f6ed99a58333 test weight of extdata() revset $ hg debugrevspec -p optimized "extdata(filedata) & 3" * optimized: (andsmally (func (symbol 'extdata') (symbol 'filedata')) (symbol '3')) 3 test non-zero exit of shell command $ hg log -qr "extdata(emptygrep)" abort: extdata command 'cat extdata.txt | grep empty' failed: exited with status 1 [255] test bad extdata() revset source $ hg log -qr "extdata()" hg: parse error: extdata takes at least 1 string argument [255] $ hg log -qr "extdata(unknown)" abort: unknown extdata source 'unknown' [255] test template support: $ hg log -r:3 -T "{node|short}{if(extdata('notes'), ' # {extdata('notes')}')}\n" 06254b906311 # first post e8342c9a2ed1 # this is buggy :( f6ed99a58333 # this change is great! 9de260b1e88e test template cache: $ hg log -r:3 -T '{rev} "{extdata("notes")}" "{extdata("shelldata")}"\n' 0 "first post" "" 1 "this is buggy :(" "" 2 "this change is great!" "another comment on 2" 3 "" "" test bad extdata() template source $ hg log -T "{extdata()}\n" hg: parse error: extdata expects one argument [255] $ hg log -T "{extdata('unknown')}\n" abort: unknown extdata source 'unknown' [255] $ hg log -T "{extdata(unknown)}\n" hg: parse error: empty data source specified (did you mean extdata('unknown')?) [255] $ hg log -T "{extdata('{unknown}')}\n" hg: parse error: empty data source specified [255] we don't fix up relative file URLs, but we do run shell commands in repo root $ mkdir sub $ cd sub $ hg log -qr "extdata(filedata)" abort: error: $ENOENT$ [255] $ hg log -qr "extdata(shelldata)" 2:f6ed99a58333 $ cd ..