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
|
# Copyright (c) 2019 Cisco and/or its affiliates.
# 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.
"""Keywords used to connect to Honeycomb through Netconf, send messages
and receive replies."""
import socket
from time import time
import paramiko
from robot.api import logger
from resources.libraries.python.honeycomb.HoneycombUtil import HoneycombError
class Netconf(object):
"""Implements methods for creating and managing Netconf sessions."""
def __init__(self, delimiter=']]>]]>'):
"""Initializer.
Note: Passing the channel object as a robotframework argument closes
the channel. Class variables are used instead,
to persist the connection channel throughout test cases.
"""
self.client = None
self.channel = None
self.delimiter = delimiter
def create_session(self, node, hello, time_out=10):
"""Create an SSH session, connect to Honeycomb on the specified node,
open a communication channel to the Netconf subsystem and exchange hello
messages.
:param node: Honeycomb node.
:param hello: Hello message and capability list to be sent to Honeycomb.
:param time_out: Timeout value for the connection in seconds.
:type node: dict
:type hello: str
:type time_out: int
"""
start = time()
client = paramiko.SSHClient()
client.set_missing_host_key_policy(paramiko.AutoAddPolicy())
client.connect(node['host'],
username=node['honeycomb']['user'],
password=node['honeycomb']['passwd'],
pkey=None,
port=node['honeycomb']['netconf_port'],
timeout=time_out)
logger.trace('Connect took {0} seconds'.format(time() - start))
logger.debug('New ssh: {0}'.format(client))
logger.debug('Connect peer: {0}'.
format(client.get_transport().getpeername()))
logger.debug(client)
channel = client.get_transport().open_session()
channel.settimeout(time_out)
channel.set_combine_stderr(True)
channel.get_pty()
channel.invoke_subsystem("netconf")
logger.debug(channel)
self.client = client
self.channel = channel
# read OpenDaylight's hello message and capability list
self.get_response(
size=131072,
err="Timeout on getting hello message."
)
self.channel.send(hello)
if not self.channel.active:
raise HoneycombError("Channel closed on capabilities exchange.")
def get_response(self, size=4096, err="Unspecified Error."):
"""Iteratively read data from the receive buffer and catenate together
until message ends with the message delimiter, or
until timeout is reached.
:param size: Maximum number of bytes to read in one iteration.
:param err: Error message to provide when timeout is reached.
:type size: int
:type err: str
:returns: Content of response.
:rtype: str
:raises HoneycombError: If the read process times out.
"""
reply = ''
try:
while not reply.endswith(self.delimiter) or \
self.channel.recv_ready():
try:
chunk = self.channel.recv(size)
if not chunk:
break
reply += chunk
if self.channel.exit_status_ready():
logger.debug('Channel exit status ready.')
break
except socket.timeout:
raise HoneycombError("Socket timeout.",
enable_logging=False)
except RuntimeError:
raise HoneycombError(err + " Content of buffer: {0}".format(reply),
enable_logging=False)
logger.trace(reply)
return reply.replace(self.delimiter, "")
def get_all_responses(self, size=4096):
"""Read responses from the receive buffer and catenate together
until a read operation times out.
:param size: Maximum number of bytes to read in one iteration.
:type size: int
:returns: Content of response.
:rtype: str
"""
response = ""
err = "Expected timeout occurred."
while True:
try:
response += self.get_response(size, err)
except HoneycombError:
break
return response
def send(self, message, **params):
"""Sends provided message through the channel.
:param message: Message to be sent to Honeycomb.
:param params: Format the message string with these parameters.
:type message: str
:type params: dict
"""
message = message.format(**params)
if not message.endswith(self.delimiter):
message += self.delimiter
logger.debug(message)
self.channel.send(message)
|
