Merge "Update test results in userguide"
[functest.git] / functest / opnfv_tests / vnf / ims / clearwater_ims_base.py
1 #!/usr/bin/env python
2 #
3 # Copyright (c) 2017 All rights reserved
4 # This program and the accompanying materials
5 # are made available under the terms of the Apache License, Version 2.0
6 # which accompanies this distribution, and is available at
7 #
8 # http://www.apache.org/licenses/LICENSE-2.0
9 import json
10 import logging
11 import os
12 import shlex
13 import shutil
14 import subprocess
15 import time
16
17 import pkg_resources
18 import requests
19
20 import functest.core.vnf as vnf
21 from functest.utils import config
22 import functest.utils.functest_utils as ft_utils
23
24 __author__ = ("Valentin Boucher <valentin.boucher@orange.com>, "
25               "Helen Yao <helanyao@gmail.com>")
26
27
28 class ClearwaterOnBoardingBase(vnf.VnfOnBoarding):
29     """ vIMS clearwater base usable by several orchestrators"""
30
31     def __init__(self, **kwargs):
32         self.logger = logging.getLogger(__name__)
33         super(ClearwaterOnBoardingBase, self).__init__(**kwargs)
34         self.case_dir = pkg_resources.resource_filename(
35             'functest', 'opnfv_tests/vnf/ims')
36         self.data_dir = getattr(config.CONF, 'dir_ims_data')
37         self.result_dir = os.path.join(getattr(config.CONF, 'dir_results'),
38                                        self.case_name)
39         self.test_dir = getattr(config.CONF, 'dir_repo_vims_test')
40
41         if not os.path.exists(self.data_dir):
42             os.makedirs(self.data_dir)
43         if not os.path.exists(self.result_dir):
44             os.makedirs(self.result_dir)
45
46     def config_ellis(self, ellis_ip, signup_code='secret', two_numbers=False):
47         output_dict = {}
48         self.logger.debug('Configure Ellis: %s', ellis_ip)
49         output_dict['ellis_ip'] = ellis_ip
50         account_url = 'http://{0}/accounts'.format(ellis_ip)
51         params = {"password": "functest",
52                   "full_name": "opnfv functest user",
53                   "email": "functest@opnfv.org",
54                   "signup_code": signup_code}
55         rq = requests.post(account_url, data=params)
56         output_dict['login'] = params
57         if rq.status_code != 201 and rq.status_code != 409:
58             raise Exception("Unable to create an account for number provision")
59         self.logger.debug('Account is created on Ellis: %s', params)
60
61         session_url = 'http://{0}/session'.format(ellis_ip)
62         session_data = {
63             'username': params['email'],
64             'password': params['password'],
65             'email': params['email']
66         }
67         rq = requests.post(session_url, data=session_data)
68         if rq.status_code != 201:
69             raise Exception('Failed to get cookie for Ellis')
70         cookies = rq.cookies
71         self.logger.debug('Cookies: %s', cookies)
72
73         number_url = 'http://{0}/accounts/{1}/numbers'.format(
74             ellis_ip, params['email'])
75         self.logger.debug('Create 1st calling number on Ellis')
76         i = 30
77         while rq.status_code != 200 and i > 0:
78             try:
79                 number_res = self.create_ellis_number(number_url, cookies)
80                 break
81             except Exception:  # pylint: disable=broad-except
82                 if i == 1:
83                     raise Exception("Unable to create a number")
84                 self.logger.info("Unable to create a number. Retry ..")
85                 time.sleep(25)
86             i = i - 1
87         output_dict['number'] = number_res
88
89         if two_numbers:
90             self.logger.debug('Create 2nd calling number on Ellis')
91             number_res = self.create_ellis_number(number_url, cookies)
92             output_dict['number2'] = number_res
93
94         return output_dict
95
96     def create_ellis_number(self, number_url, cookies):
97         rq = requests.post(number_url, cookies=cookies)
98
99         if rq.status_code != 200:
100             if rq and rq.json():
101                 reason = rq.json()['reason']
102             else:
103                 reason = rq
104             raise Exception("Unable to create a number: %s" % reason)
105         number_res = rq.json()
106         self.logger.info('Calling number is created: %s', number_res)
107         return number_res
108
109     def run_clearwater_live_test(self, dns_ip, public_domain,
110                                  bono_ip=None, ellis_ip=None,
111                                  signup_code='secret'):
112         self.logger.info('Run Clearwater live test')
113         dns_file = '/etc/resolv.conf'
114         dns_file_bak = '/etc/resolv.conf.bak'
115         self.logger.debug('Backup %s -> %s', dns_file, dns_file_bak)
116         shutil.copy(dns_file, dns_file_bak)
117         cmd = ("dnsmasq -d -u root --server=/clearwater.opnfv/{0} "
118                "-r /etc/resolv.conf.bak".format(dns_ip))
119         dnsmasq_process = subprocess.Popen(shlex.split(cmd))
120         script = ('echo -e "nameserver {0}" > {1};'
121                   'cd {2};'
122                   'rake test[{3}] SIGNUP_CODE={4}'
123                   .format('127.0.0.1',
124                           dns_file,
125                           self.test_dir,
126                           public_domain,
127                           signup_code))
128         if bono_ip and ellis_ip:
129             subscript = ' PROXY={0} ELLIS={1}'.format(bono_ip, ellis_ip)
130             script = '{0}{1}'.format(script, subscript)
131         script = ('{0}{1}'.format(script, ' --trace'))
132         cmd = "/bin/bash -c '{0}'".format(script)
133         self.logger.debug('Live test cmd: %s', cmd)
134         output_file = os.path.join(self.result_dir, "ims_test_output.txt")
135         ft_utils.execute_command(cmd,
136                                  error_msg='Clearwater live test failed',
137                                  output_file=output_file)
138         dnsmasq_process.kill()
139         with open(dns_file_bak, 'r') as bak_file:
140             result = bak_file.read()
141             with open(dns_file, 'w') as f:
142                 f.write(result)
143
144         f = open(output_file, 'r')
145         result = f.read()
146         if result != "":
147             self.logger.debug(result)
148
149         vims_test_result = ""
150         tempFile = os.path.join(self.test_dir, "temp.json")
151         try:
152             self.logger.debug("Trying to load test results")
153             with open(tempFile) as f:
154                 vims_test_result = json.load(f)
155             f.close()
156         except Exception:  # pylint: disable=broad-except
157             self.logger.error("Unable to retrieve test results")
158
159         try:
160             os.remove(tempFile)
161         except Exception:  # pylint: disable=broad-except
162             self.logger.error("Deleting file failed")
163
164         return vims_test_result