sflkit 0.2.3__tar.gz → 0.2.5__tar.gz

{sflkit-0.2.3/src/SFLKit.egg-info → sflkit-0.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sflkit
-Version: 0.2.3
+Version: 0.2.5
 Summary: SFLKit: : A Workbench for Statistical Fault Localization
 Home-page: https://github.com/uds-se/sflkit
 Author: Marius Smytzek & Andreas Zeller

{sflkit-0.2.3 → sflkit-0.2.5}/pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "sflkit"
-version = "0.2.3"
+version = "0.2.5"
 authors = [
     { name = "Marius Smytzek", email = "marius.smytzek@cispa.de" },
 ]

{sflkit-0.2.3 → sflkit-0.2.5/src/SFLKit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: sflkit
-Version: 0.2.3
+Version: 0.2.5
 Summary: SFLKit: : A Workbench for Statistical Fault Localization
 Home-page: https://github.com/uds-se/sflkit
 Author: Marius Smytzek & Andreas Zeller

{sflkit-0.2.3 → sflkit-0.2.5}/src/sflkit/__init__.py

@@ -6,7 +6,7 @@ from sflkit.analysis.predicate import Predicate
 from sflkit.config import Config, parse_config
 from sflkit.instrumentation.dir_instrumentation import DirInstrumentation
 
-__version__ = "0.2.3"
+__version__ = "0.2.5"
 
 
 def instrument_config(conf: Config, event_dump: str = None):

{sflkit-0.2.3 → sflkit-0.2.5}/src/sflkit/analysis/analysis_type.py

@@ -5,6 +5,12 @@ from typing import List, Type
 from sflkit.model.scope import Scope
 
 
+class EvaluationResult(enum.Enum):
+    TRUE = 1
+    FALSE = 0
+    UNOBSERVED = -1
+
+
 class AnalysisType(enum.Enum):
     LINE = 0
     BRANCH = 1
@@ -22,6 +28,12 @@ class AnalysisType(enum.Enum):
     SPECIAL_STRING = 13
     EMPTY_BYTES = 14
 
+    def __str__(self):
+        return self.name
+
+    def __repr__(self):
+        return self.name
+
 
 """
 If you want to add new spectra or predicates, please register them here and in sflkit/language/.py
@@ -29,7 +41,6 @@ If you want to add new spectra or predicates, please register them here and in s
 
 
 class AnalysisObject(object):
-
     function_finder = None
     loop_finder = None
     branch_finder = None
@@ -43,12 +54,13 @@ class AnalysisObject(object):
     # noinspection PyUnusedLocal
     def __init__(self, event):
         self.suspiciousness: float = 0
+        self.last_evaluation: EvaluationResult = EvaluationResult.UNOBSERVED
 
     def __repr__(self):
         return f"{self.analysis_type()}:{self.suspiciousness}"
 
     def __str__(self):
-        return repr(self)
+        return f"{self.analysis_type()}"
 
     @staticmethod
     @abstractmethod

{sflkit-0.2.3 → sflkit-0.2.5}/src/sflkit/analysis/predicate.py

@@ -5,7 +5,7 @@ from typing import Tuple, Callable, Optional
 from sflkitlib.events import EventType
 from sflkitlib.events.event import BranchEvent, FunctionExitEvent, DefEvent
 
-from sflkit.analysis.analysis_type import AnalysisType
+from sflkit.analysis.analysis_type import AnalysisType, EvaluationResult
 from sflkit.analysis.spectra import Spectrum
 from sflkit.analysis.suggestion import Suggestion, Location
 from sflkit.model import scope
@@ -24,6 +24,17 @@ class Predicate(Spectrum, ABC):
         self.increase_true = 0
         self.increase_false = 0
         self.true_hits = dict()
+        self.last_evaluation = EvaluationResult.UNOBSERVED
+
+    @staticmethod
+    def default_evaluation() -> EvaluationResult:
+        return EvaluationResult.UNOBSERVED
+
+    def get_last_evaluation(self, id_: int) -> EvaluationResult:
+        if id_ not in self.true_hits:
+            return self.default_evaluation()
+        else:
+            return self.last_evaluation
 
     def finalize(self, passed: list, failed: list):
         super().finalize(passed, failed)
@@ -46,6 +57,9 @@ class Predicate(Spectrum, ABC):
             self.true_hits[id_] = 0
         if self._evaluate_predicate(scope_):
             self.true_hits[id_] += 1
+            self.last_evaluation = EvaluationResult.TRUE
+        else:
+            self.last_evaluation = EvaluationResult.FALSE
 
     def get_metric(self, metric: Callable = None):
         if metric is None:
@@ -131,6 +145,9 @@ class Branch(Predicate):
         if event.then_id == self.then_id:
             super(Predicate, self).hit(id_, event, scope_)
             self.true_hits[id_] += 1
+            self.last_evaluation = EvaluationResult.TRUE
+        else:
+            self.last_evaluation = EvaluationResult.FALSE
 
     def get_suggestion(self, metric: Callable = None, base_dir: str = ""):
         if metric == Predicate.IncreaseFalse:
@@ -142,6 +159,9 @@ class Branch(Predicate):
             self.get_metric(metric),
         )
 
+    def __str__(self):
+        return f"{self.analysis_type()}:{self.file}:{self.line}:{'then' if self.then else 'else'}:{self.then_id}"
+
 
 class Comp(enum.Enum):
     LT = 0
@@ -165,6 +185,12 @@ class Comp(enum.Enum):
         elif self == Comp.NE:
             return x != y
 
+    def __repr__(self):
+        return self.name
+
+    def __str__(self):
+        return self.name
+
 
 class Comparison(Predicate, ABC):
     def __init__(self, file, line, op: Comp):
@@ -209,6 +235,9 @@ class ScalarPair(Comparison):
     def _get_second(self, scope_: scope.Scope):
         return scope_.value(self.var2)
 
+    def __str__(self):
+        return f"{self.analysis_type()}:{self.file}:{self.line}:{self.var1}{self.op}{self.var2}"
+
 
 class VariablePredicate(Comparison):
     def __init__(self, event, op: Comp):
@@ -228,6 +257,9 @@ class VariablePredicate(Comparison):
     def _get_first(self, scope_: scope.Scope):
         return scope_.value(self.var)
 
+    def __str__(self):
+        return f"{self.analysis_type()}:{self.file}:{self.line}:{self.var}{self.op}0"
+
 
 class NonePredicate(Comparison):
     def __init__(self, event: DefEvent):
@@ -250,6 +282,9 @@ class NonePredicate(Comparison):
     def _get_second(self, scope_: scope.Scope):
         return None
 
+    def __str__(self):
+        return f"{self.analysis_type()}:{self.file}:{self.line}:{self.var}"
+
 
 class ReturnPredicate(Comparison):
     def __init__(self, event: FunctionExitEvent, op: Comp, value: Optional[int] = 0):
@@ -275,6 +310,9 @@ class ReturnPredicate(Comparison):
     def _get_second(self, scope_: scope.Scope):
         return self.value
 
+    def __str__(self):
+        return f"{self.analysis_type()}:{self.file}:{self.line}:{self.function}{self.op}{self.value}"
+
 
 class EmptyStringPredicate(Comparison):
     def __init__(self, event: DefEvent):
@@ -297,6 +335,9 @@ class EmptyStringPredicate(Comparison):
     def _get_second(self, scope_: scope.Scope):
         return ""
 
+    def __str__(self):
+        return f"{self.analysis_type()}:{self.file}:{self.line}:{self.var}"
+
 
 class EmptyBytesPredicate(Comparison):
     def __init__(self, event: DefEvent):
@@ -319,6 +360,9 @@ class EmptyBytesPredicate(Comparison):
     def _get_second(self, scope_: scope.Scope):
         return b""
 
+    def __str__(self):
+        return f"{self.analysis_type()}:{self.file}:{self.line}:{self.var}"
+
 
 class FunctionPredicate(Predicate, ABC):
     def __init__(self, file, line, var: str, predicate: callable):
@@ -345,6 +389,9 @@ class IsAsciiPredicate(FunctionPredicate):
     def analysis_type():
         return AnalysisType.ASCII_STRING
 
+    def __str__(self):
+        return f"{self.analysis_type()}:{self.file}:{self.line}:{self.var}"
+
 
 class ContainsDigitPredicate(FunctionPredicate):
     def __init__(self, event: DefEvent):
@@ -358,6 +405,9 @@ class ContainsDigitPredicate(FunctionPredicate):
     def analysis_type():
         return AnalysisType.DIGIT_STRING
 
+    def __str__(self):
+        return f"{self.analysis_type()}:{self.file}:{self.line}:{self.var}"
+
 
 class ContainsSpecialPredicate(FunctionPredicate):
     def __init__(self, event: DefEvent):
@@ -371,6 +421,9 @@ class ContainsSpecialPredicate(FunctionPredicate):
     def analysis_type():
         return AnalysisType.SPECIAL_STRING
 
+    def __str__(self):
+        return f"{self.analysis_type()}:{self.file}:{self.line}:{self.var}"
+
 
 class Condition(Predicate):
     def __init__(self, file: str, line: int, condition: str):
@@ -391,3 +444,9 @@ class Condition(Predicate):
             self.true_hits[id_] = 0
         if event.value:
             self.true_hits[id_] += 1
+            self.last_evaluation = EvaluationResult.TRUE
+        else:
+            self.last_evaluation = EvaluationResult.FALSE
+
+    def __str__(self):
+        return f"{self.analysis_type()}:{self.file}:{self.line}:{self.condition}"

{sflkit-0.2.3 → sflkit-0.2.5}/src/sflkit/analysis/spectra.py

@@ -14,7 +14,7 @@ from sflkitlib.events.event import (
     UseEvent,
 )
 
-from sflkit.analysis.analysis_type import AnalysisObject, AnalysisType
+from sflkit.analysis.analysis_type import AnalysisObject, AnalysisType, EvaluationResult
 from sflkit.analysis.suggestion import Suggestion, Location
 from sflkit.model.scope import Scope
 
@@ -39,6 +39,20 @@ class Spectrum(AnalysisObject, ABC):
         self.failed_observed = failed_observed
         self.failed_not_observed = failed_not_observed
         self.hits = dict()
+        self.last_evaluation: EvaluationResult = EvaluationResult.FALSE
+
+    def __str__(self):
+        return f"{self.analysis_type()}:{self.file}:{self.line}"
+
+    @staticmethod
+    def default_evaluation() -> EvaluationResult:
+        return EvaluationResult.FALSE
+
+    def get_last_evaluation(self, id_: int) -> EvaluationResult:
+        if id_ not in self.hits:
+            return self.default_evaluation()
+        else:
+            return self.last_evaluation
 
     def get_metric(self, metric: Callable = None):
         if metric is None:
@@ -59,6 +73,7 @@ class Spectrum(AnalysisObject, ABC):
         self.suspiciousness = self.get_metric(metric)
 
     def hit(self, id_, event, scope_: Scope = None):
+        self.last_evaluation = True
         if id_ not in self.hits:
             self.hits[id_] = 1
         else:
@@ -483,6 +498,9 @@ class Function(Spectrum):
             self.get_metric(metric),
         )
 
+    def __str__(self):
+        return f"{self.analysis_type()}:{self.file}:{self.function}:{self.line}"
+
 
 class DefUse(Spectrum):
     def __init__(self, def_event: DefEvent, use_event: UseEvent):
@@ -505,6 +523,9 @@ class DefUse(Spectrum):
             self.get_metric(metric),
         )
 
+    def __str__(self):
+        return f"{self.analysis_type()}:{self.file}:{self.line}:{self.use_file}:{self.use_line}:{self.var}"
+
 
 class Loop(Spectrum):
     def __init__(
@@ -569,3 +590,6 @@ class Loop(Spectrum):
             [Location(self.file, line) for line in finder.get_locations(base_dir)],
             self.get_metric(metric),
         )
+
+    def __str__(self):
+        return f"{self.analysis_type()}:{self.file}:{self.line}"