zuul/zuul-jobs
Code Issues Proposed changes

Support .python-version files in ensure-python

Browse Source 
We have support for installing python from pyenv, but it currently
requires setting the python version explicitly as an argument. If
the repo in question has a .python-version file, we shouldn't need to
require the user to provide that version a second time. Instead, we can
read from the file for the install step.

Change-Id: Ic4c2d3fc7f55169cec5211010fc3a9622fa324d1
This commit is contained in:
Monty Taylor 2024-06-21 12:26:09 -07:00
parent 5663544e8d
commit 7a58814cda
6 changed files with 114 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
roles/ensure-python/README.rst
View File

@ -15,6 +15,12 @@ There are three ways to install the python interpreter:
**Role Variables**
.. zuul:jobvar:: zuul_work_dir
:default: {{ zuul.project.src_dir }}
The project directory. Serves as the location for version files for
``python_use_pyenv``.
.. zuul:rolevar:: python_version
:type: str
@ -27,7 +33,8 @@ There are three ways to install the python interpreter:
:default: False
Whether to optionally use ``pyenv`` to install python instead of distro
packages.
packages. If this is given without a ``python_version``,
it will look for a ``.python-version`` file in the ``zuul_work_dir``.
.. zuul:rolevar:: python_use_stow
:type: bool

1
roles/ensure-python/defaults/main.yaml
View File

@ -1,3 +1,4 @@
zuul_work_dir: "{{ zuul.project.src_dir }}"
python_use_pyenv: false
python_use_stow: false
python_stow_dir: /usr/local/stow

1
roles/ensure-python/tasks/main.yaml
View File

@ -56,7 +56,6 @@
- name: Install python using pyenv
when:
- python_version is defined
- python_use_pyenv
include_tasks: pyenv.yaml

8
roles/ensure-python/tasks/pyenv.yaml
View File

@ -8,6 +8,12 @@
- "{{ ansible_distribution }}.yaml"
- "{{ ansible_os_family }}.yaml"
- name: Put .python-version contents into variable
when:
- python_version is not defined
set_fact:
python_version: "{{ lookup('ansible.builtin.file', zuul.executor.work_root ~ '/' ~ zuul.project.src_dir ~ '/.python-version') }}"
- name: Install python build depends
become: true
package:
@ -19,7 +25,7 @@
dest: "{{ ansible_user_dir }}/.pyenv"
version: master
# NOTE(mnaser): pyenv does not allow us to let it install Python from a specific
# NOTE(mnaser): python-build does not allow us to let it install Python from a specific
# series so we have to do some magic to find out what's the latest
# release from a series
- name: Determine Python version

18
test-playbooks/ensure-python-pyenv-python-version.yaml Normal file
View File

@ -0,0 +1,18 @@
- hosts: all
tasks:
- name: Create a python-version file with a python version in it
delegate_to: localhost
copy:
content: 3.11
dest: "{{ zuul.executor.work_root }}/{{ zuul.project.src_dir }}/.python-version"
- name: Include ensure-python role
include_role:
name: ensure-python
vars:
python_use_pyenv: true
- name: Check installed version of Python
command: /usr/local/bin/python3 --version
register: _check_version
failed_when: "'Python 3.11' not in _check_version.stdout"

80
zuul-tests.d/python-roles-jobs.yaml
View File

@ -140,6 +140,80 @@
- name: ubuntu-noble
label: ubuntu-noble
- job:
name: zuul-jobs-test-ensure-python-pyenv-python-version
description: Test the ensure-python role with pyenv and a python-version file
files:
- roles/ensure-python/.*
run: test-playbooks/ensure-python-pyenv-python-version.yaml
tags: all-platforms
- job:
name: zuul-jobs-test-ensure-python-pyenv-python-version-centos-9-stream
description: Test the ensure-python role with pyenv and a python-version file
on centos-9-stream
parent: zuul-jobs-test-ensure-python-pyenv-python-version
tags: auto-generated
nodeset:
nodes:
- name: centos-9-stream
label: centos-9-stream
- job:
name: zuul-jobs-test-ensure-python-pyenv-python-version-debian-bookworm
description: Test the ensure-python role with pyenv and a python-version file
on debian-bookworm
parent: zuul-jobs-test-ensure-python-pyenv-python-version
tags: auto-generated
nodeset:
nodes:
- name: debian-bookworm
label: debian-bookworm
- job:
name: zuul-jobs-test-ensure-python-pyenv-python-version-debian-bullseye
description: Test the ensure-python role with pyenv and a python-version file
on debian-bullseye
parent: zuul-jobs-test-ensure-python-pyenv-python-version
tags: auto-generated
nodeset:
nodes:
- name: debian-bullseye
label: debian-bullseye
- job:
name: zuul-jobs-test-ensure-python-pyenv-python-version-ubuntu-focal
description: Test the ensure-python role with pyenv and a python-version file
on ubuntu-focal
parent: zuul-jobs-test-ensure-python-pyenv-python-version
tags: auto-generated
nodeset:
nodes:
- name: ubuntu-focal
label: ubuntu-focal
- job:
name: zuul-jobs-test-ensure-python-pyenv-python-version-ubuntu-jammy
description: Test the ensure-python role with pyenv and a python-version file
on ubuntu-jammy
parent: zuul-jobs-test-ensure-python-pyenv-python-version
tags: auto-generated
nodeset:
nodes:
- name: ubuntu-jammy
label: ubuntu-jammy
- job:
name: zuul-jobs-test-ensure-python-pyenv-python-version-ubuntu-noble
description: Test the ensure-python role with pyenv and a python-version file
on ubuntu-noble
parent: zuul-jobs-test-ensure-python-pyenv-python-version
tags: auto-generated
nodeset:
nodes:
- name: ubuntu-noble
label: ubuntu-noble
- project:
check:
jobs: &id001
@ -155,6 +229,12 @@
- zuul-jobs-test-ensure-python-pyenv-ubuntu-focal
- zuul-jobs-test-ensure-python-pyenv-ubuntu-jammy
- zuul-jobs-test-ensure-python-pyenv-ubuntu-noble
- zuul-jobs-test-ensure-python-pyenv-python-version-centos-9-stream
- zuul-jobs-test-ensure-python-pyenv-python-version-debian-bookworm
- zuul-jobs-test-ensure-python-pyenv-python-version-debian-bullseye
- zuul-jobs-test-ensure-python-pyenv-python-version-ubuntu-focal
- zuul-jobs-test-ensure-python-pyenv-python-version-ubuntu-jammy
- zuul-jobs-test-ensure-python-pyenv-python-version-ubuntu-noble
gate:
jobs: *id001
periodic-weekly: