Add a full test suite.

Author: freakboy3742

.github/workflows/ci.yml

@@ -35,27 +35,29 @@ jobs:
 
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.13"
+          python-version: "3.x"
 
       - name: Build wheels
         uses: pypa/cibuildwheel@v3.4.1
+        with:
+          output-dir: dist
 
       - uses: actions/upload-artifact@v4
         with:
-          name: wheels-${{ matrix.platform }}
-          path: ./wheelhouse/*.whl
+          name: wheels
+          path: ./dist/*.whl
           if-no-files-found: error
 
   build-sdist:
     needs: pre-commit
     name: Build sdist
-    runs-on: macos-14
+    runs-on: macos-latest
     steps:
       - uses: actions/checkout@v4
 
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.13"
+          python-version: "3.x"
 
       - name: Build sdist
         run: |
@@ -69,32 +71,28 @@ jobs:
           if-no-files-found: error
 
   smoke-test:
-    name: Smoke test
+    name: Smoke test (Python ${{ matrix.python-version }})
     needs: build-wheels
     runs-on: macos-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["py310", "py311", "py312", "py313", "py314", "py315"]
     steps:
       - uses: actions/checkout@v4
 
       - uses: actions/setup-python@v5
         with:
-          python-version: "3.13"
+          python-version: "3.x"
 
       - uses: actions/download-artifact@v4
         with:
-          name: wheels-macos
-          path: dist
+          name: wheels
+          path: wheelhouse
 
-      - name: Install and smoke-test the wheel
+      - name: Install tox
         run: |
-          python -m pip install --upgrade pip
-          python -m pip install --find-links=dist --no-index --pre std-nslog
-          python -c "
-          import sys, io, nslog
-          assert isinstance(sys.stdout, nslog.NSLogWriter)
-          assert isinstance(sys.stderr, nslog.NSLogWriter)
-          print('hello from std-nslog smoke test')
-          print('this is stderr', file=sys.stderr)
-          # nslog() should accept all log levels.
-          nslog.nslog('explicit info', level=nslog.OS_LOG_TYPE_INFO)
-          nslog.nslog('explicit error', level=nslog.OS_LOG_TYPE_ERROR)
-          "
+          python -m pip install --group tox
+
+      - name: Run smoke test
+        run: tox -e py

.gitignore

@@ -20,6 +20,7 @@ lib64/
 parts/
 sdist/
 var/
+wheelhouse/
 *.egg-info/
 .installed.cfg
 *.egg
@@ -102,5 +103,3 @@ runtime/
 
 # Ruff linter cache files
 .ruff_cache
-
-wheelhouse/

README.md

@@ -1,18 +1,16 @@
-[<img src="http://beeware.org/static/images/defaultlogo.png" width="72px" alt="Generic BeeWare Logo">](https://beeware.org/)
-
 # std-nslog
 
-[![Python Versions](https://img.shields.io/pypi/pyversions/std-nslog.svg)](https://pypi.python.org/pypi/std-nslog)
-[![PyPI Version](https://img.shields.io/pypi/v/std-nslog.svg)](https://pypi.python.org/pypi/std-nslog)
-[![Maturity](https://img.shields.io/pypi/status/std-nslog.svg)](https://pypi.python.org/pypi/std-nslog)
-[![BSD License](https://img.shields.io/pypi/l/std-nslog.svg)](https://github.com/beeware/std-nslog/blob/main/LICENSE)
-[![Discord server](https://img.shields.io/discord/836455665257021440?label=Discord%20Chat&logo=discord&style=plastic)](https://beeware.org/bee/chat/)
+[<img src="http://beeware.org/static/images/defaultlogo.png" width="72px" alt="Generic BeeWare Logo">](https://beeware.org/)
+
+[![Python Versions](https://img.shields.io/pypi/pyversions/std-nslog.svg)](https://pypi.python.org/pypi/std-nslog) [![PyPI Version](https://img.shields.io/pypi/v/std-nslog.svg)](https://pypi.python.org/pypi/std-nslog) [![Maturity](https://img.shields.io/pypi/status/std-nslog.svg)](https://pypi.python.org/pypi/std-nslog) [![BSD License](https://img.shields.io/pypi/l/std-nslog.svg)](https://github.com/beeware/std-nslog/blob/main/LICENSE) [![Discord server](https://img.shields.io/discord/836455665257021440?label=Discord%20Chat&logo=discord&style=plastic)](https://beeware.org/bee/chat/)
 
 std-nslog is a shim that redirects stderr/stdout to the Apple unified logging system (`os_log`, the modern replacement for `NSLog`). This can be useful when deploying Python code as a standalone app on macOS or iOS, where stdout/stderr aren't easily visible for end users.
 
+This functionality is baked into Python 3.14+ if you are using an embedded interpreter - set `config.use_system_logger = 1` when configuring the interpreter. The same functionality exists in all iOS CPython builds (where it is enabled by default).
+
 ## Usage
 
-std-nslog will generally only be needed in the context of a bundled macOS or iOS application. You shouldn't ever need to install it yourself into a local virtual environment. However, just in case...
+std-nslog will generally only be needed in the context of a bundled macOS application. You shouldn't ever need to install it yourself into a local virtual environment. However, just in case...
 
 To install std-nslog:
 
@@ -22,8 +20,6 @@ Then, in your code, `import nslog`. This will install the shim. The file only ne
 
 Once installed, all output written to stdout and stderr will be redirected to the unified logging system; stdout is logged at `OS_LOG_TYPE_DEFAULT`, and stderr at `OS_LOG_TYPE_ERROR`, so the two streams can be filtered separately in Console.app or `log stream`.
 
-To associate the log entries with a specific subsystem and category (useful for filtering with `log stream --predicate 'subsystem == "..."'`), set the `STD_NSLOG_SUBSYSTEM` and `STD_NSLOG_CATEGORY` environment variables before importing `nslog`. If unset, the default system log is used.
-
 ## Why no pun?
 
 While an obscure joke referencing apples and logs might be amusing, it would make no sense when it appeared in a Briefcase requirements file.

pyproject.toml

@@ -27,6 +27,8 @@ classifiers = [
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Programming Language :: Python :: 3.15",
     "Programming Language :: Python :: 3 :: Only",
     "Topic :: Software Development",
     "Topic :: Utilities",
@@ -38,6 +40,32 @@ Funding = "https://beeware.org/contributing/membership/"
 Tracker = "https://github.com/beeware/std-nslog/issues"
 Source = "https://github.com/beeware/std-nslog"
 
+[dependency-groups]
+# Extras used by developers *of* briefcase are pinned to specific versions to
+# ensure environment consistency.
+pre-commit = [
+    "pre-commit == 4.6.0",
+]
+
+setuptools-scm = [
+    "setuptools_scm == 10.0.5",
+]
+
+tox-uv = [
+    "tox-uv == 1.35.2",
+]
+
+dev = [
+    {include-group = "pre-commit"},
+    {include-group = "setuptools-scm"},
+    {include-group = "tox-uv"},
+]
+
+test = [
+    "pytest == 9.0.3",
+    {include-group = "setuptools-scm"},
+]
+
 [tool.cibuildwheel]
 build-frontend = "build"
 archs = "all"

tests/smoke.py

@@ -0,0 +1,40 @@
+"""
+std-nslog smoke test driver.
+
+This file is a *helper* for `test_smoke.py`, not a test itself.
+It imports nslog, and outputs some known strings to the console.
+"""
+
+import sys
+
+import nslog
+
+
+def main() -> None:
+    tag = sys.argv[1]
+
+    # Importing nslog should have replaced both standard streams with
+    # NSLogWriter instances; if it didn't, nothing else here is meaningful.
+    assert isinstance(sys.stdout, nslog.NSLogWriter), (
+        f"sys.stdout was not replaced by NSLogWriter (got {type(sys.stdout)!r})"
+    )
+    assert isinstance(sys.stderr, nslog.NSLogWriter), (
+        f"sys.stderr was not replaced by NSLogWriter (got {type(sys.stderr)!r})"
+    )
+
+    # Exercise stdout, stderr, and direct nslog() calls at multiple log
+    # levels. Each line is tagged so the CI verifier can pick them out of
+    # the unified log unambiguously.
+    print(f"{tag} hello from std-nslog smoke test")
+    print(f"{tag} this is stderr", file=sys.stderr)
+    nslog.nslog(f"{tag} explicit info", level=nslog.OS_LOG_TYPE_INFO)
+    nslog.nslog(f"{tag} explicit error", level=nslog.OS_LOG_TYPE_ERROR)
+
+    # NSLogWriter buffers partial lines until a newline arrives; flush
+    # explicitly so nothing is dropped before the unified-log query runs.
+    sys.stdout.flush()
+    sys.stderr.flush()
+
+
+if __name__ == "__main__":
+    main()

tests/test_smoke.py

@@ -0,0 +1,56 @@
+from __future__ import annotations
+
+import subprocess
+import sys
+import time
+import uuid
+from pathlib import Path
+
+
+def test_system_log():
+    tag = f"std-nslog-smoke-{uuid.uuid4()}"
+
+    result = subprocess.run(
+        [sys.executable, Path(__file__).parent / "smoke.py", tag],
+        capture_output=True,
+        text=True,
+        check=False,
+    )
+
+    # Assert that the smoke test ran without error.
+    assert result.returncode == 0
+
+    # Nothing the script `print()`ed should have reached the inherited
+    # stdio: NSLogWriter routes every byte to os_log instead. Anything
+    # showing up here would mean the redirection failed.
+    assert result.stdout == "", (
+        f"unexpected bytes on subprocess stdout: {result.stdout!r}"
+    )
+    assert result.stderr == "", (
+        f"unexpected bytes on subprocess stderr: {result.stderr!r}"
+    )
+
+    # Give the unified logging subsystem a moment to commit the writes
+    # before querying. Two seconds matches the existing CI margin and is
+    # well within the `log show` window we request below.
+    time.sleep(2)
+
+    log = subprocess.check_output(
+        ["log", "show", "--last", "10s", "--info"],
+        text=True,
+    )
+
+    missing = [
+        msg
+        for msg in [
+            "hello from std-nslog smoke test",
+            "this is stderr",
+            "explicit info",
+            "explicit error",
+        ]
+        if f"{tag} {msg}" not in log
+    ]
+    assert not missing, (
+        "Expected message(s) not found in `log show` output: "
+        + ", ".join(repr(m) for m in missing)
+    )

tox.ini

@@ -0,0 +1,16 @@
+[tox]
+requires = tox>=4.21
+env_list = pre-commit,py3{10,11,12,13}
+skip_missing_interpreters = True
+
+[testenv:pre-commit]
+skip_install = True
+dependency_groups = pre-commit
+commands = pre-commit run --all-files --show-diff-on-failure --color=always
+
+[testenv:py{,310,311,312,313}]
+skip_install = True
+dependency_groups = test
+commands =
+    uv pip install --find-links=wheelhouse --no-index --only-binary :all: --pre std-nslog
+    pytest {posargs:-v tests}