Closed Bug 1360062 Opened 7 years ago Closed 7 years ago

Minimal development environment for Mercurial extensions and hooks

Tracking

(Not tracked)

Status:

RESOLVED FIXED

People

(Reporter: gps, Assigned: gps)

References

Details

Attachments

(9 files)

testing: add a requirement for vcsreplicator (bug 1360062); 7 years ago Gregory Szorc [:gps] 59 bytes, text/x-review-board-request	glob : review+	Details
testing: implement environment for hg extensions and hooks (bug 1360062); 7 years ago Gregory Szorc [:gps] 59 bytes, text/x-review-board-request	glob : review+	Details
testing: port Mercurial installation to Python (bug 1360062); 7 years ago Gregory Szorc [:gps] 59 bytes, text/x-review-board-request	glob : review+	Details
testing: calculate path to mercurials from repo root (bug 1360062); 7 years ago Gregory Szorc [:gps] 59 bytes, text/x-review-board-request	glob : review+	Details
testing: install sitecustomize.py to enable code coverage; 7 years ago Gregory Szorc [:gps] 59 bytes, text/x-review-board-request	glob : review+	Details
testing: upgrade to coverage 4.3.4; 7 years ago Gregory Szorc [:gps] 59 bytes, text/x-review-board-request	glob : review+	Details
testing: enable branch code coverage; 7 years ago Gregory Szorc [:gps] 59 bytes, text/x-review-board-request	glob : review+	Details
testing: generate coverage data files in own directory; 7 years ago Gregory Szorc [:gps] 59 bytes, text/x-review-board-request	glob : review+	Details
pushlog: use grep instead of xpath for test; 7 years ago Gregory Szorc [:gps] 59 bytes, text/x-review-board-request	glob : review+	Details

Gregory Szorc [:gps]

Assignee

Description

•

7 years ago

Building on top of the work I did in bug 1357201, I want to create a minimal environment to facilitate hacking on Mercurial extensions and hooks. This environment will *not* require Docker (at least by default).

Comment hidden (mozreview-request)

We will be introducing a minimal dev environment for running Mercurial
tests. We want it to be able to execute tests in pylib/. However,
pylib/vcsreplicator currently contains a number of tests that
require vcsreplicator. And vcsreplicator has a number of dependencies
that we don't want to introduce to the generic and minimal hg dev
environment. So we want to skip them in this environment.

This commit introduces a new "vcsreplicator" requirement in hghave
to detect the presence of vcsreplicator and adds it to all
vcsreplicator tests. This will cause vcsreplicator tests to be
gracefully skipped in the minimal hg dev environment.

Review commit: https://reviewboard.mozilla.org/r/134200/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/134200/

Comment hidden (mozreview-request)

Now that we have a framework for creating individual virtualenvs
to facilitate specific workflows, let's create one to support hacking
on Mercurial extensions and hooks.

The new environment will pull in all tests for extensions and hooks.
However, some of them are skipped at run time because Docker isn't
available. That's fine. I explicitly don't want the Docker dependency
to creep in by default because that undermines a goal of a pain-free
development environment.

Also included are tests in the pylib/ directory, since there are .t
and .py tests testing various Mercurial functionality. This does
pull in some things that are unwanted (mainly on the .py test side).
However, those tests are nearly instantaneous (~250ms), so I'm not
concerned about it.

On my i7-6700K, `run-tests -j10` yields:

# Ran 113 tests, 67 skipped, 0 warned, 1 failed.
..........................................
----------------------------------------------------------------------
Ran 42 tests in 0.212s

OK

real    0m35.722s
user    2m23.752s
sys     0m22.480s


This seems very reasonable! (The failure is due to a permafail in the
conduit extension and has nothing to do with this test environment.)

Review commit: https://reviewboard.mozilla.org/r/134202/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/134202/

Comment hidden (mozreview-request)

This essentially implements what `create-test-environment` does, just
in Python instead of shell. It allows `run-tests --all-versions` to work
with the hgdev virtualenv.

Since the functionality is redundant with what was in
`create-test-environment`, we add a shim to the Python module so the code
can be invoked standalone and we change `create-test-environment` to
call it. No DRY violation!

Review commit: https://reviewboard.mozilla.org/r/134204/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/134204/

Comment hidden (mozreview-request)

We'll soon introduce another virtualenv that will want to reference
various Mercurial versions. Let's make the path to the mercurial
installs static so it can be shared by multiple environments.

Review commit: https://reviewboard.mozilla.org/r/134210/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/134210/

Comment hidden (mozreview-request)

Comment on attachment 8862249 [details]
testing: implement environment for hg extensions and hooks (bug 1360062);

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134202/diff/1-2/

Comment hidden (mozreview-request)

Comment on attachment 8862250 [details]
testing: port Mercurial installation to Python (bug 1360062);

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134204/diff/1-2/

Comment hidden (mozreview-request)

We currently do this in create-test-environment. This commit carries it
forward to environment.py powered environments.

Review commit: https://reviewboard.mozilla.org/r/134446/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/134446/

Comment hidden (mozreview-request)

We're currently running a relatively ancient version of the coverage
package. Modern versions have a number of compelling improvements, such
as better branch coverage and nicer HTML reports.

As part of the upgrade, we now use the Coverage symbol instead of
the lower case variant, which is now deprecated.

Review commit: https://reviewboard.mozilla.org/r/134448/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/134448/

Comment hidden (mozreview-request)

You have to explicitly tell the coverage module to enable branch
coverage (the default is statement coverage). Branch coverage is
useful. So let's enable it.

Review commit: https://reviewboard.mozilla.org/r/134450/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/134450/

Comment hidden (mozreview-request)

Coverage report files currently exist in the same directory as data
files. This can be a bit confusing and with a new version of coverage
even appears to emit a warning due to attempting to load a report file
as a data file.

This commit moves the coverage data files to their own directory so
they are isolated from non-data.

As part of this, I performed some light refactoring of run-tests.

Review commit: https://reviewboard.mozilla.org/r/134452/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/134452/

Comment hidden (mozreview-request)

Comment on attachment 8862248 [details]
testing: add a requirement for vcsreplicator (bug 1360062);

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134200/diff/1-2/

Comment hidden (mozreview-request)

Comment on attachment 8862262 [details]
testing: calculate path to mercurials from repo root (bug 1360062);

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134210/diff/1-2/

Comment hidden (mozreview-request)

Comment on attachment 8862249 [details]
testing: implement environment for hg extensions and hooks (bug 1360062);

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134202/diff/2-3/

Comment hidden (mozreview-request)

Comment on attachment 8862250 [details]
testing: port Mercurial installation to Python (bug 1360062);

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134204/diff/2-3/

Comment hidden (mozreview-request)

The xmldump.py helper script runs an xpath query and dumps pretty
formatted XML. It is only used by test-pushloghtml.t. Furthermore,
it is the only consumer of the lxml Python package, which takes a
long time to compile and requires some system packages to be present.
It isn't worth the hassle.

We ditch xmldump.py in favor of `grep` and nuke lxml and its
dependencies.

Review commit: https://reviewboard.mozilla.org/r/134466/diff/#index_header
See other reviews: https://reviewboard.mozilla.org/r/134466/

Comment hidden (mozreview-request)

Comment on attachment 8862249 [details]
testing: implement environment for hg extensions and hooks (bug 1360062);

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134202/diff/3-4/

Comment hidden (mozreview-request)

Comment on attachment 8862250 [details]
testing: port Mercurial installation to Python (bug 1360062);

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134204/diff/3-4/

Comment hidden (mozreview-request)

Comment on attachment 8862598 [details]
testing: install sitecustomize.py to enable code coverage;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134446/diff/1-2/

Comment hidden (mozreview-request)

Comment on attachment 8862599 [details]
testing: upgrade to coverage 4.3.4;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134448/diff/1-2/

Comment hidden (mozreview-request)

Comment on attachment 8862600 [details]
testing: enable branch code coverage;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134450/diff/1-2/

Comment hidden (mozreview-request)

Comment on attachment 8862601 [details]
testing: generate coverage data files in own directory;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134452/diff/1-2/

Comment hidden (mozreview-request)

Comment on attachment 8862248 [details]
testing: add a requirement for vcsreplicator (bug 1360062);

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134200/diff/2-3/

Comment hidden (mozreview-request)

Comment on attachment 8862262 [details]
testing: calculate path to mercurials from repo root (bug 1360062);

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134210/diff/2-3/

Comment hidden (mozreview-request)

Comment on attachment 8862620 [details]
pushlog: use grep instead of xpath for test;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134466/diff/1-2/

Comment hidden (mozreview-request)

Comment on attachment 8862249 [details]
testing: implement environment for hg extensions and hooks (bug 1360062);

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134202/diff/4-5/

Comment hidden (mozreview-request)

Comment on attachment 8862250 [details]
testing: port Mercurial installation to Python (bug 1360062);

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134204/diff/4-5/

Comment hidden (mozreview-request)

Comment on attachment 8862598 [details]
testing: install sitecustomize.py to enable code coverage;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134446/diff/2-3/

Comment hidden (mozreview-request)

Comment on attachment 8862599 [details]
testing: upgrade to coverage 4.3.4;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134448/diff/2-3/

Comment hidden (mozreview-request)

Comment on attachment 8862600 [details]
testing: enable branch code coverage;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134450/diff/2-3/

Comment hidden (mozreview-request)

Comment on attachment 8862601 [details]
testing: generate coverage data files in own directory;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134452/diff/2-3/

Comment hidden (mozreview-request)

Comment on attachment 8862248 [details]
testing: add a requirement for vcsreplicator (bug 1360062);

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134200/diff/3-4/

Comment hidden (mozreview-request)

Comment on attachment 8862262 [details]
testing: calculate path to mercurials from repo root (bug 1360062);

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134210/diff/3-4/

Comment hidden (mozreview-request)

Comment on attachment 8862620 [details]
pushlog: use grep instead of xpath for test;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134466/diff/2-3/

Comment hidden (mozreview-request)

Comment on attachment 8862249 [details]
testing: implement environment for hg extensions and hooks (bug 1360062);

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134202/diff/5-6/

Comment hidden (mozreview-request)

Comment on attachment 8862250 [details]
testing: port Mercurial installation to Python (bug 1360062);

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134204/diff/5-6/

:glob ✱

Comment 36

•

7 years ago

mozreview-review

Comment on attachment 8862598 [details]
testing: install sitecustomize.py to enable code coverage;

https://reviewboard.mozilla.org/r/134446/#review139482

::: testing/vcttesting/environment.py:15
(Diff revision 3)
> +SITECUSTOMIZE = b'''
> +import os
> +
> +if os.environ.get('CODE_COVERAGE', False):
> +    import uuid
> +    import coverage
> +
> +    covpath = os.path.join(os.environ['COVERAGE_DIR'],
> +        'coverage.%s' % uuid.uuid1())
> +    cov = coverage.coverage(data_file=covpath, auto_data=True)
> +    cov._warn_no_data = False
> +    cov._warn_unimported_source = False
> +    cov.start()
> +'''

i feel this would make more sense as a separate file which is copied, but this is ok.

Attachment #8862598 - Flags: review?(glob) → review+

:glob ✱

Comment 37

•

7 years ago

mozreview-review

Comment on attachment 8862599 [details]
testing: upgrade to coverage 4.3.4;

https://reviewboard.mozilla.org/r/134448/#review139478

::: test-requirements.txt:35
(Diff revision 3)
> -coverage==3.7.1 \
> -    --hash=sha256:d1aea1c4aa61b8366d6a42dd3650622fbf9c634ed24eaf7f379c8b970e5ed44e
> +coverage==4.3.4 \
> +    --hash=sha256:ca36d83cd591d027952e5019149c4386e7058cd674bf8cb52dc622f768d689e9

i get a hash conflict on coverage:

coverage==4.3.4 from https://pypi.python.org/packages/a7/cd/27e7267c698f8b2c25786a116ad5b26a6e8f6690d5f403bde11aa1919b72/coverage-4.3.4-cp27-cp27m-macosx_10_10_x86_64.whl#md5=ace49d4f27ba75a677bf7fa9152ca932
Expected sha256 ca36d83cd591d027952e5019149c4386e7058cd674bf8cb52dc622f768d689e9
Got        36407249a0b6669c6ad4425b0f29685579df745480c03afa70f101f09f4eead3

::: vcssync/test-requirements.txt:9
(Diff revision 3)
> -coverage==3.7.1 \
> -    --hash=sha256:d1aea1c4aa61b8366d6a42dd3650622fbf9c634ed24eaf7f379c8b970e5ed44e
> +coverage==4.3.4 \
> +    --hash=sha256:ca36d83cd591d027952e5019149c4386e7058cd674bf8cb52dc622f768d689e9

if the hash needs to be fixed, it should be fixed here too :)

Attachment #8862599 - Flags: review?(glob) → review+

:glob ✱

Comment 38

•

7 years ago

mozreview-review

Comment on attachment 8862600 [details]
testing: enable branch code coverage;

https://reviewboard.mozilla.org/r/134450/#review139486

Attachment #8862600 - Flags: review?(glob) → review+

:glob ✱

Comment 39

•

7 years ago

mozreview-review

Comment on attachment 8862601 [details]
testing: generate coverage data files in own directory;

https://reviewboard.mozilla.org/r/134452/#review139488

Attachment #8862601 - Flags: review?(glob) → review+

:glob ✱

Comment 40

•

7 years ago

mozreview-review

Comment on attachment 8862248 [details]
testing: add a requirement for vcsreplicator (bug 1360062);

https://reviewboard.mozilla.org/r/134200/#review139490

Attachment #8862248 - Flags: review?(glob) → review+

:glob ✱

Comment 41

•

7 years ago

mozreview-review

Comment on attachment 8862262 [details]
testing: calculate path to mercurials from repo root (bug 1360062);

https://reviewboard.mozilla.org/r/134210/#review139494

Attachment #8862262 - Flags: review?(glob) → review+

:glob ✱

Comment 42

•

7 years ago

mozreview-review

Comment on attachment 8862620 [details]
pushlog: use grep instead of xpath for test;

https://reviewboard.mozilla.org/r/134466/#review139496

nice

Attachment #8862620 - Flags: review?(glob) → review+

:glob ✱

Comment 43

•

7 years ago

mozreview-review

Comment on attachment 8862249 [details]
testing: implement environment for hg extensions and hooks (bug 1360062);

https://reviewboard.mozilla.org/r/134202/#review139472

::: testing/requirements-hgdev.txt:1
(Diff revision 6)
> +coverage==4.3.4 \
> +    --hash=sha256:ca36d83cd591d027952e5019149c4386e7058cd674bf8cb52dc622f768d689e9

same hash conflict here.

Attachment #8862249 - Flags: review?(glob) → review+

:glob ✱

Comment 44

•

7 years ago

mozreview-review

Comment on attachment 8862250 [details]
testing: port Mercurial installation to Python (bug 1360062);

https://reviewboard.mozilla.org/r/134204/#review139510

Attachment #8862250 - Flags: review?(glob) → review+

Gregory Szorc [:gps]

Assignee

Comment 45

•

7 years ago

mozreview-review-reply

Comment on attachment 8862599 [details]
testing: upgrade to coverage 4.3.4;

https://reviewboard.mozilla.org/r/134448/#review139478

> i get a hash conflict on coverage:
> 
> coverage==4.3.4 from https://pypi.python.org/packages/a7/cd/27e7267c698f8b2c25786a116ad5b26a6e8f6690d5f403bde11aa1919b72/coverage-4.3.4-cp27-cp27m-macosx_10_10_x86_64.whl#md5=ace49d4f27ba75a677bf7fa9152ca932
> Expected sha256 ca36d83cd591d027952e5019149c4386e7058cd674bf8cb52dc622f768d689e9
> Got        36407249a0b6669c6ad4425b0f29685579df745480c03afa70f101f09f4eead3

Ahh, the module contains compiled C extensions. I'll change this to list multiple hashes.

Comment hidden (mozreview-request)

Comment on attachment 8862598 [details]
testing: install sitecustomize.py to enable code coverage;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134446/diff/3-4/

Comment hidden (mozreview-request)

Comment on attachment 8862599 [details]
testing: upgrade to coverage 4.3.4;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134448/diff/3-4/

Comment hidden (mozreview-request)

Comment on attachment 8862600 [details]
testing: enable branch code coverage;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134450/diff/3-4/

Comment hidden (mozreview-request)

Comment on attachment 8862601 [details]
testing: generate coverage data files in own directory;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134452/diff/3-4/

Comment hidden (mozreview-request)

Comment on attachment 8862248 [details]
testing: add a requirement for vcsreplicator (bug 1360062);

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134200/diff/4-5/

Comment hidden (mozreview-request)

Comment on attachment 8862262 [details]
testing: calculate path to mercurials from repo root (bug 1360062);

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134210/diff/4-5/

Comment hidden (mozreview-request)

Comment on attachment 8862620 [details]
pushlog: use grep instead of xpath for test;

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134466/diff/3-4/

Comment hidden (mozreview-request)

Comment on attachment 8862249 [details]
testing: implement environment for hg extensions and hooks (bug 1360062);

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134202/diff/6-7/

Comment hidden (mozreview-request)

Comment on attachment 8862250 [details]
testing: port Mercurial installation to Python (bug 1360062);

Review request updated; see interdiff: https://reviewboard.mozilla.org/r/134204/diff/6-7/

Pulsebot

Comment 55

•

7 years ago

Pushed by gszorc@mozilla.com:
https://hg.mozilla.org/hgcustom/version-control-tools/rev/e04ab9bcabd4
testing: add a requirement for vcsreplicator ; r=glob
https://hg.mozilla.org/hgcustom/version-control-tools/rev/bcbbee294bc9
testing: calculate path to mercurials from repo root ; r=glob
https://hg.mozilla.org/hgcustom/version-control-tools/rev/750f5f2d996f
testing: implement environment for hg extensions and hooks ; r=glob
https://hg.mozilla.org/hgcustom/version-control-tools/rev/ba03aafd87e2
testing: port Mercurial installation to Python ; r=glob

Status: ASSIGNED → RESOLVED

Closed: 7 years ago

Resolution: --- → FIXED

:glob ✱

Comment 56

•

7 years ago

here's the revisions pulsebot missed:

https://hg.mozilla.org/hgcustom/version-control-tools/rev/aa1ccb6080df
https://hg.mozilla.org/hgcustom/version-control-tools/rev/cac0069420dd
https://hg.mozilla.org/hgcustom/version-control-tools/rev/80eccf3ae260
https://hg.mozilla.org/hgcustom/version-control-tools/rev/5db1d92942cc

Gregory Szorc [:gps]

Assignee

Updated

•

7 years ago

Blocks: 1363509

You need to log in before you can comment on or make changes to this bug.