1357201 - Make v-c-t development environment more flexible

Status: RESOLVED FIXED

(Developer Services :: General, task)

Description

[Gregory Szorc [:gps]]

version-control-tools has expanded and now contains functionality for a number of  different projects. Each project has its own specific needs. I no longer think it is appropriate to shoehorn functionality for all of these projects into a single environment.

I will be submitting patches to support multiple "environments" from within v-c-t. My initial goal is to make standalone vcssync development more tolerable (no worries about Docker, etc). But I plan to extend this to other things as well (such as making Mercurial hook development simpler).

Comment 1

[Gregory Szorc [:gps]]

Attachment: run-tests: use hg executable from active virtualenv (bug 1357201);

Currently, we assume the `hg` to use is in venv/bin/hg. Upcoming work
to introduce multiple virtualenvs will introduce multiple potential
hg executables to choose from. This commits changes the logic to use
the hg from the active virtualenv. This is semantically more correct.

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

Comment 2

[Gregory Szorc [:gps]]

Attachment: run-tests: make Docker an optional dependency (bug 1357201);

Currently, run-tests unconditionally imports a module that imports
"docker." Furthermore, it unconditionally invokes various Docker-related
functionality.

As part of future work to split up our monolithic development and test
environment, we may not have access to Docker Python code nor will we
care about Docker in some execution contexts. So refactor run-tests
so the import of vcttesting.docker is optional, --no-docker is implied
if vcttesting.docker doesn't import, and code doesn't try to do
Docker-related things when we're not using Docker.

The conditional invocation of various functions depending on whether
a Docker-related context manager is needed produces less than stellar
code. I'm not a big fan. The alternative is to create a dummy "docker"
object that implements these primitives as no-ops. This would require
a bit of extra work and I didn't feel like putting in the effort for
testing code that rarely changes.

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

Comment 3

[Gregory Szorc [:gps]]

Attachment: testing: make create-virtualenv usable as a standalone script (bug 1357201);

In preparation of introducing multiple virtualenvs, this commit
makes the create-virtualenv script executable and adds a shebang so it
can be used as a standalone script.

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

Comment 4

[Gregory Szorc [:gps]]

Attachment: global: support creating virtualenv for vcssync (bug 1357201);

Since the dawn of the version-control-tools repo we've shoehorned
everything into a single virtualenv. This worked for a while. But
the approach has been showing a number of cracks and has made it
difficult for some more isolated projects to exist in
version-control-tools. In one case (conduit), we created a new
repo partially because v-c-t's dev/test environment was... lacking.

This commit introduces the concept of multiple environments to
version-control-tools. Rather than a monolithic virtualenv, we can
create standalone virtualenvs.

The gateway to creating these environments is the `create-environment`
command. It accepts a name of the environment to create. Currently,
it only accepts "vcssync."

Creation and management of the new environments is implemented in
the vcttesting.environment module. The functionality is very primitive
and is basically some helper functions and inline "recipes." It gets
the job done.

The "vcssync" environment is defined by some pip requirements files,
which were added as part of this commit. There is a
"prod-requirements.txt" file defining the requirements to run vcssync
in production. We simply copy this file from Ansible (we'll remove
the redundancy in a later commit). "test-requirements.txt" defines
what is needed to run it locally. It simply includes
prod-requirements.txt and adds the coverage package (which is required
by run-tests).

A new documentation page has been created to show how all this works.

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

Comment 5

[Gregory Szorc [:gps]]

Attachment: ansible/vcs-sync: use vcssync/prod-requirements.txt (bug 1357201);

vcssync/prod-requirements.txt is a copy of servo-requirements.txt. Since
we don't want the testing and production virtualenvs to diverge, this
commit switches Ansible to use the prod-requirements.txt file directly.

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

Comment 6

[Gregory Szorc [:gps]]

Attachment: testing: detect missing virtualenv differently (bug 1357201);

A consequence of adding new virtualenvs under venv/* is that venv/
may exist before ./create-{deploy,test}-environment is run. This was
throwing off virtualenv presence detection in the existing scripts.

We change the scripts to look for ${VENV}/lib instead. In addition,
a `mkdir` was changed to `mkdir -p` so the command won't fail if the
directory exists.

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

Comment 7

[Gregory Szorc [:gps]]

Attachment: run-tests: detect active virtualenv (bug 1357201);

Upcoming patches will make run-tests behave a bit more intelligently
depending on the current virtualenv. In order to do that, we need
to detect the current virtualenv. This commit adds code to do that.

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

Comment 8

[Gregory Szorc [:gps]]

Attachment: testing: take virtualenv into account when finding tests (bug 1357201);

Now that we can run tests with multiple virtualenvs and not all tests
can be executed with all virtualenvs, we need to declare which tests
are compatible with which virtualenvs. This commit implements that
logic.

Mercurial extension and hooks tests are now marked as only compatible
with the "global" virtualenv. All UNIT_TEST_DIRS are marked as
compatible with the "global" virtualenv except for vcssync/tests,
which requires the "vcssync" virtualenv.

This means if we have the "global" virtualenv activated, we won't be
able to run tests in vcssync/tests. That's fine: we want to decouple
vcssync from the global virtualenv. More importantly, it means that
if we have the "vcssync" virtualenv activated and run `run-tests`
that *only* the vcssync/tests will be executed. This is because no
other test file is discovered when this virtualenv is activated.

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

Comment 9

[Gregory Szorc [:gps]]

Attachment: testing: remove vcssync dependencies from global environment (bug 1357201);

Now that vcssync has its own development environment and vcssync
tests won't run from the "global" environment, having vcssync
dependencies in the "global" environment no longer makes any sense.

So this commit removes them.

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

Comment 10

[Gregory Szorc [:gps]]

FWIW I have other improvements I want to make here. But I figured I should hold off and make sure I get buy-in to the idea before investing any more time in it.

Comment 11

[:glob ✱]

Comment on attachment 8858941 [details]
run-tests: use hg executable from active virtualenv (bug 1357201);

https://reviewboard.mozilla.org/r/130934/#review133592

Comment 12

[:glob ✱]

Comment on attachment 8858942 [details]
run-tests: make Docker an optional dependency (bug 1357201);

https://reviewboard.mozilla.org/r/130936/#review134156

Comment 13

[:glob ✱]

Comment on attachment 8858943 [details]
testing: make create-virtualenv usable as a standalone script (bug 1357201);

https://reviewboard.mozilla.org/r/130938/#review134158

Comment 14

[:glob ✱]

Comment on attachment 8858944 [details]
global: support creating virtualenv for vcssync (bug 1357201);

https://reviewboard.mozilla.org/r/130940/#review134154

::: create-environment:21
(Diff revision 1)
> +)
> +
> +
> +def main():
> +    parser = argparse.ArgumentParser()
> +    parser.add_argument('name', choices=('vcssync'),

this should be choices=['vcssync'].
current code expands to {v,c,s,s,y,n,c}

Comment 15

[:glob ✱]

Comment on attachment 8858945 [details]
ansible/vcs-sync: use vcssync/prod-requirements.txt (bug 1357201);

https://reviewboard.mozilla.org/r/130942/#review134164

Comment 16

[:glob ✱]

Comment on attachment 8858946 [details]
testing: detect missing virtualenv differently (bug 1357201);

https://reviewboard.mozilla.org/r/130944/#review134168

Comment 17

[:glob ✱]

Comment on attachment 8858947 [details]
run-tests: detect active virtualenv (bug 1357201);

https://reviewboard.mozilla.org/r/130946/#review134170

Comment 18

[:glob ✱]

Comment on attachment 8858948 [details]
testing: take virtualenv into account when finding tests (bug 1357201);

https://reviewboard.mozilla.org/r/130948/#review134178

Comment 19

[:glob ✱]

Comment on attachment 8858949 [details]
testing: remove vcssync dependencies from global environment (bug 1357201);

https://reviewboard.mozilla.org/r/130950/#review134180

Comment 20

[Gregory Szorc [:gps]]

Comment on attachment 8858944 [details]
global: support creating virtualenv for vcssync (bug 1357201);

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

Comment 21

[Gregory Szorc [:gps]]

Comment on attachment 8858945 [details]
ansible/vcs-sync: use vcssync/prod-requirements.txt (bug 1357201);

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

Comment 22

[Gregory Szorc [:gps]]

Comment on attachment 8858946 [details]
testing: detect missing virtualenv differently (bug 1357201);

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

Comment 23

[Gregory Szorc [:gps]]

Comment on attachment 8858947 [details]
run-tests: detect active virtualenv (bug 1357201);

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

Comment 24

[Gregory Szorc [:gps]]

Comment on attachment 8858948 [details]
testing: take virtualenv into account when finding tests (bug 1357201);

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

Comment 25

[Gregory Szorc [:gps]]

Comment on attachment 8858949 [details]
testing: remove vcssync dependencies from global environment (bug 1357201);

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

Comment 26

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/hgcustom/version-control-tools/rev/e241282d2a91
run-tests: use hg executable from active virtualenv ; r=glob
https://hg.mozilla.org/hgcustom/version-control-tools/rev/3aec1f71cf88
run-tests: make Docker an optional dependency ; r=glob
https://hg.mozilla.org/hgcustom/version-control-tools/rev/6a634f6578a9
testing: make create-virtualenv usable as a standalone script ; r=glob
https://hg.mozilla.org/hgcustom/version-control-tools/rev/c55c7c8a5fb1
global: support creating virtualenv for vcssync ; r=glob
https://hg.mozilla.org/hgcustom/version-control-tools/rev/154bf339ee75
ansible/vcs-sync: use vcssync/prod-requirements.txt ; r=glob
https://hg.mozilla.org/hgcustom/version-control-tools/rev/d1763b870d1b
testing: detect missing virtualenv differently ; r=glob
https://hg.mozilla.org/hgcustom/version-control-tools/rev/5789eb3357f0
run-tests: detect active virtualenv ; r=glob
https://hg.mozilla.org/hgcustom/version-control-tools/rev/9aa1d39fd32f
testing: take virtualenv into account when finding tests ; r=glob
https://hg.mozilla.org/hgcustom/version-control-tools/rev/27778b64a0ec
testing: remove vcssync dependencies from global environment ; r=glob