Merge pull request #1415 from liangxin1300/20240507_corosync_parser_improve

corosync config parser minor changes

Author: liangxin1300

crmsh/corosync.py

@@ -23,6 +23,8 @@
 
 COROSYNC_TOKEN_DEFAULT = 1000  # in ms units
 COROSYNC_CONF_TEMPLATE = """
+# Generated by crmsh
+# For more details please see corosync.conf.5 man page
 totem {
     version: 2
 }

crmsh/corosync_config_format.py

@@ -8,12 +8,13 @@
 
 
 logger = logging.getLogger(__name__)
+COMMENT_PREFIX = '#comment'
 
 
 class Parser:
     """SAX-style parser for the configuration of corosync"""
 
-    _SPLIT_RE = re.compile('\\s*({|:|})\\s*')
+    _SPLIT_RE = re.compile('\\s*(#|{|:|})\\s*')
 
     def __init__(self, ifile):
         """Parse data form a file-like object."""
@@ -34,14 +35,15 @@ def _parse(self, ifile):
             line = line.strip()
             if not line:
                 continue
-            if line[0] == '#':
-                continue
             try:
                 tokens = self._tokenize(line)
             except ValueError as e:
                 raise MalformedLineException(lineno, line)
             logger.debug('tokens: %s', tokens)
-            if tokens[1] == '{':
+            if tokens[1] == '#':
+                fake_key = f'{COMMENT_PREFIX}_{lineno}'
+                self.on_key_value(fake_key, tokens[2])
+            elif tokens[1] == '{':
                 if not tokens[0] or tokens[2]:
                     raise MalformedLineException(lineno, line)
                 self.__section_stack.append(tokens[0])
@@ -231,15 +233,18 @@ def on_dict(self, node):
                     self.on_dict(value)
                     del self._path_stack[-1]
                     self.__write_indent(len(self._path_stack))
-                    self._ofile.write('}\n')
+                    self._ofile.write('}\n\n')
                 case list(_):
                     self._path_stack.append(key)
                     self.on_list(value)
                     del self._path_stack[-1]
                 case _:
                     self.__write_indent(len(self._path_stack))
-                    self._ofile.write(key)
-                    self._ofile.write(': ')
+                    if key.startswith(COMMENT_PREFIX):
+                        self._ofile.write('# ')
+                    else:
+                        self._ofile.write(key)
+                        self._ofile.write(': ')
                     self.on_value(value)
                     self._ofile.write('\n')
 
@@ -253,7 +258,7 @@ def on_list(self, node):
                     self._ofile.write(' {\n')
                     self.on_dict(item)
                     self.__write_indent(len(self._path_stack) - 1)
-                    self._ofile.write('}\n')
+                    self._ofile.write('}\n\n')
                 case list(_):
                     raise ValueError('list of list is invalid')
                 case _:

test/unittests/test_corosync_config_format.py

@@ -51,15 +51,24 @@ def test_unbalanced_brace(self):
 
 class TestDomParserWithUnusedFeature(TestCase):
     def test_list_of_scalar(self):
+        # list of scalar is not used in corosync.conf
         dom = DomParser(StringIO('''
-# list of scalar is not used in corosync.conf
 foo: a
 foo: b
 foo: c
         ''')).dom()
         self.assertDictEqual({'foo': ['a', 'b', 'c']}, dom)
 
 
+class TestDomParserWithComment(TestCase):
+    def test_with_comment(self):
+        dom = DomParser(StringIO('''
+# comment line one
+# comment line two
+        ''')).dom()
+        self.assertDictEqual({'#comment_1': 'comment line one', '#comment_2': 'comment line two'}, dom)
+
+
 class TestDomQueryGet(TestCase):
     def setUp(self) -> None:
         self.dom = {'scalar': {'scalar': 'value'}, 'vector': [{'scalar': 'value1'}, {'scalar': 'value2'}]}
@@ -188,12 +197,15 @@ def test_serialize(self):
                 '''scalar {
 \tscalar: value
 }
+
 vector {
 \tscalar: value1
 }
+
 vector {
 \tscalar: value2
 }
+
 ''',
 
                 buf.getvalue()
@@ -228,7 +240,9 @@ def test_serialize_list_of_scalar(self):
 
 class TestParseSerialize(TestCase):
     def test_parse_serialize(self):
-        data = '''totem {
+        data = '''# Generated by crmsh
+# Do not edit this file directly
+totem {
 \tversion: 2
 \tcluster_name: capybara
 \ttransport: knet
@@ -240,19 +254,24 @@ def test_parse_serialize(self):
 \tcrypto_cipher: aes256
 \tinterface {
 \t\tlinknumber: 0
+\t\t# knet_options
 \t\tknet_transport: udp
 \t\tknet_link_priority: 0
 \t}
+
 \tinterface {
 \t\tlinknumber: 1
 \t\tknet_transport: sctp
 \t}
+
 \tinterface {
 \t\tlinknumber: 2
 \t\tknet_transport: udp
 \t\tknet_link_priority: 10
 \t}
+
 }
+
 nodelist {
 \tnode {
 \t\tring0_addr: 192.168.1.101
@@ -261,31 +280,38 @@ def test_parse_serialize(self):
 \t\tnodeid: 1
 \t\tname: mynode1
 \t}
+
 \tnode {
 \t\tring0_addr: 192.168.1.102
 \t\tring1_addr: 192.168.10.2
 \t\tring2_addr: 192.168.9.2
 \t\tnodeid: 2
 \t\tname: mynode2
 \t}
+
 \tnode {
 \t\tring0_addr: 192.168.1.103
 \t\tring1_addr: 192.168.10.3
 \t\tring2_addr: 192.168.9.3
 \t\tnodeid: 3
 \t\tname: mynode3
 \t}
+
 \tnode {
 \t\tring0_addr: 192.168.1.104
 \t\tring1_addr: 192.168.10.4
 \t\tring2_addr: 192.168.9.4
 \t\tnodeid: 4
 \t\tname: mynode4
 \t}
+
 }
+
+# quorum section
 quorum {
 \tprovider: corosync_votequorum
 }
+
 logging {
 \tto_logfile: yes
 \tlogfile: /var/log/cluster/corosync.log
@@ -294,8 +320,11 @@ def test_parse_serialize(self):
 \t\tsubsys: KNET
 \t\tdebug: on
 \t}
+
 }
+
 '''
+        self.maxDiff = None
         buf = StringIO(data)
         dom = DomParser(buf).dom()
         buf = StringIO()