Add framework for Suppressions (#98)

* Add new Suppression class
* Suppression also has a new Status class
* Extend Result class to possibly return a list of suppressions

Note: not in use yet

Signed-off-by: Eric Brown <eric.brown@securesauce.dev>

Author: ericwb

precli/core/result.py

@@ -4,6 +4,7 @@
 from precli.core.level import Level
 from precli.core.location import Location
 from precli.core.rule import Rule
+from precli.core.suppression import Suppression
 
 
 class Result:
@@ -15,6 +16,7 @@ def __init__(
         location: Location = None,
         message: str = None,
         fixes: list[Fix] = None,
+        suppressions: list[Suppression] = None,
     ):
         self._rule_id = rule_id
         self._kind = kind
@@ -30,6 +32,7 @@ def __init__(
         else:
             self._message = Rule.get_by_id(self._rule_id).message
         self._fixes = fixes if fixes is not None else []
+        self._suppressions = suppressions if suppressions is not None else []
 
     @property
     def rule_id(self) -> str:
@@ -111,3 +114,13 @@ def fixes(self) -> list[Fix]:
         :rtype: list
         """
         return self._fixes
+
+    @property
+    def suppressions(self) -> list[Suppression]:
+        """
+        Possible suppressions of the result.
+
+        :return: list of suppressions
+        :rtype: list
+        """
+        return self._suppressions

precli/core/status.py

@@ -0,0 +1,22 @@
+# Copyright 2023 Secure Saurce LLC
+import enum
+
+
+class Status(str, enum.Enum):
+    """
+    The status of a suppression.
+
+    :var ACCEPTED: The suppression is accepted.
+    :vartype ACCEPTED: str
+
+    :var UNDER_REVIEW: Under review on whether to suppress it.
+    :vartype UNDER_REVIEW: str
+
+    :var REJECTED: It was decided not to supporess the result.
+    :vartype REJECTED: str
+
+    """
+
+    ACCEPTED = "accepted"
+    UNDER_REVIEW = "underReview"
+    REJECTED = "rejected"

precli/core/suppression.py

@@ -0,0 +1,58 @@
+# Copyright 2023 Secure Saurce LLC
+from precli.core.location import Location
+from precli.core.status import Status
+
+
+class Suppression:
+    def __init__(
+        self,
+        kind: str,
+        status: Status = None,
+        location: Location = None,
+        justification: str = None,
+    ):
+        self._kind = kind
+        self._status = status
+        self._location = location
+        self._justification = justification
+
+    @property
+    def kind(self) -> str:
+        """
+        The kind of suppression. This can be one of two values:
+            "inSource" supporessed inline in the code
+            "external" suppressed in an external persistent store
+
+        :return: kind of suppression
+        :rtype: str
+        """
+        return "inSource"
+
+    @property
+    def status(self) -> Status:
+        """
+        The status of the suppression.
+
+        :return: status on whether to suppress
+        :rtype: Status
+        """
+        return self._status
+
+    @property
+    def location(self) -> Location:
+        """
+        Specifies the location of the suppression.
+
+        :return: location of suppression
+        :rtype: Location
+        """
+        return self._location
+
+    def justification(self) -> str:
+        """
+        User-supplied string that explains why the result was suppressed.
+
+        :return: why the result was suppressed
+        :rtype: str
+        """
+        return self._justification