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: Ia91227b411a07424325be1d3362d4ce79c1430a5
Implements: blueprint python-build-install-simplification
Signed-off-by: Jesse Pretorius <jesse.pretorius@rackspace.co.uk>

defaults/main.yml

@@ -64,8 +64,19 @@ horizon_developer_constraints:
   - "git+{{ trove_dashboard_git_repo }}@{{ trove_dashboard_git_install_branch }}#egg=trove_dashboard"
   - "git+{{ heat_dashboard_git_repo }}@{{ heat_dashboard_git_install_branch }}#egg=heat_dashboard"
 
+# 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.
+horizon_pip_install_args: >-
+  {{ horizon_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
-horizon_venv_tag: untagged
+horizon_venv_tag: "{{ venv_tag | default('untagged') }}"
 horizon_bin: "{{ _horizon_bin }}"
 
 # venv_download, even when true, will use the fallback method of building the

handlers/main.yml

@@ -19,3 +19,5 @@
     enabled: yes
     state: "restarted"
     daemon_reload: "{{ (ansible_service_mgr == 'systemd') | ternary('yes', omit) }}"
+  listen:
+    - "venv changed"

tasks/horizon_install_source.yml

@@ -37,6 +37,12 @@
     - { src: "/var/log/httpd", dest: "/var/log/apache2" }
   when: ansible_pkg_mgr in ['yum', 'dnf']
 
+# 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"
@@ -46,106 +52,26 @@
       {% endfor %}
   when: horizon_developer_mode | bool
 
-- name: Retrieve checksum for venv download
-  uri:
-    url: "{{ horizon_venv_download_url | replace('tgz', 'checksum') }}"
-    return_content: yes
-  register: horizon_venv_checksum
-  when: horizon_venv_download | bool
-
-- name: Attempt venv download
-  get_url:
-    url: "{{ horizon_venv_download_url }}"
-    dest: "/var/cache/{{ horizon_venv_download_url | basename }}"
-    checksum: "sha1:{{ horizon_venv_checksum.content | trim }}"
-  register: horizon_get_venv
-  retries: 5
-  delay: 5
-  until: horizon_get_venv is succeeded
-  when: horizon_venv_download | bool
-
-- name: Remove existing venv
-  file:
-    path: "{{ horizon_bin | dirname }}"
-    state: absent
-  when: horizon_get_venv is changed
-
-- name: Create horizon venv dir
-  file:
-    path: "{{ horizon_bin | dirname }}"
-    state: directory
-    mode: "0755"
-  register: horizon_venv_dir
-  when: horizon_get_venv is changed
-
-- name: Unarchive pre-built venv
-  unarchive:
-    src: "/var/cache/{{ horizon_venv_download_url | basename }}"
-    dest: "{{ horizon_bin | dirname }}"
-    copy: "no"
-  when: horizon_get_venv is changed
-  notify: Restart apache2
-
-- name: Install pip packages
-  pip:
-    name: "{{ horizon_pip_packages }}"
-    state: "{{ horizon_pip_package_state }}"
-    virtualenv: "{{ horizon_bin | dirname }}"
-    virtualenv_site_packages: "no"
-    extra_args: >-
-      {{ horizon_developer_mode | ternary('--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|success
-  retries: 5
-  delay: 2
-  when: horizon_get_venv is failed or horizon_get_venv is skipped
-  notify: Restart apache2
-
-- name: Install optional pip packages
-  pip:
-    name: "{{ horizon_optional_pip_packages }}"
-    state: "{{ horizon_pip_package_state }}"
-    virtualenv: "{{ horizon_bin | dirname }}"
-    virtualenv_site_packages: "no"
-    extra_args: >-
-      {{ horizon_developer_mode | ternary('--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|success
-  retries: 5
-  delay: 2
-  when: horizon_optional_pip_packages | length > 0
-
-- name: Remove python from path first (CentOS, openSUSE)
-  file:
-    path:  "{{ horizon_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']
-    - horizon_get_venv is changed
+    - horizon_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 {{ horizon_bin }} -name \*.pyc -delete
-    sed -si '1s/^.*python.*$/#!{{ horizon_bin | replace ('/','\/') }}\/python/' {{ horizon_bin }}/*
-    virtualenv {{ horizon_bin | dirname }} \
-        {{ (ansible_pkg_mgr == 'apt') | ternary('--always-copy', '') }} \
-        --no-pip \
-        --no-setuptools \
-        --no-wheel
-  when: horizon_get_venv is changed
-  tags:
-    - skip_ansible_lint
+- name: Install the python venv
+  include_role:
+    name: "python_venv_build"
+    private: yes
+  vars:
+    venv_build_distro_package_list: "{{ horizon_devel_distro_packages }}"
+    venv_install_destination_path: "{{ horizon_bin | dirname }}"
+    venv_install_distro_package_list: "{{ horizon_distro_packages }}"
+    venv_pip_install_args: "{{ horizon_pip_install_args }}"
+    venv_pip_packages: "{{ horizon_pip_packages + horizon_optional_pip_packages }}"
+    venv_facts_when_changed:
+      - section: "horizon"
+        option: "venv_tag"
+        value: "{{ horizon_venv_tag }}"
 
 - name: Create horizon link for venv
   file:
@@ -166,10 +92,3 @@
     - { path: "{{ horizon_lib_dir }}/openstack_dashboard", mode: "2755" }
     - { path: "{{ horizon_lib_dir }}/openstack_dashboard/local", mode: "2755" }
     - { path: "{{ horizon_lib_dir }}/openstack_dashboard/local/enabled", mode: "2755" }
-
-- name: Record the venv tag deployed
-  ini_file:
-    dest: "/etc/ansible/facts.d/openstack_ansible.fact"
-    section: horizon
-    option: venv_tag
-    value: "{{ horizon_venv_tag }}"