diff options
| author | Jeremy Stanley <fungi@yuggoth.org> | 2022-08-05 21:00:02 +0000 |
|---|---|---|
| committer | Jeremy Stanley <fungi@yuggoth.org> | 2022-08-05 21:00:02 +0000 |
| commit | 90d7dcb1ed66f9685b74cd68383c21c2203d4037 (patch) | |
| tree | 77895c73931edb5099a5fef592f6cc5cf11a287c /TESTING.rst | |
| parent | 68684d519e9f906afd899a37f9e3da92b61f914d (diff) | |
| download | zuul-90d7dcb1ed66f9685b74cd68383c21c2203d4037.tar.gz | |
Update unit test container setup and instructions
Update the TESTING.rst file to reflect that just installing and
starting zookeeperd is no longer sufficient now that we require TLS
and auth for the connection, as well as running database servers.
Suggest the container-based setup script instead. Also improve that
script to allow it to be invoked as a normal user, with root command
escalation tool choice (e.g. "sudo") supplied through a ROOTCMD
environment variable, so that things created inside the git worktree
like the CA don't end up root-owned.
Related, the tox-docker plugin previously suggested in the document
is no longer a viable option for the same reasons, so clean up the
plumbing for it in tox.ini as well.
Change-Id: Iac32799425a5bd4b1bdbf56f34a2310241ac4499
Diffstat (limited to 'TESTING.rst')
| -rw-r--r-- | TESTING.rst | 32 |
1 files changed, 14 insertions, 18 deletions
diff --git a/TESTING.rst b/TESTING.rst index 6c4c8c0d8..fe9af66f6 100644 --- a/TESTING.rst +++ b/TESTING.rst @@ -1,34 +1,30 @@ -=========================== -Testing Your OpenStack Code -=========================== +============ +Testing Zuul +============ ------------ A Quickstart ------------ -This is designed to be enough information for you to run your first tests. -Detailed information on testing can be found here: https://wiki.openstack.org/wiki/Testing +This is designed to be enough information for you to run your first tests on +an Ubuntu 20.04 (or later) host. *Install pip*:: - [apt-get | yum] install python-pip + sudo apt-get install python3-pip More information on pip here: http://www.pip-installer.org/en/latest/ -*Use pip to install tox and tox-docker*:: +*Use pip to install tox*:: - pip install tox tox-docker + pip install tox -As of zuul v3, a running zookeeper is required to execute tests. Using the -``-docker`` suffixed commands will ensure this is started automatically by tox, -but if you do not wish to use this: +A running zookeeper is required to execute tests, but it also needs to be +configured for TLS and a certificate authority set up to handle socket +authentication. Because of these complexities, it's recommended to use a +helper script to set up these dependencies, as well as a database servers:: -*Install zookeeper*:: - - [apt-get | yum] install zookeeperd - -*Start zookeeper*:: - - service zookeeper start + sudo apt-get install docker-compose # or podman-compose if preferred + ROOTCMD=sudo tools/test-setup-docker.sh .. note:: Installing and bulding javascript is not required, but tests that depend on the javascript assets having been built will be skipped |