Unintended HUGH refactoring of automotive scanners.

polybassa · polybassa · commit f0dc5c073150 · 2021-12-16T14:07:48.000+01:00
This PR:
  - changes variable names of automotive utilities to be more compliant
    with python
  - adds typing for various automotive utilities
  - refactors the core of automotive scanners which involve:
	- Ecu objects
	- EcuState objects
	- EcuAnsweringMachines
	- AutomotiveTestCases
	- AutomotiveTestCaseExecutors
  - cleans up UDS Scanner, OBD Scanner and GMLAN Scanner

Cleanups

Only use type imports from scapy.compat

Fix typing for NamedTuple

add sorted to EcuState __eq__ and __contains__

add default function

add debug flag to raise exception

add scan_range to UDS_SA Enumerator

fix bug

remove unused variable

test EcuStateComparison

improve EcuState comparision

move Profiler and Graph to independent files

remove dump to json

fix unit tests since add_edge function changed

Change internal transition functions to not use any lambdas

more cleanups

additions

remove unused variable

remove unused variable

be super sure to make a configuration

add function to create ECU clone from scanner

extend test

standalone graph tests

add documentation

fix tox

improve transition_function argument storage

minor cleanups

cleanup ecu_sim test

minor fix

update post and pre execute

test fixes

fix tests

fix test

add render function

add typing of render

Apply feedback

Fix flake8 errors

Apply feedback

Refactoring

Simplify RC and RDBI enumerators

Add Selective Enumerator for RDBI and RC

Pass current state to _get_initial_requests

Fix UDS_RCPR.answers

add cleanup to tests

update typing

fix after rebase

cleanup

add pickle test of transition function

disable pickle on python2

Also treat NR code 0x7f as serviceNotSupported

Remove old comment

Better logging for serviceNotSupported reactions

try to fix unit test

change blacklist creation

remove NamedTuple

fixes

revert changes

add root to uds_utils test

more info

update

Allow scan_range to be modified in UDS_RCStartEnumerator

minmal doc cleanup

cleanup transition functions

update render function

add weights to graph

fix unit test ecusim with old data

update

update

update uds protocol RoutineControl

update

ServiceEnumerator should ignore exit_if_service_not_supported
Remove list generation in DSCEnumerator

Refactoring + fix Flake8

Set better expansion_width (253)

Fix comment

modify ecu state modifier

refactor ecu state modifications

cleanup logging of protocols

add api docs

minor fixes

two more states

update

update

update uds ecu states

update

add test cases in enumerator.uts

update evaluate response

update

improve extension method

update

test supported_responses

fix mypy

fix types of timestamp

add directory for scanner code

split enumerator in different files

add contrib comment

fix BMW enumerator

fix BMW enumerator

add testcase positive&amp;negative results

adapt enumerator.uts to change

fix enumerator.uts

fix typing

start with documentation of testcase

complete documentation of AutomotiveTestCaseABC

Renaming

update scanner unit tests

More unit tests for individual scanner parts

fix mypy

fix docs

fix docs

fix test

fix test

remove BrokenPipeError

fix test

further cleanups

further cleanups

more tests

fix codespell

fix test

fix test

fix flake

more unit tests

cleanup

update

fix defaults

bugfix

enable exception to find bug

try bugfix

update periodicSenderThread

update

update

update unit tests

update

add connectionError

fix tox

add more verbose tpsender debug

minor cleanup

add BrokenPipeError to ignored errors during scan

fix HSFZ scan

minor fix

fix mypy

alphabetic sort of mypy enable contrib

update

close socket on Connection Error

rename HSFZ Sockets

fix mypy

fix unit test for obdscanner

refactoring of get_table_entry

fix flake and mypy

fix docs

fix build

fix mypy

disable test

fix tests

fix tests

minor cleanup

update gmlan scanner

debug closed socket error

fix tox

fix tox

update gmlan scanner

update

update

start with unit test implementation

Update retry_packet handling

update unit tests

fix tox and code

add candump

cleanup pcaps and candump logs

more unit tests

update configuration unit tests

improve tests-speed a lot

refactoring of configuration

fix test

debug socket

debug socket

more unit tests

try to fix bug

more unit tests and bugfix

update tests

more and faster tests

debug error

fix tox

fix stmin bug

fix uds unit test

include isotp stmin fix

update tests

update tests

update tests

fix test

debug test

fix tox

try fix

refactor RMBA enumerator

apply feedback

apply feedback

minor fix

minor fix in HSFZ

test propagation of exception

update

add error handling on closed sockets

update error handling

minor exception handling fix

stability update

add pickle test

fix test

debug test

fix test

fix test

improve test

improve test

speedup gmlan test

minor cleanup

update

update

update

minor changes

minor changes

remove long test from pypy

remove unused file

add unstable socket to increase test coverage

fix tox

fix tox

increase timeout of import.uts for macOSX

remove delay_state_change configuration

provide kwargs type information and documentation

fix test

remove old file

add more kwargs checks and improve execution time

update

update

fix obdscanner
diff --git a/.config/mypy/mypy_enabled.txt b/.config/mypy/mypy_enabled.txt
@@ -50,6 +50,7 @@ scapy/layers/can.py
 scapy/layers/l2.py
 
 # CONTRIB
+#scapy/contrib/http2.py  # needs to be fixed
 scapy/contrib/automotive/bmw/hsfz.py
 scapy/contrib/automotive/doip.py
 scapy/contrib/automotive/ecu.py
@@ -63,14 +64,14 @@ scapy/contrib/automotive/scanner/configuration.py
 scapy/contrib/automotive/scanner/enumerator.py
 scapy/contrib/automotive/scanner/executor.py
 scapy/contrib/automotive/scanner/graph.py
+scapy/contrib/automotive/scanner/profiler.py
 scapy/contrib/automotive/scanner/staged_test_case.py
 scapy/contrib/automotive/scanner/test_case.py
 scapy/contrib/automotive/uds_ecu_states.py
 scapy/contrib/automotive/uds_logging.py
 scapy/contrib/automotive/uds_scan.py
 scapy/contrib/cansocket_native.py
 scapy/contrib/cansocket_python_can.py
-#scapy/contrib/http2.py  # needs to be fixed
 scapy/contrib/isotp/isotp_native_socket.py
 scapy/contrib/isotp/isotp_packet.py
 scapy/contrib/isotp/isotp_scanner.py
diff --git a/scapy/contrib/automotive/scanner/executor.py b/scapy/contrib/automotive/scanner/executor.py
@@ -14,6 +14,7 @@
 from scapy.compat import Any, Union, List, Optional, \
     Dict, Callable, Type, cast
 from scapy.contrib.automotive.scanner.graph import Graph
+from scapy.contrib.automotive.scanner.profiler import Profiler, profile
 from scapy.error import Scapy_Exception, log_interactive
 from scapy.supersocket import SuperSocket
 from scapy.utils import make_lined_table, SingleConversationSocket
@@ -134,13 +135,15 @@ def scan_completed(self):
         return all(t.has_completed(s) for t, s in
                    product(self.configuration.test_cases, self.final_states))
 
+    @profile("ECU Reset")
     def reset_target(self):
         # type: () -> None
         log_interactive.info("[i] Target reset")
         if self.reset_handler:
             self.reset_handler()
         self.target_state = self.__initial_ecu_state
 
+    @profile("Reconnect")
     def reconnect(self):
         # type: () -> None
         if self.reconnect_handler:
@@ -232,7 +235,8 @@ def scan(self, timeout=None):
                         continue
                     log_interactive.info(
                         "[i] Execute %s for path %s", str(test_case), p)
-                    self.execute_test_case(test_case)
+                    with Profiler(p, test_case.__class__.__name__):
+                        self.execute_test_case(test_case)
                     test_case_executed = True
                 except (OSError, ValueError, Scapy_Exception) as e:
                     log_interactive.critical("[-] Exception: %s", e)
@@ -280,6 +284,7 @@ def enter_state_path(self, path):
                 return False
         return True
 
+    @profile("State change")
     def enter_state(self, prev_state, next_state):
         # type: (EcuState, EcuState) -> bool
         """
diff --git a/scapy/contrib/automotive/scanner/graph.py b/scapy/contrib/automotive/scanner/graph.py
@@ -10,6 +10,7 @@
 
 from scapy.compat import Union, List, Optional, Dict, Tuple, Set, TYPE_CHECKING
 from scapy.contrib.automotive.ecu import EcuState
+from scapy.contrib.automotive.scanner.profiler import Profiler
 from scapy.error import log_interactive
 
 _Edge = Tuple[EcuState, EcuState]
@@ -44,6 +45,7 @@ def add_edge(self, edge, transition_function=None):
         :param edge: edge from node to node
         :param transition_function: tuple with enter and cleanup function
         """
+        Profiler.write_milestone(repr(edge[1]))
         self.edges[edge[0]].append(edge[1])
         self.weights[edge] = 1
         self.__transition_functions[edge] = transition_function
diff --git a/scapy/contrib/automotive/scanner/profiler.py b/scapy/contrib/automotive/scanner/profiler.py
@@ -0,0 +1,80 @@
+# This file is part of Scapy
+# See http://www.secdev.org/projects/scapy for more information
+# Copyright (C) Nils Weiss <nils@we155.de>
+# Copyright (C) Andreas Korb <andreas.d.korb@gmail.com>
+# This program is published under a GPLv2 license
+
+# scapy.contrib.description = Profiler for AutomotiveTestCaseExecutor
+# scapy.contrib.status = library
+
+import time
+import functools
+
+from scapy.compat import Any, Optional, Callable
+
+
+class Profiler:
+    # For the profiling we'll use the unix time
+    # candump is using the same and thus it would be matchable
+
+    # _candump_fmt_date = datetime.datetime.now().strftime("%Y-%m-%d_%H%M%S")
+    # _filename_milestone = "milestones-%s.csv" % _candump_fmt_date
+    # _filename_profiling = "profiling-%s.csv" % _candump_fmt_date
+    _filename_milestone = "milestones.csv"
+    _filename_profiling = "profiling.csv"
+
+    _first = True
+    enabled = True
+
+    def __init__(self, state, enum=None):
+        # type: (Any, Optional[Any]) -> None
+        # We use the csv format
+        # If len(p) > 1, it would contain a ','
+        # For example: "[1, 2, 3]"
+        # Thus we replace all ',' with a ';' to avoid this
+        self.state = str(state).replace(",", ";")
+        self.enum = str(enum or state).replace(",", ";")
+        self.start_time = time.time()
+
+        if Profiler._first and Profiler.enabled:
+            Profiler._first = False
+            with open(Profiler._filename_profiling, mode="a") as f:  # noqa: E501
+                # Writing header
+                # Not required for milestone file because this is parsed
+                # manually instead of using `read_csv` of plotly
+                f.write("state,enumerator,start,end\n")
+
+    @classmethod
+    def write_milestone(cls, name):
+        # type: (str) -> None
+        if not cls.enabled:
+            return
+        with open(cls._filename_milestone, mode="a") as f:
+            f.write("%s,%f\n" % (name, time.time()))
+
+    def __enter__(self):
+        # type: () -> Profiler
+        self.start_time = time.time()
+        return self
+
+    def __exit__(self, exc_type, exc_val, exc_tb):
+        # type: (Any, Any, Any) -> None
+        if not Profiler.enabled:
+            return
+        with open(Profiler._filename_profiling, mode="a") as f:
+            f.write("%s,%s,%f,%f\n" % (
+                self.state, self.enum, self.start_time, time.time()))
+
+
+def profile(state, enum=None):
+    # type: (Any, Optional[Any]) -> Callable[[Callable[..., Any]], Callable[..., Any]]  # noqa: E501
+    def profile_decorator(func):
+        # type: (Callable[..., Any]) -> Callable[..., Any]
+        @functools.wraps(func)
+        def wrapper_profiled(*args, **kwargs):  # type: ignore
+            with Profiler(state, enum):
+                value = func(*args, **kwargs)
+            return value
+
+        return wrapper_profiled
+    return profile_decorator
