sentry-devenv 1.18.0__tar.gz → 1.20.0__tar.gz

{sentry_devenv-1.18.0 → sentry_devenv-1.20.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sentry_devenv
-Version: 1.18.0
+Version: 1.20.0
 Summary: Utilities for setting up a Sentry development environment
 Author-email: Joshua Li <joshua.li@sentry.io>, Ian Woodard <ian.woodard@sentry.io>, Buck Evan <buck.evan@sentry.io>
 Classifier: Programming Language :: Python :: 3

sentry_devenv-1.18.0/devenv/checks/credsStore.py → sentry_devenv-1.20.0/devenv/checks/dockerConfig.py

@@ -8,7 +8,7 @@ from devenv.lib_check.types import checker
 from devenv.lib_check.types import fixer
 
 tags: set[str] = {"builtin"}
-name = "credsStore"
+name = "correct docker configuration"
 
 
 @checker
@@ -23,6 +23,15 @@ def check() -> tuple[bool, str]:
     if store and not shutil.which(f"docker-credential-{store}"):
         return False, "credsStore requires nonexistent binary"
 
+    # When docker-buildx is installed via brew, brew adds cliPluginsExtraDirs
+    # which takes precedence over the default plugin path we rely on.
+    # This ensures the devenv-managed global docker cli uses the default plugin path.
+    if config.get("cliPluginsExtraDirs"):
+        return (
+            False,
+            "cliPluginsExtraDirs exists, which overshadows the default plugin path",
+        )
+
     return True, ""
 
 
@@ -33,6 +42,7 @@ def fix() -> tuple[bool, str]:
             config = json.load(f)
 
         config.pop("credsStore", None)
+        config.pop("cliPluginsExtraDirs", None)
 
         with open(os.path.expanduser("~/.docker/config.json"), "w") as f:
             json.dump(config, f)

sentry_devenv-1.20.0/devenv/checks/dockerDesktop.py

@@ -0,0 +1,47 @@
+from __future__ import annotations
+
+import time
+
+from devenv.lib import proc
+from devenv.lib_check.types import checker
+from devenv.lib_check.types import fixer
+
+tags: set[str] = {"builtin"}
+name = "docker desktop shouldn't be running"
+
+
+def docker_desktop_is_running() -> bool:
+    procs = proc.run(("/bin/ps", "-Ac", "-o", "comm"), stdout=True)
+    return "Docker Desktop" in procs.split("\n")
+
+
+@checker
+def check() -> tuple[bool, str]:
+    if docker_desktop_is_running():
+        return (
+            False,
+            "Docker Desktop is running. We don't support it, and it conflicts with colima.",
+        )
+
+    return True, ""
+
+
+@fixer
+def fix() -> tuple[bool, str]:
+    # regular pkill won't stop the Docker Desktop UI,
+    # it'll just spin. the proper way to terminate it
+    # without SIGKILL is to use osascript.
+    print("Attempting to stop Docker Desktop.")
+    try:
+        proc.run(("osascript", "-e", 'quit app "Docker Desktop"'))
+    except RuntimeError as e:
+        return False, f"failed to quit Docker Desktop:\n{e}\n"
+
+    # osascript doesn't wait to make sure it finishes quitting
+    # so let's block for up to 5 secs
+    for _ in range(10):
+        time.sleep(0.5)
+        if not docker_desktop_is_running():
+            return True, ""
+
+    return False, "Docker Desktop is taking too long to quit... try again?"

{sentry_devenv-1.18.0 → sentry_devenv-1.20.0}/devenv/checks/limaDns.py

@@ -8,7 +8,7 @@ from devenv.lib_check.types import checker
 from devenv.lib_check.types import fixer
 
 tags: set[str] = {"builtin"}
-name = "limaDns"
+name = "colima's DNS isn't working"
 
 
 @checker
@@ -19,7 +19,7 @@ def check() -> tuple[bool, str]:
 
     status = colima.check()
     if status != colima.ColimaStatus.UP:
-        return False, "colima isn't up"
+        return False, "Colima isn't running."
 
     try:
         proc.run(

{sentry_devenv-1.18.0 → sentry_devenv-1.20.0}/devenv/doctor.py

@@ -143,7 +143,7 @@ def run_checks(
     results: dict[Check, tuple[bool, str]] = {}
     for check in checks:
         if check in skip:
-            print(f"\t⏭️  Skipped {check.name}".expandtabs(4))
+            print(f"   ⏭️  Skipped {check.name}")
             continue
         futures[check] = executor.submit(check.check)
     for check, future in futures.items():
@@ -162,9 +162,9 @@ def filter_failing_checks(
     for check, result in results.items():
         ok, msg = result
         if ok:
-            print(f"\t✅ check: {check.name}".expandtabs(4))
+            print(f"   ✅ check: {check.name}")
             continue
-        print(f"\t❌ check: {check.name}{msg}".expandtabs(4))
+        print(f"   ❌ check: {check.name}\n   {msg}")
         failing_checks.append(check)
     return failing_checks
 
@@ -172,7 +172,7 @@ def filter_failing_checks(
 def prompt_for_fix(check: Check) -> bool:
     """Prompt the user to attempt a fix."""
     return input(
-        f"\t\tDo you want to attempt to fix {check.name}? (Y/n): ".expandtabs(4)
+        f"   Do you want to attempt to fix {check.name}? (Y/n): "
     ).lower() in {"y", "yes", ""}
 
 
@@ -229,19 +229,19 @@ def main(context: Context, argv: Sequence[str] | None = None) -> int:
         if args.check_only:
             return 1
 
-    print("\nThe following problems have been identified:")
     skip: list[Check] = []
+    print("\nLet's go through the failures one by one.")
     for check in failing_checks:
-        print(f"\t❌ {check.name}".expandtabs(4))
+        print(f"❌ {check.name}")
         # Prompt for fixes one by one, so the user can decide to skip a fix.
         if prompt_for_fix(check):
             ok, msg = attempt_fix(check, executor)
             if ok:
-                print(f"\t\t✅ fix: {check.name}".expandtabs(4))
+                print(f"✅ fix: {check.name}")
             else:
-                print(f"\t\t❌ fix: {check.name}{msg}".expandtabs(4))
+                print(f"❌ fix: {check.name}{msg}")
         else:
-            print(f"\t\t⏭️  Skipping {check.name}".expandtabs(4))
+            print(f"   ⏭️  Skipping {check.name}")
             skip.append(check)
 
     print("\nChecking that fixes worked as expected...")

{sentry_devenv-1.18.0 → sentry_devenv-1.20.0}/devenv/lib/archive.py

@@ -38,51 +38,60 @@ def download(
         dest = f"{cache_root}/{sha256}"
         os.makedirs(cache_root, exist_ok=True)
 
-    if not os.path.exists(dest):
-        headers = {}
-        if url.startswith("https://ghcr.io/v2/homebrew"):
-            # downloading homebrew blobs requires auth
-            # you can get an anonymous token from https://ghcr.io/token?service=ghcr.io&scope=repository%3Ahomebrew/core/go%3Apull
-            # but there's also a special shortcut token QQ==
-            # https://github.com/Homebrew/brew/blob/2184406bd8444e4de2626f5b0c749d4d08cb1aed/Library/Homebrew/brew.sh#L993
-            headers["Authorization"] = "bearer QQ=="
-
-        req = urllib.request.Request(url, headers=headers)
-
-        retry_sleep = 1.0
-        while retries >= 0:
-            try:
-                resp = urllib.request.urlopen(req)
-                break
-            except HTTPError as e:
-                if retries == 0:
-                    raise RuntimeError(f"Error getting {url}: {e}")
-                print(f"Error getting {url} ({retries} retries left): {e}")
-
-            time.sleep(retry_sleep)
-            retries -= 1
-            retry_sleep *= retry_exp
-
-        dest_dir = os.path.dirname(dest)
-        os.makedirs(dest_dir, exist_ok=True)
-
-        with tempfile.NamedTemporaryFile(delete=False, dir=dest_dir) as tmpf:
-            shutil.copyfileobj(resp, tmpf)
-            tmpf.seek(0)
-            checksum = hashlib.sha256()
+    if os.path.islink(dest):
+        # there are cases where dest can be an existing symlink
+        # (docker desktop starts and puts symlinks into ~/.docker/cli-plugins)
+        # such symlinks should be removed otherwise callers to download
+        # usually try to chmod after and end up with PermissionError
+        os.remove(dest)
+
+    if os.path.exists(dest):
+        return dest
+
+    headers = {}
+    if url.startswith("https://ghcr.io/v2/homebrew"):
+        # downloading homebrew blobs requires auth
+        # you can get an anonymous token from https://ghcr.io/token?service=ghcr.io&scope=repository%3Ahomebrew/core/go%3Apull
+        # but there's also a special shortcut token QQ==
+        # https://github.com/Homebrew/brew/blob/2184406bd8444e4de2626f5b0c749d4d08cb1aed/Library/Homebrew/brew.sh#L993
+        headers["Authorization"] = "bearer QQ=="
+
+    req = urllib.request.Request(url, headers=headers)
+
+    retry_sleep = 1.0
+    while retries >= 0:
+        try:
+            resp = urllib.request.urlopen(req)
+            break
+        except HTTPError as e:
+            if retries == 0:
+                raise RuntimeError(f"Error getting {url}: {e}")
+            print(f"Error getting {url} ({retries} retries left): {e}")
+
+        time.sleep(retry_sleep)
+        retries -= 1
+        retry_sleep *= retry_exp
+
+    dest_dir = os.path.dirname(dest)
+    os.makedirs(dest_dir, exist_ok=True)
+
+    with tempfile.NamedTemporaryFile(delete=False, dir=dest_dir) as tmpf:
+        shutil.copyfileobj(resp, tmpf)
+        tmpf.seek(0)
+        checksum = hashlib.sha256()
+        buf = tmpf.read(4096)
+        while buf:
+            checksum.update(buf)
             buf = tmpf.read(4096)
-            while buf:
-                checksum.update(buf)
-                buf = tmpf.read(4096)
-
-            if not secrets.compare_digest(checksum.hexdigest(), sha256):
-                raise RuntimeError(
-                    f"checksum mismatch for {url}:\n"
-                    f"- got: {checksum.hexdigest()}\n"
-                    f"- expected: {sha256}\n"
-                )
-
-            atomic_replace(tmpf.name, dest)
+
+        if not secrets.compare_digest(checksum.hexdigest(), sha256):
+            raise RuntimeError(
+                f"checksum mismatch for {url}:\n"
+                f"- got: {checksum.hexdigest()}\n"
+                f"- expected: {sha256}\n"
+            )
+
+        atomic_replace(tmpf.name, dest)
 
     return dest
 

{sentry_devenv-1.18.0 → sentry_devenv-1.20.0}/devenv/lib/colima.py

@@ -78,7 +78,7 @@ def install_global() -> None:
         installed_version = stdout.strip().split()[-1]
         if version == installed_version:
             return
-        print(f"installed colima {installed_version} is outdated!")
+        print(f"installed colima {installed_version} is unexpected!")
 
     print(f"installing colima {version}...")
     uninstall(binroot)

{sentry_devenv-1.18.0 → sentry_devenv-1.20.0}/devenv/lib/docker.py

@@ -101,7 +101,7 @@ def _check_buildx(binroot: str, expected_version: str) -> bool:
         return True
 
     print(
-        f"installed docker-buildx {installed_version} is outdated! expected: {expected_version}"
+        f"installed docker-buildx {installed_version} is unexpected! expected: {expected_version}"
     )
     return False
 
@@ -133,7 +133,7 @@ def install_global() -> None:
         stdout = proc.run((f"{binroot}/docker", "--version"), stdout=True)
         installed_version = stdout.strip().split()[2][:-1]
         if version != installed_version:
-            print(f"installed docker {installed_version} is outdated!")
+            print(f"installed docker {installed_version} is unexpected!")
             print(f"installing docker (cli, not desktop) {version}...")
             uninstall(binroot)
             _install(

{sentry_devenv-1.18.0 → sentry_devenv-1.20.0}/devenv/lib/gcloud.py

@@ -82,7 +82,7 @@ def install(version: str, url: str, sha256: str, reporoot: str) -> None:
             installed_version = f.read().strip()
             if version == installed_version:
                 return
-            print(f"installed gcloud {installed_version} is outdated!")
+            print(f"installed gcloud {installed_version} is unexpected!")
 
     print(f"installing gcloud {version}...")
     uninstall(binroot)

{sentry_devenv-1.18.0 → sentry_devenv-1.20.0}/devenv/lib/limactl.py

@@ -91,7 +91,7 @@ def install_global() -> None:
         installed_version = stdout.strip().split()[-1]
         if version == installed_version:
             return
-        print(f"installed limactl {installed_version} is outdated!")
+        print(f"installed limactl {installed_version} is unexpected!")
 
     uninstall(binroot)
     _install(cfg[SYSTEM_MACHINE], cfg[f"{SYSTEM_MACHINE}_sha256"], binroot)

{sentry_devenv-1.18.0 → sentry_devenv-1.20.0}/devenv/lib/node.py

@@ -67,7 +67,7 @@ def installed(version: str, binroot: str) -> bool:
         if version == installed_version:
             return True
 
-        print(f"installed node {installed_version} is outdated!")
+        print(f"installed node {installed_version} is unexpected!")
         return False
 
 
@@ -118,7 +118,7 @@ def installed_yarn(version: str, binroot: str) -> bool:
     if version == installed_version:
         return True
 
-    print(f"installed yarn {installed_version} is outdated!")
+    print(f"installed yarn {installed_version} is unexpected!")
     return False
 
 

{sentry_devenv-1.18.0 → sentry_devenv-1.20.0}/devenv/lib/tenv.py

@@ -88,7 +88,7 @@ def install(version: str, url: str, sha256: str, reporoot: str) -> None:
         installed_version = _version(binpath)
         if version == installed_version:
             return
-        print(f"installed tenv {installed_version} is outdated!")
+        print(f"installed tenv {installed_version} is unexpected!")
 
     print(f"installing tenv {version}...")
     uninstall(binroot)

{sentry_devenv-1.18.0 → sentry_devenv-1.20.0}/devenv/lib/venv.py

@@ -106,7 +106,7 @@ def ensure(venv: str, python_version: str, url: str, sha256: str) -> None:
         return
 
     print(
-        f"virtualenv doesn't exist or is using an outdated python, recreating at {venv}..."
+        f"virtualenv doesn't exist or is using an unexpected python, recreating at {venv}..."
     )
     if os.path.exists(venv):
         shutil.rmtree(venv)

{sentry_devenv-1.18.0 → sentry_devenv-1.20.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "sentry_devenv"
-version = "1.18.0"
+version = "1.20.0"
 authors = [
   { name="Joshua Li", email="joshua.li@sentry.io" },
   { name="Ian Woodard", email="ian.woodard@sentry.io" },

{sentry_devenv-1.18.0 → sentry_devenv-1.20.0}/sentry_devenv.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sentry_devenv
-Version: 1.18.0
+Version: 1.20.0
 Summary: Utilities for setting up a Sentry development environment
 Author-email: Joshua Li <joshua.li@sentry.io>, Ian Woodard <ian.woodard@sentry.io>, Buck Evan <buck.evan@sentry.io>
 Classifier: Programming Language :: Python :: 3

{sentry_devenv-1.18.0 → sentry_devenv-1.20.0}/sentry_devenv.egg-info/SOURCES.txt

@@ -16,7 +16,8 @@ devenv/pythons.py
 devenv/sync.py
 devenv/update.py
 devenv/checks/__init__.py
-devenv/checks/credsStore.py
+devenv/checks/dockerConfig.py
+devenv/checks/dockerDesktop.py
 devenv/checks/limaDns.py
 devenv/checks/test.py
 devenv/lib/__init__.py
@@ -54,7 +55,7 @@ tests/test_pythons.py
 tests/test_sync.py
 tests/utils.py
 tests/checks/__init__.py
-tests/checks/test_credStore.py
+tests/checks/test_dockerConfig.py
 tests/doctor/__init__.py
 tests/doctor/test_attempt_fix.py
 tests/doctor/test_filter_failing_checks.py

sentry_devenv-1.18.0/tests/checks/test_credStore.py → sentry_devenv-1.20.0/tests/checks/test_dockerConfig.py

@@ -8,7 +8,7 @@ from unittest import mock
 
 import pytest
 
-from devenv.checks import credsStore
+from devenv.checks import dockerConfig
 
 
 @pytest.fixture
@@ -25,26 +25,32 @@ def fake_config(tmp_path: pathlib.Path) -> Generator[pathlib.Path]:
 
 def test_no_credsStore_ok(fake_config: pathlib.Path) -> None:
     fake_config.write_text("{}")
-    assert credsStore.check() == (True, "")
+    assert dockerConfig.check() == (True, "")
 
 
 def test_binary_ok(fake_config: pathlib.Path) -> None:
     fake_config.write_text('{"credsStore": "example"}')
     with mock.patch.object(shutil, "which", return_value="/fake/exe"):
-        assert credsStore.check() == (True, "")
+        assert dockerConfig.check() == (True, "")
 
 
 @pytest.mark.parametrize("name", ("desktop", "osxkeychain"))
 def test_binary_missing(fake_config: pathlib.Path, name: str) -> None:
     fake_config.write_text(f'{{"credsStore": "{name}"}}')
     with mock.patch.object(shutil, "which", return_value=None):
-        assert credsStore.check() == (
+        assert dockerConfig.check() == (
             False,
             "credsStore requires nonexistent binary",
         )
 
 
-def test_fix(fake_config: pathlib.Path) -> None:
+def test_fix_credsStore(fake_config: pathlib.Path) -> None:
     fake_config.write_text('{"credsStore": "bad"}')
-    assert credsStore.fix() == (True, "")
+    assert dockerConfig.fix() == (True, "")
+    assert fake_config.read_text() == "{}"
+
+
+def test_fix_cliPluginsExtraDirs(fake_config: pathlib.Path) -> None:
+    fake_config.write_text('{"cliPluginsExtraDirs": ["foo/"]}')
+    assert dockerConfig.fix() == (True, "")
     assert fake_config.read_text() == "{}"

{sentry_devenv-1.18.0 → sentry_devenv-1.20.0}/tests/doctor/test_run_checks.py

@@ -51,7 +51,7 @@ def test_run_checks_skip(capsys: pytest.CaptureFixture[str]) -> None:
         [first_check, second_check], ThreadPoolExecutor(), skip=[second_check]
     ) == {first_check: (True, "")}
     captured = capsys.readouterr()
-    assert captured.out == "    ⏭️  Skipped failing check\n"
+    assert captured.out == "   ⏭️  Skipped failing check\n"
 
 
 def test_run_checks_multiple_failing_checks() -> None:

{sentry_devenv-1.18.0 → sentry_devenv-1.20.0}/tests/lib/test_archive.py

@@ -1,6 +1,7 @@
 from __future__ import annotations
 
 import io
+import os
 import pathlib
 import tarfile
 import time
@@ -169,6 +170,12 @@ def test_download(tmp_path: pathlib.Path, mock_sleep: mock.MagicMock) -> None:
     )
 
     dest = f"{tmp_path}/a"
+
+    # if dest is already a valid symlink it should be paved over
+    with open(f"{tmp_path}/hi", "wb"):
+        pass
+    os.symlink(f"{tmp_path}/hi", dest)
+
     with mock.patch.object(
         urllib.request,
         "urlopen",
@@ -186,7 +193,22 @@ def test_download(tmp_path: pathlib.Path, mock_sleep: mock.MagicMock) -> None:
     with open(dest, "rb") as f:
         assert f.read() == data
 
-    dest = f"{tmp_path}/b"
+
+def test_download_exceeded_retries(
+    tmp_path: pathlib.Path, mock_sleep: mock.MagicMock
+) -> None:
+    data_sha256 = (
+        "b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c"
+    )
+
+    err = urllib.error.HTTPError(
+        "https://example.com/foo",
+        503,
+        "Service Unavailable",
+        "",  # type: ignore
+        io.BytesIO(b""),
+    )
+    dest = f"{tmp_path}/a"
     with pytest.raises(RuntimeError) as excinfo:
         with mock.patch.object(
             urllib.request,
@@ -202,7 +224,42 @@ def test_download(tmp_path: pathlib.Path, mock_sleep: mock.MagicMock) -> None:
         == "Error getting https://example.com/foo: HTTP Error 503: Service Unavailable"
     )
 
-    dest = f"{tmp_path}/b"
+
+def test_download_dest_is_broken_symlink(
+    tmp_path: pathlib.Path, mock_sleep: mock.MagicMock
+) -> None:
+    data = b"foo\n"
+    data_sha256 = (
+        "b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c"
+    )
+
+    dest = f"{tmp_path}/a"
+
+    # if dest is already a dead symlink it should be paved over as well
+    os.symlink(f"{tmp_path}/does-not-exist", dest)
+
+    with mock.patch.object(
+        urllib.request,
+        "urlopen",
+        autospec=True,
+        side_effect=(io.BytesIO(data),),
+    ):
+        archive.download("https://example.com/foo", data_sha256, dest)
+
+    with open(dest, "rb") as f:
+        assert f.read() == data
+
+
+def test_download_wrong_sha(
+    tmp_path: pathlib.Path, mock_sleep: mock.MagicMock
+) -> None:
+    data = b"foo\n"
+    data_sha256 = (
+        "b5bb9d8014a0f9b1d61e21e796d78dccdf1352f23cd32812f4850b878ae4944c"
+    )
+
+    dest = f"{tmp_path}/a"
+
     with pytest.raises(RuntimeError) as excinfo:
         with mock.patch.object(
             urllib.request,