Khen Nursimulu | a7b842a | 2016-12-03 23:28:42 -0500 | [diff] [blame] | 1 | #!/usr/bin/env python |
| 2 | # |
| 3 | # Copyright 2016 the original author or authors. |
| 4 | # |
| 5 | # Code adapted from https://github.com/choppsv1/netconf |
| 6 | # |
| 7 | # Licensed under the Apache License, Version 2.0 (the "License"); |
| 8 | # you may not use this file except in compliance with the License. |
| 9 | # You may obtain a copy of the License at |
| 10 | # |
| 11 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 12 | # |
| 13 | # Unless required by applicable law or agreed to in writing, software |
| 14 | # distributed under the License is distributed on an "AS IS" BASIS, |
| 15 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 16 | # See the License for the specific language governing permissions and |
| 17 | # limitations under the License. |
| 18 | # |
| 19 | import structlog |
| 20 | from base.commit import Commit |
| 21 | from base.copy_config import CopyConfig |
| 22 | from base.delete_config import DeleteConfig |
| 23 | from base.discard_changes import DiscardChanges |
| 24 | from base.edit_config import EditConfig |
| 25 | from base.get import Get |
| 26 | from base.get_config import GetConfig |
| 27 | from base.lock import Lock |
| 28 | from base.unlock import UnLock |
| 29 | from base.close_session import CloseSession |
| 30 | from base.kill_session import KillSession |
Khen Nursimulu | aaac7ee | 2016-12-11 22:03:52 -0500 | [diff] [blame] | 31 | from ext.get_voltha import GetVoltha |
Khen Nursimulu | a7b842a | 2016-12-03 23:28:42 -0500 | [diff] [blame] | 32 | from netconf import NSMAP, qmap |
| 33 | import netconf.nc_common.error as ncerror |
Khen Nursimulu | e0d53f8 | 2016-12-14 11:05:44 -0800 | [diff] [blame^] | 34 | |
Khen Nursimulu | a7b842a | 2016-12-03 23:28:42 -0500 | [diff] [blame] | 35 | log = structlog.get_logger() |
Khen Nursimulu | 3b21294 | 2016-12-12 23:09:53 -0500 | [diff] [blame] | 36 | from lxml import etree |
| 37 | |
Khen Nursimulu | a7b842a | 2016-12-03 23:28:42 -0500 | [diff] [blame] | 38 | |
| 39 | class RpcFactory: |
Khen Nursimulu | e0d53f8 | 2016-12-14 11:05:44 -0800 | [diff] [blame^] | 40 | instance = None |
Khen Nursimulu | a7b842a | 2016-12-03 23:28:42 -0500 | [diff] [blame] | 41 | |
Khen Nursimulu | e0d53f8 | 2016-12-14 11:05:44 -0800 | [diff] [blame^] | 42 | def __init__(self): |
| 43 | self.rpc_map = {} |
| 44 | # TODO: This will be loaded after the yang modules have been |
| 45 | # generated from proto files |
| 46 | self.register_rpc('{urn:opencord:params:xml:ns:voltha:ietf-voltha}', |
| 47 | 'VolthaGlobalService', 'GetVoltha', GetVoltha) |
| 48 | self.register_rpc('{urn:opencord:params:xml:ns:voltha:ietf-voltha}', |
| 49 | 'any', 'any', GetVoltha) |
Khen Nursimulu | a7b842a | 2016-12-03 23:28:42 -0500 | [diff] [blame] | 50 | |
Khen Nursimulu | e0d53f8 | 2016-12-14 11:05:44 -0800 | [diff] [blame^] | 51 | def _get_key(self, namespace, service, name): |
| 52 | return ''.join([namespace, service, name]) |
Khen Nursimulu | 3b21294 | 2016-12-12 23:09:53 -0500 | [diff] [blame] | 53 | |
Khen Nursimulu | e0d53f8 | 2016-12-14 11:05:44 -0800 | [diff] [blame^] | 54 | def register_rpc(self, namespace, service, name, klass): |
| 55 | key = self._get_key(namespace, service, name) |
| 56 | if key not in self.rpc_map.keys(): |
| 57 | self.rpc_map[key] = klass |
Khen Nursimulu | 3b21294 | 2016-12-12 23:09:53 -0500 | [diff] [blame] | 58 | |
Khen Nursimulu | e0d53f8 | 2016-12-14 11:05:44 -0800 | [diff] [blame^] | 59 | def get_handler(self, namespace, service, name): |
| 60 | key = self._get_key(namespace, service, name) |
| 61 | if key in self.rpc_map.keys(): |
| 62 | return self.rpc_map[key] |
Khen Nursimulu | 3b21294 | 2016-12-12 23:09:53 -0500 | [diff] [blame] | 63 | |
Khen Nursimulu | e0d53f8 | 2016-12-14 11:05:44 -0800 | [diff] [blame^] | 64 | def get_rpc_handler(self, rpc_node, msg, grpc_channel, session): |
| 65 | try: |
| 66 | msg_id = rpc_node.get('message-id') |
| 67 | log.info("Received-rpc-message-id", msg_id=msg_id) |
Khen Nursimulu | 3b21294 | 2016-12-12 23:09:53 -0500 | [diff] [blame] | 68 | |
Khen Nursimulu | e0d53f8 | 2016-12-14 11:05:44 -0800 | [diff] [blame^] | 69 | except (TypeError, ValueError): |
| 70 | raise ncerror.SessionError(msg, |
| 71 | "No valid message-id attribute found") |
Khen Nursimulu | 3b21294 | 2016-12-12 23:09:53 -0500 | [diff] [blame] | 72 | |
Khen Nursimulu | e0d53f8 | 2016-12-14 11:05:44 -0800 | [diff] [blame^] | 73 | log.info("rpc-node", node=etree.tostring(rpc_node, pretty_print=True)) |
Khen Nursimulu | a7b842a | 2016-12-03 23:28:42 -0500 | [diff] [blame] | 74 | |
Khen Nursimulu | e0d53f8 | 2016-12-14 11:05:44 -0800 | [diff] [blame^] | 75 | # Get the first child of rpc as the method name |
| 76 | rpc_method = rpc_node.getchildren() |
| 77 | if len(rpc_method) != 1: |
| 78 | log.error("badly-formatted-rpc-method", msg_id=msg_id) |
| 79 | raise ncerror.BadMsg(rpc_node) |
Khen Nursimulu | a7b842a | 2016-12-03 23:28:42 -0500 | [diff] [blame] | 80 | |
Khen Nursimulu | e0d53f8 | 2016-12-14 11:05:44 -0800 | [diff] [blame^] | 81 | rpc_method = rpc_method[0] |
Khen Nursimulu | 3b21294 | 2016-12-12 23:09:53 -0500 | [diff] [blame] | 82 | |
Khen Nursimulu | e0d53f8 | 2016-12-14 11:05:44 -0800 | [diff] [blame^] | 83 | if rpc_method.prefix is None: |
| 84 | log.error("rpc-method-has-no-prefix", msg_id=msg_id) |
| 85 | raise ncerror.BadMsg(rpc_node) |
Khen Nursimulu | a7b842a | 2016-12-03 23:28:42 -0500 | [diff] [blame] | 86 | |
Khen Nursimulu | e0d53f8 | 2016-12-14 11:05:44 -0800 | [diff] [blame^] | 87 | try: |
| 88 | # extract the namespace, service and name |
| 89 | namespace = ''.join( |
| 90 | ['{', rpc_method.nsmap[rpc_method.prefix], '}']) |
| 91 | # rpc_name = rpc_method.tag.replace(qmap('nc'), "") |
| 92 | rpc = rpc_method.tag.replace(namespace, "").split('-') |
| 93 | rpc_service = rpc[0] |
| 94 | rpc_name = rpc[1] |
| 95 | log.info("rpc-request", |
| 96 | namespace=namespace, |
| 97 | service=rpc_service, |
| 98 | name=rpc_name) |
| 99 | except Exception as e: |
| 100 | log.error("rpc-parsing-error", exception=repr(e)) |
| 101 | raise ncerror.BadMsg(rpc_node) |
Khen Nursimulu | a7b842a | 2016-12-03 23:28:42 -0500 | [diff] [blame] | 102 | |
Khen Nursimulu | e0d53f8 | 2016-12-14 11:05:44 -0800 | [diff] [blame^] | 103 | class_handler = self.get_handler(namespace, rpc_service, rpc_name) |
| 104 | if class_handler is None: |
| 105 | # TODO: for now just assume anything in voltha namespace will be |
| 106 | # handled by the same api |
| 107 | class_handler = self.get_handler(namespace, 'any', 'any') |
Khen Nursimulu | a7b842a | 2016-12-03 23:28:42 -0500 | [diff] [blame] | 108 | |
Khen Nursimulu | e0d53f8 | 2016-12-14 11:05:44 -0800 | [diff] [blame^] | 109 | voltha_method_ref = ''.join([rpc_service, '-', rpc_name]) |
| 110 | if class_handler is not None: |
| 111 | return class_handler(rpc_node, rpc_method, voltha_method_ref, |
| 112 | grpc_channel, session) |
Khen Nursimulu | a7b842a | 2016-12-03 23:28:42 -0500 | [diff] [blame] | 113 | |
Khen Nursimulu | e0d53f8 | 2016-12-14 11:05:44 -0800 | [diff] [blame^] | 114 | log.error("rpc-not-implemented", rpc=rpc_name) |
Khen Nursimulu | 3b21294 | 2016-12-12 23:09:53 -0500 | [diff] [blame] | 115 | |
Khen Nursimulu | e0d53f8 | 2016-12-14 11:05:44 -0800 | [diff] [blame^] | 116 | rpc_class_handlers = { |
| 117 | 'getvoltha': GetVoltha, |
| 118 | 'get-config': GetConfig, |
| 119 | 'get': Get, |
| 120 | 'edit-config': EditConfig, |
| 121 | 'copy-config': CopyConfig, |
| 122 | 'delete-config': DeleteConfig, |
| 123 | 'commit': Commit, |
| 124 | 'lock': Lock, |
| 125 | 'unlock': UnLock, |
| 126 | 'close-session': CloseSession, |
| 127 | 'kill-session': KillSession |
| 128 | } |
Khen Nursimulu | a7b842a | 2016-12-03 23:28:42 -0500 | [diff] [blame] | 129 | |
Khen Nursimulu | 3b21294 | 2016-12-12 23:09:53 -0500 | [diff] [blame] | 130 | |
Khen Nursimulu | a7b842a | 2016-12-03 23:28:42 -0500 | [diff] [blame] | 131 | def get_rpc_factory_instance(): |
Khen Nursimulu | e0d53f8 | 2016-12-14 11:05:44 -0800 | [diff] [blame^] | 132 | if RpcFactory.instance == None: |
| 133 | RpcFactory.instance = RpcFactory() |
| 134 | return RpcFactory.instance |
Khen Nursimulu | a7b842a | 2016-12-03 23:28:42 -0500 | [diff] [blame] | 135 | |
Khen Nursimulu | aaac7ee | 2016-12-11 22:03:52 -0500 | [diff] [blame] | 136 | |
| 137 | if __name__ == '__main__': |
Khen Nursimulu | e0d53f8 | 2016-12-14 11:05:44 -0800 | [diff] [blame^] | 138 | fac = get_rpc_factory_instance() |
| 139 | fac.register_rpc('urn:opencord:params:xml:ns:voltha:ietf-voltha', |
| 140 | 'VolthaGlobalService', 'GetVoltha', GetVoltha) |
| 141 | rpc = fac.get_handler('urn:opencord:params:xml:ns:voltha:ietf-voltha', |
| 142 | 'VolthaGlobalService', 'GetVoltha') |
| 143 | # rpc = fac.rpc_class_handlers.get('getvoltha', None) |
| 144 | print rpc(None, None, None, None) |