slaprunner.py 10.2 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30
# -*- coding: utf-8 -*-
##############################################################################
#
# Copyright (c) 2013 Vifib SARL and Contributors. All Rights Reserved.
#
# WARNING: This program as such is intended to be used by professional
# programmers who take the whole responsibility of assessing all potential
# consequences resulting from its eventual inadequacies and bugs
# End users who are looking for a ready-to-use solution with commercial
# guarantees and support are strongly adviced to contract a Free Software
# Service Company
#
# This program is Free Software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 3
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
#
##############################################################################

from .resiliencytestsuite import ResiliencyTestSuite

31
import base64
32
import cookielib
33
import json
34
from lxml import etree
35
import random
36
import ssl
37 38 39
import string
import time
import urllib2
40
import urllib
41 42 43 44 45 46 47 48 49

class NotHttpOkException(Exception):
  pass

class SlaprunnerTestSuite(ResiliencyTestSuite):
  """
  Run Slaprunner Resiliency Test.
  It is highly suggested to read ResiliencyTestSuite code.
  """
50
  def __init__(self, *args, **kwargs):
51 52
    # Setup urllib2 with cookie support
    cookie_jar = cookielib.CookieJar()
53 54
    ssl_context = ssl._create_unverified_context()

55
    self._opener_director = urllib2.build_opener(
56 57
        urllib2.HTTPCookieProcessor(cookie_jar),
        urllib2.HTTPSHandler(context=ssl_context)
58
    )
59

60
    ResiliencyTestSuite.__init__(self, *args, **kwargs)
61

62 63 64 65 66 67 68 69 70 71 72 73 74
  def _getPartitionParameterDict(self):
    """
    Helper.
    Return the partition parameter dict of the main root ("resilient") instance.
    """
    # XXX Hardcoded parameters, should be obtained dynamically
    return self.partition.request(
      software_release=self.software,
      software_type='resilient',
      partition_reference=self.root_instance_name,
      partition_parameter_kw={
        'resiliency-backup-periodicity': '*/6 * * * *',
        'auto-deploy-instance': 'false',
75 76 77
        'auto-deploy': 'true',
        # XXX HACK!
        "slapos-reference": 'slaprunner-erp5-resiliency'
78 79 80
        }
    ).getConnectionParameterDict()
    self.deleteTimestamp()
81

82 83 84 85 86 87
  def _connectToSlaprunner(self, resource, data=None):
    """
    Utility.
    Connect through HTTP to the slaprunner instance.
    Require self.slaprunner_backend_url to be set.
    """
88 89 90 91 92 93
    try:
      url = "%s/%s" % (self.slaprunner_backend_url, resource)
      if data:
        result = self._opener_director.open(url, data=data)
      else:
        result = self._opener_director.open(url)
94

95 96 97 98 99 100
      if result.getcode() is not 200:
        raise NotHttpOkException(result.getcode())
      return result.read()
    except urllib2.HTTPError:
      self.logger.error('Error when contacting slaprunner at URL: {}'.format(url))
      raise
101 102 103

  def _login(self):
    self.logger.debug('Logging in...')
104
    b64string = base64.encodestring('%s:%s' % (self.slaprunner_user, self.slaprunner_password))[:-1]
105 106 107 108 109 110
    self._opener_director.addheaders = [
        ('Authorization', 'Basic %s' % b64string),
        # By default we will prefer to receive JSON to simplify
        # treatments of the response
        ("Accept", "application/json"),
    ]
111 112 113

  def _retrieveInstanceLogFile(self):
    """
114 115
    Store the logfile (=data) of the instance, check it is not empty nor it is
    html.
116
    """
117
    time.sleep(30)
118
    data = self._connectToSlaprunner(
119 120
        resource='getFileContent',
        data="file=instance_root/slappart0/var/log/log.log"
121
    )
122
    try:
123
        json_data = json.loads(data)
124 125
        if json_data['code'] == 0:
          raise IOError(json_data['result'])
126
        data = json_data['result']
127 128
        self.logger.info('Retrieved data are:\n%s' % data)
    except (ValueError, KeyError):
129
        if data.find('<') != -1:
130 131 132
          raise IOError(
              'Could not retrieve logfile content: retrieved content is html.'
          )
133
        if data.find('Could not load') != -1:
134 135 136
          raise IOError(
              'Could not retrieve logfile content: server could not load the file.'
          )
137
        if data.find('Hello') == -1:
138 139 140
          raise IOError(
              'Could not retrieve logfile content: retrieve content does not match "Hello".'
          )
141 142
    return data

143 144 145 146 147 148
  def _retrieveSoftwareLogFileTail(self, truncate=100):
    """
      Retrieve the tail of the software.log file.
    """
    data = self._connectToSlaprunner(
             resource='getFileLog',
149
             data="filename=instance_root/../software.log&truncate=%s" % truncate)
150 151 152 153 154 155
    try:
      data = json.loads(data)['result']
      self.logger.info('Tail of software.log:\n%s' % data)
    except (ValueError, KeyError):
      self.logger.info("Fail to get software.log")

156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175

  def _waitForSoftwareBuild(self, limit=5000):
    """
    Wait until SR is built or limit reach 0
    """
    def getSRStatus():
      """
      Return current status (-1 in case of connection problem)
      """
      try:
        return self._connectToSlaprunner(resource='isSRReady')
      except (NotHttpOkException, urllib2.HTTPError) as error:
        # The nginx frontend might timeout before software release is finished.
        self.logger.warning('Problem occured when contacting the server: %s' % error)
        return -1

    status = getSRStatus()
    while limit > 0 and status != '1':
      status = getSRStatus()
      limit -= 1
176 177 178 179
      if status == '0':
        self.logger.info('Software release is Failing to Build. Sleeping...')
      else:
        self.logger.info('Software release is still building. Sleeping...')
180 181 182 183
      time.sleep(20)
      for sleep_wait in range(3):
        self._retrieveSoftwareLogFileTail(truncate=100)
        time.sleep(10)
184

185

186
  def _buildSoftwareRelease(self):
187 188 189 190 191 192
    self.logger.info('Building the Software Release...')
    try:
      self._connectToSlaprunner(resource='runSoftwareProfile')
    except (NotHttpOkException, urllib2.HTTPError):
      # The nginx frontend might timeout before software release is finished.
      pass
193

194
    self._waitForSoftwareBuild()
195

196
  def _deployInstance(self):
197 198 199 200 201 202
    self.logger.info('Deploying instance...')
    try:
      self._connectToSlaprunner(resource='runInstanceProfile')
    except (NotHttpOkException, urllib2.HTTPError):
      # The nginx frontend might timeout before someftware release is finished.
      pass
203
    while True:
204
      time.sleep(15)
205 206 207 208
      result = json.loads(self._connectToSlaprunner(resource='slapgridResult', data='position=0&log='))
      if result['instance']['state'] is False:
        break
      self.logger.info('Buildout is still running. Sleeping...')
209 210
    self.logger.info('Instance has been deployed.')

211
  def _gitClone(self):
212
    self.logger.debug('Doing git clone of https://lab.nexedi.com/nexedi/slapos.git..')
213
    try:
214
      data = self._connectToSlaprunner(
215
          resource='cloneRepository',
216
          data='repo=https://lab.nexedi.com/nexedi/slapos.git&name=workspace/slapos&email=slapos@slapos.org&user=slapos'
217
      )
218
      data = json.loads(data)
219
      if data['code'] == 0:
220
        self.logger.warning(data['result'])
221

222 223 224
    except (NotHttpOkException, urllib2.HTTPError):
      # cloning can be very long.
      # XXX: quite dirty way to check.
225
      while self._connectToSlaprunner('getProjectStatus', data='project=workspace/slapos').find('On branch master') == -1:
226 227
        self.logger.info('git-cloning ongoing, sleeping...')

228
  def _openSoftwareRelease(self, software_release='erp5testnode/testsuite/dummy'):
229
    self.logger.debug('Opening %s software release...' % software_release)
230
    data = self._connectToSlaprunner(
231
        resource='setCurrentProject',
232
        data='path=workspace/slapos/software/%s/' % software_release
233
    )
234
    if json.loads(data)['code'] == 0:
235 236
      self.logger.warning(data['result'])
      raise IOError(data['result'])
237 238

  def generateData(self):
239 240 241
    """
    Generate Data for slaprunner
    """
242 243 244 245 246 247 248 249 250 251

  def pushDataOnMainInstance(self):
    """
    Create a dummy Software Release,
    Build it,
    Wait for build to be successful,
    Deploy instance,
    Wait for instance to be started.
    Store the main IP of the slaprunner for future use.
    """
252
    self.logger.debug('Getting the backend URL...')
253
    parameter_dict = self._getPartitionParameterDict()
254
    self.slaprunner_backend_url = parameter_dict['backend-url']
255
    self.logger.info('backend_url is %s.' % self.slaprunner_backend_url)
256 257
    self.slaprunner_user = parameter_dict['init-user']
    self.slaprunner_password = parameter_dict['init-password']
258 259 260 261 262

    self._login()

    self._gitClone()
    # XXX should be taken from parameter.
263
    self._openSoftwareRelease()
264 265

    self._buildSoftwareRelease()
266
    time.sleep(15)
267 268 269
    self._deployInstance()

    self.data = self._retrieveInstanceLogFile()
270 271 272 273 274 275 276 277 278 279 280 281

  def checkDataOnCloneInstance(self):
    """
    Check that:
      * backend_url is different
      * Software Release profile is the same,
      * Software Release is built and is the same, (?)
      * Instance is deployed and is the same.
    """
    # XXX: does the promise wait for the software to be built and the instance to be ready?
    old_slaprunner_backend_url = self.slaprunner_backend_url
    self.slaprunner_backend_url = self._returnNewInstanceParameter(
282
        parameter_key='backend-url',
283 284
        old_parameter_value=old_slaprunner_backend_url,
        force_new=True,
285 286
    )
    self._login()
287
    self._waitForSoftwareBuild()
288
    time.sleep(15)
289 290
    new_data = self._retrieveInstanceLogFile()

291
    if new_data.startswith(self.data):
292
      self.logger.info('Data are the same: success.')
293
      return True
294 295 296 297 298 299 300 301 302 303
    else:
      self.logger.info('Data are different: failure.')


def runTestSuite(*args, **kwargs):
  """
  Run Slaprunner Resiliency Test.
  """
  return SlaprunnerTestSuite(*args, **kwargs).runTestSuite()