Gallopsled · peace-maker · Dec 18, 2024 · Dec 18, 2024 · Dec 18, 2024 · Dec 18, 2024
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -284,10 +284,25 @@ jobs:
         pip install --upgrade pip
         pip install --upgrade --editable .
 
+    - name: Install documentation dependencies
+      run: pip install -r docs/requirements.txt
+
     - name: Sanity checks
       run: |
         python -bb -c 'from pwn import *'
         python -bb examples/text.py
+
+    - name: Coverage doctests
+      run: |
+        python -bb -m coverage run -m sphinx -b doctest docs/source docs/build/doctest
+
+    # FIXME: Paths are broken when uploading coverage on ubuntu
+    # coverage.exceptions.NoSource: No source for code: '/home/runner/work/pwntools/pwntools/D:\a\pwntools\pwntools\pwn\__init__.py'.
+    # - uses: actions/upload-artifact@v4
+    #   with:
+    #     name: coverage-windows
+    #     path: .coverage*
+    #     include-hidden-files: true
 
   upload-coverage:
     runs-on: ubuntu-latest

diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -19,6 +19,6 @@ psutil
 requests>=2.5.1
 ropgadget>=5.3
 sphinx==1.8.6; python_version<'3'
-sphinx>=7.0.0; python_version>='3'
+sphinx>=8.1.3, <9; python_version>='3'
 sphinx_rtd_theme
 sphinxcontrib-autoprogram<=0.1.5
diff --git a/docs/source/adb.rst b/docs/source/adb.rst
@@ -4,6 +4,9 @@
    from pwn import *
    adb = pwnlib.adb
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 :mod:`pwnlib.adb` --- Android Debug Bridge
 =====================================================
 

diff --git a/docs/source/asm.rst b/docs/source/asm.rst
@@ -4,6 +4,9 @@
    import subprocess
    from pwn import *
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 :mod:`pwnlib.asm` --- Assembler functions
 =========================================
 

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -398,6 +398,11 @@ def dont_skip_any_doctests(app, what, name, obj, skip, options):
 
 class _DummyClass(object): pass
 
+# doctest optionflags for platform-specific tests
+# they are skipped on other platforms
+WINDOWS = doctest.register_optionflag('WINDOWS')
+LINUX = doctest.register_optionflag('LINUX')
+
 class Py2OutputChecker(_DummyClass, doctest.OutputChecker):
     def check_output(self, want, got, optionflags):
         sup = super(Py2OutputChecker, self).check_output
@@ -425,27 +430,70 @@ def check_output(self, want, got, optionflags):
                 return False
         return True
 
+import sphinx.ext.doctest
+
+class PlatformDocTestRunner(sphinx.ext.doctest.SphinxDocTestRunner):
+    def run(self, test, compileflags=None, out=None, clear_globs=True):
+        original_optionflags = self.optionflags | test.globs.get('doctest_additional_flags', 0)
+        def filter_platform(example):
+            optionflags = original_optionflags
+            if example.options:
+                for (optionflag, val) in example.options.items():
+                    if val:
+                        optionflags |= optionflag
+                    else:
+                        optionflags &= ~optionflag
+
+            if (optionflags & WINDOWS) == WINDOWS and sys.platform != 'win32':
+                return False
+            if (optionflags & LINUX) == LINUX and sys.platform != 'linux':
+                return False
+            return True
+
+        test.examples[:] = [example for example in test.examples if filter_platform(example)]
+
+        return super(PlatformDocTestRunner, self).run(test, compileflags, out, clear_globs)
+
+class PlatformDocTestBuilder(sphinx.ext.doctest.DocTestBuilder):
+    _test_runner = None
+
+    @property
+    def test_runner(self):
+        return self._test_runner
+
+    @test_runner.setter
+    def test_runner(self, value):
+        self._test_runner = PlatformDocTestRunner(value._checker, value._verbose, value.optionflags)
+
 def py2_doctest_init(self, checker=None, verbose=None, optionflags=0):
     if checker is None:
         checker = Py2OutputChecker()
     doctest.DocTestRunner.__init__(self, checker, verbose, optionflags)
 
 if 'doctest' in sys.argv:
-    def setup(app):
-        pass # app.connect('autodoc-skip-member', dont_skip_any_doctests)
 
     if sys.version_info[:1] < (3,):
-        import sphinx.ext.doctest
         sphinx.ext.doctest.SphinxDocTestRunner.__init__ = py2_doctest_init
     else:
+        def setup(app):
+            app.add_builder(PlatformDocTestBuilder, override=True)
+            # app.connect('autodoc-skip-member', dont_skip_any_doctests)
         # monkey patching paramiko due to https://github.com/paramiko/paramiko/pull/1661
         import paramiko.client
         import binascii
         paramiko.client.hexlify = lambda x: binascii.hexlify(x).decode()
         paramiko.util.safe_string = lambda x: '' # function result never *actually used*
     class EndlessLoop(Exception): pass
-    def alrm_handler(sig, frame):
-        signal.alarm(180) # three minutes
-        raise EndlessLoop()
-    signal.signal(signal.SIGALRM, alrm_handler)
-    signal.alarm(600) # ten minutes
+    if sys.platform == 'win32':
+        def alrm_handler():
+            raise EndlessLoop()
+        import threading
+        timer = threading.Timer(600, alrm_handler)
+        timer.daemon = True
+        timer.start()
+    else:
+        def alrm_handler(sig, frame):
+            signal.alarm(180) # three minutes
+            raise EndlessLoop()
+        signal.signal(signal.SIGALRM, alrm_handler)
+        signal.alarm(600) # ten minutes
diff --git a/docs/source/elf/corefile.rst b/docs/source/elf/corefile.rst
@@ -18,6 +18,9 @@
    # Set the environment here so it's not in the middle of our tests.
    os.environ.setdefault('SHELL', '/bin/sh')
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 
 :mod:`pwnlib.elf.corefile` --- Core Files
 ===========================================================

diff --git a/docs/source/elf/elf.rst b/docs/source/elf/elf.rst
@@ -5,6 +5,9 @@
    from pwnlib.elf.maps import CAT_PROC_MAPS_EXIT
    import shutil
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 :mod:`pwnlib.elf.elf` --- ELF Files
 ===========================================================
 

diff --git a/docs/source/encoders.rst b/docs/source/encoders.rst
@@ -1,6 +1,9 @@
 .. testsetup:: *
 
    from pwn import *
+
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
 
 :mod:`pwnlib.encoders` --- Encoding Shellcode
 ===============================================

diff --git a/docs/source/filesystem.rst b/docs/source/filesystem.rst
@@ -6,6 +6,9 @@
     from pwnlib.tubes.ssh import ssh
     from pwnlib.filesystem import *
 
+    import doctest
+    doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 :mod:`pwnlib.filesystem` --- Manipulating Files Locally and Over SSH
 ====================================================================
 

diff --git a/docs/source/gdb.rst b/docs/source/gdb.rst
@@ -4,6 +4,9 @@
     context.arch = 'amd64'
     context.terminal = [os.path.join(os.path.dirname(pwnlib.__file__), 'gdb_faketerminal.py')]
 
+    import doctest
+    doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 :mod:`pwnlib.gdb` --- Working with GDB
 ======================================
 

diff --git a/docs/source/intro.rst b/docs/source/intro.rst
@@ -2,6 +2,9 @@
 
    from pwn import *
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 Getting Started
 ========================
 

diff --git a/docs/source/libcdb.rst b/docs/source/libcdb.rst
@@ -3,6 +3,9 @@
    from pwn import *
    from pwnlib.libcdb import *
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 :mod:`pwnlib.libcdb` --- Libc Database
 ===========================================
 

diff --git a/docs/source/qemu.rst b/docs/source/qemu.rst
@@ -2,6 +2,9 @@
 
    from pwn import *
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 
 :mod:`pwnlib.qemu` --- QEMU Utilities
 ==========================================

diff --git a/docs/source/rop/rop.rst b/docs/source/rop/rop.rst
@@ -19,6 +19,9 @@
 
    context.clear()
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 
 :mod:`pwnlib.rop.rop` --- Return Oriented Programming
 ==========================================================

diff --git a/docs/source/rop/srop.rst b/docs/source/rop/srop.rst
@@ -7,6 +7,9 @@
    from pwnlib.elf import ELF
    from pwnlib.tubes.process import process
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 :mod:`pwnlib.rop.srop` --- Sigreturn Oriented Programming
 ==========================================================
 

diff --git a/docs/source/runner.rst b/docs/source/runner.rst
@@ -3,6 +3,9 @@
    from pwnlib.runner import *
    from pwnlib.asm import asm
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 :mod:`pwnlib.runner` --- Running Shellcode
 ===========================================
 

diff --git a/docs/source/shellcraft.rst b/docs/source/shellcraft.rst
@@ -2,6 +2,9 @@
 
    from pwnlib import shellcraft
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 :mod:`pwnlib.shellcraft` --- Shellcode generation
 =================================================
 

diff --git a/docs/source/shellcraft/aarch64.rst b/docs/source/shellcraft/aarch64.rst
@@ -3,6 +3,9 @@
    from pwn import *
    context.clear(arch='aarch64')
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 :mod:`pwnlib.shellcraft.aarch64` --- Shellcode for AArch64
 ===========================================================
 

diff --git a/docs/source/shellcraft/amd64.rst b/docs/source/shellcraft/amd64.rst
@@ -3,6 +3,9 @@
    from pwn import *
    context.clear(arch='amd64')
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 :mod:`pwnlib.shellcraft.amd64` --- Shellcode for AMD64
 ===========================================================
 

diff --git a/docs/source/shellcraft/arm.rst b/docs/source/shellcraft/arm.rst
@@ -3,6 +3,9 @@
    from pwn import *
    context.clear(arch='arm')
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 :mod:`pwnlib.shellcraft.arm` --- Shellcode for ARM
 ===========================================================
 

diff --git a/docs/source/shellcraft/i386.rst b/docs/source/shellcraft/i386.rst
@@ -3,6 +3,9 @@
    from pwn import *
    context.clear(arch='i386')
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 :mod:`pwnlib.shellcraft.i386` --- Shellcode for Intel 80386
 ===========================================================
 

diff --git a/docs/source/shellcraft/mips.rst b/docs/source/shellcraft/mips.rst
@@ -12,6 +12,9 @@
 
    context.clear(arch='mips')
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 :mod:`pwnlib.shellcraft.mips` --- Shellcode for MIPS
 ===========================================================
 

diff --git a/docs/source/shellcraft/riscv64.rst b/docs/source/shellcraft/riscv64.rst
@@ -3,6 +3,9 @@
    from pwn import *
    context.clear(arch='riscv64')
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 :mod:`pwnlib.shellcraft.riscv64` --- Shellcode for RISCV64
 ==========================================================
 

diff --git a/docs/source/shellcraft/thumb.rst b/docs/source/shellcraft/thumb.rst
@@ -3,6 +3,9 @@
    from pwn import *
    context.clear(arch='thumb')
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 :mod:`pwnlib.shellcraft.thumb` --- Shellcode for Thumb Mode
 ===========================================================
 

diff --git a/docs/source/tubes.rst b/docs/source/tubes.rst
@@ -2,6 +2,9 @@
 
    from pwn import *
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 :mod:`pwnlib.tubes` --- Talking to the World!
 =============================================
 

diff --git a/docs/source/tubes/buffer.rst b/docs/source/tubes/buffer.rst
@@ -2,6 +2,9 @@
 
    from pwnlib.tubes.buffer import *
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 :mod:`pwnlib.tubes.buffer` --- buffer implementation for tubes
 ==============================================================
 

diff --git a/docs/source/tubes/processes.rst b/docs/source/tubes/processes.rst
@@ -2,6 +2,9 @@
 
    from pwn import *
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 :mod:`pwnlib.tubes.process` --- Processes
 ===========================================================
 

diff --git a/docs/source/tubes/serial.rst b/docs/source/tubes/serial.rst
@@ -2,6 +2,9 @@
 
    from pwn import *
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 :mod:`pwnlib.tubes.serialtube` --- Serial Ports
 ===========================================================
 

diff --git a/docs/source/tubes/sockets.rst b/docs/source/tubes/sockets.rst
@@ -3,6 +3,9 @@
    from pwn import *
    from pwnlib.tubes.server import server
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 :mod:`pwnlib.tubes.sock` --- Sockets
 ===========================================================
 

diff --git a/docs/source/tubes/ssh.rst b/docs/source/tubes/ssh.rst
@@ -2,6 +2,9 @@
 
    from pwn import *
 
+   import doctest
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+
 :mod:`pwnlib.tubes.ssh` --- SSH
 ===========================================================