aboutsummaryrefslogtreecommitdiffstats
path: root/vnfs/vnf/vnf.py
blob: 3ad1dcda50da6e2c05a496d6d8914e32b09c07f9 (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
# Copyright 2015-2017 Intel Corporation.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

"""
Interface for VNF.
"""

import time
import pexpect
from tools import tasks

class IVnf(tasks.Process):

    """
    Interface for VNF.
    """

    _number_vnfs = 0

    def __init__(self):
        """
        Initialization method.

        Purpose of this method is to initialize all
        common Vnf data, no services should be started by
        this call (use ``start`` method instead).
        """
        self._number = IVnf._number_vnfs
        self._logger.debug('Initializing %s. VM with index %s',
                           self._number + 1, self._number)
        IVnf._number_vnfs = IVnf._number_vnfs + 1
        self._log_prefix = 'vnf_%d_cmd : ' % self._number
        self._login_active = False

    def stop(self):
        """
        Stops VNF instance.
        """
        if self.is_running():
            self._logger.info('Killing VNF...')

            # force termination of VNF and wait for it to terminate; It will avoid
            # sporadic reboot of host. (caused by hugepages or DPDK ports)
            super(IVnf, self).kill(signal='-9', sleep=10)

    def login(self, dummy_timeout=120):
        """
        Login to GUEST instance.

        This can be used after booting the machine

        :param timeout: Timeout to wait for login to complete.

        :returns: True if login is active
        """
        raise NotImplementedError()

    def execute(self, cmd, delay=0):
        """
        execute ``cmd`` with given ``delay``.

        This method makes asynchronous call to guest system
        and waits given ``delay`` before returning. Can be
        used with ``wait`` method to create synchronous call.

        :param cmd: Command to execute on guest system.
        :param delay: Delay (in seconds) to wait after sending
                      command before returning. Please note that
                      this value can be floating point which
                      allows to pass milliseconds.

        :returns: None.
        """
        self._logger.debug('%s%s', self._log_prefix, cmd)

        # ensure that output from previous commands is flushed
        try:
            while not self._child.expect(r'.+', timeout=0.1):
                pass
        except (pexpect.TIMEOUT, pexpect.EOF):
            pass

        self._child.sendline(cmd)
        time.sleep(delay)

    def wait(self, prompt='', timeout=30):
        """
        wait for ``prompt`` on guest system for given ``timeout``.

        This method ends based on two conditions:
        * ``prompt`` has been detected
        * ``timeout`` has been reached.

        :param prompt: method end condition. If ``prompt``
                             won't be detected during given timeout,
                             method will return False.
        :param timeout: Time to wait for prompt (in seconds).
                        Please note that this value can be floating
                        point which allows to pass milliseconds.

        :returns: output of executed command
        """
        self._child.expect(prompt, timeout=timeout)
        return self._child.before

    def execute_and_wait(self, cmd, timeout=30, prompt=''):
        """
        execute ``cmd`` with given ``timeout``.

        This method makes synchronous call to guest system
        and waits till ``cmd`` execution is finished
        (based on ``prompt value) or ''timeout'' has
        been reached.

        :param cmd: Command to execute on guest system.
        :param timeout: Timeout till the end of execution is not
                        detected.
        :param prompt: method end condition. If ``prompt``
                             won't be detected during given timeout,
                             method will return False. If no argument
                             or None value will be passed, default
                             ``prompt`` passed in __init__
                             method will be used.

        :returns: output of executed command
        """
        self.execute(cmd)
        return self.wait(prompt=prompt, timeout=timeout)

    def validate_start(self, _dummyresult):
        """ Validate call of VNF start()
        """
        if self._child and self._child.isalive():
            return True

        return False

    def validate_stop(self, result):
        """ Validate call of VNF stop()
        """
        return not self.validate_start(result)

    @staticmethod
    def validate_execute_and_wait(result, _dummy_cmd, _dummy_timeout=30, _dummy_prompt=''):
        """ Validate command execution within VNF
        """
        return len(result) > 0

    @staticmethod
    def validate_login(result):
        """ Validate successful login into guest
        """
        return result

    @staticmethod
    def reset_vnf_counter():
        """
        Reset internal VNF counters

        This method is static
        """
        IVnf._number_vnfs = 0