SEBA-89 Framework for fabric-crossconnect service
Change-Id: I65d8199b50703feaf828ca9bc251558ac2878fae
diff --git a/xos/synchronizer/config.yaml b/xos/synchronizer/config.yaml
new file mode 100644
index 0000000..adc2a63
--- /dev/null
+++ b/xos/synchronizer/config.yaml
@@ -0,0 +1,35 @@
+
+# Copyright 2017-present Open Networking Foundation
+#
+# 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.
+
+
+name: fabric-crossconnect
+required_models:
+ - FabricCrossconnectService
+ - FabricCrossconnectServiceInstance
+ - ServiceInstanceLink
+steps_dir: "/opt/xos/synchronizers/fabric-crossconnect/steps"
+model_policies_dir: "/opt/xos/synchronizers/fabric-crossconnect/model_policies"
+sys_dir: "/opt/xos/synchronizers/fabric-crossconnect/sys"
+models_dir: "/opt/xos/synchronizers/fabric-crossconnect/models"
+logging:
+ version: 1
+ handlers:
+ console:
+ class: logging.StreamHandler
+ loggers:
+ 'multistructlog':
+ handlers:
+ - console
+ level: DEBUG
diff --git a/xos/synchronizer/fabric-crossconnect-synchronizer.py b/xos/synchronizer/fabric-crossconnect-synchronizer.py
new file mode 100755
index 0000000..337472d
--- /dev/null
+++ b/xos/synchronizer/fabric-crossconnect-synchronizer.py
@@ -0,0 +1,35 @@
+#!/usr/bin/env python
+
+# Copyright 2017-present Open Networking Foundation
+#
+# 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.
+
+# This imports and runs ../../xos-observer.py
+
+import importlib
+import os
+import sys
+from xosconfig import Config
+
+base_config_file = os.path.abspath(os.path.dirname(os.path.realpath(__file__)) + '/config.yaml')
+mounted_config_file = os.path.abspath(os.path.dirname(os.path.realpath(__file__)) + '/mounted_config.yaml')
+
+if os.path.isfile(mounted_config_file):
+ Config.init(base_config_file, 'synchronizer-config-schema.yaml', mounted_config_file)
+else:
+ Config.init(base_config_file, 'synchronizer-config-schema.yaml')
+
+observer_path = os.path.join(os.path.dirname(os.path.realpath(__file__)),"../../synchronizers/new_base")
+sys.path.append(observer_path)
+mod = importlib.import_module("xos-synchronizer")
+mod.main()
diff --git a/xos/synchronizer/model_policies/model_policy_fabriccrossconnectserviceinstance.py b/xos/synchronizer/model_policies/model_policy_fabriccrossconnectserviceinstance.py
new file mode 100644
index 0000000..ea591dd
--- /dev/null
+++ b/xos/synchronizer/model_policies/model_policy_fabriccrossconnectserviceinstance.py
@@ -0,0 +1,45 @@
+
+# Copyright 2017-present Open Networking Foundation
+#
+# 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.
+
+
+from synchronizers.new_base.modelaccessor import FabricCrossconnectServiceInstance, model_accessor
+from synchronizers.new_base.policy import Policy
+from synchronizers.new_base.exceptions import *
+
+from xosconfig import Config
+from multistructlog import create_logger
+
+log = create_logger(Config().get('logging'))
+
+class FabricCrossconnectServiceInstancePolicy(Policy):
+ model_name = "FabricCrossconnectServiceInstance"
+
+ def handle_create(self, service_instance):
+ return self.handle_update(service_instance)
+
+ def handle_update(self, service_instance):
+ log.info("Handle_update Fabric Crossconnect Service Instance", service_instance=service_instance)
+
+ if (service_instance.link_deleted_count > 0) and (not service_instance.provided_links.exists()):
+ # If this instance has no links pointing to it, delete
+ self.handle_delete(service_instance)
+ if FabricCrossconnectServiceInstance.objects.filter(id=service_instance.id).exists():
+ service_instance.delete()
+ return
+
+ def handle_delete(self, service_instance):
+ log.info("Handle_delete Fabric-Crossconnect Service Instance", service_instance=service_instance)
+
+
diff --git a/xos/synchronizer/models/fabric-crossconnect.xproto b/xos/synchronizer/models/fabric-crossconnect.xproto
new file mode 100644
index 0000000..29b90e1
--- /dev/null
+++ b/xos/synchronizer/models/fabric-crossconnect.xproto
@@ -0,0 +1,13 @@
+option name = "fabric-crossconnect";
+option app_label = "fabric-crossconnect";
+
+message FabricCrossconnectService (Service){
+ option verbose_name = "Fabric Crossconnect Service";
+ option description="Fabric Crossconnect implementation";
+}
+
+
+message FabricCrossconnectServiceInstance (ServiceInstance){
+ option verbose_name = "Fabric Crossconnect Service Instance";
+ option owner_class_name="FabricCrossconnectService";
+}
diff --git a/xos/synchronizer/steps/sync_fabric_crossconnect_service_instance.py b/xos/synchronizer/steps/sync_fabric_crossconnect_service_instance.py
new file mode 100644
index 0000000..8f03075
--- /dev/null
+++ b/xos/synchronizer/steps/sync_fabric_crossconnect_service_instance.py
@@ -0,0 +1,114 @@
+# Copyright 2017-present Open Networking Foundation
+#
+# 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.
+
+from synchronizers.new_base.syncstep import SyncStep, DeferredException
+from synchronizers.new_base.modelaccessor import model_accessor, FabricCrossconnectServiceInstance, ServiceInstance
+
+from xosconfig import Config
+from multistructlog import create_logger
+import urllib
+import requests
+from requests.auth import HTTPBasicAuth
+
+
+class SyncFabricCrossconnectServiceInstance(SyncStep):
+ provides = [FabricCrossconnectServiceInstance]
+ log = create_logger(Config().get('logging'))
+
+ observes = FabricCrossconnectServiceInstance
+
+ @staticmethod
+ def format_url(url):
+ if 'http' in url:
+ return url
+ else:
+ return 'http://%s' % url
+
+ @staticmethod
+ def get_fabric_onos_info(si):
+
+ # get the fabric-crossconnect service
+ fabric_crossconnect = si.owner
+
+ # get the onos_fabric service
+ fabric_onos = [s.leaf_model for s in fabric_crossconnect.provider_services if "onos" in s.name.lower()]
+
+ if len(fabric_onos) == 0:
+ raise Exception('Cannot find ONOS service in provider_services of Fabric-Crossconnect')
+
+ fabric_onos = fabric_onos[0]
+
+ return {
+ 'url': SyncFabricCrossconnectServiceInstance.format_url("%s:%s" % (fabric_onos.rest_hostname, fabric_onos.rest_port)),
+ 'user': fabric_onos.rest_username,
+ 'pass': fabric_onos.rest_password
+ }
+
+ def get_bng_port(self, o):
+ # TODO(smbaker): Get BNG port from somewhere
+ return 2
+
+ def sync_record(self, o):
+ self.log.info("Sync'ing Fabric Crossconnect Service Instance", service_instance=o)
+
+ onos = self.get_fabric_onos_info(o)
+
+ si = ServiceInstance.objects.get(id=o.id)
+
+ s_tag = si.get_westbound_service_instance_properties("s_tag")
+ west_dpid = si.get_westbound_service_instance_properties("switch_datapath_id")
+ west_port = si.get_westbound_service_instance_properties("switch_port")
+ east_port = self.get_bng_port(o)
+
+ data = { "deviceId": west_dpid,
+ "vlanId": s_tag,
+ "ports": [ west_port, east_port ] }
+
+ url = onos['url'] + '/onos/segmentsrouting/xconnect'
+
+ self.log.info("Sending request to ONOS", url=url, body=data)
+
+ r = requests.post(url, json=data, auth=HTTPBasicAuth(onos['user'], onos['pass']))
+
+ if r.status_code != 200:
+ raise Exception("Failed to create fabric crossconnect in ONOS: %s" % r.text)
+
+ self.log.info("ONOS response", res=r.text)
+
+ def delete_record(self, o):
+ self.log.info("Deleting Fabric Crossconnect Service Instance", service_instance=o)
+
+ # TODO(smbaker): make sure it's not in use by some other subscriber
+
+ if o.enacted:
+ onos = self.get_fabric_onos_info(o)
+
+ si = ServiceInstance.objects.get(id=o.id)
+
+ # TODO(smbaker): unable to get westbound service_instance while deleting?
+
+ s_tag = si.get_westbound_service_instance_properties("s_tag")
+ west_dpid = si.get_westbound_service_instance_properties("switch_datapath_id")
+
+ data = { "deviceId": west_dpid,
+ "vlanID": s_tag }
+
+ url = onos['url'] + '/onos/segmentrouting/xconnect'
+
+ r = requests.delete(url, json=data, auth=HTTPBasicAuth(onos['user'], onos['pass']))
+
+ if r.status_code != 204:
+ raise Exception("Failed to remove fabric crossconnect in ONOS: %s" % r.text)
+
+ self.log.info("ONOS response", res=r.text)
diff --git a/xos/synchronizer/steps/test_sync_fabric_crossconnect_service_instance.py b/xos/synchronizer/steps/test_sync_fabric_crossconnect_service_instance.py
new file mode 100644
index 0000000..5140ea6
--- /dev/null
+++ b/xos/synchronizer/steps/test_sync_fabric_crossconnect_service_instance.py
@@ -0,0 +1,98 @@
+# Copyright 2017-present Open Networking Foundation
+#
+# 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.
+
+import unittest
+
+import functools
+from mock import patch, call, Mock, PropertyMock
+import requests_mock
+import multistructlog
+from multistructlog import create_logger
+
+import os, sys
+
+# Hack to load synchronizer framework
+test_path=os.path.abspath(os.path.dirname(os.path.realpath(__file__)))
+xos_dir=os.path.join(test_path, "../../..")
+if not os.path.exists(os.path.join(test_path, "new_base")):
+ xos_dir=os.path.join(test_path, "../../../../../../orchestration/xos/xos")
+ services_dir = os.path.join(xos_dir, "../../xos_services")
+sys.path.append(xos_dir)
+sys.path.append(os.path.join(xos_dir, 'synchronizers', 'new_base'))
+# END Hack to load synchronizer framework
+
+# generate model from xproto
+def get_models_fn(service_name, xproto_name):
+ name = os.path.join(service_name, "xos", xproto_name)
+ if os.path.exists(os.path.join(services_dir, name)):
+ return name
+ else:
+ name = os.path.join(service_name, "xos", "synchronizer", "models", xproto_name)
+ if os.path.exists(os.path.join(services_dir, name)):
+ return name
+ raise Exception("Unable to find service=%s xproto=%s" % (service_name, xproto_name))
+# END generate model from xproto
+
+def mock_get_westbound_service_instance_properties(prop):
+ if prop == "status":
+ return "enabled"
+ return prop
+
+def match_json(desired, req):
+ if desired!=req.json():
+ raise Exception("Got request %s, but body is not matching" % req.url)
+ return False
+ return True
+
+class TestSyncOLTDevice(unittest.TestCase):
+
+ def setUp(self):
+ global DeferredException
+
+ self.sys_path_save = sys.path
+ sys.path.append(xos_dir)
+ sys.path.append(os.path.join(xos_dir, 'synchronizers', 'new_base'))
+
+ # Setting up the config module
+ from xosconfig import Config
+ config = os.path.join(test_path, "../test_fabric_crossconnect_config.yaml")
+ Config.clear()
+ Config.init(config, "synchronizer-config-schema.yaml")
+ # END Setting up the config module
+
+ from synchronizers.new_base.mock_modelaccessor_build import build_mock_modelaccessor
+ build_mock_modelaccessor(xos_dir, services_dir, [get_models_fn("fabric-crossconnect", "fabric-crossconnect.xproto")])
+ import synchronizers.new_base.modelaccessor
+
+ from sync_fabric_crossconnect_service_instance import SyncFabricCrossconnectServiceInstance, model_accessor, DeferredException
+
+ # import all class names to globals
+ for (k, v) in model_accessor.all_model_classes.items():
+ globals()[k] = v
+
+
+ self.sync_step = SyncFabricCrossconnectServiceInstance
+ self.sync_step.log = Mock()
+
+ # TODO: stuff
+
+ def test_sync(self):
+ pass
+
+ def tearDown(self):
+ self.o = None
+ sys.path = self.sys_path_save
+
+if __name__ == '__main__':
+ unittest.main()
diff --git a/xos/synchronizer/test_fabric_crossconnect_config.yaml b/xos/synchronizer/test_fabric_crossconnect_config.yaml
new file mode 100644
index 0000000..2dede85
--- /dev/null
+++ b/xos/synchronizer/test_fabric_crossconnect_config.yaml
@@ -0,0 +1,29 @@
+
+# Copyright 2017-present Open Networking Foundation
+#
+# 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.
+
+name: test-fabric-crossconnect
+accessor:
+ username: xosadmin@opencord.org
+ password: "sample"
+ kind: "testframework"
+logging:
+ version: 1
+ handlers:
+ console:
+ class: logging.StreamHandler
+ loggers:
+ 'multistructlog':
+ handlers:
+ - console