Several CI related fixes (#3399)

* Fix UTscapy timeout logs

* Add doc

* Set fail-fast to false

* Linting

* Use bash substring

* Install libpcap

* Run tox in parallel mode

Author: guedou

.appveyor.yml

@@ -63,9 +63,10 @@ test_script:
   # Set environment variables
   - set PYTHONPATH=%APPVEYOR_BUILD_FOLDER%
   - set PATH=%APPVEYOR_BUILD_FOLDER%;C:\Program Files\Wireshark\;C:\Program Files\Windump\;%PATH%
+  - set TOX_PARALLEL_NO_SPINNER=1
 
   # Main unit tests
-  - "%PYTHON%\\python -m tox -- %UT_FLAGS%"
+  - "%PYTHON%\\python -m tox --parallel -- %UT_FLAGS%"
 
 after_test:
   # Run codecov

.config/ci/install.sh

@@ -4,15 +4,17 @@
 # ./install.sh [install mode]
 
 # Detect install mode
-if [[ "${1}" == "libpcap" ]]; then
+if [[ "${1}" == "libpcap" ]]
+then
     SCAPY_USE_LIBPCAP="yes"
-    if [[ ! -z "$GITHUB_ACTIONS" ]]; then
+    if [[ ! -z "$GITHUB_ACTIONS" ]]
+    then
       echo "SCAPY_USE_LIBPCAP=yes" >> $GITHUB_ENV
     fi
 fi
 
 # Install on osx
-if [ "$OSTYPE" = "darwin"* ] || [ "$TRAVIS_OS_NAME" = "osx" ]
+if [ "${OSTYPE:0:6}" = "darwin" ] || [ "$TRAVIS_OS_NAME" = "osx" ]
 then
   if [ ! -z $SCAPY_USE_LIBPCAP ]
   then
@@ -27,12 +29,12 @@ then
   sudo apt-get update
   sudo apt-get -qy install tshark net-tools || exit 1
   sudo apt-get -qy install can-utils build-essential linux-headers-$(uname -r) linux-modules-extra-$(uname -r) || exit 1
-fi
 
-# Make sure libpcap is installed
-if [ ! -z $SCAPY_USE_LIBPCAP ]
-then
-  sudo apt-get -qy install libpcap-dev  || exit 1
+  # Make sure libpcap is installed
+  if [ ! -z $SCAPY_USE_LIBPCAP ]
+  then
+    sudo apt-get -qy install libpcap-dev  || exit 1
+  fi
 fi
 
 # On Travis, "osx" dependencies are installed in .travis.yml

.config/ci/test.sh

@@ -89,7 +89,7 @@ echo UT_FLAGS=$UT_FLAGS
 echo TOXENV=$TOXENV
 
 # Launch Scapy unit tests
-tox -- ${UT_FLAGS} || exit 1
+TOX_PARALLEL_NO_SPINNER=1 tox --parallel -- ${UT_FLAGS} || exit 1
 
 # Stop if NO_BASH_TESTS is set
 if [ ! -z "$SIMPLE_TESTS" ]

.github/workflows/unittests.yml

@@ -60,6 +60,7 @@ jobs:
     runs-on: ${{ matrix.os }}
     timeout-minutes: 20
     strategy:
+      fail-fast: false
       matrix:
         os: [ubuntu-latest]
         python: [2.7, 3.9]

scapy/autorun.py

@@ -11,12 +11,14 @@
 import code
 import logging
 import sys
+import threading
 import traceback
 
 from scapy.config import conf
 from scapy.themes import NoTheme, DefaultTheme, HTMLTheme2, LatexTheme2
 from scapy.error import log_scapy, Scapy_Exception
 from scapy.utils import tex_escape
+from scapy.modules.six.moves import queue
 import scapy.modules.six as six
 
 
@@ -28,6 +30,10 @@ class StopAutorun(Scapy_Exception):
     code_run = ""
 
 
+class StopAutorunTimeout(StopAutorun):
+    pass
+
+
 class ScapyAutorunInterpreter(code.InteractiveInterpreter):
     def __init__(self, *args, **kargs):
         code.InteractiveInterpreter.__init__(self, *args, **kargs)
@@ -87,6 +93,27 @@ def autorun_commands(cmds, my_globals=None, verb=None):
         return six.moves.builtins.__dict__.get("_", None)
 
 
+def autorun_commands_timeout(cmds, timeout=None, **kwargs):
+    """
+    Wraps autorun_commands with a timeout that raises StopAutorunTimeout
+    on expiration.
+    """
+    if timeout is None:
+        return autorun_commands(cmds, **kwargs)
+
+    q = queue.Queue()
+
+    def _runner():
+        q.put(autorun_commands(cmds, **kwargs))
+    th = threading.Thread(target=_runner)
+    th.daemon = True
+    th.start()
+    th.join(timeout)
+    if th.is_alive():
+        raise StopAutorunTimeout
+    return q.get()
+
+
 class StringWriter(object):
     """Util to mock sys.stdout and sys.stderr, and
     store their output in a 's' var."""
@@ -111,6 +138,7 @@ def autorun_get_interactive_session(cmds, **kargs):
     commands passed as "cmds" and return all output
 
     :param cmds: a list of commands to run
+    :param timeout: timeout in seconds
     :returns: (output, returned) contains both sys.stdout and sys.stderr logs
     """
     sstdout, sstderr, sexcepthook = sys.stdout, sys.stderr, sys.excepthook
@@ -122,7 +150,7 @@ def autorun_get_interactive_session(cmds, **kargs):
         try:
             sys.stdout = sys.stderr = sw
             sys.excepthook = sys.__excepthook__
-            res = autorun_commands(cmds, **kargs)
+            res = autorun_commands_timeout(cmds, **kargs)
         except StopAutorun as e:
             e.code_run = sw.s
             raise
@@ -138,14 +166,15 @@ def autorun_get_interactive_live_session(cmds, **kargs):
     commands passed as "cmds" and return all output
 
     :param cmds: a list of commands to run
+    :param timeout: timeout in seconds
     :returns: (output, returned) contains both sys.stdout and sys.stderr logs
     """
     sstdout, sstderr = sys.stdout, sys.stderr
     sw = StringWriter(debug=sstdout)
     try:
         try:
             sys.stdout = sys.stderr = sw
-            res = autorun_commands(cmds, **kargs)
+            res = autorun_commands_timeout(cmds, **kargs)
         except StopAutorun as e:
             e.code_run = sw.s
             raise

scapy/tools/UTscapy.py

@@ -29,7 +29,7 @@
 
 from scapy.consts import WINDOWS
 import scapy.modules.six as six
-from scapy.modules.six.moves import range, queue
+from scapy.modules.six.moves import range
 from scapy.config import conf
 from scapy.compat import base64_bytes, bytes_hex, plain_str
 from scapy.themes import DefaultTheme, BlackAndWhite
@@ -521,18 +521,14 @@ def remove_empty_testsets(test_campaign):
 
 def _run_test_timeout(test, get_interactive_session, verb=3, my_globals=None):
     """Run a test with timeout"""
-    q = queue.Queue()
-
-    def _runner():
-        output, res = get_interactive_session(test, verb=verb, my_globals=my_globals)
-        q.put((output, res))
-    th = threading.Thread(target=_runner)
-    th.daemon = True
-    th.start()
-    th.join(60 * 3)  # 3 min timeout
-    if th.is_alive():
-        return "Test timed out", False
-    return q.get()
+    from scapy.autorun import StopAutorunTimeout
+    try:
+        return get_interactive_session(test,
+                                       timeout=3 * 60,  # 3 min
+                                       verb=verb,
+                                       my_globals=my_globals)
+    except StopAutorunTimeout:
+        return "-- Test timed out ! --", False
 
 
 def run_test(test, get_interactive_session, theme, verb=3,
@@ -1242,7 +1238,6 @@ def main():
 
     # Check active threads
     if VERB > 2:
-        import threading
         if threading.active_count() > 1:
             print("\nWARNING: UNFINISHED THREADS")
             print(threading.enumerate())
@@ -1252,6 +1247,8 @@ def main():
             print("\nWARNING: UNFINISHED PROCESSES")
             print(processes)
 
+    sys.stdout.flush()
+
     # Return state
     return glob_result