functest/opnfv_tests/sdn/odl/odl.py

   1 #!/usr/bin/env python
   2
   3 # Copyright (c) 2016 Orange and others.
   4 #
   5 # All rights reserved. This program and the accompanying materials
   6 # are made available under the terms of the Apache License, Version 2.0
   7 # which accompanies this distribution, and is available at
   8 # http://www.apache.org/licenses/LICENSE-2.0
   9
  10 """Define classes required to run ODL suites.
  11
  12 It has been designed for any context. But helpers are given for
  13 running test suites in OPNFV environment.
  14
  15 Example:
  16         $ python odl.py
  17 """
  18
  19 from __future__ import division
  20
  21 import argparse
  22 import fileinput
  23 import logging
  24 import os
  25 import re
  26 import sys
  27
  28 from six.moves import urllib
  29 from snaps.openstack.utils import keystone_utils
  30
  31 from functest.core import robotframework
  32 from functest.opnfv_tests.openstack.snaps import snaps_utils
  33 from functest.utils import config
  34 from functest.utils import env
  35
  36 __author__ = "Cedric Ollivier <cedric.ollivier@orange.com>"
  37
  38
  39 class ODLTests(robotframework.RobotFramework):
  40     """ODL test runner."""
  41
  42     odl_test_repo = getattr(config.CONF, 'dir_repo_odl_test')
  43     neutron_suite_dir = os.path.join(
  44         odl_test_repo, "csit/suites/openstack/neutron")
  45     basic_suite_dir = os.path.join(
  46         odl_test_repo, "csit/suites/integration/basic")
  47     default_suites = [basic_suite_dir, neutron_suite_dir]
  48     odl_variables_file = os.path.join(
  49         odl_test_repo, 'csit/variables/Variables.robot')
  50     __logger = logging.getLogger(__name__)
  51
  52     def __init__(self, **kwargs):
  53         super(ODLTests, self).__init__(**kwargs)
  54         self.res_dir = os.path.join(
  55             getattr(config.CONF, 'dir_results'), 'odl')
  56         self.xml_file = os.path.join(self.res_dir, 'output.xml')
  57
  58     @classmethod
  59     def set_robotframework_vars(cls, odlusername="admin", odlpassword="admin"):
  60         """Set credentials in csit/variables/Variables.robot.
  61
  62         Returns:
  63             True if credentials are set.
  64             False otherwise.
  65         """
  66
  67         try:
  68             for line in fileinput.input(cls.odl_variables_file,
  69                                         inplace=True):
  70                 print(re.sub("@{AUTH}.*",
  71                              "@{{AUTH}}           {}    {}".format(
  72                                  odlusername, odlpassword),
  73                              line.rstrip()))
  74             return True
  75         except Exception:  # pylint: disable=broad-except
  76             cls.__logger.exception("Cannot set ODL creds:")
  77             return False
  78
  79     def run_suites(self, suites=None, **kwargs):
  80         """Run the test suites
  81
  82         It has been designed to be called in any context.
  83         It requires the following keyword arguments:
  84
  85            * odlusername,
  86            * odlpassword,
  87            * osauthurl,
  88            * neutronurl,
  89            * osusername,
  90            * osprojectname,
  91            * ospassword,
  92            * odlip,
  93            * odlwebport,
  94            * odlrestconfport.
  95
  96         Here are the steps:
  97            * set all RobotFramework_variables,
  98            * create the output directories if required,
  99            * get the results in output.xml,
 100            * delete temporary files.
 101
 102         Args:
 103             kwargs: Arbitrary keyword arguments.
 104
 105         Returns:
 106             EX_OK if all suites ran well.
 107             EX_RUN_ERROR otherwise.
 108         """
 109         try:
 110             if not suites:
 111                 suites = self.default_suites
 112             odlusername = kwargs['odlusername']
 113             odlpassword = kwargs['odlpassword']
 114             osauthurl = kwargs['osauthurl']
 115             keystoneurl = "{}://{}".format(
 116                 urllib.parse.urlparse(osauthurl).scheme,
 117                 urllib.parse.urlparse(osauthurl).netloc)
 118             variable = ['KEYSTONEURL:' + keystoneurl,
 119                         'NEUTRONURL:' + kwargs['neutronurl'],
 120                         'OS_AUTH_URL:"' + osauthurl + '"',
 121                         'OSUSERNAME:"' + kwargs['osusername'] + '"',
 122                         ('OSUSERDOMAINNAME:"' +
 123                          kwargs['osuserdomainname'] + '"'),
 124                         'OSTENANTNAME:"' + kwargs['osprojectname'] + '"',
 125                         ('OSPROJECTDOMAINNAME:"' +
 126                          kwargs['osprojectdomainname'] + '"'),
 127                         'OSPASSWORD:"' + kwargs['ospassword'] + '"',
 128                         'ODL_SYSTEM_IP:' + kwargs['odlip'],
 129                         'PORT:' + kwargs['odlwebport'],
 130                         'RESTCONFPORT:' + kwargs['odlrestconfport']]
 131         except KeyError:
 132             self.__logger.exception("Cannot run ODL testcases. Please check")
 133             return self.EX_RUN_ERROR
 134         if not os.path.isfile(self.odl_variables_file):
 135             self.__logger.info("Skip writting ODL creds")
 136         else:
 137             if not self.set_robotframework_vars(odlusername, odlpassword):
 138                 return self.EX_RUN_ERROR
 139         return super(ODLTests, self).run(variable=variable, suites=suites)
 140
 141     def run(self, **kwargs):
 142         """Run suites in OPNFV environment
 143
 144         It basically checks env vars to call main() with the keywords
 145         required.
 146
 147         Args:
 148             kwargs: Arbitrary keyword arguments.
 149
 150         Returns:
 151             EX_OK if all suites ran well.
 152             EX_RUN_ERROR otherwise.
 153         """
 154         try:
 155             suites = self.default_suites
 156             try:
 157                 suites = kwargs["suites"]
 158             except KeyError:
 159                 pass
 160             snaps_creds = snaps_utils.get_credentials()
 161             kwargs = {'neutronurl': keystone_utils.get_endpoint(
 162                 snaps_creds, 'network')}
 163             kwargs['odlip'] = urllib.parse.urlparse(
 164                 kwargs['neutronurl']).hostname
 165             kwargs['odlwebport'] = '8080'
 166             kwargs['odlrestconfport'] = '8181'
 167             kwargs['odlusername'] = 'admin'
 168             kwargs['odlpassword'] = 'admin'
 169             installer_type = env.get('INSTALLER_TYPE')
 170             kwargs['osusername'] = os.environ['OS_USERNAME']
 171             kwargs['osuserdomainname'] = os.environ.get(
 172                 'OS_USER_DOMAIN_NAME', 'Default')
 173             kwargs['osprojectname'] = os.environ['OS_PROJECT_NAME']
 174             kwargs['osprojectdomainname'] = os.environ.get(
 175                 'OS_PROJECT_DOMAIN_NAME', 'Default')
 176             kwargs['osauthurl'] = os.environ['OS_AUTH_URL']
 177             kwargs['ospassword'] = os.environ['OS_PASSWORD']
 178             if installer_type == 'fuel':
 179                 kwargs['odlwebport'] = '8181'
 180                 kwargs['odlrestconfport'] = '8282'
 181             elif installer_type == 'apex' or installer_type == 'netvirt':
 182                 kwargs['odlip'] = env.get('SDN_CONTROLLER_IP')
 183                 kwargs['odlwebport'] = '8081'
 184                 kwargs['odlrestconfport'] = '8081'
 185             elif installer_type == 'compass':
 186                 kwargs['odlrestconfport'] = '8080'
 187             elif installer_type == 'daisy':
 188                 kwargs['odlip'] = env.get('SDN_CONTROLLER_IP')
 189                 kwargs['odlwebport'] = '8181'
 190                 kwargs['odlrestconfport'] = '8087'
 191             else:
 192                 kwargs['odlip'] = env.get('SDN_CONTROLLER_IP')
 193         except KeyError as ex:
 194             self.__logger.error("Cannot run ODL testcases. "
 195                                 "Please check env var: "
 196                                 "%s", str(ex))
 197             return self.EX_RUN_ERROR
 198         except Exception:  # pylint: disable=broad-except
 199             self.__logger.exception("Cannot run ODL testcases.")
 200             return self.EX_RUN_ERROR
 201
 202         return self.run_suites(suites, **kwargs)
 203
 204
 205 class ODLParser(object):  # pylint: disable=too-few-public-methods
 206     """Parser to run ODL test suites."""
 207
 208     def __init__(self):
 209         self.parser = argparse.ArgumentParser()
 210         self.parser.add_argument(
 211             '-n', '--neutronurl', help='Neutron Endpoint',
 212             default='http://127.0.0.1:9696')
 213         self.parser.add_argument(
 214             '-k', '--osauthurl', help='OS_AUTH_URL as defined by OpenStack',
 215             default='http://127.0.0.1:5000/v3')
 216         self.parser.add_argument(
 217             '-a', '--osusername', help='Username for OpenStack',
 218             default='admin')
 219         self.parser.add_argument(
 220             '-f', '--osuserdomainname', help='User domain name for OpenStack',
 221             default='Default')
 222         self.parser.add_argument(
 223             '-b', '--osprojectname', help='Projet name for OpenStack',
 224             default='admin')
 225         self.parser.add_argument(
 226             '-g', '--osprojectdomainname',
 227             help='Project domain name for OpenStack',
 228             default='Default')
 229         self.parser.add_argument(
 230             '-c', '--ospassword', help='Password for OpenStack',
 231             default='admin')
 232         self.parser.add_argument(
 233             '-o', '--odlip', help='OpenDaylight IP',
 234             default='127.0.0.1')
 235         self.parser.add_argument(
 236             '-w', '--odlwebport', help='OpenDaylight Web Portal Port',
 237             default='8080')
 238         self.parser.add_argument(
 239             '-r', '--odlrestconfport', help='OpenDaylight RESTConf Port',
 240             default='8181')
 241         self.parser.add_argument(
 242             '-d', '--odlusername', help='Username for ODL',
 243             default='admin')
 244         self.parser.add_argument(
 245             '-e', '--odlpassword', help='Password for ODL',
 246             default='admin')
 247         self.parser.add_argument(
 248             '-p', '--pushtodb', help='Push results to DB',
 249             action='store_true')
 250
 251     def parse_args(self, argv=None):
 252         """Parse arguments.
 253
 254         It can call sys.exit if arguments are incorrect.
 255
 256         Returns:
 257             the arguments from cmdline
 258         """
 259         if not argv:
 260             argv = []
 261         return vars(self.parser.parse_args(argv))
 262
 263
 264 def main():
 265     """Entry point"""
 266     logging.basicConfig()
 267     odl = ODLTests()
 268     parser = ODLParser()
 269     args = parser.parse_args(sys.argv[1:])
 270     try:
 271         result = odl.run_suites(ODLTests.default_suites, **args)
 272         if result != robotframework.RobotFramework.EX_OK:
 273             return result
 274         if args['pushtodb']:
 275             return odl.push_to_db()
 276         return result
 277     except Exception:  # pylint: disable=broad-except
 278         return robotframework.RobotFramework.EX_RUN_ERROR