This is an archive of the discontinued Mercurial Phabricator instance.

Differential D1750

run-tests: extract sorting of tests to own function
ClosedPublic

Authored by indygreg on Dec 22 2017, 3:01 PM.

Details

Reviewers
yuja
Group Reviewers
hg-reviewers
Commits
rHG212a6e9aecb0: run-tests: extract sorting of tests to own function
Summary

TestRunner._run() is a large function and is difficult to follow.
Let's extract the test sorting to its own function to make it shorter.

When I refactored run-tests.py several years ago, I put a lot of
functionality in methods. The prevailing Mercurial style is to use
functions - not classes - where possible. While refactoring the code,
I decided to undo this historical mistake of mine by moving the code
to a standalone function.

Diff Detail

Repository
rHG Mercurial
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

indygreg created this revision.Dec 22 2017, 3:01 PM
quark added a subscriber: quark.Dec 22 2017, 3:45 PM
quark added inline comments.
tests/run-tests.py
2271

I prefer the name testdescs since they are "test descriptions", not the real test objects. I think I renamed tests to testdescs intentionally.

indygreg updated this revision to Diff 4591.Dec 22 2017, 8:05 PM
yuja accepted this revision.Dec 22 2017, 8:39 PM
This revision is now accepted and ready to land.Dec 22 2017, 8:39 PM
Closed by commit rHG212a6e9aecb0: run-tests: extract sorting of tests to own function (authored by indygreg). · Explain WhyDec 22 2017, 9:08 PM
This revision was automatically updated to reflect the committed changes.

Revision Contents
Changeset List

PathPackages
Mtests/run-tests.py (83 lines)

Diff 4600

tests/run-tests.py

# blacklisted test # blacklisted test
tres = {'result': res} tres = {'result': res}
outcome[tc.name] = tres outcome[tc.name] = tres
jsonout = json.dumps(outcome, sort_keys=True, indent=4, jsonout = json.dumps(outcome, sort_keys=True, indent=4,
separators=(',', ': ')) separators=(',', ': '))
outf.writelines(("testreport =", jsonout)) outf.writelines(("testreport =", jsonout))
def sorttests(testdescs, shuffle=False):
quarkUnsubmitted
Not Done

I prefer the name testdescs since they are "test descriptions", not the real test objects. I think I renamed tests to testdescs intentionally.

quark: I prefer the name `testdescs` since they are "test descriptions", not the real test objects. I…
"""Do an in-place sort of tests."""
if shuffle:
random.shuffle(testdescs)
return
# keywords for slow tests
slow = {b'svn': 10,
b'cvs': 10,
b'hghave': 10,
b'largefiles-update': 10,
b'run-tests': 10,
b'corruption': 10,
b'race': 10,
b'i18n': 10,
b'check': 100,
b'gendoc': 100,
b'contrib-perf': 200,
}
perf = {}
def sortkey(f):
# run largest tests first, as they tend to take the longest
f = f['path']
try:
return perf[f]
except KeyError:
try:
val = -os.stat(f).st_size
except OSError as e:
if e.errno != errno.ENOENT:
raise
perf[f] = -1e9 # file does not exist, tell early
return -1e9
for kw, mul in slow.items():
if kw in f:
val *= mul
if f.endswith(b'.py'):
val /= 10.0
perf[f] = val / 1000.0
return perf[f]
testdescs.sort(key=sortkey)
class TestRunner(object): class TestRunner(object):
"""Holds context for executing tests. """Holds context for executing tests.
Tests rely on a lot of state. This object holds it for them. Tests rely on a lot of state. This object holds it for them.
""" """
# Programs required to run tests. # Programs required to run tests.
REQUIREDTOOLS = [ REQUIREDTOOLS = [
statprof.stop() statprof.stop()
statprof.display() statprof.display()
return result return result
finally: finally:
os.umask(oldmask) os.umask(oldmask)
def _run(self, testdescs): def _run(self, testdescs):
if self.options.random: sorttests(testdescs, shuffle=self.options.random)
random.shuffle(testdescs)
else:
# keywords for slow tests
slow = {b'svn': 10,
b'cvs': 10,
b'hghave': 10,
b'largefiles-update': 10,
b'run-tests': 10,
b'corruption': 10,
b'race': 10,
b'i18n': 10,
b'check': 100,
b'gendoc': 100,
b'contrib-perf': 200,
}
perf = {}
def sortkey(f):
# run largest tests first, as they tend to take the longest
f = f['path']
try:
return perf[f]
except KeyError:
try:
val = -os.stat(f).st_size
except OSError as e:
if e.errno != errno.ENOENT:
raise
perf[f] = -1e9 # file does not exist, tell early
return -1e9
for kw, mul in slow.items():
if kw in f:
val *= mul
if f.endswith(b'.py'):
val /= 10.0
perf[f] = val / 1000.0
return perf[f]
testdescs.sort(key=sortkey)
self._testdir = osenvironb[b'TESTDIR'] = getattr( self._testdir = osenvironb[b'TESTDIR'] = getattr(
os, 'getcwdb', os.getcwd)() os, 'getcwdb', os.getcwd)()
# assume all tests in same folder for now # assume all tests in same folder for now
if testdescs: if testdescs:
pathname = os.path.dirname(testdescs[0]['path']) pathname = os.path.dirname(testdescs[0]['path'])
if pathname: if pathname:
osenvironb[b'TESTDIR'] = os.path.join(osenvironb[b'TESTDIR'], osenvironb[b'TESTDIR'] = os.path.join(osenvironb[b'TESTDIR'],