Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Require scie-pants 0.9.2 or newer, for new distribution model (Cherry-pick of #19654) #19694

Merged
merged 1 commit into from
Aug 29, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 33 additions & 1 deletion src/python/pants/bin/pants_runner.py
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,9 @@
from dataclasses import dataclass
from typing import List, Mapping

from packaging.version import Version

from pants.base.deprecated import warn_or_error
from pants.base.exception_sink import ExceptionSink
from pants.base.exiter import ExitCode
from pants.engine.env_vars import CompleteEnvironmentVars
Expand All @@ -20,6 +23,10 @@

logger = logging.getLogger(__name__)

# Pants 2.18 is using a new distribution model, that's only supported in 0.9.0 (this is 0.9.2,
# because _detecting_ the version is only supported from 0.9.2), so people should upgrade
MINIMUM_SCIE_PANTS_VERSION = Version("0.9.2")


@dataclass(frozen=True)
class PantsRunner:
Expand Down Expand Up @@ -80,7 +87,11 @@ def run(self, start_time: float) -> ExitCode:
stdout_fileno=stdout_fileno,
stderr_fileno=stderr_fileno,
):
if "SCIE" not in os.environ and "NO_SCIE_WARNING" not in os.environ:
run_via_scie = "SCIE" in os.environ
enable_scie_warning = "NO_SCIE_WARNING" not in os.environ
scie_pants_version = os.environ.get("SCIE_PANTS_VERSION")

if not run_via_scie and enable_scie_warning:
raise RuntimeError(
softwrap(
f"""
Expand All @@ -90,6 +101,27 @@ def run(self, start_time: float) -> ExitCode:
),
)

if run_via_scie and (
# either scie-pants is too old to communicate its version:
scie_pants_version is None
# or the version itself is too old:
or Version(scie_pants_version) < MINIMUM_SCIE_PANTS_VERSION
):
current_version_text = (
f"The current version of the `pants` launcher binary is {scie_pants_version}"
if scie_pants_version
else "Run `PANTS_BOOTSTRAP_VERSION=report pants` to see the current version of the `pants` launcher binary"
)
warn_or_error(
"2.18.0.dev6",
f"using a `pants` launcher binary older than {MINIMUM_SCIE_PANTS_VERSION}",
softwrap(
f"""
{current_version_text}, and see {doc_url("installation")} for how to upgrade.
"""
),
)

# N.B. We inline imports to speed up the python thin client run, and avoids importing
# engine types until after the runner has had a chance to set __PANTS_BIN_NAME.
if self._should_run_with_pantsd(global_bootstrap_options):
Expand Down