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