blob: 37ba3059e0fc2600293cb7778fadb517854734e8 [file] [log] [blame]
Khen Nursimulu8ffb8932017-01-26 13:40:49 -05001#!/usr/bin/env python
2#
3# Copyright 2017 the original author or authors.
4#
5# Licensed under the Apache License, Version 2.0 (the "License");
6# you may not use this file except in compliance with the License.
7# You may obtain a copy of the License at
8#
9# http://www.apache.org/licenses/LICENSE-2.0
10#
11# Unless required by applicable law or agreed to in writing, software
12# distributed under the License is distributed on an "AS IS" BASIS,
13# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14# See the License for the specific language governing permissions and
15# limitations under the License.
16#
17import structlog
18from netconf.nc_rpc.rpc import Rpc
19import netconf.nc_common.error as ncerror
20from twisted.internet.defer import inlineCallbacks, returnValue
21import dicttoxml
22from netconf.nc_common.utils import qmap, ns
23from netconf.constants import Constants as C
24from netconf.grpc_client.nc_rpc_mapper import \
25 get_nc_rpc_mapper_instance
26
27log = structlog.get_logger()
28
29
30class VolthaRpc(Rpc):
31 def __init__(self, request, request_xml, grpc_client, session,
32 capabilities):
33 super(VolthaRpc, self).__init__(request, request_xml, grpc_client,
34 session, capabilities)
35 self.service = None
36 self.method = None
37 self.metadata = None
38 self._extract_parameters()
39 if not self.rpc_response.is_error:
40 self._validate_parameters()
41
42 @inlineCallbacks
43 def execute(self):
44 if self.rpc_response.is_error:
45 returnValue(self.rpc_response)
46
47 log.info('voltha-rpc-request', session=self.session.session_id,
48 request=self.request)
49
50 # Execute the request
51 res_dict = yield self.grpc_client.invoke_voltha_rpc(
52 service=self.service,
53 method=self.method,
54 params=self.request['params'],
55 metadata=self.metadata)
56
57 # convert dict to xml
58 xml = dicttoxml.dicttoxml(res_dict, attr_type=True)
59 log.info('voltha-info', res=res_dict, xml=xml)
60
61 root_elem = self.get_root_element(xml)
62
63 # Build the yang response
64 self.rpc_response.node = self.rpc_response.build_yang_response(
65 root_elem, self.request, custom_rpc=True)
66 self.rpc_response.is_error = False
67
68 returnValue(self.rpc_response)
69
70 def _validate_parameters(self):
71 log.info('validate-parameters', session=self.session.session_id)
72 # For now just validate that the command is presenf
73 if self.request:
74 try:
75 if self.request['command'] is None:
76 self.rpc_response.is_error = True
77 self.rpc_response.node = ncerror.BadMsg(self.request_xml)
78 return
79
80 except Exception as e:
81 self.rpc_response.is_error = True
82 self.rpc_response.node = ncerror.ServerException(
83 self.request_xml)
84 return
85
86 def _extract_parameters(self):
87 try:
88 rpc_node = self.request_xml.find(''.join(
89 [qmap(C.VOLTHA),
90 self.request['command']])
91 )
92 self.request['params'] = {}
93 if rpc_node is not None:
94 for r in rpc_node:
95 self.request['params'][
96 r.tag.replace(qmap(C.VOLTHA), "")] = r.text
97
98 # Remove the subclass element in the request if it is present as
99 # it is not required for rpc calls
100 if self.request.has_key('subclass'):
101 self.request.pop('subclass', None)
102
103 # Extract the service and method from the rpc command
104 command = self.request['command'].split('-')
105 if len(command) != 2:
106 log.debug('invalid-format', command=self.request['command'])
107 raise
108
109 self.service = command[0]
110 self.method = command[1]
111 if self.request.has_key('metadata'):
112 self.metadata = self.request['metadata']
113
114 except Exception as e:
115 self.rpc_response.is_error = True
116 self.rpc_response.node = ncerror.BadMsg(self.request_xml)
117 log.exception('params-parsing-error', xml=self.request_xml, e=e)