Exclude Polyspace defects with status "Not a Defect" or "Justified"; Add substitution of env variables for min/max possible for Robot and Polyspace

README.rst

@@ -324,6 +324,18 @@ For example, "run-time check" is the family of Code Prover and "defect" is the f
 The value of that key is a list, which contains the name of the column to check as a key and
 the value of that column to check together with ``min`` and ``max`` values.
 
+Note that all defects with one of the following statuses are excluded from the warnings and code quality report:
+
+- Justified
+- Not a Defect
+
+These statuses are used when you do not plan to fix your code in response to a result.
+The status "No Action Planned" is not listed because this is a default status if you do not explicitly specify
+a status in you annotation.
+More info can be found `on this help page`_.
+
+.. _`on this help page`: https://nl.mathworks.com/help/polyspace_access/ug/fix-or-comment-polyspace-results-web-browser.html
+
 Example Checks
 ^^^^^^^^^^^^^^
 

src/mlx/warnings/polyspace_checker.py

@@ -113,6 +113,20 @@ def return_check_limits(self):
             count += checker.return_check_limits()
         return count
 
+    def config_parser(self, config, name):
+        ''' Parsing configuration dict extracted by previously opened JSON or YAML file
+
+        Args:
+            config (dict): Content of configuration file
+        '''
+        try:
+            from .warnings import substitute_envvar
+
+            substitute_envvar(config, {'min', 'max'})
+            print("Config parsing for {name} completed".format(name=name))
+        except KeyError as err:
+            print("Incomplete config. Missing: {key}".format(key=err))
+
     def parse_config(self, config):
         """Parsing configuration dict extracted by previously opened JSON or yaml/yml file
 
@@ -145,6 +159,7 @@ def parse_config(self, config):
                     column_name = key.lower()
                     check_value = value.lower()
                     checker = PolyspaceFamilyChecker(family_value, column_name, check_value, verbose=self.verbose)
+                    self.config_parser(check, f"{family_value} ({column_name}:{check_value})")
                     checker.parse_config(check)
                     checker.cq_findings = self.cq_findings  # share object with sub-checkers
                     self.checkers.append(checker)
@@ -243,7 +258,7 @@ def add_code_quality_finding(self, row):
         if "line" in row:
             finding["location"]["positions"]["begin"]["line"] = row["line"]
         if "col" in row:
-            finding["location"]["positions"]["begin"]["column"] = row["line"]
+            finding["location"]["positions"]["begin"]["column"] = row["col"]
         finding["description"] = description
         exclude = ("new", "status", "severity", "comment", "key")
         row_without_key = [value for key, value in row.items() if key not in exclude]
@@ -258,13 +273,17 @@ def check(self, content):
             content (dict): The row of the TSV file
         '''
         if content[self.column_name].lower() == self.check_value:
-            tab_sep_string = "\t".join(content.values())
-            if not self._is_excluded(tab_sep_string):
-                self.count = self.count + 1
-                self.counted_warnings.append('family: {} -> {}: {}'.format(
-                    self.family_value,
-                    self.column_name,
-                    self.check_value
-                ))
-                if self.cq_enabled and content["color"].lower() != "green":
-                    self.add_code_quality_finding(content)
+            if content["status"].lower() in ["not a defect", "justified"]:
+                self.print_when_verbose("Excluded row {!r} because the status is 'Not a defect' or 'Justified'"
+                                        .format(content))
+            else:
+                tab_sep_string = "\t".join(content.values())
+                if not self._is_excluded(tab_sep_string):
+                    self.count = self.count + 1
+                    self.counted_warnings.append('family: {} -> {}: {}'.format(
+                        self.family_value,
+                        self.column_name,
+                        self.check_value
+                    ))
+                    if self.cq_enabled and content["color"].lower() != "green":
+                        self.add_code_quality_finding(content)

src/mlx/warnings/robot_checker.py

@@ -88,12 +88,27 @@ def return_check_limits(self):
             count += checker.return_check_limits()
         return count
 
+    def config_parser(self, config, name):
+        ''' Parsing configuration dict extracted by previously opened JSON or YAML file
+
+        Args:
+            config (dict): Content of configuration file
+        '''
+        try:
+            from .warnings import substitute_envvar
+
+            substitute_envvar(config, {'min', 'max'})
+            print("Config parsing for suite {name!r} completed".format(name=name))
+        except KeyError as err:
+            print("Incomplete config. Missing: {key}".format(key=err))
+
     def parse_config(self, config):
         self.checkers = []
         check_suite_name = config.get('check_suite_names', True)
         for suite_config in config['suites']:
             checker = RobotSuiteChecker(suite_config['name'], check_suite_name=check_suite_name,
                                         verbose=self.verbose)
+            self.config_parser(suite_config, suite_config['name'])
             checker.parse_config(suite_config)
             self.checkers.append(checker)
 

tests/test_in/config_example_polyspace_exclude.json

@@ -36,8 +36,8 @@
         "run-time check": [
             {
                 "color": "red",
-                "min": 0,
-                "max": 0
+                "min": "$MIN_POLY_WARNINGS",
+                "max": "${MAX_POLY_WARNINGS}"
             },
             {
                 "color": "orange",

tests/test_in/config_example_robot.json

@@ -45,8 +45,8 @@
             },
             {
                 "name": "b4d su1te name",
-                "min": 0,
-                "max": 0
+                "min": "$MIN_ROBOT_WARNINGS",
+                "max": "${MAX_ROBOT_WARNINGS}"
             }
         ]
     },

tests/test_in/polyspace.tsv

@@ -25,28 +25,28 @@ ID	Family	Group	Color	New	Check	Information	Function	File	Status	Severity	Commen
 22036	Run-time Check	Numerical	Green	no	Overflow		dummy_function()	dummy_file_name.c	Unreviewed	Unset		C4992326D32B4698C491	6	4
 22065	Run-time Check	Data flow	Green	no	Non-initialized local variable		dummy_function()	dummy_file_name.c	Unreviewed	Unset		C49953E693A45698C489	5	5
 22035	Run-time Check	Data flow	Green	no	Non-initialized local variable		dummy_function()	dummy_file_name.c	Unreviewed	Unset		C499232693A45698C491	5	6
-21989	Run-time Check	Numerical	Green	no	Overflow		dummy_function()	dummy_file_name.c	Unreviewed	Unset		C4997327D32B4698C881	6	7
+21989	Run-time Check	Numerical	Green	no	Overflow		dummy_function()	dummy_file_name.c	Not a defect	Unset		C4997327D32B4698C881	6	7
 19928	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.c	Unreviewed	Unset		62C8B1F4CA9126336A	6	8
-19962	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.c	Unreviewed	Unset		62D8A9F4CA91263472	7	9
+19962	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.c	Not a defect	Unset		62D8A9F4CA91263472	7	9
 19526	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.c	Unreviewed	Unset		66C899F4CA9126316A	7	10
 19424	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.h	Unreviewed	Unset		62E489F4CA91263262	6	11
-19429	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.h	Unreviewed	Unset		62E4A1F4CA91263162	6	2
+19429	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.h	Justified	Unset		62E4A1F4CA91263162	6	2
 19442	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.h	Unreviewed	Unset		62C091F4CA91263170	7	3
-19450	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.h	Unreviewed	Unset		62C091F4CA91263170	7	3
+19450	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.h	Justified	Unset		62C091F4CA91263170	7	3
 19375	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.c	Unreviewed	Unset		66C089F4CA9126326C	8	4
 19378	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.c	Unreviewed	Unset		66C091F4CA9126316E	8	5
 19377	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.c	Unreviewed	Unset		66C091F4CA9126336A	7	6
 19357	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.c	Unreviewed	Unset		66C8A9F4CA91263368	7	7
 19352	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.c	Unreviewed	Unset		66C8A9F4CA91263760	8	8
-19351	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.c	Unreviewed	Unset		66C8A9F4CA91263862	8	9
+19351	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.c	Justified	Unset		66C8A9F4CA91263862	8	9
 19355	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.c	Unreviewed	Unset		66C8A9F4CA91263962	9	10
 19354	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.c	Unreviewed	Unset		CC9153E995234C62C091	9	11
 19358	Run-time Check	Numerical	Orange	no	Overflow	Origin: Path related issue	dummy_function()	dummy_file_name.c	Unreviewed	Unset		CC9153E995234C62C0C1	8	3
 19360	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.c	Unreviewed	Unset		66C8B1F4CA91263262	8	4
 19349	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.c	Unreviewed	Unset		66C8C1F4CA91263262	9	5
 19345	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.c	Unreviewed	Unset		66C8C1F4CA91263470	9	6
 19344	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.c	Unreviewed	Unset		66C8C1F4CA91263572	10	7
-19339	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.c	Unreviewed	Unset		66CC91F4CA91263464	10	8
+19339	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.c	Not a defect	Unset		66CC91F4CA91263464	10	8
 19338	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.c	Unreviewed	Unset		66CC91F4CA91263468	9	9
 19336	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.c	Unreviewed	Unset		66CC91F4CA91263970	9	10
 19335	Run-time Check	Numerical	Orange	no	Overflow		dummy_function()	dummy_file_name.c	Unreviewed	Unset		CC9923E995234C62C0C9	10	11