summaryrefslogtreecommitdiffstats
path: root/modules/opnfv/utils/ovs_logger.py
blob: 2107bdc35bd173c48982e5e2455af0d8e62d049f (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
##############################################################################
# Copyright (c) 2015 Ericsson AB and others.
# Author: George Paraskevopoulos (geopar@intracom-telecom.com)
# 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
##############################################################################

import opnfv.utils.opnfv_logger as OPNFVLogger
import os
import time
import shutil

logger = OPNFVLogger.Logger('ovs_logger').getLogger()


class OVSLogger(object):

    def __init__(self, basedir, ft_resdir):
        self.ovs_dir = basedir
        self.ft_resdir = ft_resdir
        self.__mkdir_p(self.ovs_dir)
        self.__mkdir_p(self.ft_resdir)

    def __mkdir_p(self, dirpath):
        if not os.path.exists(dirpath):
            os.makedirs(dirpath)

    def __ssh_host(self, ssh_conn):
        try:
            _, stdout, _ = ssh_conn.exec_command('hostname')
            found_host = stdout.readline()
            return found_host
        except Exception as e:
            logger.error(e)

    def __dump_to_file(self, operation, host, text, timestamp=None):
        ts = (timestamp if timestamp is not None
              else time.strftime("%Y%m%d-%H%M%S"))
        dumpdir = os.path.join(self.ovs_dir, ts)
        self.__mkdir_p(dumpdir)
        fname = '{0}_{1}'.format(operation, host)
        with open(os.path.join(dumpdir, fname), 'w') as f:
            f.write(text)

    def __remote_cmd(self, ssh_conn, cmd):
        try:
            _, stdout, stderr = ssh_conn.exec_command(cmd)
            errors = stderr.readlines()
            if len(errors) > 0:
                host = self.__ssh_host(ssh_conn)
                logger.error(''.join(errors))
                raise Exception('Could not execute {0} in {1}'
                                .format(cmd, host))
            output = ''.join(stdout.readlines())
            return output
        except Exception as e:
            logger.error('[__remote_command(ssh_client, {0})]: {1}'
                         .format(cmd, e))
            return None

    def create_artifact_archive(self):
        shutil.make_archive(self.ovs_dir,
                            'zip',
                            root_dir=os.path.dirname(self.ovs_dir),
                            base_dir=self.ovs_dir)
        shutil.copy2('{0}.zip'.format(self.ovs_dir), self.ft_resdir)

    def ofctl_dump_flows(self, ssh_conn, br='br-int',
                         choose_table=None, timestamp=None):
        try:
            cmd = 'sudo ovs-ofctl -OOpenFlow13 dump-flows {0}'.format(br)
            if choose_table is not None:
                cmd = '{0} table={1}'.format(cmd, choose_table)
            output = self.__remote_cmd(ssh_conn, cmd)
            operation = 'ofctl_dump_flows'
            host = self.__ssh_host(ssh_conn)
            self.__dump_to_file(operation, host, output, timestamp=timestamp)
            return output
        except Exception as e:
            logger.error('[ofctl_dump_flows(ssh_client, {0}, {1})]: {2}'
                         .format(br, choose_table, e))
            return None

    def vsctl_show(self, ssh_conn, timestamp=None):
        try:
            cmd = 'sudo ovs-vsctl show'
            output = self.__remote_cmd(ssh_conn, cmd)
            operation = 'vsctl_show'
            host = self.__ssh_host(ssh_conn)
            self.__dump_to_file(operation, host, output, timestamp=timestamp)
            return output
        except Exception as e:
            logger.error('[vsctl_show(ssh_client)]: {0}'.format(e))
            return None

    def dump_ovs_logs(self, controller_clients, compute_clients,
                      related_error=None, timestamp=None):
        """
        delete controller_clients argument because
        that was producing an error in XCI installer.

        For more information see:
        TODO: https://jira.opnfv.org/browse/RELENG-314
        """
        del controller_clients
        if timestamp is None:
            timestamp = time.strftime("%Y%m%d-%H%M%S")
        # clients = controller_clients + compute_clients
        clients = compute_clients
        for client in clients:
            self.ofctl_dump_flows(client, timestamp=timestamp)
            self.vsctl_show(client, timestamp=timestamp)

        if related_error is not None:
            dumpdir = os.path.join(self.ovs_dir, timestamp)
            self.__mkdir_p(dumpdir)
            with open(os.path.join(dumpdir, 'error'), 'w') as f:
                f.write(related_error)