Skip to content

Quote labels in missing toolchains debug advice #27104

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

Closed
wants to merge 2 commits into from
Closed

Quote labels in missing toolchains debug advice #27104

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
64ae5ad
Quote labels in missing toolchains debug advice
Silic0nS0ldier Sep 29, 2025
4cf7f09
Quote only if necessary, add test case
Silic0nS0ldier Oct 2, 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
15 changes: 15 additions & 0 deletions ...n/java/com/google/devtools/build/lib/skyframe/toolchains/ToolchainResolutionFunction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@
import java.util.Optional;
import java.util.SequencedSet;
import java.util.Set;
import java.util.regex.Pattern;
import javax.annotation.Nullable;

/**
Expand Down Expand Up @@ -392,10 +393,24 @@ protected Code getDetailedCode() {

private static String getMessage(
PlatformInfo targetPlatformInfo, SequencedSet<ToolchainTypeInfo> missingToolchainTypes) {
// All characters with special meaning anywhere in a regex (':' for example is only special within brackets).
List<Character> regexSpecialChars = "+.|([{^$?\\*".codePoints()
.mapToObj(c -> (char) c)
.toList();
ImmutableList<String> labelStrings =
missingToolchainTypes.stream()
.map(ToolchainTypeInfo::typeLabel)
.map(Label::toString)
.map(label -> {
// Regex-quote if label contains special characters.
for (char c : regexSpecialChars) {
if (label.indexOf(c) >= 0) {
return Pattern.quote(label);
}
}

return label;
})
.collect(toImmutableList());
ImmutableList<String> missingToolchainRows =
missingToolchainTypes.stream()
Expand Down
2 changes: 2 additions & 0 deletions src/test/java/com/google/devtools/build/lib/skyframe/toolchains/BUILD
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,11 +139,13 @@ java_test(
"//src/main/java/com/google/devtools/build/lib/analysis:platform_options",
"//src/main/java/com/google/devtools/build/lib/analysis/config:build_options",
"//src/main/java/com/google/devtools/build/lib/analysis/config:toolchain_type_requirement",
"//src/main/java/com/google/devtools/build/lib/analysis/platform",
"//src/main/java/com/google/devtools/build/lib/cmdline",
"//src/main/java/com/google/devtools/build/lib/skyframe/config",
"//src/main/java/com/google/devtools/build/lib/skyframe/toolchains:constraint_value_lookup_util",
"//src/main/java/com/google/devtools/build/lib/skyframe/toolchains:platform_lookup_util",
"//src/main/java/com/google/devtools/build/lib/skyframe/toolchains:toolchain_context_key",
"//src/main/java/com/google/devtools/build/lib/skyframe/toolchains:toolchain_resolution_function",
"//src/main/java/com/google/devtools/build/lib/skyframe/toolchains:toolchain_type_lookup_util",
"//src/main/java/com/google/devtools/build/lib/skyframe/toolchains:unloaded_toolchain_context",
"//src/main/java/com/google/devtools/build/skyframe",
Expand Down
28 changes: 27 additions & 1 deletion ...va/com/google/devtools/build/lib/skyframe/toolchains/ToolchainResolutionFunctionTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,11 @@
import static com.google.devtools.build.skyframe.EvaluationResultSubjectFactory.assertThatEvaluationResult;

import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.analysis.PlatformOptions;
import com.google.devtools.build.lib.analysis.config.BuildOptions;
import com.google.devtools.build.lib.analysis.config.ToolchainTypeRequirement;
import com.google.devtools.build.lib.analysis.platform.PlatformInfo;
import com.google.devtools.build.lib.analysis.platform.ToolchainTypeInfo;
import com.google.devtools.build.lib.analysis.PlatformOptions;
import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.rules.platform.ToolchainTestCase;
import com.google.devtools.build.lib.skyframe.config.BuildConfigurationKey;
Expand All @@ -30,6 +32,7 @@
import com.google.devtools.build.lib.skyframe.util.SkyframeExecutorTestUtils;
import com.google.devtools.build.skyframe.EvaluationResult;
import com.google.devtools.build.skyframe.SkyKey;
import java.util.LinkedHashSet;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
Expand Down Expand Up @@ -396,6 +399,29 @@ public void resolve_mandatory_missing() throws Exception {
""");
}

@Test
public void unresolved_toolchain_message_regex_quotes() throws Exception {
PlatformInfo platformInfo = PlatformInfo.builder()
.setLabel(Label.parseCanonicalUnchecked("//platforms:test_platform"))
.build();
ToolchainTypeInfo toolchainTypeInfo = ToolchainTypeInfo.create(
Label.parseCanonicalUnchecked("@@repo+//toolchain:test_toolchain"));
LinkedHashSet<ToolchainTypeInfo> missingToolchainTypes = new LinkedHashSet<>();
missingToolchainTypes.add(toolchainTypeInfo);

var exception = new ToolchainResolutionFunction.UnresolvedToolchainsException(platformInfo, missingToolchainTypes);

assertThat(exception)
.hasMessageThat()
.isEqualTo(
"""
No matching toolchains found for types:
@@repo+//toolchain:test_toolchain
To debug, rerun with --toolchain_resolution_debug='\\Q@@repo+//toolchain:test_toolchain\\E'
"""
);
}

@Test
public void resolve_mandatory_missing_customPlatformMessage() throws Exception {
scratch.appendFile(
Expand Down
Loading