Add POSIX optionflag

Run test on other UNIX systems too if they don't use Linux specifics. Add a TODO optionflag too to mark platform restrictions that might be too strict and should be looked at.
Gallopsled · Dec 22, 2024 · c92fe20 · c92fe20
1 parent d80b096
commit c92fe20
Show file tree

Hide file tree

Showing 29 changed files with 52 additions and 29 deletions.
diff --git a/docs/source/asm.rst b/docs/source/asm.rst
@@ -4,8 +4,9 @@
    import subprocess
    from pwn import *
 
+   # TODO: Remove global POSIX flag
    import doctest
-   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['POSIX']
 
 :mod:`pwnlib.asm` --- Assembler functions
 =========================================

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -402,6 +402,10 @@ class _DummyClass(object): pass
 # they are skipped on other platforms
 WINDOWS = doctest.register_optionflag('WINDOWS')
 LINUX = doctest.register_optionflag('LINUX')
+POSIX = doctest.register_optionflag('POSIX')
+
+# doctest optionflag for tests that haven't been looked at yet
+TODO = doctest.register_optionflag('TODO')
 
 class Py2OutputChecker(_DummyClass, doctest.OutputChecker):
     def check_output(self, want, got, optionflags):
@@ -448,6 +452,8 @@ def filter_platform(example):
                 return False
             if (optionflags & LINUX) == LINUX and sys.platform != 'linux':
                 return False
+            if (optionflags & POSIX) == POSIX and os.name != 'posix':
+                return False
             return True
 
         test.examples[:] = [example for example in test.examples if filter_platform(example)]

diff --git a/docs/source/elf/corefile.rst b/docs/source/elf/corefile.rst
@@ -19,7 +19,7 @@
    os.environ.setdefault('SHELL', '/bin/sh')
 
    import doctest
-   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['POSIX']
 
 
 :mod:`pwnlib.elf.corefile` --- Core Files

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

diff --git a/docs/source/encoders.rst b/docs/source/encoders.rst
@@ -2,8 +2,9 @@
 
    from pwn import *
 
+   # TODO: Remove global POSIX flag
    import doctest
-   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['POSIX']
 
 :mod:`pwnlib.encoders` --- Encoding Shellcode
 ===============================================

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

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

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

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

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

diff --git a/docs/source/rop/rop.rst b/docs/source/rop/rop.rst
@@ -19,6 +19,7 @@
 
    context.clear()
 
+   # TODO: Remove global LINUX flag
    import doctest
    doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
 

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

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

diff --git a/docs/source/shellcraft/amd64.rst b/docs/source/shellcraft/amd64.rst
@@ -3,6 +3,7 @@
    from pwn import *
    context.clear(arch='amd64')
 
+   # TODO: POSIX/WINDOWS shellcode test
    import doctest
    doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
 

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

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

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

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

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

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

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

diff --git a/docs/source/ui.rst b/docs/source/ui.rst
@@ -4,7 +4,7 @@
    import io
 
    import doctest
-   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['LINUX']
+   doctest_additional_flags = doctest.OPTIONFLAGS_BY_NAME['POSIX']
 
 :mod:`pwnlib.ui` --- Functions for user interaction
 ===================================================

diff --git a/pwnlib/context/__init__.py b/pwnlib/context/__init__.py
@@ -310,7 +310,7 @@ class ContextType(object):
         32
 
     .. doctest::
-        :options: +LINUX
+        :options: +POSIX +TODO
 
         >>> def nop():
         ...   print(enhex(pwnlib.asm.asm('nop')))
@@ -875,7 +875,7 @@ def binary(self, binary):
         Examples:
 
         .. doctest::
-            :options: +LINUX
+            :options: +POSIX +TODO
 
             >>> context.clear()
             >>> context.arch, context.bits
@@ -1412,7 +1412,7 @@ def cache_dir(self):
             True
             >>> os.chmod(cache_dir, 0o000)
             >>> context.cache_dir = True
-            >>> context.cache_dir is None # doctest: +LINUX
+            >>> context.cache_dir is None # doctest: +POSIX +TODO
             True
             >>> os.chmod(cache_dir, 0o755)
             >>> cache_dir == context.cache_dir

diff --git a/pwnlib/fmtstr.py b/pwnlib/fmtstr.py
@@ -34,7 +34,7 @@
 We can automate the exploitation of the process like so:
 
 .. doctest::
-    :options: +LINUX
+    :options: +POSIX +TODO
 
     >>> program = pwnlib.data.elf.fmtstr.get('i386')
     >>> def exec_fmt(payload):

diff --git a/pwnlib/memleak.py b/pwnlib/memleak.py
@@ -40,7 +40,7 @@ def some_leaker(addr):
     Example:
 
     .. doctest::
-        :options: +LINUX
+        :options: +POSIX +TODO
 
         >>> import pwnlib
         >>> binsh = pwnlib.util.misc.read('/bin/sh')

diff --git a/pwnlib/util/iters.py b/pwnlib/util/iters.py
@@ -889,7 +889,7 @@ def mbruteforce(func, alphabet, length, method = 'upto', start = None, threads =
     Example:
 
     .. doctest::
-      :options: +LINUX
+      :options: +POSIX +TODO
 
       >>> mbruteforce(lambda x: x == 'hello', string.ascii_lowercase, length = 10)
       'hello'

diff --git a/pwnlib/util/misc.py b/pwnlib/util/misc.py
@@ -123,7 +123,7 @@ def read(path, count=-1, skip=0):
 
     Examples:
 
-        >>> read('/proc/self/exe')[:4] # doctest: +LINUX
+        >>> read('/proc/self/exe')[:4] # doctest: +LINUX +TODO
         b'\x7fELF'
     """
     path = os.path.expanduser(os.path.expandvars(path))
@@ -163,7 +163,7 @@ def which(name, all = False, path=None):
 
     Example:
 
-        >>> which('sh') # doctest: +ELLIPSIS +LINUX
+        >>> which('sh') # doctest: +ELLIPSIS +POSIX +TODO
         '.../bin/sh'
     """
     # If name is a path, do not attempt to resolve it.

diff --git a/pwnlib/util/packing.py b/pwnlib/util/packing.py
@@ -990,7 +990,7 @@ def dd(dst, src, count = 0, skip = 0, seek = 0, truncate = False):
         ['H', 'e', 'l', 'l', 'o', b'?']
 
     .. doctest::
-        :options: +LINUX
+        :options: +POSIX +TODO
 
         >>> _ = open('/tmp/foo', 'w').write('A' * 10)
         >>> dd(open('/tmp/foo'), open('/dev/zero'), skip = 3, count = 4).read()

diff --git a/pwnlib/util/sh_string.py b/pwnlib/util/sh_string.py
@@ -281,7 +281,7 @@ def test(original):
     r"""Tests the output provided by a shell interpreting a string
 
     .. doctest::
-        :options: +LINUX
+        :options: +POSIX
 
         >>> test(b'foobar')
         >>> test(b'foo bar')