1353122 - Commit index should have service-level tests and they should run on circleci

Status: RESOLVED INCOMPLETE

(Conduit :: General, enhancement)

Comment 1

[Māris Fogels [:mars] (please needinfo)]

Attachment: commitindex: docker container optimizations (bug 1353122)

Dockerfile fixups:
- Decrease the image size by not caching pip requirements.
- Stop the container from polluting the developer's source tree with root-owned
  *pyc files.
- Switch to "pip install -e" because "setup.py develop" triggers bugs in some
  configurations.

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

Comment 2

[Māris Fogels [:mars] (please needinfo)]

Attachment: commitindex: add a service test harness and test suite (bug 1353122)

Add a new test suite that runs the commitindex service in its own container and
pokes at it with HTTP requests.  These tests are called "service tests".  The
developer can run the entire project test suite, including the new service
tests, by running "invoke servicetest" in the project root.

Service tests live in the new test_service.py module and are marked with the
"@servicetest" decorator.  The unit test suite will skip over the marked tests
unless servicetest-specific command-line flags are given to pytest.

The new service-level test suite is executed by a new container, "servicetest",
that runs beside the "commitindex" container.  The servicetest container runs
the entire test suite, including the specially-marked tests that exercise the
commitindex container.  The servicetest container is also responsible for
restarting the commitindex container between tests, ensuring a clean slate
before each test run.  The servicetest container performs this trickery by
controlling the host's docker service via the host's own docker control socket
(the host's socket is mounted into the servicetest container by
docker-compose).

The whole operation is orchestrated from a new "servicetest" task in tasks.py.
The task inspects the environment created by docker-compose and passes relevant
information to the servicetest container.  The servicetest container uses the
container information to control the test environment.

The service tests are run in their own isolated docker-compose environment.
They have an accompanying docker-compose.servicetest.yml file for configuring
and controlling the servicetest environment. Note that "docker-compose -f
docker-compose.servicetest.yml up" does *not* run the test suite by itself -
instead the tasks.py sets up the environment using a series of
carefully-crafted docker-compose commands.

The new docker-compose environment creates some maintenance overhead because
each update to the commitindex container will require editing two
docker-compose files (one for the dev environment and one for the servicetest
suite). However I don't see this as a problem because we will want to split the
docker-compose configuration anyway, once we have a production-ready container
to run in CI.

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

Comment 3

[David Walsh :davidwalsh]

Comment on attachment 8854140 [details]
commitindex: docker container optimizations (bug 1353122)

https://reviewboard.mozilla.org/r/126114/#review128686

::: commitindex/docker/commitindex/dockerfile-dev:9
(Diff revision 1)
> -RUN pip install -r /requirements.txt
> +RUN pip install --no-cache -r /requirements.txt
>  ADD dev-requirements.txt /dev-requirements.txt
> -RUN pip install -r /dev-requirements.txt
> +RUN pip install --no-cache -r /dev-requirements.txt
> +
> +# Bytecode pollutes the developer's source tree with root-owned *.pyc files.
> +# Set this after pip has finished and before we start to work with the 

Space :)

::: commitindex/tests/test_service.py:1
(Diff revision 1)
> +# This Source Code Form is subject to the terms of the Mozilla Public

Seeing single and double quotes both used; may want to choose one for consistency.

Comment 4

[David Walsh :davidwalsh]

Comment on attachment 8854140 [details]
commitindex: docker container optimizations (bug 1353122)

https://reviewboard.mozilla.org/r/126116/#review128696

::: commitindex/docker/commitindex/dockerfile-dev:9
(Diff revision 1)
> -RUN pip install -r /requirements.txt
> +RUN pip install --no-cache -r /requirements.txt
>  ADD dev-requirements.txt /dev-requirements.txt
> -RUN pip install -r /dev-requirements.txt
> +RUN pip install --no-cache -r /dev-requirements.txt
> +
> +# Bytecode pollutes the developer's source tree with root-owned *.pyc files.
> +# Set this after pip has finished and before we start to work with the 

Whitespace :)

Comment 5

[Māris Fogels [:mars] (please needinfo)]

Attachment: commitindex: add service test for /iterations POST (bug 1353122)

Use POST instead of GET in test_new_iteration_and_topic().

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

Comment 6

[Māris Fogels [:mars] (please needinfo)]

Comment on attachment 8854141 [details]
commitindex: add a service test harness and test suite (bug 1353122)

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

Comment 7

[Māris Fogels [:mars] (please needinfo)]

Comment on attachment 8854140 [details]
commitindex: docker container optimizations (bug 1353122)

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

Comment 8

[Māris Fogels [:mars] (please needinfo)]

Comment on attachment 8854141 [details]
commitindex: add a service test harness and test suite (bug 1353122)

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

Comment 9

[Māris Fogels [:mars] (please needinfo)]

Comment on attachment 8854211 [details]
commitindex: add service test for /iterations POST (bug 1353122)

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

Comment 10

[Māris Fogels [:mars] (please needinfo)]

Attachment: conduitdemo: tidy up bmo container tree (bug 1353122)

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

Comment 11

[Israel Madueme [:imadueme]]

Outdated, no longer needed - there is no commitindex yet in the new commit pipeline architecture.