Skip to content

Commit 07c5c1a

Browse files
fmeumcopybara-github
fmeum
authored and
copybara-github
committed
Ensure repository names don't start with ~
By ensuring that repository names do not start with `~`, runfiles paths are certain not to begin with tildes, which means that they don't need to be shell escaped. Prevents bazelbuild#16560 (comment) Closes bazelbuild#16564. PiperOrigin-RevId: 484232215 Change-Id: Ie70940aa709f6c7a886564189a3579780731dca6
1 parent 30f6c82 commit 07c5c1a

File tree

4 files changed

+33
-21
lines changed

4 files changed

+33
-21
lines changed

‎src/main/java/com/google/devtools/build/lib/bazel/bzlmod/BazelModuleResolutionFunction.java‎

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -366,8 +366,16 @@ static BazelModuleResolutionValue createValue(
366366
// Calculate a unique name for each used extension id.
367367
BiMap<String, ModuleExtensionId> extensionUniqueNames = HashBiMap.create();
368368
for (ModuleExtensionId id : extensionUsagesById.rowKeySet()) {
369-
String bestName =
370-
id.getBzlFileLabel().getRepository().getName() + "~" + id.getExtensionName();
369+
// Ensure that the resulting extension name (and thus the repository names derived from it) do
370+
// not start with a tilde.
371+
RepositoryName repository = id.getBzlFileLabel().getRepository();
372+
String nonEmptyRepoPart;
373+
if (repository.isMain()) {
374+
nonEmptyRepoPart = "_main";
375+
} else {
376+
nonEmptyRepoPart = repository.getName();
377+
}
378+
String bestName = nonEmptyRepoPart + "~" + id.getExtensionName();
371379
if (extensionUniqueNames.putIfAbsent(bestName, id) == null) {
372380
continue;
373381
}

‎src/main/java/com/google/devtools/build/lib/cmdline/RepositoryName.java‎

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,10 @@ public final class RepositoryName {
3939

4040
@SerializationConstant public static final RepositoryName MAIN = new RepositoryName("");
4141

42-
private static final Pattern VALID_REPO_NAME = Pattern.compile("[\\w\\-.~]*");
42+
// Repository names must not start with a tilde as shells treat unescaped paths starting with them
43+
// specially.
44+
// https://www.gnu.org/software/bash/manual/html_node/Tilde-Expansion.html
45+
private static final Pattern VALID_REPO_NAME = Pattern.compile("|[\\w\\-.][\\w\\-.~]*");
4346

4447
// Must start with a letter. Can contain ASCII letters and digits, underscore, dash, and dot.
4548
private static final Pattern VALID_USER_PROVIDED_NAME = Pattern.compile("[a-zA-Z][-.\\w]*$");
@@ -156,7 +159,7 @@ static void validate(String name) throws LabelSyntaxException {
156159
if (!VALID_REPO_NAME.matcher(name).matches()) {
157160
throw LabelParser.syntaxErrorf(
158161
"invalid repository name '@%s': repo names may contain only A-Z, a-z, 0-9, '-', '_', '.'"
159-
+ " and '~'",
162+
+ " and '~' and must not start with '~'",
160163
StringUtilities.sanitizeControlChars(name));
161164
}
162165
}

‎src/test/java/com/google/devtools/build/lib/bazel/bzlmod/ModuleExtensionResolutionTest.java‎

Lines changed: 17 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1041,7 +1041,7 @@ public void generatedReposHaveCorrectMappings_strictDepsViolation() throws Excep
10411041
assertThat(result.hasError()).isTrue();
10421042
assertThat(result.getError().getException())
10431043
.hasMessageThat()
1044-
.contains("No repository visible as '@foo' from repository '@~ext~ext'");
1044+
.contains("No repository visible as '@foo' from repository '@_main~ext~ext'");
10451045
}
10461046

10471047
@Test
@@ -1082,7 +1082,7 @@ public void importNonExistentRepo() throws Exception {
10821082
scratch.file(workspaceRoot.getRelative("BUILD").getPathString());
10831083
scratch.file(
10841084
workspaceRoot.getRelative("data.bzl").getPathString(),
1085-
"load('@@~ext~ext//:data.bzl', ext_data='data')",
1085+
"load('@@_main~ext~ext//:data.bzl', ext_data='data')",
10861086
"data=ext_data");
10871087

10881088
SkyKey skyKey = BzlLoadValue.keyForBuild(Label.parseCanonical("//:data.bzl"));
@@ -1216,7 +1216,7 @@ public void extensionRepoCtxReadsFromAnotherExtensionRepo() throws Exception {
12161216
workspaceRoot.getRelative("defs.bzl").getPathString(),
12171217
"load('@data_repo//:defs.bzl','data_repo')",
12181218
"def _ext_impl(ctx):",
1219-
" data_file = ctx.read(Label('@@~my_ext2~candy2//:data.bzl'))",
1219+
" data_file = ctx.read(Label('@@_main~my_ext2~candy2//:data.bzl'))",
12201220
" data_repo(name='candy1',data=data_file)",
12211221
"my_ext=module_extension(implementation=_ext_impl)",
12221222
"def _ext_impl2(ctx):",
@@ -1264,7 +1264,8 @@ public void testReportRepoAndBzlCycles_circularExtReposCtxRead() throws Exceptio
12641264
SkyKey skyKey =
12651265
PackageValue.key(
12661266
PackageIdentifier.create(
1267-
RepositoryName.createUnvalidated("~my_ext~candy1"), PathFragment.EMPTY_FRAGMENT));
1267+
RepositoryName.createUnvalidated("_main~my_ext~candy1"),
1268+
PathFragment.EMPTY_FRAGMENT));
12681269
EvaluationResult<PackageValue> result =
12691270
evaluator.evaluate(ImmutableList.of(skyKey), evaluationContext);
12701271
assertThat(result.hasError()).isTrue();
@@ -1275,11 +1276,11 @@ public void testReportRepoAndBzlCycles_circularExtReposCtxRead() throws Exceptio
12751276
assertContainsEvent(
12761277
"ERROR <no location>: Circular definition of repositories generated by module extensions"
12771278
+ " and/or .bzl files:\n"
1278-
+ ".-> @~my_ext~candy1\n"
1279+
+ ".-> @_main~my_ext~candy1\n"
12791280
+ "| extension 'my_ext' defined in //:defs.bzl\n"
1280-
+ "| @~my_ext2~candy2\n"
1281+
+ "| @_main~my_ext2~candy2\n"
12811282
+ "| extension 'my_ext2' defined in //:defs.bzl\n"
1282-
+ "`-- @~my_ext~candy1");
1283+
+ "`-- @_main~my_ext~candy1");
12831284
}
12841285

12851286
@Test
@@ -1310,7 +1311,7 @@ public void testReportRepoAndBzlCycles_circularExtReposLoadInDefFile() throws Ex
13101311
SkyKey skyKey =
13111312
PackageValue.key(
13121313
PackageIdentifier.create(
1313-
RepositoryName.createUnvalidated("~my_ext~candy1"),
1314+
RepositoryName.createUnvalidated("_main~my_ext~candy1"),
13141315
PathFragment.create("data.bzl")));
13151316
EvaluationResult<PackageValue> result =
13161317
evaluator.evaluate(ImmutableList.of(skyKey), evaluationContext);
@@ -1322,13 +1323,13 @@ public void testReportRepoAndBzlCycles_circularExtReposLoadInDefFile() throws Ex
13221323
assertContainsEvent(
13231324
"ERROR <no location>: Circular definition of repositories generated by module extensions"
13241325
+ " and/or .bzl files:\n"
1325-
+ ".-> @~my_ext~candy1\n"
1326+
+ ".-> @_main~my_ext~candy1\n"
13261327
+ "| extension 'my_ext' defined in //:defs.bzl\n"
1327-
+ "| @~my_ext2~candy2\n"
1328+
+ "| @_main~my_ext2~candy2\n"
13281329
+ "| extension 'my_ext2' defined in //:defs2.bzl\n"
13291330
+ "| //:defs2.bzl\n"
1330-
+ "| @~my_ext~candy1//:data.bzl\n"
1331-
+ "`-- @~my_ext~candy1");
1331+
+ "| @_main~my_ext~candy1//:data.bzl\n"
1332+
+ "`-- @_main~my_ext~candy1");
13321333
}
13331334

13341335
@Test
@@ -1350,7 +1351,7 @@ public void testReportRepoAndBzlCycles_extRepoLoadSelfCycle() throws Exception {
13501351
SkyKey skyKey =
13511352
PackageValue.key(
13521353
PackageIdentifier.create(
1353-
RepositoryName.createUnvalidated("~my_ext~candy1"),
1354+
RepositoryName.createUnvalidated("_main~my_ext~candy1"),
13541355
PathFragment.create("data.bzl")));
13551356
EvaluationResult<PackageValue> result =
13561357
evaluator.evaluate(ImmutableList.of(skyKey), evaluationContext);
@@ -1362,10 +1363,10 @@ public void testReportRepoAndBzlCycles_extRepoLoadSelfCycle() throws Exception {
13621363
assertContainsEvent(
13631364
"ERROR <no location>: Circular definition of repositories generated by module extensions"
13641365
+ " and/or .bzl files:\n"
1365-
+ ".-> @~my_ext~candy1\n"
1366+
+ ".-> @_main~my_ext~candy1\n"
13661367
+ "| extension 'my_ext' defined in //:defs.bzl\n"
13671368
+ "| //:defs.bzl\n"
1368-
+ "| @~my_ext~candy1//:data.bzl\n"
1369-
+ "`-- @~my_ext~candy1");
1369+
+ "| @_main~my_ext~candy1//:data.bzl\n"
1370+
+ "`-- @_main~my_ext~candy1");
13701371
}
13711372
}

‎src/test/py/bazel/bzlmod/bazel_module_test.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -371,7 +371,7 @@ def testRepositoryRuleErrorInModuleExtensionFailsTheBuild(self):
371371
allow_failure=True)
372372
self.AssertExitCode(exit_code, 48, stderr)
373373
self.assertIn(
374-
"ERROR: <builtin>: //pkg:~module_ext~foo: no such attribute 'invalid_attr' in 'repo_rule' rule",
374+
"ERROR: <builtin>: //pkg:_main~module_ext~foo: no such attribute 'invalid_attr' in 'repo_rule' rule",
375375
stderr)
376376
self.assertTrue(
377377
any([

0 commit comments

Comments
 (0)