beachcomber 0.3.1

A centralized daemon that caches shell state (git, battery, hostname, etc.) so every consumer reads from one fast cache instead of independently forking shells
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79

"""Unit tests for socket path discovery."""

from __future__ import annotations

import os
import tempfile

import pytest

from libbeachcomber.discovery import discover_socket_path, get_uid


class TestGetUid:
    def test_returns_int(self) -> None:
        uid = get_uid()
        assert isinstance(uid, int)
        assert uid >= 0

    def test_matches_os_geteuid(self) -> None:
        assert get_uid() == os.geteuid()


class TestDiscoverSocketPath:
    def test_falls_back_to_tmpdir(self, monkeypatch: pytest.MonkeyPatch) -> None:
        monkeypatch.delenv("XDG_RUNTIME_DIR", raising=False)
        monkeypatch.setenv("TMPDIR", "/tmp")
        uid = get_uid()
        path = discover_socket_path()
        assert path == f"/tmp/beachcomber-{uid}/sock"

    def test_uses_custom_tmpdir(self, monkeypatch: pytest.MonkeyPatch) -> None:
        monkeypatch.delenv("XDG_RUNTIME_DIR", raising=False)
        monkeypatch.setenv("TMPDIR", "/var/run/user/tmp")
        uid = get_uid()
        path = discover_socket_path()
        assert path == f"/var/run/user/tmp/beachcomber-{uid}/sock"

    def test_strips_trailing_slash_from_tmpdir(
        self, monkeypatch: pytest.MonkeyPatch
    ) -> None:
        monkeypatch.delenv("XDG_RUNTIME_DIR", raising=False)
        monkeypatch.setenv("TMPDIR", "/tmp/")
        uid = get_uid()
        path = discover_socket_path()
        assert path == f"/tmp/beachcomber-{uid}/sock"

    def test_uses_xdg_runtime_dir_when_socket_exists(
        self, monkeypatch: pytest.MonkeyPatch, tmp_path: pytest.TempPathFixture
    ) -> None:
        xdg = tmp_path / "run"
        sock_dir = xdg / "beachcomber"
        sock_dir.mkdir(parents=True)
        (sock_dir / "sock").touch()

        monkeypatch.setenv("XDG_RUNTIME_DIR", str(xdg))
        path = discover_socket_path()
        assert path == str(sock_dir / "sock")

    def test_ignores_xdg_runtime_dir_when_socket_missing(
        self, monkeypatch: pytest.MonkeyPatch, tmp_path: pytest.TempPathFixture
    ) -> None:
        xdg = tmp_path / "run"
        xdg.mkdir()
        # No sock file created.

        monkeypatch.setenv("XDG_RUNTIME_DIR", str(xdg))
        monkeypatch.setenv("TMPDIR", "/tmp")
        uid = get_uid()
        path = discover_socket_path()
        assert path == f"/tmp/beachcomber-{uid}/sock"

    def test_no_tmpdir_env_uses_slash_tmp(
        self, monkeypatch: pytest.MonkeyPatch
    ) -> None:
        monkeypatch.delenv("XDG_RUNTIME_DIR", raising=False)
        monkeypatch.delenv("TMPDIR", raising=False)
        uid = get_uid()
        path = discover_socket_path()
        assert path == f"/tmp/beachcomber-{uid}/sock"