Use a common python build/install role

In order to radically simplify how we prepare the service
venvs, we use a common role to do the wheel builds and the
venv preparation. This makes the process far simpler to
understand, because the role does its own building and
installing. It also reduces the code maintenance burden,
because instead of duplicating the build processes in the
repo_build role and the service role - we only have it all
done in a single place.

We also change the role venv tag var to use the integrated
build's common venv tag so that we can remove the role's
venv tag in group_vars in the integrated build. This reduces
memory consumption and also reduces the duplication.

This is by no means the final stop in the simplification
process, but it is a step forward. The will be work to follow
which:

1. Replaces 'developer mode' with an equivalent mechanism
   that uses the common role and is simpler to understand.
   We will also simplify the provisioning of pip install
   arguments when doing this.
2. Simplifies the installation of optional pip packages.
   Right now it's more complicated than it needs to be due
   to us needing to keep the py_pkgs plugin working in the
   integrated build.
3. Deduplicates the distro package installs. Right now the
   role installs the distro packages twice - just before
   building the venv, and during the python_venv_build role
   execution.

Depends-On: https://review.openstack.org/598957
Change-Id: I18cc964196dbbf5019bc116c41861cb39e466e14
Implements: blueprint python-build-install-simplification
Signed-off-by: Jesse Pretorius <jesse.pretorius@rackspace.co.uk>

defaults/main.yml

@@ -35,8 +35,19 @@ glance_developer_mode: false
 glance_developer_constraints:
   - "git+{{ glance_git_repo }}@{{ glance_git_install_branch }}#egg=glance"
 
+# TODO(odyssey4me):
+# This can be simplified once all the roles are using
+# python_venv_build. We can then switch to using a
+# set of constraints in pip.conf inside the venv,
+# perhaps prepared by giving a giving a list of
+# constraints to the role.
+glance_pip_install_args: >-
+  {{ glance_developer_mode | ternary(pip_install_developer_constraints | default('--constraint /opt/developer-pip-constraints.txt'), '') }}
+  {{ (pip_install_upper_constraints is defined) | ternary('--constraint ' + pip_install_upper_constraints | default(''), '') }}
+  {{ pip_install_options | default('') }}
+
 # Name of the virtual env to deploy into
-glance_venv_tag: untagged
+glance_venv_tag: "{{ venv_tag | default('untagged') }}"
 glance_bin: "{{ _glance_bin }}"
 
 # Set the etc dir path where glance is installed.

handlers/main.yml

@@ -24,7 +24,9 @@
   until: _stop is success
   retries: 5
   delay: 2
-  listen: "Restart glance services"
+  listen:
+    - "Restart glance services"
+    - "venv changed"
 
 # TODO(odyssey4me):
 # Assuming glance-registry is removed in the S cycle as planned, this
@@ -52,7 +54,9 @@
   register: _remove_glance_service
   changed_when: _remove_glance_service.rc == 2
   failed_when: _remove_glance_service.rc not in [0, 2]
-  listen: "Restart glance services"
+  listen:
+    - "Restart glance services"
+    - "venv changed"
   # This task causes ansible-lint to give a ANSIBLE0014
   # error, which does not make much sense given how the
   # environment variable is used in this case.
@@ -74,7 +78,9 @@
     - "/etc/systemd/system/{{ glance_services['glance-registry']['service_name'] }}.service"
   when:
     - not glance_services['glance-registry']['condition']
-  listen: "Restart glance services"
+  listen:
+    - "Restart glance services"
+    - "venv changed"
 
 # Note (odyssey4me):
 # The policy.json file is currently read continually by the services
@@ -92,7 +98,9 @@
     group: "{{ glance_system_group_name }}"
     mode: "0640"
     remote_src: yes
-  listen: "Restart glance services"
+  listen:
+    - "Restart glance services"
+    - "venv changed"
 
 - name: Start services
   service:
@@ -105,7 +113,9 @@
   until: _start is success
   retries: 5
   delay: 2
-  listen: "Restart glance services"
+  listen:
+    - "Restart glance services"
+    - "venv changed"
 
 - meta: noop
   listen: Manage LB

tasks/glance_install_source.yml

@@ -13,6 +13,12 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+# TODO(odyssey4me):
+# This can be simplified once all the roles are using
+# python_venv_build. We can then switch to using a
+# set of constraints in pip.conf inside the venv,
+# perhaps prepared by giving a giving a list of
+# constraints to the role.
 - name: Create developer mode constraint file
   copy:
     dest: "/opt/developer-pip-constraints.txt"
@@ -22,119 +28,26 @@
       {% endfor %}
   when: glance_developer_mode | bool
 
-- name: Retrieve checksum for venv download
-  uri:
-    url: "{{ glance_venv_download_url | replace('tgz', 'checksum') }}"
-    return_content: yes
-  register: glance_venv_checksum
-  when: glance_venv_download | bool
-
-- name: Attempt venv download
-  get_url:
-    url: "{{ glance_venv_download_url }}"
-    dest: "/var/cache/{{ glance_venv_download_url | basename }}"
-    checksum: "sha1:{{ glance_venv_checksum.content | trim }}"
-  register: glance_get_venv
-  when: glance_venv_download | bool
-
-- name: Remove existing venv
-  file:
-    path: "{{ glance_bin | dirname }}"
-    state: absent
-  when: glance_get_venv  is changed
-
-- name: Create glance venv dir
-  file:
-    path: "{{ glance_bin | dirname }}"
-    state: directory
-  register: glance_venv_dir
-  when: glance_get_venv  is changed
-
-- name: Unarchive pre-built venv
-  unarchive:
-    src: "/var/cache/{{ glance_venv_download_url | basename }}"
-    dest: "{{ glance_bin | dirname }}"
-    copy: "no"
-  when: glance_get_venv  is changed
-  notify:
-    - Manage LB
-    - Restart glance services
-
-- name: Install pip packages
-  pip:
-    name: "{{ glance_pip_packages }}"
-    state: "{{ glance_pip_package_state }}"
-    virtualenv: "{{ glance_bin | dirname }}"
-    virtualenv_site_packages: "no"
-    extra_args: >-
-      {{ glance_developer_mode | ternary(pip_install_developer_constraints | default('--constraint /opt/developer-pip-constraints.txt'), '') }}
-      {{ (pip_install_upper_constraints is defined) | ternary('--constraint ' + pip_install_upper_constraints | default(''),'') }}
-      {{ pip_install_options | default('') }}
-  register: install_packages
-  until: install_packages is success
-  retries: 5
-  delay: 2
-  when: glance_get_venv | failed or glance_get_venv | skipped
-  notify:
-    - Manage LB
-    - Restart glance services
-
-- name: Remove python from path first (CentOS, openSUSE)
-  file:
-    path:  "{{ glance_bin | dirname }}/bin/python2.7"
-    state: "absent"
+- name: Ensure remote wheel building is disabled in developer mode
+  set_fact:
+    venv_build_host: "{{ ansible_hostname }}"
   when:
-    - ansible_pkg_mgr in ['yum', 'dnf', 'zypper']
-    - glance_get_venv  is changed
+    - glance_developer_mode | bool
 
-# NOTE(odyssey4me):
-# We reinitialize the venv to ensure that the right
-# version of python is in the venv, but we do not
-# want virtualenv to also replace pip, setuptools
-# and wheel so we tell it not to.
-# We do not use --always-copy for CentOS/SuSE due
-# to https://github.com/pypa/virtualenv/issues/565
-- name: Update virtualenv path
-  shell: |
-    find {{ glance_bin }} -name \*.pyc -delete
-    sed -si '1s/^.*python.*$/#!{{ glance_bin | replace ('/','\/') }}\/python/' {{ glance_bin }}/*
-    virtualenv {{ glance_bin | dirname }} \
-        {{ (ansible_pkg_mgr == 'apt') | ternary('--always-copy', '') }} \
-        --no-pip \
-        --no-setuptools \
-        --no-wheel
-  when: glance_get_venv  is changed
-  tags:
-    - skip_ansible_lint
-
-- name: Install optional pip packages
-  pip:
-    name: "{{ glance_optional_oslomsg_amqp1_pip_packages }}"
-    state: "{{ glance_pip_package_state }}"
-    virtualenv: "{{ glance_bin | dirname }}"
-    virtualenv_site_packages: "no"
-  when: glance_oslomsg_amqp1_enabled
-  register: install_optional_packages
-  until: install_optional_packages is success
-  retries: 5
-  delay: 2
-  notify:
-    - Manage LB
-    - Restart glance services
-
-- name: Record the need for a service restart
-  ini_file:
-    dest: "/etc/ansible/facts.d/openstack_ansible.fact"
-    section: "glance"
-    option: "need_service_restart"
-    value: true
-  when: (glance_get_venv | changed) or
-        (glance_venv_dir | changed) or
-        ('need_service_restart' not in ansible_local['openstack_ansible']['glance'])
-
-- name: Record the venv tag deployed
-  ini_file:
-    dest: "/etc/ansible/facts.d/openstack_ansible.fact"
-    section: glance
-    option: venv_tag
-    value: "{{ glance_venv_tag }}"
+- name: Install the python venv
+  include_role:
+    name: "python_venv_build"
+    private: yes
+  vars:
+    venv_build_distro_package_list: "{{ glance_devel_distro_packages }}"
+    venv_install_destination_path: "{{ glance_bin | dirname }}"
+    venv_install_distro_package_list: "{{ glance_distro_packages }}"
+    venv_pip_install_args: "{{ glance_pip_install_args }}"
+    venv_pip_packages: "{{ (glance_oslomsg_amqp1_enabled | bool) | ternary(glance_pip_packages + glance_optional_oslomsg_amqp1_pip_packages, glance_pip_packages) }}"
+    venv_facts_when_changed:
+      - section: "glance"
+        option: "need_service_restart"
+        value: True
+      - section: "glance"
+        option: "venv_tag"
+        value: "{{ glance_venv_tag }}"