Mercurial > hg
view tests/test-contrib-check-code.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 | e223c0438f89 |
children | ff47ba7a2903 |
line wrap: on
line source
$ cat > correct.py <<EOF > def toto(arg1, arg2): > del arg2 > return (5 + 6, 9) > EOF $ cat > wrong.py <<EOF > def toto( arg1, arg2): > del(arg2) > return ( 5+6, 9) > EOF $ cat > quote.py <<EOF > # let's use quote in comments > (''' ( 4x5 ) > but """\\''' and finally''', > """let's fool checkpatch""", '1+2', > '"""', 42+1, """and > ( 4-1 ) """, "( 1+1 )\" and ") > a, '\\\\\\\\', "\\\\\\" x-2", "c-1" > EOF $ cat > classstyle.py <<EOF > class newstyle_class(object): > pass > > class oldstyle_class: > pass > > class empty(): > pass > > no_class = 1: > pass > EOF $ check_code="$TESTDIR"/../contrib/check-code.py $ "$check_code" ./wrong.py ./correct.py ./quote.py ./classstyle.py ./wrong.py:1: > def toto( arg1, arg2): gratuitous whitespace in () or [] ./wrong.py:2: > del(arg2) Python keyword is not a function ./wrong.py:3: > return ( 5+6, 9) gratuitous whitespace in () or [] missing whitespace in expression ./quote.py:5: > '"""', 42+1, """and missing whitespace in expression ./classstyle.py:4: > class oldstyle_class: old-style class, use class foo(object) ./classstyle.py:7: > class empty(): class foo() creates old style object, use class foo(object) [1] $ cat > python3-compat.py << EOF > foo <> bar > reduce(lambda a, b: a + b, [1, 2, 3, 4]) > dict(key=value) > EOF $ "$check_code" python3-compat.py python3-compat.py:1: > foo <> bar <> operator is not available in Python 3+, use != python3-compat.py:2: > reduce(lambda a, b: a + b, [1, 2, 3, 4]) reduce is not available in Python 3+ python3-compat.py:3: > dict(key=value) dict() is different in Py2 and 3 and is slower than {} [1] $ cat > foo.c <<EOF > void narf() { > strcpy(foo, bar); > // strcpy_s is okay, but this comment is not > strcpy_s(foo, bar); > } > EOF $ "$check_code" ./foo.c ./foo.c:2: > strcpy(foo, bar); don't use strcpy, use strlcpy or memcpy ./foo.c:3: > // strcpy_s is okay, but this comment is not don't use //-style comments [1] $ cat > is-op.py <<EOF > # is-operator comparing number or string literal > x = None > y = x is 'foo' > y = x is "foo" > y = x is 5346 > y = x is -6 > y = x is not 'foo' > y = x is not "foo" > y = x is not 5346 > y = x is not -6 > EOF $ "$check_code" ./is-op.py ./is-op.py:3: > y = x is 'foo' object comparison with literal ./is-op.py:4: > y = x is "foo" object comparison with literal ./is-op.py:5: > y = x is 5346 object comparison with literal ./is-op.py:6: > y = x is -6 object comparison with literal ./is-op.py:7: > y = x is not 'foo' object comparison with literal ./is-op.py:8: > y = x is not "foo" object comparison with literal ./is-op.py:9: > y = x is not 5346 object comparison with literal ./is-op.py:10: > y = x is not -6 object comparison with literal [1] $ cat > for-nolineno.py <<EOF > except: > EOF $ "$check_code" for-nolineno.py --nolineno for-nolineno.py:0: > except: naked except clause [1] $ cat > warning.t <<EOF > $ function warnonly { > > } > $ diff -N aaa > $ function onwarn {} > EOF $ "$check_code" warning.t $ "$check_code" --warn warning.t warning.t:1: > $ function warnonly { warning: don't use 'function', use old style warning.t:3: > $ diff -N aaa warning: don't use 'diff -N' warning.t:4: > $ function onwarn {} warning: don't use 'function', use old style [1] $ cat > error.t <<EOF > $ [ foo == bar ] > EOF $ "$check_code" error.t error.t:1: > $ [ foo == bar ] [ foo == bar ] is a bashism, use [ foo = bar ] instead [1] $ rm error.t $ cat > raise-format.py <<EOF > raise SomeException, message > # this next line is okay > raise SomeException(arg1, arg2) > EOF $ "$check_code" not-existing.py raise-format.py Skipping*not-existing.py* (glob) raise-format.py:1: > raise SomeException, message don't use old-style two-argument raise, use Exception(message) [1] $ cat <<EOF > tab.t > indent > > heredoc > EOF $ "$check_code" tab.t tab.t:1: > indent don't use tabs to indent [1] $ rm tab.t $ cat > rst.py <<EOF > """problematic rst text > > .. note:: > wrong > """ > > ''' > > .. note:: > > valid > > new text > > .. note:: > > also valid > ''' > > """mixed > > .. note:: > > good > > .. note:: > plus bad > """ > EOF $ $check_code -w rst.py rst.py:3: > .. note:: warning: add two newlines after '.. note::' rst.py:26: > .. note:: warning: add two newlines after '.. note::' [1] $ cat > ./map-inside-gettext.py <<EOF > print(_("map inside gettext %s" % v)) > > print(_("concatenating " " by " " space %s" % v)) > print(_("concatenating " + " by " + " '+' %s" % v)) > > print(_("mapping operation in different line %s" > % v)) > > print(_( > "leading spaces inside of '(' %s" % v)) > EOF $ "$check_code" ./map-inside-gettext.py ./map-inside-gettext.py:1: > print(_("map inside gettext %s" % v)) don't use % inside _() ./map-inside-gettext.py:3: > print(_("concatenating " " by " " space %s" % v)) don't use % inside _() ./map-inside-gettext.py:4: > print(_("concatenating " + " by " + " '+' %s" % v)) don't use % inside _() ./map-inside-gettext.py:6: > print(_("mapping operation in different line %s" don't use % inside _() ./map-inside-gettext.py:9: > print(_( don't use % inside _() [1] web templates $ mkdir -p mercurial/templates $ cat > mercurial/templates/example.tmpl <<EOF > {desc} > {desc|escape} > {desc|firstline} > {desc|websub} > EOF $ "$check_code" --warnings mercurial/templates/example.tmpl mercurial/templates/example.tmpl:2: > {desc|escape} warning: follow desc keyword with either firstline or websub [1] 'string join across lines with no space' detection $ cat > stringjoin.py <<EOF > foo = (' foo' > 'bar foo.' > 'bar foo:' > 'bar foo@' > 'bar foo%' > 'bar foo*' > 'bar foo+' > 'bar foo-' > 'bar') > EOF 'missing _() in ui message' detection $ cat > uigettext.py <<EOF > ui.status("% 10s %05d % -3.2f %*s %%" > # this use '\\\\' instead of '\\', because the latter in > # heredoc on shell becomes just '\' > '\\\\ \n \t \0' > """12345 > """ > '''.:*+-= > ''' "%-6d \n 123456 .:*+-= foobar") > EOF superfluous pass $ cat > superfluous_pass.py <<EOF > # correct examples > if foo: > pass > else: > # comment-only line means still need pass > pass > def nothing(): > pass > class empty(object): > pass > if whatever: > passvalue(value) > # bad examples > if foo: > "foo" > pass > else: # trailing comment doesn't fool checker > wat() > pass > def nothing(): > "docstring means no pass" > pass > class empty(object): > """multiline > docstring also > means no pass""" > pass > EOF (Checking multiple invalid files at once examines whether caching translation table for repquote() works as expected or not. All files should break rules depending on result of repquote(), in this case) $ "$check_code" stringjoin.py uigettext.py superfluous_pass.py stringjoin.py:1: > foo = (' foo' string join across lines with no space stringjoin.py:2: > 'bar foo.' string join across lines with no space stringjoin.py:3: > 'bar foo:' string join across lines with no space stringjoin.py:4: > 'bar foo@' string join across lines with no space stringjoin.py:5: > 'bar foo%' string join across lines with no space stringjoin.py:6: > 'bar foo*' string join across lines with no space stringjoin.py:7: > 'bar foo+' string join across lines with no space stringjoin.py:8: > 'bar foo-' string join across lines with no space uigettext.py:1: > ui.status("% 10s %05d % -3.2f %*s %%" missing _() in ui message (use () to hide false-positives) superfluous_pass.py:14: > if foo: omit superfluous pass superfluous_pass.py:17: > else: # trailing comment doesn't fool checker omit superfluous pass superfluous_pass.py:20: > def nothing(): omit superfluous pass superfluous_pass.py:23: > class empty(object): omit superfluous pass [1]