|
| 1 | +"""Hermetic telemetry tests: env is set to opt-out before importing unstructured. |
| 2 | +
|
| 3 | +This module must set DO_NOT_TRACK (or equivalent) before any import of unstructured |
| 4 | +so that init_telemetry() runs with opt-out at import time and no real network/subprocess |
| 5 | +occurs. Tests then use monkeypatch and mocks to assert behavior. |
| 6 | +""" |
| 7 | + |
| 8 | +from __future__ import annotations |
| 9 | + |
| 10 | +# Set opt-out before any unstructured import so package init does not run telemetry. |
| 11 | +import os |
| 12 | + |
| 13 | +os.environ["DO_NOT_TRACK"] = "1" |
| 14 | +os.environ.pop("UNSTRUCTURED_TELEMETRY_ENABLED", None) |
| 15 | +os.environ.pop("SCARF_NO_ANALYTICS", None) |
| 16 | + |
| 17 | +import platform |
| 18 | +import subprocess |
| 19 | +import sys |
| 20 | +from pathlib import Path |
| 21 | +from unittest.mock import Mock |
| 22 | + |
| 23 | +import pytest |
| 24 | +import requests |
| 25 | + |
| 26 | +from unstructured import utils |
| 27 | + |
| 28 | + |
| 29 | +@pytest.fixture |
| 30 | +def telemetry_mocks(monkeypatch): |
| 31 | + """Clear telemetry env and patch requests.get + subprocess.check_output. |
| 32 | +
|
| 33 | + Returns (mock_get, mock_subprocess). Use for both send and no-send tests so |
| 34 | + we can assert network and subprocess side effects. |
| 35 | + """ |
| 36 | + monkeypatch.delenv("UNSTRUCTURED_TELEMETRY_ENABLED", raising=False) |
| 37 | + monkeypatch.delenv("SCARF_NO_ANALYTICS", raising=False) |
| 38 | + monkeypatch.delenv("DO_NOT_TRACK", raising=False) |
| 39 | + mock_get = Mock() |
| 40 | + mock_subprocess = Mock() |
| 41 | + monkeypatch.setattr("unstructured.utils.requests.get", mock_get) |
| 42 | + monkeypatch.setattr("unstructured.utils.subprocess.check_output", mock_subprocess) |
| 43 | + return mock_get, mock_subprocess |
| 44 | + |
| 45 | + |
| 46 | +def _apply_telemetry_env(monkeypatch, env_overrides): |
| 47 | + """Set env vars from dict; keys are env var names, values are str or None (delenv).""" |
| 48 | + for key, value in env_overrides.items(): |
| 49 | + if value is None: |
| 50 | + monkeypatch.delenv(key, raising=False) |
| 51 | + else: |
| 52 | + monkeypatch.setenv(key, value) |
| 53 | + |
| 54 | + |
| 55 | +class DescribeScarfAnalytics: |
| 56 | + """Tests for scarf_analytics (telemetry off by default, opt-in only).""" |
| 57 | + |
| 58 | + def it_telemetry_opt_out_any_non_empty_for_both_vars(self, monkeypatch): |
| 59 | + """Contract: DO_NOT_TRACK and SCARF_NO_ANALYTICS both opt out on any non-empty value.""" |
| 60 | + monkeypatch.delenv("DO_NOT_TRACK", raising=False) |
| 61 | + monkeypatch.delenv("SCARF_NO_ANALYTICS", raising=False) |
| 62 | + assert utils._telemetry_opt_out() is False |
| 63 | + monkeypatch.setenv("DO_NOT_TRACK", "yes") |
| 64 | + assert utils._telemetry_opt_out() is True |
| 65 | + monkeypatch.delenv("DO_NOT_TRACK", raising=False) |
| 66 | + monkeypatch.setenv("SCARF_NO_ANALYTICS", "on") |
| 67 | + assert utils._telemetry_opt_out() is True |
| 68 | + |
| 69 | + def it_telemetry_opt_in_only_true_or_1(self, monkeypatch): |
| 70 | + """Contract: only UNSTRUCTURED_TELEMETRY_ENABLED in ('true','1') opts in.""" |
| 71 | + monkeypatch.delenv("UNSTRUCTURED_TELEMETRY_ENABLED", raising=False) |
| 72 | + assert utils._telemetry_opt_in() is False |
| 73 | + for val in ("true", "1", "True", "TRUE"): |
| 74 | + monkeypatch.setenv("UNSTRUCTURED_TELEMETRY_ENABLED", val) |
| 75 | + assert utils._telemetry_opt_in() is True |
| 76 | + for val in ("false", "0", "yes", ""): |
| 77 | + monkeypatch.setenv("UNSTRUCTURED_TELEMETRY_ENABLED", val) |
| 78 | + assert utils._telemetry_opt_in() is False |
| 79 | + |
| 80 | + @pytest.mark.parametrize( |
| 81 | + "env_overrides", |
| 82 | + [ |
| 83 | + {}, |
| 84 | + {"DO_NOT_TRACK": "true"}, |
| 85 | + {"DO_NOT_TRACK": "1"}, |
| 86 | + {"DO_NOT_TRACK": "TRUE"}, |
| 87 | + {"DO_NOT_TRACK": "false"}, |
| 88 | + {"DO_NOT_TRACK": "0"}, |
| 89 | + {"SCARF_NO_ANALYTICS": "true"}, |
| 90 | + {"SCARF_NO_ANALYTICS": "yes"}, |
| 91 | + {"SCARF_NO_ANALYTICS": "on"}, |
| 92 | + {"SCARF_NO_ANALYTICS": "1"}, |
| 93 | + {"SCARF_NO_ANALYTICS": "TRUE"}, |
| 94 | + {"SCARF_NO_ANALYTICS": "false"}, |
| 95 | + {"SCARF_NO_ANALYTICS": "0"}, |
| 96 | + {"SCARF_NO_ANALYTICS": " true "}, |
| 97 | + {"UNSTRUCTURED_TELEMETRY_ENABLED": "false"}, |
| 98 | + {"UNSTRUCTURED_TELEMETRY_ENABLED": "0"}, |
| 99 | + {"UNSTRUCTURED_TELEMETRY_ENABLED": "yes"}, |
| 100 | + {"UNSTRUCTURED_TELEMETRY_ENABLED": "FALSE"}, |
| 101 | + {"UNSTRUCTURED_TELEMETRY_ENABLED": "true", "DO_NOT_TRACK": "true"}, |
| 102 | + {"UNSTRUCTURED_TELEMETRY_ENABLED": "true", "SCARF_NO_ANALYTICS": "on"}, |
| 103 | + ], |
| 104 | + ids=[ |
| 105 | + "default_no_opt_in", |
| 106 | + "DO_NOT_TRACK=true", |
| 107 | + "DO_NOT_TRACK=1", |
| 108 | + "DO_NOT_TRACK=TRUE", |
| 109 | + "DO_NOT_TRACK=false", |
| 110 | + "DO_NOT_TRACK=0", |
| 111 | + "SCARF_NO_ANALYTICS=true", |
| 112 | + "SCARF_NO_ANALYTICS=yes", |
| 113 | + "SCARF_NO_ANALYTICS=on", |
| 114 | + "SCARF_NO_ANALYTICS=1", |
| 115 | + "SCARF_NO_ANALYTICS=TRUE", |
| 116 | + "SCARF_NO_ANALYTICS=false", |
| 117 | + "SCARF_NO_ANALYTICS=0", |
| 118 | + "SCARF_NO_ANALYTICS=whitespace", |
| 119 | + "opt_in=false", |
| 120 | + "opt_in=0", |
| 121 | + "opt_in=yes", |
| 122 | + "opt_in=FALSE", |
| 123 | + "opt_in_true_but_DO_NOT_TRACK", |
| 124 | + "opt_in_true_but_SCARF_NO_ANALYTICS", |
| 125 | + ], |
| 126 | + ) |
| 127 | + def it_does_not_send_telemetry_when_disabled_or_opted_out( |
| 128 | + self, monkeypatch, telemetry_mocks, env_overrides |
| 129 | + ): |
| 130 | + """No network or subprocess when telemetry disabled or opt-out set.""" |
| 131 | + mock_get, mock_subprocess = telemetry_mocks |
| 132 | + _apply_telemetry_env(monkeypatch, env_overrides) |
| 133 | + utils.scarf_analytics() |
| 134 | + mock_get.assert_not_called() |
| 135 | + mock_subprocess.assert_not_called() |
| 136 | + |
| 137 | + @pytest.mark.parametrize("opt_in_value", ["true", "True", "TRUE", "1"]) |
| 138 | + def it_sends_telemetry_when_opt_in_is_set(self, monkeypatch, telemetry_mocks, opt_in_value): |
| 139 | + mock_get, mock_subprocess = telemetry_mocks |
| 140 | + _apply_telemetry_env(monkeypatch, {"UNSTRUCTURED_TELEMETRY_ENABLED": opt_in_value}) |
| 141 | + utils.scarf_analytics() |
| 142 | + mock_get.assert_called_once() |
| 143 | + mock_subprocess.assert_called_once_with(["nvidia-smi"], stderr=subprocess.DEVNULL) |
| 144 | + call_args = mock_get.call_args |
| 145 | + assert call_args[0][0] == "https://packages.unstructured.io/python-telemetry" |
| 146 | + params = call_args[1]["params"] |
| 147 | + assert set(params.keys()) == {"version", "platform", "python", "arch", "gpu", "dev"} |
| 148 | + assert call_args[1]["timeout"] == 10 |
| 149 | + |
| 150 | + @pytest.mark.parametrize( |
| 151 | + ("version_val", "expected_dev"), |
| 152 | + [("1.2.3.dev0", "true"), ("1.2.3", "false")], |
| 153 | + ids=["dev_version", "release_version"], |
| 154 | + ) |
| 155 | + def it_sends_telemetry_with_correct_dev_param( |
| 156 | + self, monkeypatch, telemetry_mocks, version_val, expected_dev |
| 157 | + ): |
| 158 | + mock_get, mock_subprocess = telemetry_mocks |
| 159 | + _apply_telemetry_env(monkeypatch, {"UNSTRUCTURED_TELEMETRY_ENABLED": "true"}) |
| 160 | + monkeypatch.setattr("unstructured.utils.__version__", version_val) |
| 161 | + utils.scarf_analytics() |
| 162 | + mock_get.assert_called_once() |
| 163 | + mock_subprocess.assert_called_once() |
| 164 | + params = mock_get.call_args[1]["params"] |
| 165 | + assert params["dev"] == expected_dev |
| 166 | + assert params["version"] == version_val |
| 167 | + assert params["platform"] == platform.system() |
| 168 | + assert params["arch"] == platform.machine() |
| 169 | + assert mock_get.call_args[1]["timeout"] == 10 |
| 170 | + |
| 171 | + def it_handles_requests_exception_gracefully(self, monkeypatch, telemetry_mocks): |
| 172 | + mock_get, mock_subprocess = telemetry_mocks |
| 173 | + mock_get.side_effect = requests.RequestException("network error") |
| 174 | + _apply_telemetry_env(monkeypatch, {"UNSTRUCTURED_TELEMETRY_ENABLED": "true"}) |
| 175 | + utils.scarf_analytics() # does not raise |
| 176 | + mock_get.assert_called_once() |
| 177 | + mock_subprocess.assert_called_once() |
| 178 | + assert mock_get.call_args[0][0] == "https://packages.unstructured.io/python-telemetry" |
| 179 | + assert "version" in mock_get.call_args[1]["params"] |
| 180 | + |
| 181 | + @pytest.mark.parametrize( |
| 182 | + "exc", |
| 183 | + [ |
| 184 | + OSError(), |
| 185 | + PermissionError("nvidia-smi denied"), |
| 186 | + subprocess.CalledProcessError(returncode=1, cmd=["nvidia-smi"]), |
| 187 | + ], |
| 188 | + ids=["OSError", "PermissionError", "CalledProcessError"], |
| 189 | + ) |
| 190 | + def it_handles_nvidia_smi_failure_gracefully(self, monkeypatch, telemetry_mocks, exc): |
| 191 | + """nvidia-smi probe failures must not propagate; telemetry still sends with gpu=False.""" |
| 192 | + mock_get, mock_subprocess = telemetry_mocks |
| 193 | + mock_subprocess.side_effect = exc |
| 194 | + _apply_telemetry_env(monkeypatch, {"UNSTRUCTURED_TELEMETRY_ENABLED": "true"}) |
| 195 | + utils.scarf_analytics() # does not raise |
| 196 | + mock_get.assert_called_once() |
| 197 | + assert mock_get.call_args[1]["params"]["gpu"] == "False" |
| 198 | + mock_subprocess.assert_called_once_with(["nvidia-smi"], stderr=subprocess.DEVNULL) |
| 199 | + |
| 200 | + def it_import_unstructured_succeeds_with_opt_out(self): |
| 201 | + """Import path with opt-out env does not crash (integration-style).""" |
| 202 | + project_root = Path(__file__).resolve().parent.parent |
| 203 | + env = {k: v for k, v in os.environ.items() if k != "UNSTRUCTURED_TELEMETRY_ENABLED"} |
| 204 | + env.update( |
| 205 | + { |
| 206 | + "DO_NOT_TRACK": "1", |
| 207 | + "SCARF_NO_ANALYTICS": "1", |
| 208 | + "UNSTRUCTURED_TELEMETRY_ENABLED": "", |
| 209 | + "PYTHONPATH": str(project_root), |
| 210 | + } |
| 211 | + ) |
| 212 | + result = subprocess.run( |
| 213 | + [sys.executable, "-c", "import unstructured; print('ok')"], |
| 214 | + env=env, |
| 215 | + cwd=project_root, |
| 216 | + capture_output=True, |
| 217 | + text=True, |
| 218 | + timeout=30, |
| 219 | + ) |
| 220 | + assert result.returncode == 0, result.stderr or result.stdout |
| 221 | + assert "ok" in result.stdout |
| 222 | + |
| 223 | + def it_import_unstructured_runs_telemetry_once_when_opt_in(self): |
| 224 | + """Import path with opt-in runs init_telemetry exactly once (patch then import).""" |
| 225 | + project_root = Path(__file__).resolve().parent.parent |
| 226 | + env = { |
| 227 | + k: v |
| 228 | + for k, v in os.environ.items() |
| 229 | + if k not in ("DO_NOT_TRACK", "SCARF_NO_ANALYTICS", "UNSTRUCTURED_TELEMETRY_ENABLED") |
| 230 | + } |
| 231 | + env.update( |
| 232 | + { |
| 233 | + "UNSTRUCTURED_TELEMETRY_ENABLED": "true", |
| 234 | + "PYTHONPATH": str(project_root), |
| 235 | + } |
| 236 | + ) |
| 237 | + script = """ |
| 238 | +from unittest.mock import Mock, patch |
| 239 | +m_get = Mock() |
| 240 | +m_subprocess = Mock() |
| 241 | +with patch('requests.get', m_get), patch('subprocess.check_output', m_subprocess): |
| 242 | + import unstructured |
| 243 | +exit(0 if (m_get.call_count == 1 and m_subprocess.call_count == 1) else 1) |
| 244 | +""" |
| 245 | + result = subprocess.run( |
| 246 | + [sys.executable, "-c", script], |
| 247 | + env=env, |
| 248 | + cwd=project_root, |
| 249 | + capture_output=True, |
| 250 | + text=True, |
| 251 | + timeout=30, |
| 252 | + ) |
| 253 | + assert result.returncode == 0, ( |
| 254 | + "Import with opt-in should run telemetry exactly once (requests.get and " |
| 255 | + "subprocess.check_output each called once). " |
| 256 | + f"stderr={result.stderr!r} stdout={result.stdout!r}" |
| 257 | + ) |
0 commit comments