Move checks to pre-deployment stage

Some checks, such as the SSH password, SR type and hotfixes
installed could be moved to a pre-deployment stage. If we move
them there, then failures should occur earlier in the process
rather than waiting to the end of the deployment.

Change-Id: I831e79fdc1132fc938141a20837ee345fe276020

branding.inc

@@ -2,4 +2,4 @@ HYPERVISOR_NAME=XenServer
 HYPERVISOR_LOWER=xenserver
 PLUGIN_NAME=fuel-plugin-xenserver
 PLUGIN_VERSION=3.91
-PLUGIN_REVISION=2
+PLUGIN_REVISION=3

plugin_source/deployment_scripts/compute_post_deployment.py

@@ -89,30 +89,6 @@ def scp(host, username, target_path, filename):
                    '%s@%s:%s' % (username, host, target_path))
 
 
-def ssh_copy_id(host, username, password):
-    ssh_askpass = "askpass.sh"
-
-    s = ('#!/bin/sh\n'
-         'echo "{password}"').format(password=password)
-    with open(ssh_askpass, 'w') as f:
-        f.write(s)
-    os.chmod(ssh_askpass, stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH)
-
-    if os.path.exists(XS_RSA):
-        os.remove(XS_RSA)
-    if os.path.exists(XS_RSA + ".pub"):
-        os.remove(XS_RSA + ".pub")
-    execute('ssh-keygen', '-f', XS_RSA, '-t', 'rsa', '-N', '')
-
-    env = {
-        "HOME": "/root",
-        "SSH_ASKPASS": os.path.abspath(ssh_askpass),
-        "DISPLAY": ":.",
-    }
-    execute("setsid", "ssh-copy-id", "-o", "StrictHostKeyChecking=no",
-            "-i", XS_RSA, "%s@%s" % (username, host), env=env)
-
-
 def get_astute(astute_path):
     """Return the root object read from astute.yaml"""
     if not os.path.exists(astute_path):
@@ -209,28 +185,6 @@ def init_eth():
     reportError('HIMN failed to get IP address from Hypervisor')
 
 
-def check_host_compatibility(himn, username):
-    hotfix = 'XS65ESP1013'
-    installed = ssh(himn, username,
-                    'xe patch-list name-label=%s --minimal' % hotfix)
-    ver = ssh(himn, username,
-              ('xe host-param-get uuid=$(xe host-list --minimal) '
-               'param-name=software-version param-key=platform_version'))
-
-    if not installed and ver[:3] == PLATFORM_VERSION:
-        reportError(('Hotfix %s has not been installed '
-                     'and product version is %s') % (hotfix, ver))
-
-
-def check_local_sr(himn, username):
-    sr_type = ssh(himn, username,
-                  ('xe sr-param-get param-name=type uuid=`xe pool-list params=default-SR --minimal`'))
-
-    if sr_type != "ext" and sr_type != "nfs":
-        reportError(('Default SR type should be EXT or NFS.  If using local storage, Please make sure thin'
-                     ' provisioning is enabled on your host during installation.'))
-
-
 def install_xenapi_sdk():
     """Install XenAPI Python SDK"""
     execute('cp', 'XenAPI.py', DIST_PACKAGES_DIR)
@@ -501,9 +455,6 @@ if __name__ == '__main__':
             astute, ('public_ssl', 'services'))
 
         if username and password and endpoints and himn_local:
-            ssh_copy_id(HIMN_IP, username, password)
-            check_host_compatibility(HIMN_IP, username)
-            check_local_sr(HIMN_IP, username)
             route_to_compute(endpoints, HIMN_IP, himn_local, username)
             if install_xapi:
                 install_suppack(HIMN_IP, username)

plugin_source/deployment_scripts/compute_pre_deployment.py

@@ -0,0 +1,228 @@
+#!/usr/bin/env python
+
+import ConfigParser
+import logging
+import netifaces
+import os
+import re
+from socket import inet_ntoa
+from struct import pack
+import subprocess # nosec
+import sys
+import stat
+import yaml
+
+
+XS_RSA = '/root/.ssh/xs_rsa'
+ASTUTE_PATH = '/etc/astute.yaml'
+ASTUTE_SECTION = '@PLUGIN_NAME@'
+LOG_ROOT = '/var/log/@PLUGIN_NAME@'
+LOG_FILE = 'compute_pre_deployment.log'
+HIMN_IP = '169.254.0.1'
+INT_BRIDGE = 'br-int'
+XS_PLUGIN_ISO = 'xenapi-plugins-mitaka.iso'
+DIST_PACKAGES_DIR = '/usr/lib/python2.7/dist-packages/'
+PLATFORM_VERSION = '1.9'
+
+if not os.path.exists(LOG_ROOT):
+    os.mkdir(LOG_ROOT)
+
+logging.basicConfig(filename=os.path.join(LOG_ROOT, LOG_FILE),
+                    level=logging.DEBUG)
+
+
+def reportError(err):
+    logging.error(err)
+    raise Exception(err)
+
+
+def execute(*cmd, **kwargs):
+    cmd = map(str, cmd)
+    _env = kwargs.get('env')
+    env_prefix = ''
+    if _env:
+        env_prefix = ''.join(['%s=%s ' % (k, _env[k]) for k in _env])
+
+        env = dict(os.environ)
+        env.update(_env)
+    else:
+        env = None
+    logging.info(env_prefix + ' '.join(cmd))
+    proc = subprocess.Popen(cmd, stdin=subprocess.PIPE, stdout=subprocess.PIPE, # nosec
+                 stderr=subprocess.PIPE, env=env)
+
+    if 'prompt' in kwargs:
+        prompt = kwargs.get('prompt')
+        proc.stdout.flush()
+        (out, err) = proc.communicate(prompt)
+    else:
+        out = proc.stdout.readlines()
+        err = proc.stderr.readlines()
+        (out, err) = map(' '.join, [out, err])
+
+    # Both if/else need to deal with "\n" scenario
+    (out, err) = (out.replace('\n', ''), err.replace('\n', ''))
+
+    if out:
+        logging.debug(out)
+    if err:
+        logging.error(err)
+
+    if proc.returncode is not None and proc.returncode != 0:
+        raise Exception(err)
+
+    return out
+
+
+def ssh(host, username, *cmd, **kwargs):
+    cmd = map(str, cmd)
+
+    return execute('ssh', '-i', XS_RSA,
+                   '-o', 'StrictHostKeyChecking=no',
+                   '%s@%s' % (username, host), *cmd,
+                   prompt=kwargs.get('prompt'))
+
+
+def scp(host, username, target_path, filename):
+    return execute('scp', '-i', XS_RSA,
+                   '-o', 'StrictHostKeyChecking=no', filename,
+                   '%s@%s:%s' % (username, host, target_path))
+
+
+def ssh_copy_id(host, username, password):
+    ssh_askpass = "askpass.sh"
+
+    s = ('#!/bin/sh\n'
+         'echo "{password}"').format(password=password)
+    with open(ssh_askpass, 'w') as f:
+        f.write(s)
+    os.chmod(ssh_askpass, stat.S_IXUSR | stat.S_IXGRP | stat.S_IXOTH)
+
+    if os.path.exists(XS_RSA):
+        os.remove(XS_RSA)
+    if os.path.exists(XS_RSA + ".pub"):
+        os.remove(XS_RSA + ".pub")
+    execute('ssh-keygen', '-f', XS_RSA, '-t', 'rsa', '-N', '')
+
+    env = {
+        "HOME": "/root",
+        "SSH_ASKPASS": os.path.abspath(ssh_askpass),
+        "DISPLAY": ":.",
+    }
+    execute("setsid", "ssh-copy-id", "-o", "StrictHostKeyChecking=no",
+            "-i", XS_RSA, "%s@%s" % (username, host), env=env)
+
+
+def get_astute(astute_path):
+    """Return the root object read from astute.yaml"""
+    if not os.path.exists(astute_path):
+        reportError('%s not found' % astute_path)
+    with open(astute_path) as f:
+        astute = yaml.safe_load(f)
+    return astute
+
+
+def astute_get(dct, keys, default=None, fail_if_missing=True):
+    """A safe dictionary getter"""
+    for key in keys:
+        if key in dct:
+            dct = dct[key]
+        else:
+            if fail_if_missing:
+                reportError('Value of "%s" is missing' % key)
+            return default
+    return dct
+
+
+def get_options(astute, astute_section):
+    """Return username and password filled in plugin."""
+    if astute_section not in astute:
+        reportError('%s not found' % astute_section)
+
+    options = astute[astute_section]
+    logging.info('username: {username}'.format(**options))
+    logging.info('password: {password}'.format(**options))
+    logging.info('install_xapi: {install_xapi}'.format(**options))
+    return options['username'], options['password'], \
+        options['install_xapi']
+
+
+def init_eth():
+    """Initialize the net interface connected to HIMN
+
+    Returns:
+        the IP addresses of local host and hypervisor.
+    """
+
+    domid = execute('xenstore-read', 'domid')
+    himn_mac = execute(
+        'xenstore-read',
+        '/local/domain/%s/vm-data/himn_mac' % domid)
+    logging.info('himn_mac: %s' % himn_mac)
+
+    _mac = lambda eth: \
+        netifaces.ifaddresses(eth).get(netifaces.AF_LINK)[0]['addr']
+    eths = [eth for eth in netifaces.interfaces() if _mac(eth) == himn_mac]
+    if len(eths) != 1:
+        reportError('Cannot find eth matches himn_mac')
+
+    eth = eths[0]
+    logging.info('himn_eth: %s' % eth)
+
+    ip = netifaces.ifaddresses(eth).get(netifaces.AF_INET)
+
+    if not ip:
+        execute('dhclient', eth)
+        fname = '/etc/network/interfaces.d/ifcfg-' + eth
+        s = ('auto {eth}\n'
+             'iface {eth} inet dhcp\n'
+             'post-up route del default dev {eth}').format(eth=eth)
+        with open(fname, 'w') as f:
+            f.write(s)
+        logging.info('%s created' % fname)
+        execute('ifdown', eth)
+        execute('ifup', eth)
+        ip = netifaces.ifaddresses(eth).get(netifaces.AF_INET)
+
+    if ip:
+        himn_local = ip[0]['addr']
+        himn_xs = '.'.join(himn_local.split('.')[:-1] + ['1'])
+        if HIMN_IP == himn_xs:
+            logging.info('himn_local: %s' % himn_local)
+            return eth, himn_local
+
+    reportError('HIMN failed to get IP address from Hypervisor')
+
+
+def check_host_compatibility(himn, username):
+    hotfix = 'XS65ESP1013'
+    installed = ssh(himn, username,
+                    'xe patch-list name-label=%s --minimal' % hotfix)
+    ver = ssh(himn, username,
+              ('xe host-param-get uuid=$(xe host-list --minimal) '
+               'param-name=software-version param-key=platform_version'))
+
+    if not installed and ver[:3] == PLATFORM_VERSION:
+        reportError(('Hotfix %s has not been installed '
+                     'and product version is %s') % (hotfix, ver))
+
+
+def check_local_sr(himn, username):
+    sr_type = ssh(himn, username,
+                  ('xe sr-param-get param-name=type uuid=`xe pool-list params=default-SR --minimal`'))
+
+    if sr_type != "ext" and sr_type != "nfs":
+        reportError(('Default SR type should be EXT or NFS.  If using local storage, Please make sure thin'
+                     ' provisioning is enabled on your host during installation.'))
+
+
+if __name__ == '__main__':
+    astute = get_astute(ASTUTE_PATH)
+    if astute:
+        username, password, install_xapi = get_options(astute, ASTUTE_SECTION)
+        himn_eth, himn_local = init_eth()
+
+        if username and password and himn_local:
+            ssh_copy_id(HIMN_IP, username, password)
+            check_host_compatibility(HIMN_IP, username)
+            check_local_sr(HIMN_IP, username)

plugin_source/deployment_tasks.yaml

@@ -1,15 +1,23 @@
 - id: 'install-pv-tool'
   role: ['compute']
-  required_for: ['compute-post-deployment']
-  requires: ['post_deployment_start']
+  required_for: ['compute-pre-deployment']
+  requires: ['pre_deployment_start']
   type: shell
   parameters:
     cmd: 'dpkg -i ./xe-guest-utilities_6.5.0-1393_amd64.deb'
     timeout: 10
+- id: 'compute-pre-deployment'
+  role: ['compute']
+  required_for: ['pre_deployment_end']
+  requires: ['install-pv-tool']
+  type: shell
+  parameters:
+    cmd: ./compute_pre_deployment.py
+    timeout: 120
 - id: 'compute-post-deployment'
   role: ['compute']
   required_for: ['post_deployment_end']
-  requires: ['install-pv-tool']
+  requires: ['post_deployment_start']
   type: shell
   parameters:
     cmd: ./compute_post_deployment.py