fix: write content as-is without trailing new lines (#104)

**Issue:** while writing content into files, new lines are added after
every stanza and new property of a given stanza.
**Fix:** After all the things are written, there are 2 extra lines that
are added as a part of logic which moves the file seeker 2 places ahead,
hence we move back one character and remove the last character.
**Test:** updated the test case to write the content as is, as it should
be written to a file.

.gitignore

@@ -5,3 +5,5 @@ __pycache__
 .pytest_cache
 dist
 actionlint
+*.log
+events.pickle

addonfactory_splunk_conf_parser_lib.py

@@ -14,6 +14,8 @@
 # limitations under the License.
 #
 import configparser
+from os import SEEK_SET
+from typing import Any, Dict
 
 COMMENT_PREFIX = ";#*"
 COMMENT_KEY = "__COMMENTS__"
@@ -28,6 +30,10 @@ class TABConfigParser(configparser.RawConfigParser):
     3. Support multiline end with \
     """
 
+    _defaults: Dict[Any, Any]
+    _sections: Dict[Any, Any]
+    _optcre: Dict[Any, Any]
+
     def _read(self, fp, fpname):
         """
         Override the built-in _read() method to read comments
@@ -149,7 +155,8 @@ def _read(self, fp, fpname):
                 if isinstance(val, list):
                     options[name] = "\n".join(val)
 
-    def write(self, fp):
+    # As the type of fp is not defined in RawConfigParser which is the parent class so we have to go with Any.
+    def write(self, fp: Any, *args) -> None:
         """
         Override the write() method to write comments
         """
@@ -162,7 +169,6 @@ def write(self, fp):
         if hasattr(self, "fields_outside_stanza"):
             for field in self.fields_outside_stanza:
                 fp.write(field)
-
         if self._defaults:
             fp.write("[%s]\n" % DEFAULTSECT)
             for (key, value) in list(self._defaults.items()):
@@ -187,6 +193,10 @@ def write(self, fp):
             # write the separator line for stanza
             fp.write("\n")
 
+        # remove the trailing lines in a file, as the content should be written as-is
+        fp.seek(fp.tell() - 1, SEEK_SET)
+        fp.truncate()
+
     def optionxform(self, optionstr):
         return optionstr
 

pyproject.toml

@@ -44,6 +44,7 @@ keywords = ["splunk"]
 
 [tool.poetry.dependencies]
 python = "^3.7"
+configparser = "5.3.0"
 
 [tool.poetry.dev-dependencies]
 pytest = ">=7"

test_addonfactory_splunk_conf_parser_lib.py

@@ -83,8 +83,7 @@ def test_write(self):
         parser.read_string(conf)
         output = io.StringIO()
         parser.write(output)
-        expected_output = conf + "\n"
-        self.assertEqual(expected_output, output.getvalue())
+        self.assertEqual(conf, output.getvalue())
 
     def test_items(self):
         conf = """