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 constants
  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(constants.CONST, '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(constants.CONST, '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             snaps_creds = snaps_utils.get_credentials()
 160             kwargs = {'neutronurl': keystone_utils.get_endpoint(
 161                 snaps_creds, 'network')}
 162             kwargs['odlip'] = urllib.parse.urlparse(
 163                 kwargs['neutronurl']).hostname
 164             kwargs['odlwebport'] = '8080'
 165             kwargs['odlrestconfport'] = '8181'
 166             kwargs['odlusername'] = 'admin'
 167             kwargs['odlpassword'] = 'admin'
 168             installer_type = None
 169             if 'INSTALLER_TYPE' in os.environ:
 170                 installer_type = os.environ['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'] = '8181'
 181                 kwargs['odlrestconfport'] = '8282'
 182             elif installer_type == 'apex' or installer_type == 'netvirt':
 183                 kwargs['odlip'] = os.environ['SDN_CONTROLLER_IP']
 184                 kwargs['odlwebport'] = '8081'
 185                 kwargs['odlrestconfport'] = '8081'
 186             elif installer_type == 'compass':
 187                 kwargs['odlrestconfport'] = '8080'
 188             elif installer_type == 'daisy':
 189                 kwargs['odlip'] = os.environ['SDN_CONTROLLER_IP']
 190                 kwargs['odlwebport'] = '8181'
 191                 kwargs['odlrestconfport'] = '8087'
 192             else:
 193                 kwargs['odlip'] = os.environ['SDN_CONTROLLER_IP']
 194         except KeyError as ex:
 195             self.__logger.error("Cannot run ODL testcases. "
 196                                 "Please check env var: "
 197                                 "%s", str(ex))
 198             return self.EX_RUN_ERROR
 199         except Exception:  # pylint: disable=broad-except
 200             self.__logger.exception("Cannot run ODL testcases.")
 201             return self.EX_RUN_ERROR
 202
 203         return self.run_suites(suites, **kwargs)
 204
 205
 206 class ODLParser(object):  # pylint: disable=too-few-public-methods
 207     """Parser to run ODL test suites."""
 208
 209     def __init__(self):
 210         self.parser = argparse.ArgumentParser()
 211         self.parser.add_argument(
 212             '-n', '--neutronurl', help='Neutron Endpoint',
 213             default='http://127.0.0.1:9696')
 214         self.parser.add_argument(
 215             '-k', '--osauthurl', help='OS_AUTH_URL as defined by OpenStack',
 216             default='http://127.0.0.1:5000/v3')
 217         self.parser.add_argument(
 218             '-a', '--osusername', help='Username for OpenStack',
 219             default='admin')
 220         self.parser.add_argument(
 221             '-f', '--osuserdomainname', help='User domain name for OpenStack',
 222             default='Default')
 223         self.parser.add_argument(
 224             '-b', '--osprojectname', help='Projet name for OpenStack',
 225             default='admin')
 226         self.parser.add_argument(
 227             '-g', '--osprojectdomainname',
 228             help='Project domain name for OpenStack',
 229             default='Default')
 230         self.parser.add_argument(
 231             '-c', '--ospassword', help='Password for OpenStack',
 232             default='admin')
 233         self.parser.add_argument(
 234             '-o', '--odlip', help='OpenDaylight IP',
 235             default='127.0.0.1')
 236         self.parser.add_argument(
 237             '-w', '--odlwebport', help='OpenDaylight Web Portal Port',
 238             default='8080')
 239         self.parser.add_argument(
 240             '-r', '--odlrestconfport', help='OpenDaylight RESTConf Port',
 241             default='8181')
 242         self.parser.add_argument(
 243             '-d', '--odlusername', help='Username for ODL',
 244             default='admin')
 245         self.parser.add_argument(
 246             '-e', '--odlpassword', help='Password for ODL',
 247             default='admin')
 248         self.parser.add_argument(
 249             '-p', '--pushtodb', help='Push results to DB',
 250             action='store_true')
 251
 252     def parse_args(self, argv=None):
 253         """Parse arguments.
 254
 255         It can call sys.exit if arguments are incorrect.
 256
 257         Returns:
 258             the arguments from cmdline
 259         """
 260         if not argv:
 261             argv = []
 262         return vars(self.parser.parse_args(argv))
 263
 264
 265 def main():
 266     """Entry point"""
 267     logging.basicConfig()
 268     odl = ODLTests()
 269     parser = ODLParser()
 270     args = parser.parse_args(sys.argv[1:])
 271     try:
 272         result = odl.run_suites(ODLTests.default_suites, **args)
 273         if result != robotframework.RobotFramework.EX_OK:
 274             return result
 275         if args['pushtodb']:
 276             return odl.push_to_db()
 277         return result
 278     except Exception:  # pylint: disable=broad-except
 279         return robotframework.RobotFramework.EX_RUN_ERROR