Allow ensure-tox to upgrade tox version

Adds new variable `tox_upgrade: false` which can be used to change
behavior of ensure-tox role. By default old bahaviour is maintained.

This fixes failure to run "Run tox without tests" on some platform which
already have an ancient version (like 1.6) on the system. Users
encountering this can easily set tox_upgrade to true.

Such old versions of tox are not able to upgrade itself and not even
able to parse the tox.ini file.

The only way to avoid this is to assure that the system has a recent
enough version of tox.

Tox ability to boostrap itself was added only in 3.8.0 which is
not present in most distributions.

This change also switches the default tox executable to use python
module calling method in order to avoid calling /usr/bin/tox file
which could be broken after the upgrade.

Change-Id: I27950691a815bbb458952b585084f2fa1158661f
Needed-By: https://review.rdoproject.org/r/#/c/21594/
This commit is contained in:
Sorin Sbarnea 2019-07-25 16:38:50 +01:00
parent 6e865fa04a
commit 4f2975f210
6 changed files with 74 additions and 5 deletions

View File

@ -2,3 +2,22 @@ Ensure tox is installed
If tox is not already installed, it will be installed via pip in the
user install directory (i.e., "pip install --user").
**Role Variables**
.. zuul:rolevar:: tox_upgrade
:default: false
If you want the installation of latest tox, regardless presence on the
system, define `tox_upgrade: true`.
.. zuul:rolevar:: tox_condition
:default: tox
Python requirements condition to be used when installing tox. You can define
it to "tox>=3.8.0" to force a minimal version.
.. zuul:rolevar:: tox_executable
:default: {{ ansible_python.executable }} -m tox
Location of the tox executable.

View File

@ -0,0 +1,7 @@
# when set, it will always install latest version of tox using --user
# be aware that this may break /usr/bin/tox executable due to changed internals
tox_upgrade: false
tox_condition: tox
tox_environment:
PIP_DISABLE_PIP_VERSION_CHECK: "1"
PIP_NO_WARN_SCRIPT_LOCATION: "1"

View File

@ -1,2 +1,43 @@
- name: Ensure tox is installed
shell: type tox || pip install --user tox
- name: Check if tox is accesible # noqa 305
environment: "{{ tox_environment }}"
shell: |
set -eux
tox --version
{{ ansible_python.executable }} -m tox --version
register: result
failed_when: result.rc != 0 and 'not found' not in result.stderr
changed_when: false
# installing tox with --user will create tox script inside ~/.local/bin but
# this folder is *not* included PATH in all distros. While most modern ones
# adopted it, there is no guarantee.
- name: Ensure tox is installed # noqa 305
shell: |
set -eu
# {# for systems that do not have ~/.local/bin in PATH yet #}
# if [[ ":$PATH:" != *":${HOME}/.local/bin:"* ]] && [ -d "${HOME}/.local/bin" ]; then
# export PATH=${HOME}/.local/bin:$PATH
# fi
{% if result is failed or tox_upgrade %}
{{ ansible_python.executable }} -m pip install --user --upgrade '{{ tox_condition }}'
{% else %}
{{ ansible_python.executable }} -m pip install --user '{{ tox_condition }}'
{% endif %}
{{ ansible_python.executable }} -m tox --version
args:
executable: /bin/bash
# We want to be sure that if someone calls 'tox' without having `~/.local/bin`
# in PATH, they still get a *working* copy of it.
- name: Ensure a system tox is also available
become: true
environment: "{{ tox_environment }}"
shell: |
set -eu
type tox >/dev/null || {
{# -s is key here to prevent it from finding tox from userdir #}
{{ ansible_python.executable }} -s -m pip install '{{ tox_condition }}'
}
tox --version
args:
executable: /bin/bash

View File

@ -2,6 +2,6 @@
# TODO(mordred) This needs to switch back to not being venv - venv is OpenStack
# specific.
tox_envlist: venv
tox_executable: tox
tox_executable: "{{ ansible_python.executable }} -m tox"
zuul_work_dir: "{{ zuul.project.src_dir }}"

View File

@ -12,7 +12,7 @@ Runs tox for a project
Which tox environment to run.
.. zuul:rolevar:: tox_executable
:default: tox
:default: {{ ansible_python.executable }} -m tox
Location of the tox executable.

View File

@ -1,7 +1,9 @@
---
tox_environment: {}
tox_envlist: venv
tox_executable: tox
# Calling tox as a module in order to avoid case where tox script gets broken
# because user installed newer version of tox into user packages.
tox_executable: "{{ ansible_python.executable }} -m tox"
tox_extra_args: -vv
tox_install_siblings: true