adt: generalise walk over ADT objects

Not only packages, but other ADT objects can use walk function to discover its components. To limit the code redundancy I created a walk_step method which discovers components of the highest level.
jfilak · Jul 27, 2023 · a4df89e · a4df89e
1 parent 66c20d4
commit a4df89e
Show file tree

Hide file tree

Showing 3 changed files with 56 additions and 13 deletions.
diff --git a/sap/adt/package.py b/sap/adt/package.py
@@ -1,6 +1,5 @@
 """ABAP Package (DEV/C) ADT functionality module"""
 
-from types import SimpleNamespace
 from collections import deque
 
 # pylint: disable=unused-import
@@ -206,18 +205,7 @@ def walk(package):
 
     while toexplore:
         explored, path = toexplore.pop()
-        root_node = repository.read_node(explored)
-
-        subpackages = [subpkg.OBJECT_NAME for subpkg in root_node.objects]
-
-        nodekeys = [objtyp.NODE_ID for objtyp in root_node.types if objtyp.OBJECT_TYPE != 'DEVC/K']
-        if nodekeys:
-            objects_node = repository.read_node(explored, nodekeys=nodekeys)
-            objects = [SimpleNamespace(typ=obj.OBJECT_TYPE, name=obj.OBJECT_NAME, uri=obj.OBJECT_URI)
-                       for obj in objects_node.objects]
-        else:
-            objects = []
-
+        subpackages, objects = repository.walk_step(explored)
         toexplore.extendleft(((Package(package.connection, subpkg), path + [subpkg]) for subpkg in subpackages))
 
         yield (path, subpackages, objects)
diff --git a/sap/adt/repository.py b/sap/adt/repository.py
@@ -123,3 +123,19 @@ def read_node(self, adt_object, withdescr=False, nodekeys=None):
         xml.sax.parseString(resp.text, parser)
 
         return SimpleNamespace(objects=parser.tree_content, types=parser.object_types, categories=parser.categories)
+
+    def walk_step(self, adt_object, withdescr=False):
+        """Returns list of intermediate subpackages and objects"""
+
+        root_node = self.read_node(adt_object, withdescr=withdescr)
+        subpackages = [subpkg.OBJECT_NAME for subpkg in root_node.objects]
+
+        nodekeys = [objtyp.NODE_ID for objtyp in root_node.types if objtyp.OBJECT_TYPE != 'DEVC/K']
+        if nodekeys:
+            objects_node = self.read_node(adt_object, withdescr=withdescr, nodekeys=nodekeys)
+            objects = [SimpleNamespace(typ=obj.OBJECT_TYPE, name=obj.OBJECT_NAME, uri=obj.OBJECT_URI)
+                       for obj in objects_node.objects]
+        else:
+            objects = []
+
+        return subpackages, objects
diff --git a/test/unit/test_sap_adt_repository.py b/test/unit/test_sap_adt_repository.py
@@ -167,6 +167,45 @@ def test_read_node_not_unique_nodekeys(self):
 
         self.assertEqual(connection.execs[0].body, PACKAGE_SOURCE_LIBRARY_REQUEST_XML)
 
+    def test_walk_step(self):
+        subpackages = [SimpleNamespace(OBJECT_NAME='SUBPACKAGE1'), SimpleNamespace(OBJECT_NAME='SUBPACKAGE2')]
+        types = [SimpleNamespace(NODE_ID='000005', OBJECT_TYPE='CLAS/OC'),
+                 SimpleNamespace(NODE_ID='000011', OBJECT_TYPE='DEVC/K')]
+        first_call = SimpleNamespace(objects=subpackages, types=types)
+
+        objects = [SimpleNamespace(OBJECT_NAME='OBJECT1', OBJECT_TYPE='PROG', OBJECT_URI='URI'),
+                   SimpleNamespace(OBJECT_NAME='OBJECT2', OBJECT_TYPE='FUGR/F', OBJECT_URI='URI')]
+        second_call = SimpleNamespace(objects=objects)
+
+        self.patch('sap.adt.repository.Repository.read_node', side_effect=[first_call, second_call])
+
+        repository = sap.adt.Repository(None)
+        actual_subpackages, actual_objects = repository.walk_step('PACKAGE')
+
+        self.assertEqual(actual_subpackages, [subpackage.OBJECT_NAME for subpackage in subpackages])
+        self.assertEqual(actual_objects,
+                         [SimpleNamespace(typ=obj.OBJECT_TYPE, name=obj.OBJECT_NAME, uri=obj.OBJECT_URI) for obj in objects])
+
+    def test_walk_step_empty_nodekeys(self):
+        subpackages = [SimpleNamespace(OBJECT_NAME='SUBPACKAGE1'), SimpleNamespace(OBJECT_NAME='SUBPACKAGE2')]
+        types = [SimpleNamespace(NODE_ID='000005', OBJECT_TYPE='DEVC/K')]
+        first_call = SimpleNamespace(objects=subpackages, types=types)
+        self.patch('sap.adt.repository.Repository.read_node', side_effect=[first_call])
+
+        repository = sap.adt.Repository(None)
+        actual_subpackages, actual_objects = repository.walk_step('PACKAGE')
+
+        self.assertEqual(actual_subpackages, [subpackage.OBJECT_NAME for subpackage in subpackages])
+        self.assertEqual(actual_objects, [])
+
+    def test_walk_step_with_description(self):
+        fake_read_node = self.patch('sap.adt.repository.Repository.read_node')
+
+        repository = sap.adt.Repository(None)
+        repository.walk_step('PACKAGE', withdescr=True)
+
+        fake_read_node.assert_called_once_with('PACKAGE', withdescr=True)
+
 
 if __name__ == '__main__':
     unittest.main()