Skip to content

chore: migrate off of bazelisk query command #14214

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.

Sign up for GitHub

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

Merged
ohmayr merged 2 commits into from
Aug 12, 2025
Merged

chore: migrate off of bazelisk query command #14214

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
45943da
chore: migrate off of bazelisk query command
ohmayr Aug 11, 2025
ad04076
update tests
ohmayr Aug 12, 2025
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
49 changes: 28 additions & 21 deletions .generator/cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
import json
import logging
import os
import re
import subprocess
import sys
import subprocess
Expand Down Expand Up @@ -66,37 +67,43 @@ def handle_configure():


def _determine_bazel_rule(api_path: str, source: str) -> str:
"""Executes a `bazelisk query` to find a Bazel rule.
"""Finds a Bazel rule by parsing the BUILD.bazel file directly.

Args:
api_path(str): The API path to query for.
api_path (str): The API path, e.g., 'google/cloud/language/v1'.
source(str): The path to the root of the Bazel workspace.

Returns:
str: The discovered Bazel rule.
str: The discovered Bazel rule, e.g., '//google/cloud/language/v1:language-v1-py'.

Raises:
ValueError: If the subprocess call fails or returns an empty result.
ValueError: If the file can't be processed or no matching rule is found.
"""
logger.info(f"Determining Bazel rule for api_path: '{api_path}'")
logger.info(f"Determining Bazel rule for api_path: '{api_path}' by parsing file.")
try:
query = f'filter("-py$", kind("rule", //{api_path}/...:*))'
command = ["bazelisk", "query", query]
result = subprocess.run(
command,
cwd=source,
capture_output=True,
text=True,
check=True,
)
bazel_rule = result.stdout.strip()
if not bazel_rule:
raise ValueError(f"Bazelisk query `{query}` returned an empty bazel rule.")
build_file_path = os.path.join(source, api_path, "BUILD.bazel")

with open(build_file_path, "r") as f:
content = f.read()

match = re.search(r'name\s*=\s*"([^"]+-py)"', content)

# This check is for a logical failure (no match), not a runtime exception.
# It's good to keep it for clear error messaging.
if not match:
raise ValueError(
f"No Bazel rule with a name ending in '-py' found in {build_file_path}"
)

rule_name = match.group(1)
bazel_rule = f"//{api_path}:{rule_name}"

logger.info(f"Found Bazel rule: {bazel_rule}")
return bazel_rule
except Exception as e:
raise ValueError(f"Bazelisk query `{query}` failed") from e
raise ValueError(
f"Failed to determine Bazel rule for '{api_path}' by parsing."
) from e


def _get_library_id(request_data: Dict) -> str:
Expand Down Expand Up @@ -227,11 +234,11 @@ def handle_generate(
Args:
librarian(str): Path to the directory in the container which contains
the librarian configuration.
source(str): Path to the directory in the container which contains
source(str): Path to the directory in the container which contains
API protos.
output(str): Path to the directory in the container where code
output(str): Path to the directory in the container where code
should be generated.
input(str): The path path to the directory in the container
input(str): The path path to the directory in the container
which contains additional generator input.

Raises:
Expand Down
36 changes: 27 additions & 9 deletions .generator/test_cli.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,10 +110,8 @@ def test_determine_bazel_rule_success(mocker, caplog):
Tests the happy path of _determine_bazel_rule.
"""
caplog.set_level(logging.INFO)
mock_result = MagicMock(
stdout="//google/cloud/language/v1:google-cloud-language-v1-py\n"
)
mocker.patch("cli.subprocess.run", return_value=mock_result)
mock_content = 'name = "google-cloud-language-v1-py",\n'
mocker.patch("cli.open", mock_open(read_data=mock_content))

rule = _determine_bazel_rule("google/cloud/language/v1", "source")

Expand All @@ -131,15 +129,35 @@ def test_build_bazel_target_success(mocker, caplog):
assert "Bazel build for mock/bazel:rule rule completed successfully" in caplog.text


def test_build_bazel_target_fails_to_find_rule_match(mocker, caplog):
"""
Tests that ValueError is raised if the subprocess command fails.
"""
caplog.set_level(logging.ERROR)
mock_content = '"google-cloud-language-v1-py",\n'
mocker.patch("cli.open", mock_open(read_data=mock_content))

with pytest.raises(ValueError):
_build_bazel_target("mock/bazel:rule", "source")


def test_build_bazel_target_fails_to_determine_rule(caplog):
"""
Tests that ValueError is raised if the subprocess command fails.
"""
caplog.set_level(logging.ERROR)
with pytest.raises(ValueError):
_build_bazel_target("mock/bazel:rule", "source")


def test_build_bazel_target_fails(mocker, caplog):
"""
Tests that ValueError is raised if the subprocess command fails.
"""
caplog.set_level(logging.ERROR)
mocker.patch(
"cli.subprocess.run",
side_effect=subprocess.CalledProcessError(1, "cmd", stderr="Build failed"),
)
mock_content = '"google-cloud-language-v1-py",\n'
mocker.patch("cli.open", mock_open(read_data=mock_content))

with pytest.raises(ValueError):
_build_bazel_target("mock/bazel:rule", "source")

Expand Down Expand Up @@ -174,7 +192,7 @@ def test_locate_and_extract_artifact_success(mocker, caplog):
"google-cloud-language",
"source",
"output",
"google/cloud/language/v1"
"google/cloud/language/v1",
)
assert (
"Found artifact at: /path/to/bazel-bin/google/cloud/language/v1/rule-py.tar.gz"
Expand Down
Loading