Add a CI and a basic integration test

.coveragerc

@@ -0,0 +1,24 @@
+[run]
+branch = True
+include =
+    pyrdp/*
+    twisted/*
+    bin/*
+
+[report]
+# Regexes for lines to exclude from consideration
+exclude_lines =
+    # Have to re-enable the standard pragma
+    pragma: no cover
+
+    # Don't complain about missing debug-only code:
+    def __repr__
+
+    # Don't complain if tests don't hit defensive assertion code:
+    raise AssertionError
+    raise NotImplementedError
+
+    # Don't complain if non-runnable code isn't run:
+    if 0:
+
+ignore_errors = True

.github/workflows/ci.yml

@@ -0,0 +1,69 @@
+name: Continuous Integration
+
+on: [push, pull_request]
+
+jobs:
+  docker-build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Build Docker image
+      run: docker build .
+
+  install-and-test-ubuntu:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-python@v1
+      with:
+        python-version: '3.7' # Version range or exact version of a Python version to use, using semvers version range syntax.
+        architecture: 'x64'
+
+    - name: Python version
+      run: python --version
+    - name: Pip version
+      run: pip --version
+
+    - name: Install setuptools
+      run: sudo apt install python3-setuptools
+    - name: Install PyRDP dependencies
+      run: sudo apt install libdbus-1-dev libdbus-glib-1-dev libgl1-mesa-glx git python3-dev
+    - name: Install PyRDP
+      working-directory: .
+      run: pip install -U -e .
+
+    - name: Install ci dependencies
+      run: pip install -r requirements-ci.txt
+
+    - name: Integration Test with a prerecorded PCAP.
+      working-directory: ./
+      run: coverage run test/test.py
+
+    - name: Coverage
+      run: coverage report --fail-under=50
+
+
+
+  install-and-test-windows:
+    runs-on: windows-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v1
+        with:
+          python-version: '3.7' # Version range or exact version of a Python version to use, using semvers version range syntax.
+          architecture: 'x64'
+
+      - name: Python version
+        run: python --version
+      - name: Pip version
+        run: pip --version
+      - name: Install PyRDP
+        working-directory: .
+        run: pip install -U -e .
+
+      - name: Integration Test with a prerecorded PCAP.
+        working-directory: ./
+        run: python test/test.py

.gitignore

@@ -3,6 +3,10 @@
 *.pyd
 venv*/
 /*.prof
+.coverage
+
+# Zip the pcap instead
+*.pcap
 
 # IDE stuff
 .project

pyrdp/mitm/RDPMITM.py

@@ -37,15 +37,16 @@
 from pyrdp.mitm.TCPMITM import TCPMITM
 from pyrdp.mitm.VirtualChannelMITM import VirtualChannelMITM
 from pyrdp.mitm.X224MITM import X224MITM
-from pyrdp.recording import FileLayer, RecordingFastPathObserver, RecordingSlowPathObserver
+from pyrdp.recording import FileLayer, RecordingFastPathObserver, RecordingSlowPathObserver, \
+    Recorder
 
 
 class RDPMITM:
     """
     Main MITM class. The job of this class is to orchestrate the components for all the protocols.
     """
 
-    def __init__(self, mainLogger: SessionLogger, crawlerLogger: SessionLogger, config: MITMConfig):
+    def __init__(self, mainLogger: SessionLogger, crawlerLogger: SessionLogger, config: MITMConfig, state: RDPMITMState=None, recorder: Recorder=None):
         """
         :param log: base logger to use for the connection
         :param config: the MITM configuration
@@ -72,7 +73,7 @@ def __init__(self, mainLogger: SessionLogger, crawlerLogger: SessionLogger, conf
         self.statCounter = StatCounter()
         """Class to keep track of connection-related statistics such as # of mouse events, # of output events, etc."""
 
-        self.state = RDPMITMState(config)
+        self.state = state if state is not None else RDPMITMState(self.config)
         """The MITM state"""
 
         self.client = RDPLayerSet()
@@ -84,7 +85,7 @@ def __init__(self, mainLogger: SessionLogger, crawlerLogger: SessionLogger, conf
         self.player = TwistedPlayerLayerSet()
         """Layers on the attacker side"""
 
-        self.recorder = MITMRecorder([], self.state)
+        self.recorder = recorder if recorder is not None else MITMRecorder([], self.state)
         """Recorder for this connection"""
 
         self.channelMITMs = {}

requirements-ci.txt

@@ -0,0 +1 @@
+coverage

setup.py

@@ -36,6 +36,7 @@
         'PySide2',
         'pytz',
         'rsa',
+        'scapy',
         'service_identity',
         'twisted',
         'dbus-python;platform_system!="Windows"',