evo-cli 0.28.0__tar.gz → 0.28.1__tar.gz

{evo_cli-0.28.0 → evo_cli-0.28.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: evo_cli
-Version: 0.28.0
+Version: 0.28.1
 Summary: Evolution CLI - a developer toolbox for setting up dev machines
 Author: maycuatroi
 Project-URL: Homepage, https://github.com/maycuatroi/evo-cli

evo_cli-0.28.1/evo_cli/VERSION

@@ -0,0 +1 @@
+0.28.1

{evo_cli-0.28.0 → evo_cli-0.28.1}/evo_cli/commands/openvpn.py

@@ -294,12 +294,14 @@ def disconnect(name):
 
 def _disconnect(name):
     state = _guard(vpn.request, name, "disconnect")
+    if state["state"] == "STOPPED" and state.get("error"):
+        click.echo(f"{name} was not running; last error: {state['error']}", err=True)
     deadline = time.monotonic() + 20
     while state["state"] != "STOPPED" and time.monotonic() < deadline:
         time.sleep(0.2)
         state = _guard(vpn.request, name)
     if state["state"] != "STOPPED":
-        raise click.ClickException("Disconnect not confirmed; inspect evo openvpn status.")
+        raise click.ClickException(state.get("error") or "Disconnect not confirmed; inspect evo openvpn status.")
     click.echo(f"{name}: stopped (OpenVPN Connect profiles unchanged).")
 
 

{evo_cli-0.28.0 → evo_cli-0.28.1}/evo_cli/openvpn.py

@@ -366,6 +366,58 @@ def last_profile():
         return None
 
 
+def _worker_alive(base):
+    """The worker holds its lock for life, and the kernel releases it however the worker dies."""
+    import fcntl
+
+    try:
+        with open(str(base) + ".lock") as lock:
+            fcntl.flock(lock, fcntl.LOCK_EX | fcntl.LOCK_NB)
+    except FileNotFoundError:
+        return False
+    except BlockingIOError:
+        return True
+    return False
+
+
+def _config_pids(base):
+    """PIDs whose command line names this session's config (OpenVPN, its sudo or wrapper); None if unknown."""
+    config = str(base) + ".ovpn"
+    try:
+        output = subprocess.run(
+            ["ps", "-A", "-o", "pid=", "-o", "args="], capture_output=True, text=True, timeout=5, check=True
+        ).stdout
+    except (OSError, subprocess.SubprocessError):
+        return None
+    return [line.split(None, 1)[0] for line in output.splitlines() if config in line]
+
+
+def _reap(name, last):
+    """Finish the cleanup of a worker that died without it (SIGKILL, SIGTERM), once nothing of it runs.
+
+    Otherwise its last published state would read as UNKNOWN forever, blocking connect and disconnect.
+    """
+    base = session_path(name)
+    if _worker_alive(base):
+        return {"profile": name, "state": "UNKNOWN", "error": "Worker unavailable; inspect OpenVPN processes."}
+    pids = _config_pids(base)
+    if pids is None:
+        return {"profile": name, "state": "UNKNOWN", "error": "Worker gone; cannot list processes to confirm."}
+    if pids:
+        listed = " ".join(pids)
+        error = f"OpenVPN still runs without its worker (PID {listed}); stop it with: sudo kill {listed}"
+        return {"profile": name, "state": "UNKNOWN", "error": error}
+    for suffix in (".sock", ".mgmt", ".ovpn"):
+        Path(str(base) + suffix).unlink(missing_ok=True)
+    state = {
+        "profile": name,
+        "state": "STOPPED",
+        "error": f"Worker exited unexpectedly (last state {last['state']}); no OpenVPN process was left running.",
+    }
+    private_write(Path(str(base) + ".json"), json.dumps(state))
+    return state
+
+
 def request(name, command="status"):
     endpoint = str(session_path(name)) + ".sock"
     with socket.socket(socket.AF_UNIX) as client:
@@ -377,11 +429,7 @@ def request(name, command="status"):
             if path.exists():
                 last = json.loads(path.read_text())
                 if last["state"] not in ("FAILED", "STOPPED") or last.get("cleanup_failed"):
-                    return {
-                        "profile": name,
-                        "state": "UNKNOWN",
-                        "error": "Worker unavailable; inspect OpenVPN processes.",
-                    }
+                    return _reap(name, last)
                 if last.get("error"):
                     return {"profile": name, "state": "STOPPED", "error": last["error"]}
             return {"profile": name, "state": "STOPPED"}

{evo_cli-0.28.0 → evo_cli-0.28.1}/evo_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: evo_cli
-Version: 0.28.0
+Version: 0.28.1
 Summary: Evolution CLI - a developer toolbox for setting up dev machines
 Author: maycuatroi
 Project-URL: Homepage, https://github.com/maycuatroi/evo-cli

{evo_cli-0.28.0 → evo_cli-0.28.1}/tests/test_openvpn.py

@@ -258,10 +258,51 @@ def test_plain_password_escaping_and_no_unrequested_otp():
         vpn.quote("x\nsignal SIGTERM")
 
 
-def test_stale_state_is_not_connected_or_confirmed_stopped(store):
-    path = Path(str(vpn.session_path("m1")) + ".json")
-    vpn.private_write(path, '{"state":"CONNECTED"}')
+def _ps(monkeypatch, output):
+    def run(command, **kwargs):
+        assert command[0] == "ps"
+        if output is None:
+            raise OSError("no ps")
+        return subprocess.CompletedProcess(command, 0, stdout=output)
+
+    monkeypatch.setattr(vpn.subprocess, "run", run)
+
+
+def test_stale_state_is_not_connected_or_confirmed_stopped(store, monkeypatch):
+    import fcntl
+
+    base = str(vpn.session_path("m1"))
+    vpn.private_write(Path(base + ".json"), '{"state":"CONNECTED"}')
+    _ps(monkeypatch, "")
+    with open(base + ".lock", "a") as held:
+        fcntl.flock(held, fcntl.LOCK_EX | fcntl.LOCK_NB)
+        assert vpn.request("m1")["state"] == "UNKNOWN"  # the worker lives but does not answer
+    _ps(monkeypatch, None)
     assert vpn.request("m1")["state"] == "UNKNOWN"
+    _ps(monkeypatch, f"  4242 /usr/sbin/openvpn --config {base}.ovpn --verb 3\n  4300 -zsh\n")
+    state = vpn.request("m1")
+    assert state["state"] == "UNKNOWN" and state["error"].endswith("sudo kill 4242")
+
+
+def test_dead_worker_is_reaped_and_disconnect_confirms_it(store, monkeypatch):
+    import socket
+
+    vpn.save_profile("m1", {"config": CONFIG})
+    base = str(vpn.session_path("m1"))
+    vpn.private_write(Path(base + ".json"), '{"profile":"m1","state":"CONNECTED","vpn_ip":"10.8.0.2"}')
+    # What a SIGKILLed worker leaves: a socket nobody listens on, the management socket and the config.
+    with socket.socket(socket.AF_UNIX) as stale:
+        stale.bind(base + ".sock")
+    for suffix in (".mgmt", ".ovpn", ".lock"):
+        Path(base + suffix).touch()
+    _ps(monkeypatch, "  4300 -zsh\n")
+    result = CliRunner().invoke(cli, ["openvpn", "disconnect", "m1"])
+    assert result.exit_code == 0, result.output
+    assert "m1 was not running; last error: Worker exited unexpectedly (last state CONNECTED)" in result.output
+    assert "m1: stopped" in result.output
+    assert not any(Path(base + suffix).exists() for suffix in (".sock", ".mgmt", ".ovpn"))
+    assert json.loads(Path(base + ".json").read_text())["state"] == "STOPPED"
+    assert vpn.request("m1")["state"] == "STOPPED"  # so connect and import accept the profile again
 
 
 FAKE_OPENVPN = """

evo_cli-0.28.0/evo_cli/VERSION

@@ -1 +0,0 @@
-0.28.0