test_build_static.py

import subprocess
import sys
import os
import pytest
from .conditions import has_breakpad, has_crashpad, has_native, is_android


def test_static_lib(cmake):
    tmp_path = cmake(
        ["sentry_example"],
        {
            "SENTRY_BACKEND": "none",
            "SENTRY_TRANSPORT": "none",
            "BUILD_SHARED_LIBS": "OFF",
        },
    )

    # on linux we can use `ldd` to check that we don’t link to `libsentry.so`
    if sys.platform == "linux" and not is_android:
        output = subprocess.check_output("ldd sentry_example", cwd=tmp_path, shell=True)
        assert b"libsentry.so" not in output

    # on windows, we read the file header to check that the exe is compiled correctly
    if sys.platform == "win32":
        with open(os.path.join(tmp_path, "sentry_example.exe"), "rb") as binary:
            binary.seek(0x3C, 0)
            offset = int.from_bytes(binary.read(4), byteorder="little")
            binary.seek(offset, 0)
            magic = binary.read(6)
            # https://docs.microsoft.com/en-us/windows/win32/debug/pe-format#signature-image-only
            if os.environ.get("TEST_X86"):
                expected = b"PE\x00\x00\x4c\x01"  # IMAGE_FILE_MACHINE_I386
            elif os.environ.get("PROCESSOR_ARCHITECTURE") == "ARM64":
                expected = b"PE\x00\x00\x64\xaa"  # IMAGE_FILE_MACHINE_ARM64
            else:
                expected = b"PE\x00\x00\x64\x86"  # IMAGE_FILE_MACHINE_AMD64
            assert magic == expected
    # similarly, we use `file` on linux
    if sys.platform == "linux":
        output = subprocess.check_output(
            "file sentry_example", cwd=tmp_path, shell=True
        )
        assert (
            b"ELF 32-bit" if os.environ.get("TEST_X86") else b"ELF 64-bit"
        ) in output


@pytest.mark.skipif(not has_crashpad, reason="test needs crashpad backend")
def test_static_crashpad(cmake):
    cmake(
        ["sentry_example"],
        {
            "SENTRY_BACKEND": "crashpad",
            "SENTRY_TRANSPORT": "none",
            "BUILD_SHARED_LIBS": "OFF",
        },
    )


@pytest.mark.skipif(not has_crashpad, reason="test needs crashpad backend")
@pytest.mark.skipif(not sys.platform == "win32", reason="test requires Windows")
def test_static_crashpad_static_runtime(cmake):
    """
    When this test fails it is most likely that you didn't reflect a target change inside the `crashpad` build in the
    top-level `crashpad` target properties (`FOLDER`, `MSVC_RUNTIME_LIBRARY`) for Windows builds.
    """
    cmake(
        ["sentry_example"],
        {
            "SENTRY_BACKEND": "crashpad",
            "SENTRY_TRANSPORT": "none",
            "BUILD_SHARED_LIBS": "OFF",
            "SENTRY_BUILD_RUNTIMESTATIC": "ON",
        },
    )


@pytest.mark.skipif(not has_breakpad, reason="test needs breakpad backend")
def test_static_breakpad(cmake):
    cmake(
        ["sentry_example"],
        {
            "SENTRY_BACKEND": "breakpad",
            "SENTRY_TRANSPORT": "none",
            "BUILD_SHARED_LIBS": "OFF",
        },
    )


@pytest.mark.skipif(not has_native, reason="test needs native backend")
def test_static_native(cmake):
    cmake(
        ["sentry_example"],
        {
            "SENTRY_BACKEND": "native",
            "SENTRY_TRANSPORT": "none",
            "BUILD_SHARED_LIBS": "OFF",
        },
    )