Merge pull request #269 from test-fullautomation/namsonx/task/stabi_b…

…ranch Namsonx/task/stabi branch
test-fullautomation · Apr 11, 2024 · 60a8d00 · 60a8d00
2 parents e330c63 + 24b714f
commit 60a8d00
Show file tree

Hide file tree

Showing 6 changed files with 24 additions and 11 deletions.
diff --git a/RobotFramework_TestsuitesManagement/Config/CConfig.py b/RobotFramework_TestsuitesManagement/Config/CConfig.py
@@ -328,9 +328,9 @@ def loadCfg(self):
         except Exception as error:
             CConfig.bLoadedCfg = False
             CConfig.sLoadedCfgError = ''
-            for item in str(error).split(': \''):
-                CConfig.sLoadedCfgError += f"{item}\n                  "
-            logger.error(f"Loading of JSON configuration file failed! Reason: {CConfig.sLoadedCfgError}")
+            for line in str(error).splitlines():
+                logger.error(f"{line}") # outcome: every single line starts with timestamp and log level
+                CConfig.sLoadedCfgError += f"{line}\n                  " # to be compatible with original version
             BuiltIn().unknown('Loading of JSON configuration file failed!')
             raise Exception
 
@@ -534,9 +534,10 @@ def __loadConfigFileLevel2(self) -> bool:
         except Exception as error:
             CConfig.bLoadedCfg = False
             CConfig.sLoadedCfgError = ''
-            for item in str(error).split(': \''):
-                CConfig.sLoadedCfgError += f"'{item}', "
-            logger.error(f"Loading of JSON configuration file failed! Reason: {CConfig.sLoadedCfgError}")
+            for line in str(error).splitlines():
+                logger.error(f"{line}") # outcome: every single line starts with timestamp and log level
+                CConfig.sLoadedCfgError += f"{line}\n                  " # to be compatible with original version / but when the error is already logged, for what do we need to store the error message in sLoadedCfgError?
+            logger.error('Loading of JSON configuration file failed!')
             return False
         sListOfVariants = ''
         for item in list(oSuiteConfig.keys()):

diff --git a/RobotFramework_TestsuitesManagement/RobotFramework_TestsuitesManagement.pdf b/RobotFramework_TestsuitesManagement/RobotFramework_TestsuitesManagement.pdf
diff --git a/RobotFramework_TestsuitesManagement/version.py b/RobotFramework_TestsuitesManagement/version.py
@@ -18,5 +18,5 @@
 #
 # Version and date of package RobotFramework_TestsuitesManagement
 #
-VERSION      = "0.7.6"
-VERSION_DATE = "01.04.2024"
+VERSION      = "0.7.7"
+VERSION_DATE = "10.04.2024"
diff --git a/config/robotframework_aio/release_items_RobotFramework_TestsuitesManagement.json b/config/robotframework_aio/release_items_RobotFramework_TestsuitesManagement.json
@@ -82,6 +82,15 @@
   | ``\u007d``
 
   Finally, the value of ``var1`` is 2 and the value of ``var2`` is 3.
+
+* Extended debugging support:
+
+  In case of JSON syntax errors in configuration files, the **Robot Framework** log files contain an extract of the JSON content nearby the position, where the error occurred.
+  Line breaks in JSON content are replaced by '``\\n``' in log output.
+
+  | ``ERROR - Expecting ',' delimiter: line 10 column 1 (char 246)``
+  | ``ERROR - Nearby: '... arams\" : \u007b\\n              \"global\": \u007b\\n\"param1\" : 1\\n\"param2\" : 2\\n        ...'``
+
 "
                             ]
                 }

diff --git a/packagedoc/additional_docs/History.tex b/packagedoc/additional_docs/History.tex
@@ -50,4 +50,7 @@
 \historychange{- Added naming convention check for parameter names.\newline
 - Updated logging message.}
 
+\historyversiondate{0.7.7}{04/2024}
+\historychange{Extended debugging support. In case of JSON syntax errors in configuration files, the Robot Framework log files contain an extract of the JSON content nearby the position, where the error occurred.}
+
 \end{packagehistory}
diff --git a/test/testtools/GenSnippetsTSM.py b/test/testtools/GenSnippetsTSM.py
@@ -22,8 +22,8 @@
 #
 # **************************************************************************************************************
 #
-VERSION      = "0.2.0"
-VERSION_DATE = "19.03.2024"
+VERSION      = "0.2.1"
+VERSION_DATE = "10.04.2024"
 #
 # **************************************************************************************************************
 
@@ -325,7 +325,7 @@ def __init__(self, oConfig=None, oCounter=None, oLogger=None):
       # error indicators, used while parsing relevant content from Robot Framework debug log file and used to define the text color
       self.__listErrorIndicators = ["ERROR", "Error", "error", "UNKNOWN", "unknown", "FAIL", "failed", "AssertionError",
                                     "Expecting", "expecting", "Expected", "expected", "Unexpected", "unexpected", "Invalid", "invalid", "Reason",
-                                    "not found", "have to be", "does not support", "No closing quotation", "Missing", "missing"]
+                                    "not found", "have to be", "does not support", "No closing quotation", "Missing", "missing", "Nearby"]
 
       # filter strings, used while parsing relevant content from Robot Framework debug log file
       self.__sInfoIndicators  = ";".join(self.__listInfoIndicators)