From acc6e461a92b14091fef9f49514f26364579391d Mon Sep 17 00:00:00 2001
From: Christian Poessinger <christian@poessinger.com>
Date: Mon, 6 Sep 2021 12:09:57 +0200
Subject: vyos.util: add function to search a key recursively in a dictionary

data = {
    'interfaces': {'dummy': {'dum0': {'address': ['192.0.2.17/29']}},
                'ethernet': {'eth0': {'address': ['2001:db8::1/64', '192.0.2.1/29'],
                                      'description': 'Test123',
                                      'duplex': 'auto',
                                      'hw_id': '00:00:00:00:00:01',
                                      'speed': 'auto'},
                             'eth1': {'address': ['192.0.2.9/29'],
                                      'description': 'Test456',
                                      'duplex': 'auto',
                                      'hw_id': '00:00:00:00:00:02',
                                      'speed': 'auto'}}}
}

dict_search_recursive(data, 'hw_id') will yield both '00:00:00:00:00:01' and
'00:00:00:00:00:02' as generator object.
---
 src/tests/test_dict_search.py | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

(limited to 'src')

diff --git a/src/tests/test_dict_search.py b/src/tests/test_dict_search.py
index 991722f0f..1028437b2 100644
--- a/src/tests/test_dict_search.py
+++ b/src/tests/test_dict_search.py
@@ -16,13 +16,25 @@
 
 from unittest import TestCase
 from vyos.util import dict_search
+from vyos.util import dict_search_recursive
 
 data = {
     'string': 'fooo',
     'nested': {'string': 'bar', 'empty': '', 'list': ['foo', 'bar']},
     'non': {},
     'list': ['bar', 'baz'],
-    'dict': {'key_1': {}, 'key_2': 'vyos'}
+    'dict': {'key_1': {}, 'key_2': 'vyos'},
+    'interfaces': {'dummy': {'dum0': {'address': ['192.0.2.17/29']}},
+                'ethernet': {'eth0': {'address': ['2001:db8::1/64', '192.0.2.1/29'],
+                                      'description': 'Test123',
+                                      'duplex': 'auto',
+                                      'hw_id': '00:00:00:00:00:01',
+                                      'speed': 'auto'},
+                             'eth1': {'address': ['192.0.2.9/29'],
+                                      'description': 'Test456',
+                                      'duplex': 'auto',
+                                      'hw_id': '00:00:00:00:00:02',
+                                      'speed': 'auto'}}}
 }
 
 class TestDictSearch(TestCase):
@@ -63,3 +75,10 @@ class TestDictSearch(TestCase):
         # TestDictSearch: Return list items when querying nested list
         self.assertEqual(dict_search('nested.list', None), None)
         self.assertEqual(dict_search(None, data), None)
+
+    def test_dict_search_recursive(self):
+        # Test nested search in dictionary
+        tmp = list(dict_search_recursive(data, 'hw_id'))
+        self.assertEqual(len(tmp), 2)
+        tmp = list(dict_search_recursive(data, 'address'))
+        self.assertEqual(len(tmp), 3)
-- 
cgit v1.2.3