Skip to content
Merged
Show file tree
Hide file tree
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
27 changes: 25 additions & 2 deletions BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -75,18 +75,41 @@ exports_files(
visibility = ["//docs:__subpackages__"],
)

# LINT.IfChange(synced_files)
filegroup(
name = "downloader_configs",
srcs = [
"downloader_cfg.bazelrc",
"downloader_config.cfg",
],
visibility = ["//tests:__subpackages__"],
)

# Expose gazelle's synced downloader configs from the root package:
# rules_python_gazelle_plugin is not a bazel_dep in root MODULE.bazel, and
# .bazelrc.deleted_packages disables //gazelle so Bazel ignores
# gazelle/BUILD.bazel and treats gazelle/* as part of //.
filegroup(
name = "gazelle_downloader_configs",
srcs = [
"gazelle/downloader_cfg.bazelrc",
"gazelle/downloader_config.cfg",
],
visibility = ["//tests:__subpackages__"],
)
# LINT.ThenChange(//dev/sync_downloader_configs.py:synced_files)

filegroup(
name = "distribution",
srcs = [
"BUILD.bazel",
"MODULE.bazel",
"WORKSPACE",
"WORKSPACE.bzlmod",
"downloader_cfg.bazelrc",
"downloader_config.cfg",
"internal_dev_deps.bzl",
"internal_dev_setup.bzl",
"version.bzl",
":downloader_configs",
"//command_line_option:distribution",
"//crates:distribution",
"//python:distribution",
Expand Down
8 changes: 8 additions & 0 deletions dev/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
load("@rules_multirun//:defs.bzl", "multirun")
load("//python:py_library.bzl", "py_library")
load("//python/uv:lock.bzl", "lock") # buildifier: disable=bzl-visibility

licenses(["notice"])
Expand All @@ -11,6 +12,13 @@ exports_files(
visibility = ["//:__subpackages__"],
)

py_library(
name = "sync_downloader_configs",
srcs = ["sync_downloader_configs.py"],
imports = [".."],
visibility = ["//:__subpackages__"],
)

# Run bazel run //dev:uv_lock.update
lock(
name = "uv_lock",
Expand Down
31 changes: 24 additions & 7 deletions dev/sync_downloader_configs.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,41 +10,58 @@
file was updated.
"""

from __future__ import annotations

import sys
from pathlib import Path

# Config filenames relative to a module root directory.
_SYNCED_FILES = (
# LINT.IfChange(synced_files)
SYNCED_FILES = (
# keep-sorted start
"downloader_cfg.bazelrc",
"downloader_config.cfg",
# keep-sorted end
)
# LINT.ThenChange(//sphinxdocs/BUILD.bazel:synced_files)

# Standalone module subworkspace paths relative to the repository root.
_SUBWORKSPACE_DIRS = (
# LINT.IfChange(subworkspace_dirs)
SUBWORKSPACE_DIRS = (
# keep-sorted start
"gazelle",
"sphinxdocs",
# keep-sorted end
)
# LINT.ThenChange(//tests/dev/BUILD.bazel:subworkspace_dirs)


def main() -> None:
repo_root = Path(__file__).resolve().parent.parent
def sync_downloader_configs(repo_root: Path) -> list[str]:
"""Synchronizes root downloader config files into standalone subworkspaces.

Args:
repo_root: Path to the repository root directory.

Returns:
Sorted repository-root-relative POSIX paths of files that were updated.
"""
updated: list[str] = []
for filename in _SYNCED_FILES:
for filename in SYNCED_FILES:
canonical = repo_root / filename
canonical_content = canonical.read_text(encoding="utf-8")
for rel_dir in _SUBWORKSPACE_DIRS:
for rel_dir in SUBWORKSPACE_DIRS:
sub = repo_root / rel_dir / filename
if sub.read_text(encoding="utf-8") != canonical_content:
sub.write_text(canonical_content, encoding="utf-8")
updated.append(sub.relative_to(repo_root).as_posix())
return sorted(updated)


def main() -> None:
repo_root = Path(__file__).resolve().parent.parent
updated = sync_downloader_configs(repo_root)
if updated:
for rel_path in sorted(updated):
for rel_path in updated:
print(f"{rel_path}: out of sync (updated from root)")
sys.exit(1)

Expand Down
14 changes: 14 additions & 0 deletions sphinxdocs/BUILD.bazel
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,30 @@ package(default_visibility = ["//visibility:public"])

exports_files(["pyproject.toml"])

# LINT.IfChange(synced_files)
filegroup(
name = "downloader_configs",
srcs = [
"downloader_cfg.bazelrc",
"downloader_config.cfg",
],
visibility = ["@rules_python//tests:__subpackages__"],
)
# LINT.ThenChange(//BUILD.bazel:synced_files)

filegroup(
name = "distribution",
srcs = glob(
["**/*"],
exclude = [
"bazel-*/**",
"downloader_cfg.bazelrc",
"downloader_config.cfg",
"integration_tests/**",
"tests/**",
],
) + [
":downloader_configs",
"//dev:distribution",
"//sphinxdocs:distribution",
],
Expand Down
17 changes: 17 additions & 0 deletions tests/dev/BUILD.bazel
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
load("@bazel_skylib//rules:build_test.bzl", "build_test")
load("//python:pytest_test.bzl", "pytest_test")
load("//python/private:bzlmod_enabled.bzl", "BZLMOD_ENABLED") # buildifier: disable=bzl-visibility

# Builds the cross-compiled release files in test runs too, e.g. with
Expand All @@ -10,3 +11,19 @@ build_test(
tags = [] if BZLMOD_ENABLED else ["manual"],
targets = ["//dev/release_artifacts:cross_compiled_artifacts"],
)

pytest_test(
name = "sync_downloader_configs_test",
srcs = ["sync_downloader_configs_test.py"],
# LINT.IfChange(subworkspace_dirs)
data = [
"//:downloader_configs",
"//:gazelle_downloader_configs",
"@sphinxdocs//:downloader_configs",
],
# LINT.ThenChange(//tests/dev/sync_downloader_configs_test.py:subworkspace_dirs)
deps = [
"//dev:sync_downloader_configs",
"//python/runfiles",
],
)
64 changes: 64 additions & 0 deletions tests/dev/sync_downloader_configs_test.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
"""Tests that subworkspace downloader configs stay in sync with root configs."""

from __future__ import annotations

from pathlib import Path

from dev import sync_downloader_configs
from python.runfiles import runfiles

# Maps subworkspace directory names (from SUBWORKSPACE_DIRS) to their runfiles
# path prefixes relative to rf.root().
# LINT.IfChange(subworkspace_dirs)
_SUBWORKSPACE_RUNFILES_PREFIXES = {
# keep-sorted start
"gazelle": "rules_python/gazelle",
"sphinxdocs": "sphinxdocs",
# keep-sorted end
}
# LINT.ThenChange(//dev/sync_downloader_configs.py:subworkspace_dirs)


def test_subworkspace_files_match_root():
rf = runfiles.CreateOrRaise()
root = rf.root()

assert set(_SUBWORKSPACE_RUNFILES_PREFIXES) == set(
sync_downloader_configs.SUBWORKSPACE_DIRS
)

mismatched: list[str] = []
for filename in sync_downloader_configs.SYNCED_FILES:
canonical = (root / f"rules_python/{filename}").read_text(encoding="utf-8")
for rel_dir, rf_prefix in _SUBWORKSPACE_RUNFILES_PREFIXES.items():
sub_content = (root / f"{rf_prefix}/{filename}").read_text(encoding="utf-8")
if sub_content != canonical:
mismatched.append(f"{rel_dir}/{filename}")

assert not mismatched, (
"Out-of-sync downloader configs (run ./dev/sync_downloader_configs.py):\n"
+ "\n".join(sorted(mismatched))
)


def test_updates_stale_files(tmp_path: Path):
for filename in sync_downloader_configs.SYNCED_FILES:
(tmp_path / filename).write_text(f"canonical {filename}\n", encoding="utf-8")
for rel_dir in sync_downloader_configs.SUBWORKSPACE_DIRS:
sub = tmp_path / rel_dir / filename
sub.parent.mkdir(parents=True, exist_ok=True)
sub.write_text("stale\n", encoding="utf-8")

updated = sync_downloader_configs.sync_downloader_configs(tmp_path)

assert updated == [
"gazelle/downloader_cfg.bazelrc",
"gazelle/downloader_config.cfg",
"sphinxdocs/downloader_cfg.bazelrc",
"sphinxdocs/downloader_config.cfg",
]
for filename in sync_downloader_configs.SYNCED_FILES:
for rel_dir in sync_downloader_configs.SUBWORKSPACE_DIRS:
sub = tmp_path / rel_dir / filename
assert sub.read_text(encoding="utf-8") == f"canonical {filename}\n"
assert sync_downloader_configs.sync_downloader_configs(tmp_path) == []
Loading