allow to import and export xml client side

Author: oroulet

opcua/client/client.py

@@ -8,6 +8,8 @@
 
 from opcua import ua
 from opcua.client.ua_client import UaClient
+from opcua.common.xmlimporter import XmlImporter
+from opcua.common.xmlexporter import XmlExporter
 from opcua.common.node import Node
 from opcua.common.manage_nodes import delete_nodes
 from opcua.common.subscription import Subscription
@@ -502,4 +504,33 @@ def get_namespace_index(self, uri):
 
     def delete_nodes(self, nodes, recursive=False):
         return delete_nodes(self.uaclient, nodes, recursive)
-            
+
+    def import_xml(self, path):
+        """
+        Import nodes defined in xml
+        """
+        importer = XmlImporter(self)
+        return importer.import_xml(path)
+
+    def export_xml(self, nodes, path):
+        """
+        Export defined nodes to xml
+        """
+        exp = XmlExporter(self)
+        exp.build_etree(nodes)
+        return exp.write_xml(path)
+
+    def register_namespace(self, uri):
+        """
+        Register a new namespace. Nodes should in custom namespace, not 0.
+        This method is mainly implemented for symetry with server
+        """
+        ns_node = self.get_node(ua.NodeId(ua.ObjectIds.Server_NamespaceArray))
+        uries = ns_node.get_value()
+        if uri in uries:
+            return uries.index(uri)
+        uries.append(uri)
+        ns_node.set_value(uries)
+        return len(uries) - 1
+
+

opcua/client/ua_client.py

@@ -504,6 +504,16 @@ def add_nodes(self, nodestoadd):
         response.ResponseHeader.ServiceResult.check()
         return response.Results
 
+    def add_references(self, refs):
+        self.logger.info("add_references")
+        request = ua.AddReferencesRequest()
+        request.Parameters.ReferencesToAdd = refs
+        data = self._uasocket.send_request(request)
+        response = ua.AddReferencesResponse.from_binary(data)
+        self.logger.debug(response)
+        response.ResponseHeader.ServiceResult.check()
+        return response.Results
+
     def delete_nodes(self, params):
         self.logger.info("delete_nodes")
         request = ua.DeleteNodesRequest()

opcua/common/manage_nodes.py

@@ -334,7 +334,8 @@ def _create_method(parent, nodeid, qname, callback, inputs, outputs):
                         [_vtype_to_argument(vtype) for vtype in outputs],
                         varianttype=ua.VariantType.ExtensionObject,
                         datatype=ua.ObjectIds.Argument)
-    parent.server.add_method_callback(method.nodeid, callback)
+    if hasattr(parent.server, "add_method_callback"):
+        parent.server.add_method_callback(method.nodeid, callback)
     return results[0].AddedNodeId
 
 

opcua/common/xmlexporter.py

@@ -235,7 +235,7 @@ def add_variable_common(self, node, el):
             dtype_name = dtype.to_string()
         rank = node.get_value_rank()
         if rank != -1:
-            el.attrib["ValueRank"] = str(rank)
+            el.attrib["ValueRank"] = str(int(rank))
         dim = node.get_attribute(ua.AttributeIds.ArrayDimensions)
         if dim.Value.Value:
             el.attrib["ArrayDimensions"] = ",".join([str(i) for i in dim.Value.Value])

opcua/common/xmlimporter.py

@@ -6,8 +6,7 @@
 import uuid
 from copy import copy
 
-import dateutil.parser
-
+import opcua
 from opcua import ua
 from opcua.common import xmlparser
 
@@ -77,6 +76,18 @@ def import_xml(self, xmlpath):
                 continue
             nodes.append(node)
         return nodes
+
+    def _add_node(self, node):
+        if isinstance(self.server, opcua.server.server.Server):
+            return self.server.iserver.isession.add_nodes([node])
+        else:
+            return self.server.uaclient.add_nodes([node])
+
+    def _add_references(self, refs):
+        if isinstance(self.server, opcua.server.server.Server):
+            return self.server.iserver.isession.add_references(refs)
+        else:
+            return self.server.uaclient.add_references(refs)
 
     def make_objects(self, node_datas):
         new_nodes = []
@@ -142,7 +153,7 @@ def add_object(self, obj):
         attrs.DisplayName = ua.LocalizedText(obj.displayname)
         attrs.EventNotifier = obj.eventnotifier
         node.NodeAttributes = attrs
-        res = self.server.iserver.isession.add_nodes([node])
+        res = self._add_node(node)
         self._add_refs(obj)
         res[0].StatusCode.check()
         return res[0].AddedNodeId
@@ -155,7 +166,7 @@ def add_object_type(self, obj):
         attrs.DisplayName = ua.LocalizedText(obj.displayname)
         attrs.IsAbstract = obj.abstract
         node.NodeAttributes = attrs
-        res = self.server.iserver.isession.add_nodes([node])
+        res = self._add_node(node)
         self._add_refs(obj)
         res[0].StatusCode.check()
         return res[0].AddedNodeId
@@ -180,7 +191,7 @@ def add_variable(self, obj):
         if obj.dimensions:
             attrs.ArrayDimensions = obj.dimensions
         node.NodeAttributes = attrs
-        res = self.server.iserver.isession.add_nodes([node])
+        res = self._add_node(node)
         self._add_refs(obj)
         res[0].StatusCode.check()
         return res[0].AddedNodeId
@@ -232,7 +243,7 @@ def _add_variable_value(self, obj):
             for ext in obj.value:
                 extobj = self._make_ext_obj(ext)
                 values.append(extobj)
-            return values
+            return ua.Variant(values, ua.VariantType.ExtensionObject)
         elif obj.valuetype == 'ListOfGuid':
             return ua.Variant([
                 uuid.UUID(guid) for guid in obj.value
@@ -242,7 +253,7 @@ def _add_variable_value(self, obj):
             if hasattr(ua.ua_binary.Primitives, vtype):
                 return ua.Variant(obj.value, getattr(ua.VariantType, vtype))
             else:
-                return [getattr(ua, vtype)(v) for v in obj.value]
+                return ua.Variant([getattr(ua, vtype)(v) for v in obj.value])
         elif obj.valuetype == 'ExtensionObject':
             extobj = self._make_ext_obj(obj.value)
             return ua.Variant(extobj, getattr(ua.VariantType, obj.valuetype))
@@ -277,7 +288,7 @@ def add_variable_type(self, obj):
         if obj.dimensions:
             attrs.ArrayDimensions = obj.dimensions
         node.NodeAttributes = attrs
-        res = self.server.iserver.isession.add_nodes([node])
+        res = self._add_node(node)
         self._add_refs(obj)
         res[0].StatusCode.check()
         return res[0].AddedNodeId
@@ -297,7 +308,7 @@ def add_method(self, obj):
         if obj.dimensions:
             attrs.ArrayDimensions = obj.dimensions
         node.NodeAttributes = attrs
-        res = self.server.iserver.isession.add_nodes([node])
+        res = self._add_node(node)
         self._add_refs(obj)
         res[0].StatusCode.check()
         return res[0].AddedNodeId
@@ -315,7 +326,7 @@ def add_reference_type(self, obj):
         if obj.symmetric:
             attrs.Symmetric = obj.symmetric
         node.NodeAttributes = attrs
-        res = self.server.iserver.isession.add_nodes([node])
+        res = self._add_node(node)
         self._add_refs(obj)
         res[0].StatusCode.check()
         return res[0].AddedNodeId
@@ -329,7 +340,7 @@ def add_datatype(self, obj):
         if obj.abstract:
             attrs.IsAbstract = obj.abstract
         node.NodeAttributes = attrs
-        res = self.server.iserver.isession.add_nodes([node])
+        res = self._add_node(node)
         self._add_refs(obj)
         res[0].StatusCode.check()
         return res[0].AddedNodeId
@@ -346,7 +357,7 @@ def _add_refs(self, obj):
             ref.TargetNodeClass = ua.NodeClass.DataType
             ref.TargetNodeId = self._migrate_ns(self.to_nodeid(data.target))
             refs.append(ref)
-        self.server.iserver.isession.add_references(refs)
+        self._add_references(refs)
 
     def _sort_nodes_by_parentid(self, ndatas):
         """

opcua/server/server.py

@@ -17,13 +17,13 @@
 from opcua.server.event_generator import EventGenerator
 from opcua.common.node import Node
 from opcua.common.subscription import Subscription
-from opcua.common import xmlimporter
 from opcua.common.manage_nodes import delete_nodes
 from opcua.client.client import Client
 from opcua.crypto import security_policies
 from opcua.common.event_objects import BaseEvent
 from opcua.common.shortcuts import Shortcuts
 from opcua.common.xmlexporter import XmlExporter
+from opcua.common.xmlimporter import XmlImporter
 from opcua.common.ua_utils import get_nodes_of_namespace
 use_crypto = True
 try:
@@ -418,7 +418,7 @@ def import_xml(self, path):
         """
         Import nodes defined in xml
         """
-        importer = xmlimporter.XmlImporter(self)
+        importer = XmlImporter(self)
         return importer.import_xml(path)
 
     def export_xml(self, nodes, path):

tests/tests_client.py

@@ -11,7 +11,7 @@
 port_num1 = 48510
 
 
-class TestClient(unittest.TestCase, CommonTests, SubscriptionTests):
+class TestClient(unittest.TestCase, CommonTests, SubscriptionTests, XmlTests):
 
     '''
     Run common tests on client side

tests/tests_xml.py

@@ -24,7 +24,7 @@ class XmlTests(object):
     assertEqual = dir
 
     def test_xml_import(self):
-        self.srv.import_xml("tests/custom_nodes.xml")
+        self.opc.import_xml("tests/custom_nodes.xml")
         o = self.opc.get_objects_node()
         v = o.get_child(["1:MyXMLFolder", "1:MyXMLObject", "1:MyXMLVariable"])
         val = v.get_value()
@@ -52,9 +52,9 @@ def test_xml_import_additional_ns(self):
         self.srv.register_namespace('http://placeholder.toincrease.nsindex')  # if not already shift the new namespaces
 
         # "tests/custom_nodes.xml" isn't created with namespaces in mind, provide new test file
-        self.srv.import_xml("tests/custom_nodesns.xml")  # the ns=1 in to file now should be mapped to ns=2
+        self.opc.import_xml("tests/custom_nodesns.xml")  # the ns=1 in to file now should be mapped to ns=2
 
-        ns = self.srv.get_namespace_index("http://examples.freeopcua.github.io/")
+        ns = self.opc.get_namespace_index("http://examples.freeopcua.github.io/")
         o = self.opc.get_objects_node()
 
         o2 = o.get_child(["{0:d}:MyBaseObject".format(ns)])
@@ -102,7 +102,7 @@ def test_xml_vars(self):
         self.opc.register_namespace("tititi")
         self.opc.register_namespace("whatthexxx")
         o = self.opc.nodes.objects.add_object(2, "xmlexportobj")
-        v = o.add_variable(3, "myxmlvar", 6.78, ua.VariantType.Float)
+        v = o.add_variable(3, "myxmlvar", 6.78, ua.VariantType.Double)
         a = o.add_variable(3, "myxmlvar-array", [6, 1], ua.VariantType.UInt16)
         a2 = o.add_variable(3, "myxmlvar-2dim", [[1, 2], [3, 4]], ua.VariantType.UInt32)
         a3 = o.add_variable(3, "myxmlvar-2dim", [[]], ua.VariantType.ByteString)
@@ -113,7 +113,7 @@ def test_xml_vars(self):
         self.opc.import_xml("export-vars.xml")
 
         self.assertEqual(v.get_value(), 6.78)
-        self.assertEqual(v.get_data_type(), ua.NodeId(ua.ObjectIds.Float))
+        self.assertEqual(v.get_data_type(), ua.NodeId(ua.ObjectIds.Double))
 
         self.assertEqual(a.get_data_type(), ua.NodeId(ua.ObjectIds.UInt16))
         self.assertIn(a.get_value_rank(), (0, 1))
@@ -135,7 +135,6 @@ def test_xml_ns(self):
         ns_array = self.opc.get_namespace_array()
         if len(ns_array) < 3:
             self.opc.register_namespace("dummy_ns")
-        print("ARRAY", self.opc.get_namespace_array())
 
         ref_ns = self.opc.register_namespace("ref_namespace")
         new_ns = self.opc.register_namespace("my_new_namespace")
@@ -151,7 +150,6 @@ def test_xml_ns(self):
         o_bname = onew.add_object("ns={0};i=4000".format(new_ns), "{0}:BNAME".format(bname_ns))
 
         nodes = [o, o50, o200, onew, vnew, v_no_parent, o_bname]
-        print("CREATED", nodes, o_no_export)
         self.opc.export_xml(nodes, "export-ns.xml")
         # delete node and change index og new_ns before re-importing
         self.opc.delete_nodes(nodes)
@@ -165,10 +163,8 @@ def test_xml_ns(self):
         new_ns = self.opc.register_namespace("my_new_namespace")
 
         new_nodes = self.opc.import_xml("export-ns.xml")
-        print("NEW NODES", new_nodes)
 
         for i in [o, o50, o200]:
-            print(i)
             i.get_browse_name()
         with self.assertRaises(uaerrors.BadNodeIdUnknown):
             onew.get_browse_name()
@@ -179,11 +175,8 @@ def test_xml_ns(self):
         # get index of namespaces after import
         new_ns = self.opc.register_namespace("my_new_namespace")
         bname_ns = self.opc.register_namespace("bname_namespace")
-        print("ARRAY 2", self.opc.get_namespace_array())
 
-        print("NEW NS", new_ns, onew)
         onew.nodeid.NamespaceIndex = new_ns
-        print("OENE", onew)
         onew.get_browse_name()
         vnew2 = onew.get_children()[0]
         self.assertEqual(new_ns, vnew2.nodeid.NamespaceIndex)
@@ -313,7 +306,8 @@ def test_xml_enumvalues(self):
         self._test_xml_var_type(o, "enumvalues")
 
     def test_xml_custom_uint32(self):
-        t = self.opc.create_custom_data_type(2, 'MyCustomUint32', ua.ObjectIds.UInt32)
+        #t = self.opc.nodes. create_custom_data_type(2, 'MyCustomUint32', ua.ObjectIds.UInt32)
+        t = self.opc.get_node(ua.ObjectIds.UInt32).add_data_type(2, 'MyCustomUint32')
         o = self.opc.nodes.objects.add_variable(2, "xmlcustomunit32", 0, varianttype=ua.VariantType.UInt32, datatype=t.nodeid)
         self._test_xml_var_type(o, "cuint32")