From 352c577db23bc1c22d6573937ceb6eebe5665cc6 Mon Sep 17 00:00:00 2001
From: Matt Thompson <mattt@defunct.ca>
Date: Mon, 25 Jan 2016 11:39:57 +0000
Subject: [PATCH] Re-deploy the Cinder venv if it mismatches the repo

We currently have two issues with venvs:

- if you update your venv on the repo server, it is not possible for
  that updated venv to land on the service's container as the get_url
  task always skips if the file exists (even if the file is different)
- if you have an updated venv on the repo server and forcefully delete
  the cached venv tarball on the service's container, the new tarball
  will get unarchived over top of the existing venv

This commit does the following:

- gets the checksum of the /var/cache tarball and downloads checksum
  file from repo server
- updates "Attempt venv download" to only download the venv if the
  cache doesn't exist or if the local and remote checksums differ
- adds a "force: true" to "Attempt venv download" task so that the venv
  tarball will get re-downloaded when the when condition is true (this
  is necessary otherwise the download will get skipped since the
  destination already exists)
- adds a new task "Remove existing venv" so we can first remove the
  venv before we unarchive the potentially new venv from the repo
  server
- updates "Create cinder venv dir" and "Unarchive pre-built venv"
  tasks to only proceed if "cinder_get_venv | changed", which
  prevents these tasks from running when they the venv tarball hasn't
  changed
- adds multiple service restarts to
  os_cinder/tasks/cinder_install.yml so that cinder will restart
  correctly should the venv/packages update without any associated
  config changes

NOTE: The reason why we compare local and remote checksum is to avoid
      unnecessarily downloading the venv when the checksums are in fact
      the same.  On small deploys this is more or less a non-issue but
      if a deploy w/ thousands of compute nodes re-runs playbooks we
      want to limit the venv downloads when it's unnecessary.

Change-Id: I41624b27fa6b94b7174746d591d5c646dd118706
---
 defaults/main.yml        |  1 +
 tasks/cinder_install.yml | 49 +++++++++++++++++++++++++++++++++++++---
 2 files changed, 47 insertions(+), 3 deletions(-)

diff --git a/defaults/main.yml b/defaults/main.yml
index dbb5acc1..e6da8560 100644
--- a/defaults/main.yml
+++ b/defaults/main.yml
@@ -232,6 +232,7 @@ cinder_requires_pip_packages:
   - virtualenv
   - virtualenv-tools
   - python-keystoneclient # Keystoneclient needed to OSA keystone lib
+  - httplib2
 
 # Common pip packages
 cinder_pip_packages:
diff --git a/tasks/cinder_install.yml b/tasks/cinder_install.yml
index fb6c49dd..fb7c4849 100644
--- a/tasks/cinder_install.yml
+++ b/tasks/cinder_install.yml
@@ -52,13 +52,42 @@
     - cinder-install
     - cinder-pip-packages
 
+- name: Get local venv checksum
+  stat:
+    path: "/var/cache/{{ cinder_venv_download_url | basename }}"
+    get_md5: False
+  when: cinder_venv_enabled | bool
+  register: local_venv_stat
+  tags:
+    - cinder-install
+    - cinder-pip-packages
+
+- name: Get remote venv checksum
+  uri:
+    url: "{{ cinder_venv_download_url | replace('tgz', 'checksum') }}"
+    return_content: True
+  when: cinder_venv_enabled | bool
+  register: remote_venv_checksum
+  tags:
+    - cinder-install
+    - cinder-pip-packages
+
+# TODO: When project moves to ansible 2 we can pass this a sha256sum which will:
+#       a) allow us to remove force: yes
+#       b) allow the module to calculate the checksum of dest file which would
+#          result in file being downloaded only if provided and dest sha256sum
+#          checksums differ
 - name: Attempt venv download
   get_url:
     url: "{{ cinder_venv_download_url }}"
     dest: "/var/cache/{{ cinder_venv_download_url | basename }}"
+    force: yes
   ignore_errors: true
   register: get_venv
-  when: cinder_venv_enabled | bool
+  when:
+    - cinder_venv_enabled | bool
+    - (local_venv_stat.stat.exists == False or
+        {{ local_venv_stat.stat.checksum is defined and local_venv_stat.stat.checksum != remote_venv_checksum.content | trim }})
   tags:
     - cinder-install
     - cinder-pip-packages
@@ -71,13 +100,24 @@
     - cinder-install
     - cinder-pip-packages
 
+- name: Remove existing venv
+  file:
+    path: "{{ cinder_venv_bin | dirname }}"
+    state: absent
+  when:
+    - cinder_venv_enabled | bool
+    - cinder_get_venv | changed
+  tags:
+    - cinder-install
+    - cinder-pip-packages
+
 - name: Create cinder venv dir
   file:
     path: "{{ cinder_venv_bin | dirname }}"
     state: directory
   when:
     - cinder_venv_enabled | bool
-    - cinder_get_venv | success
+    - cinder_get_venv | changed
   tags:
     - cinder-install
     - cinder-pip-packages
@@ -89,7 +129,8 @@
     copy: "no"
   when:
     - cinder_venv_enabled | bool
-    - cinder_get_venv | success
+    - cinder_get_venv | changed
+  notify: Restart cinder services
   tags:
     - cinder-install
     - cinder-pip-packages
@@ -120,6 +161,7 @@
   when:
     - cinder_venv_enabled | bool
     - cinder_get_venv | failed
+  notify: Restart cinder services
   tags:
     - cinder-install
     - cinder-pip-packages
@@ -136,6 +178,7 @@
   with_items:
     - "{{ cinder_pip_packages }}"
   when: not cinder_venv_enabled | bool
+  notify: Restart cinder services
   tags:
     - cinder-install
     - cinder-pip-packages