summaryrefslogtreecommitdiffstats
path: root/functest/opnfv_tests/vnf/epc/juju_epc.py
blob: b2dbabdb4b50ce3e953a8203bfa202114c3936d6 (plain)
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
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
#!/usr/bin/env python

# Copyright (c) 2016 Rebaca and others.
#
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
"""Juju testcase implementation."""

import errno
import logging
import os
import time
import json
import re
import subprocess
import sys

from copy import deepcopy
import pkg_resources

from functest.core import singlevm
from functest.utils import config
from functest.utils import env
from functest.utils import functest_utils

__author__ = "Amarendra Meher <amarendra@rebaca.com>"
__author__ = "Soumaya K Nayek <soumaya.nayek@rebaca.com>"

CLOUD_TEMPLATE = """clouds:
  abot-epc:
    type: openstack
    auth-types: [userpass]
    endpoint: {url}
    regions:
      {region}:
        endpoint: {url}"""

CREDS_TEMPLATE2 = """credentials:
  abot-epc:
    default-credential: abot-epc
    abot-epc:
      auth-type: userpass
      password: {pass}
      project-domain-name: {project_domain_n}
      tenant-name: {tenant_n}"""

CREDS_TEMPLATE = """credentials:
  abot-epc:
    default-credential: abot-epc
    abot-epc:
      auth-type: userpass
      password: {pass}
      project-domain-name: {project_domain_n}
      tenant-name: {tenant_n}
      user-domain-name: {user_domain_n}
      username: {user_n}"""


class JujuEpc(singlevm.VmReady2):
    # pylint:disable=too-many-instance-attributes
    """Abot EPC deployed with JUJU Orchestrator Case"""

    __logger = logging.getLogger(__name__)

    cidr = '192.168.120.0/24'

    filename = ('/home/opnfv/functest/images/'
                'ubuntu-16.04-server-cloudimg-amd64-disk1.img')
    filename_alt = ('/home/opnfv/functest/images/'
                    'ubuntu-14.04-server-cloudimg-amd64-disk1.img')

    flavor_ram = 2048
    flavor_vcpus = 1
    flavor_disk = 10

    flavor_alt_ram = 4096
    flavor_alt_vcpus = 1
    flavor_alt_disk = 10

    juju_timeout = '4800'

    def __init__(self, **kwargs):
        if "case_name" not in kwargs:
            kwargs["case_name"] = "juju_epc"
        super(JujuEpc, self).__init__(**kwargs)

        # Retrieve the configuration
        self.case_dir = pkg_resources.resource_filename(
            'functest', 'opnfv_tests/vnf/epc')
        try:
            self.config = getattr(
                config.CONF, 'vnf_{}_config'.format(self.case_name))
        except Exception:
            raise Exception("VNF config file not found")
        self.config_file = os.path.join(self.case_dir, self.config)
        self.orchestrator = dict(
            requirements=functest_utils.get_parameter_from_yaml(
                "orchestrator.requirements", self.config_file))

        self.created_object = []
        self.details['orchestrator'] = dict(
            name=functest_utils.get_parameter_from_yaml(
                "orchestrator.name", self.config_file),
            version=functest_utils.get_parameter_from_yaml(
                "orchestrator.version", self.config_file),
            status='ERROR',
            result=''
        )

        self.vnf = dict(
            descriptor=functest_utils.get_parameter_from_yaml(
                "vnf.descriptor", self.config_file),
            requirements=functest_utils.get_parameter_from_yaml(
                "vnf.requirements", self.config_file)
        )
        self.details['vnf'] = dict(
            descriptor_version=self.vnf['descriptor']['version'],
            name=functest_utils.get_parameter_from_yaml(
                "vnf.name", self.config_file),
            version=functest_utils.get_parameter_from_yaml(
                "vnf.version", self.config_file),
        )
        self.__logger.debug("VNF configuration: %s", self.vnf)

        self.details['test_vnf'] = dict(
            name=functest_utils.get_parameter_from_yaml(
                "vnf_test_suite.name", self.config_file),
            version=functest_utils.get_parameter_from_yaml(
                "vnf_test_suite.version", self.config_file),
            tag_name=functest_utils.get_parameter_from_yaml(
                "vnf_test_suite.tag_name", self.config_file)
        )

        self.res_dir = os.path.join(
            getattr(config.CONF, 'dir_results'), self.case_name)

        try:
            self.public_auth_url = self.get_public_auth_url(self.orig_cloud)
            if not self.public_auth_url.endswith(('v3', 'v3/')):
                self.public_auth_url = "{}/v3".format(self.public_auth_url)
        except Exception:  # pylint: disable=broad-except
            self.public_auth_url = None
        self.sec = None
        self.image_alt = None
        self.flavor_alt = None

    def check_requirements(self):
        if not os.path.exists("/src/epc-requirements/go/bin/juju"):
            self.__logger.warning(
                "Juju cannot be cross-compiled (arm and arm64) from the time "
                "being")
            self.is_skipped = True
            self.project.clean()
        if env.get('NEW_USER_ROLE').lower() == "admin":
            self.__logger.warning(
                "Defining NEW_USER_ROLE=admin will easily break the testcase "
                "because Juju doesn't manage tenancy (e.g. subnet  "
                "overlapping)")

    def _register_cloud(self):
        assert self.public_auth_url
        self.__logger.info("Creating Cloud for Abot-epc .....")
        clouds_yaml = os.path.join(self.res_dir, "clouds.yaml")
        cloud_data = {
            'url': self.public_auth_url,
            'region': self.cloud.region_name if self.cloud.region_name else (
                'RegionOne')}
        with open(clouds_yaml, 'w') as yfile:
            yfile.write(CLOUD_TEMPLATE.format(**cloud_data))
        cmd = ['juju', 'add-cloud', 'abot-epc', '-f', clouds_yaml, '--replace']
        output = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
        self.__logger.info("%s\n%s", " ".join(cmd), output.decode("utf-8"))

    def _register_credentials(self):
        self.__logger.info("Creating Credentials for Abot-epc .....")
        credentials_yaml = os.path.join(self.res_dir, "credentials.yaml")
        creds_data = {
            'pass': self.project.password,
            'tenant_n': self.project.project.name,
            'user_n': self.project.user.name,
            'project_domain_n': self.cloud.auth.get(
                "project_domain_name", "Default"),
            'user_domain_n': self.cloud.auth.get(
                "user_domain_name", "Default")}
        with open(credentials_yaml, 'w') as yfile:
            yfile.write(CREDS_TEMPLATE.format(**creds_data))
        cmd = ['juju', 'add-credential', 'abot-epc', '-f', credentials_yaml,
               '--replace']
        output = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
        self.__logger.info("%s\n%s", " ".join(cmd), output.decode("utf-8"))

    def prepare(self):
        """Prepare testcase (Additional pre-configuration steps)."""
        assert self.public_auth_url
        self.__logger.info("Additional pre-configuration steps")
        try:
            os.makedirs(self.res_dir)
        except OSError as ex:
            if ex.errno != errno.EEXIST:
                self.__logger.exception("Cannot create %s", self.res_dir)
                raise Exception

        self.__logger.info("ENV:\n%s", env.string())
        self._register_cloud()
        self._register_credentials()

    def publish_image(self, name=None):
        image = super(JujuEpc, self).publish_image(name)
        cmd = ['juju', 'metadata', 'generate-image', '-d', '/root',
               '-i', image.id, '-s', 'xenial',
               '-r', self.cloud.region_name if self.cloud.region_name else (
                   'RegionOne'),
               '-u', self.public_auth_url]
        output = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
        self.__logger.info("%s\n%s", " ".join(cmd), output.decode("utf-8"))
        return image

    def publish_image_alt(self, name=None):
        image_alt = super(JujuEpc, self).publish_image_alt(name)
        cmd = ['juju', 'metadata', 'generate-image', '-d', '/root',
               '-i', image_alt.id, '-s', 'trusty',
               '-r', self.cloud.region_name if self.cloud.region_name else (
                   'RegionOne'),
               '-u', self.public_auth_url]
        output = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
        self.__logger.info("%s\n%s", " ".join(cmd), output.decode("utf-8"))
        return image_alt

    def deploy_orchestrator(self):  # pylint: disable=too-many-locals
        """
        Create network, subnet, router

        Bootstrap juju
        """
        self.image_alt = self.publish_image_alt()
        self.flavor_alt = self.create_flavor_alt()
        self.__logger.info("Starting Juju Bootstrap process...")
        try:
            cmd = ['timeout', JujuEpc.juju_timeout,
                   'juju', 'bootstrap',
                   'abot-epc/{}'.format(
                       self.cloud.region_name if self.cloud.region_name else (
                           'RegionOne')),
                   'abot-controller',
                   '--agent-version', '2.3.9',
                   '--metadata-source', '/root',
                   '--constraints', 'mem=2G',
                   '--bootstrap-series', 'xenial',
                   '--config', 'network={}'.format(self.network.id),
                   '--config', 'ssl-hostname-verification=false',
                   '--config', 'external-network={}'.format(self.ext_net.id),
                   '--config', 'use-floating-ip=true',
                   '--config', 'use-default-secgroup=true',
                   '--debug']
            output = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
            self.__logger.info("%s\n%s", " ".join(cmd), output.decode("utf-8"))
        except subprocess.CalledProcessError as cpe:
            self.__logger.error(
                "Exception with Juju Bootstrap: %s\n%s",
                cpe.cmd, cpe.output.decode("utf-8"))
            return False
        except Exception:  # pylint: disable=broad-except
            self.__logger.exception("Some issue with Juju Bootstrap ...")
            return False

        return True

    def check_app(self, name='abot-epc-basic', status='active'):
        """Check application status."""
        cmd = ['juju', 'status', '--format', 'short', name]
        for i in range(10):
            output = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
            self.__logger.info("%s\n%s", " ".join(cmd), output.decode("utf-8"))
            ret = re.search(
                r'(?=workload:({})\))'.format(status), output.decode("utf-8"))
            if ret:
                self.__logger.info("%s workload is %s", name, status)
                break
            self.__logger.info(
                "loop %d: %s workload differs from %s", i + 1, name, status)
            time.sleep(60)
        else:
            self.__logger.error("%s workload differs from %s", name, status)
            return False
        return True

    def deploy_vnf(self):
        """Deploy ABOT-OAI-EPC."""
        self.__logger.info("Upload VNFD")
        descriptor = self.vnf['descriptor']
        self.__logger.info("Deploying Abot-epc bundle file ...")
        cmd = ['juju', 'deploy', '{}'.format(descriptor.get('file_name'))]
        output = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
        self.__logger.info("%s\n%s", " ".join(cmd), output.decode("utf-8"))
        self.__logger.info("Waiting for instances .....")
        try:
            cmd = ['timeout', JujuEpc.juju_timeout, 'juju-wait']
            output = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
            self.__logger.info("%s\n%s", " ".join(cmd), output.decode("utf-8"))
            self.__logger.info("Deployed Abot-epc on Openstack")
        except subprocess.CalledProcessError as cpe:
            self.__logger.error(
                "Exception with Juju VNF Deployment: %s\n%s",
                cpe.cmd, cpe.output.decode("utf-8"))
            return False
        except Exception:  # pylint: disable=broad-except
            self.__logger.exception("Some issue with the VNF Deployment ..")
            return False

        self.__logger.info("Checking status of ABot and EPC units ...")
        cmd = ['juju', 'status']
        output = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
        self.__logger.debug("%s\n%s", " ".join(cmd), output.decode("utf-8"))
        for app in ['abot-epc-basic', 'oai-epc', 'oai-hss']:
            if not self.check_app(app):
                return False

        self.__logger.info("Transferring the feature files to Abot_node ...")
        cmd = ['timeout', JujuEpc.juju_timeout,
               'juju', 'scp', '--', '-r', '-v',
               '{}/featureFiles'.format(self.case_dir), 'abot-epc-basic/0:~/']
        output = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
        self.__logger.info("%s\n%s", " ".join(cmd), output.decode("utf-8"))

        self.__logger.info("Copying the feature files within Abot_node ")
        cmd = ['timeout', JujuEpc.juju_timeout,
               'juju', 'ssh', 'abot-epc-basic/0',
               'sudo', 'cp', '-vfR', '~/featureFiles/*',
               '/etc/rebaca-test-suite/featureFiles']
        output = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
        self.__logger.info("%s\n%s", " ".join(cmd), output.decode("utf-8"))
        return True

    def test_vnf(self):
        """Run test on ABoT."""
        start_time = time.time()
        self.__logger.info("Running VNF Test cases....")
        cmd = ['juju', 'run-action', 'abot-epc-basic/0', 'run',
               'tagnames={}'.format(self.details['test_vnf']['tag_name'])]
        output = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
        self.__logger.info("%s\n%s", " ".join(cmd), output.decode("utf-8"))

        cmd = ['timeout', JujuEpc.juju_timeout, 'juju-wait']
        output = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
        self.__logger.info("%s\n%s", " ".join(cmd), output.decode("utf-8"))

        duration = time.time() - start_time
        self.__logger.info("Getting results from Abot node....")
        cmd = ['timeout', JujuEpc.juju_timeout,
               'juju', 'scp', '--', '-v',
               'abot-epc-basic/0:'
               '/var/lib/abot-epc-basic/artifacts/TestResults.json',
               '{}/.'.format(self.res_dir)]
        output = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
        self.__logger.info("%s\n%s", " ".join(cmd), output.decode("utf-8"))
        self.__logger.info("Parsing the Test results...")
        res = (process_abot_test_result('{}/TestResults.json'.format(
            self.res_dir)))
        short_result = sig_test_format(res)
        self.__logger.info(short_result)
        self.details['test_vnf'].update(
            status='PASS', result=short_result, full_result=res,
            duration=duration)
        self.__logger.info(
            "Test VNF result: Passed: %d, Failed:%d, Skipped: %d",
            short_result['passed'],
            short_result['failures'], short_result['skipped'])
        return True

    def run(self, **kwargs):
        self.start_time = time.time()
        try:
            assert super(JujuEpc, self).run(**kwargs) == self.EX_OK
            self.prepare()
            if (self.deploy_orchestrator() and
                    self.deploy_vnf() and
                    self.test_vnf()):
                self.stop_time = time.time()
                self.result = 100
                return self.EX_OK
            self.result = 0
            self.stop_time = time.time()
            return self.EX_TESTCASE_FAILED
        except Exception:  # pylint: disable=broad-except
            self.stop_time = time.time()
            self.__logger.exception("Exception on VNF testing")
            return self.EX_TESTCASE_FAILED

    def clean(self):
        """Clean created objects/functions."""
        try:
            cmd = ['juju', 'debug-log', '--replay', '--no-tail']
            output = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
            self.__logger.debug(
                "%s\n%s", " ".join(cmd), output.decode("utf-8"))
            self.__logger.info("Destroying Orchestrator...")
            cmd = ['timeout', JujuEpc.juju_timeout,
                   'juju', 'destroy-controller', '-y', 'abot-controller',
                   '--destroy-all-models']
            output = subprocess.check_output(cmd, stderr=subprocess.STDOUT)
            self.__logger.info("%s\n%s", " ".join(cmd), output.decode("utf-8"))
        except subprocess.CalledProcessError as cpe:
            self.__logger.error(
                "Exception with Juju Cleanup: %s\n%s",
                cpe.cmd, cpe.output.decode("utf-8"))
        except Exception:  # pylint: disable=broad-except
            self.__logger.exception("General issue during the undeployment ..")
        for fip in self.cloud.list_floating_ips():
            self.cloud.delete_floating_ip(fip.id)
        if self.image_alt:
            self.cloud.delete_image(self.image_alt)
        if self.flavor_alt:
            self.orig_cloud.delete_flavor(self.flavor_alt.id)
        super(JujuEpc, self).clean()


def sig_test_format(sig_test):
    """
    Process the signaling result to have a short result
    """
    nb_passed = 0
    nb_failures = 0
    nb_skipped = 0
    for data_test in sig_test:
        if data_test['result'] == "passed":
            nb_passed += 1
        elif data_test['result'] == "failed":
            nb_failures += 1
        elif data_test['result'] == "skipped":
            nb_skipped += 1
    total_sig_test_result = {}
    total_sig_test_result['passed'] = nb_passed
    total_sig_test_result['failures'] = nb_failures
    total_sig_test_result['skipped'] = nb_skipped
    return total_sig_test_result


def process_abot_test_result(file_path):
    """ Process ABoT Result """
    with open(file_path) as test_result:
        data = json.load(test_result)
        res = []
        for tests in data:
            tests = update_data(tests)
            try:
                flatten_steps = tests['elements'][0].pop('flatten_steps')
                for steps in flatten_steps:
                    steps['result'] = steps['step_status']
                    res.append(steps)
            except Exception:  # pylint: disable=broad-except
                logging.error("Could not post data to ElasticSearch host")
                raise
        return res


def update_data(obj):
    """ Update Result data"""
    try:
        obj['feature_file'] = os.path.splitext(os.path.basename(obj['uri']))[0]

        for element in obj['elements']:
            element['final_result'] = "passed"
            element['flatten_steps'] = []

            for step in element['steps']:
                temp_dict = {}
                step['result'][step['result']['status']] = 1
                if step['result']['status'].lower() in ['fail', 'failed']:
                    element['final_result'] = "failed"

                temp_dict['feature_file'] = obj['feature_file']
                temp_dict['step_name'] = step['name']
                temp_dict['step_status'] = step['result']['status']
                temp_dict['step_duration'] = step['result'].get('duration', 0)
                temp_dict['step_' + step['result']['status']] = 1
                element['flatten_steps'].append(deepcopy(temp_dict))

            # Need to put the tag in OBJ and not ELEMENT
            if 'tags' in obj:
                element['tags'] = deepcopy(obj['tags'])
                for tag in obj['tags']:
                    element[tag['name']] = 1
            else:
                for tag in element['tags']:
                    element[tag['name']] = 1

    except Exception:  # pylint: disable=broad-except
        logging.error("Error in updating data, %s", sys.exc_info()[0])
        raise

    return obj