diff options
author | twerth <twerth@google.com> | 2018-05-15 05:02:31 -0700 |
---|---|---|
committer | Copybara-Service <copybara-piper@google.com> | 2018-05-15 05:03:50 -0700 |
commit | c4f2d80270f1ce947fcf7fb0a4e5f0afb3a7062d (patch) | |
tree | 5928bf2f9d72ffc3eec0a5e08456e2574a4c2e31 /src/test/java | |
parent | bd16ab9454e624a26c53a0f3fb892e20fb1c36e6 (diff) |
Allow more characters in labels.
Partly addresses #374.
Specifically allow !%^`"'&;<>?[]{|} in target and package names. It's actually
simpler now to declare what we don't allow. In target names:
0-31 (control characters)
58 ':' (colon)
92 '\' (backslash)
127 (delete)
In package names:
0-31 (control characters)
58 ':' (colon)
64 '@' (at-sign)
92 '\' (backslash)
127 (delete)
- '\' is a path segment separator on Windows, and allowing it can lead to
silent output file conflicts and - therefore - data corruption. We may be
able to allow it in the future, but I didn't want to make that call.
- ':' is a special character that Bazel interprets as the package name / target
name separator.
- '@' in package names can probably be allowed; at the beginning of a label it
indicates a workspace name, but not within a segment. We actually have some
tests that disallow it specifically, but those can probably just be deleted;
however, it does require a bit of investigation, so I decided to delay that
change.
It is possible that we don't correctly escape filenames in all cases. Also note
that the shell may require escaping for specific characters, and that Bazel
treats a single '*' (star) target name specially when given on the command
line.
RELNOTES: Bazel now allows almost all 7-bit ASCII characters in labels.
PiperOrigin-RevId: 196650651
Diffstat (limited to 'src/test/java')
7 files changed, 70 insertions, 25 deletions
diff --git a/src/test/java/com/google/devtools/build/lib/cmdline/LabelTest.java b/src/test/java/com/google/devtools/build/lib/cmdline/LabelTest.java index 7e34cc64e8..be61b9472a 100644 --- a/src/test/java/com/google/devtools/build/lib/cmdline/LabelTest.java +++ b/src/test/java/com/google/devtools/build/lib/cmdline/LabelTest.java @@ -30,7 +30,8 @@ import org.junit.runners.JUnit4; @RunWith(JUnit4.class) public class LabelTest { - private static final String BAD_PACKAGE_CHARS = "package names may contain only"; + private static final String BAD_PACKAGE_CHARS = + "package names may contain A-Z, a-z, 0-9, or any of"; private static final String INVALID_TARGET_NAME = "invalid target name"; private static final String INVALID_PACKAGE_NAME = "invalid package name"; @@ -89,7 +90,7 @@ public class LabelTest { @Test public void testLabelResolutionBadSyntax() throws Exception { try { - parseCommandLine("//absolute:A+bad%syntax", ""); + parseCommandLine("//absolute:A+bad:syntax", ""); fail(); } catch (LabelSyntaxException e) { // Expected exception @@ -303,12 +304,6 @@ public class LabelTest { "//foo:bar:"); assertSyntaxError("target names may not contain ':'", "//foo/bar::"); - assertSyntaxError("target names may not contain '&'", - "//foo:bar&"); - // Warning: if these assertions are false, tools that assume that they can safely quote labels - // may need to be fixed. Please consult with bazel-dev before loosening these restrictions. - assertSyntaxError("target names may not contain '''", "//foo/bar:baz'foo"); - assertSyntaxError("target names may not contain '\"'", "//foo/bar:baz\"foo"); } @Test diff --git a/src/test/java/com/google/devtools/build/lib/cmdline/LabelValidatorTest.java b/src/test/java/com/google/devtools/build/lib/cmdline/LabelValidatorTest.java index 2156ddf84d..fcb187f268 100644 --- a/src/test/java/com/google/devtools/build/lib/cmdline/LabelValidatorTest.java +++ b/src/test/java/com/google/devtools/build/lib/cmdline/LabelValidatorTest.java @@ -53,6 +53,37 @@ public class LabelValidatorTest { assertThat(LabelValidator.validatePackageName("a/b..")).isNull(); assertThat(LabelValidator.validatePackageName("a$( )/b..")).isNull(); + // These are in ascii code order. + assertThat(LabelValidator.validatePackageName("foo!bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo\"bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo#bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo$bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo%bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo&bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo'bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo(bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo)bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo*bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo+bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo,bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo-bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo.bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo+bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo;bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo<bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo=bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo>bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo?bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo[bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo]bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo^bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo_bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo`bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo{bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo|bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo}bar")).isNull(); + assertThat(LabelValidator.validatePackageName("foo~bar")).isNull(); + // Bad: assertThat(LabelValidator.validatePackageName("/foo")) .isEqualTo("package names may not start with '/'"); @@ -82,16 +113,39 @@ public class LabelValidatorTest { @Test public void testValidateTargetName() throws Exception { - assertThat(LabelValidator.validateTargetName("foo")).isNull(); + assertThat(LabelValidator.validateTargetName("foo!bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo\"bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo#bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo$bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo%bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo&bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo'bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo(bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo)bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo*bar")).isNull(); assertThat(LabelValidator.validateTargetName("foo+bar")).isNull(); - assertThat(LabelValidator.validateTargetName("foo_bar")).isNull(); - assertThat(LabelValidator.validateTargetName("foo=bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo,bar")).isNull(); assertThat(LabelValidator.validateTargetName("foo-bar")).isNull(); assertThat(LabelValidator.validateTargetName("foo.bar")).isNull(); - assertThat(LabelValidator.validateTargetName("foo@bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo+bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo;bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo<bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo=bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo>bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo?bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo[bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo]bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo^bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo_bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo`bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo{bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo|bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo}bar")).isNull(); assertThat(LabelValidator.validateTargetName("foo~bar")).isNull(); - assertThat(LabelValidator.validateTargetName("foo#bar")).isNull(); + + assertThat(LabelValidator.validateTargetName("foo/bar")).isNull(); + assertThat(LabelValidator.validateTargetName("foo@bar")).isNull(); assertThat(LabelValidator.validateTargetName("foo/")) .isEqualTo("target names may not end with '/'"); @@ -99,8 +153,6 @@ public class LabelValidatorTest { .isEqualTo("target names may not contain ':'"); assertThat(LabelValidator.validateTargetName("bar:")) .isEqualTo("target names may not contain ':'"); - assertThat(LabelValidator.validateTargetName("bar&")) - .isEqualTo("target names may not contain '&'"); } @Test diff --git a/src/test/java/com/google/devtools/build/lib/cmdline/TargetPatternTest.java b/src/test/java/com/google/devtools/build/lib/cmdline/TargetPatternTest.java index 012e120139..e33d1f37c3 100644 --- a/src/test/java/com/google/devtools/build/lib/cmdline/TargetPatternTest.java +++ b/src/test/java/com/google/devtools/build/lib/cmdline/TargetPatternTest.java @@ -50,7 +50,7 @@ public class TargetPatternTest { @Test public void testInvalidPatterns() throws TargetParsingException { try { - parse("Bar&&&java"); + parse("Bar@java"); fail(); } catch (TargetParsingException expected) { } diff --git a/src/test/java/com/google/devtools/build/lib/packages/OutputFileTest.java b/src/test/java/com/google/devtools/build/lib/packages/OutputFileTest.java index 57b7c59090..c422f77e2f 100644 --- a/src/test/java/com/google/devtools/build/lib/packages/OutputFileTest.java +++ b/src/test/java/com/google/devtools/build/lib/packages/OutputFileTest.java @@ -167,7 +167,7 @@ public class OutputFileTest extends PackageLoadingTestCase { "bad_out_name/BUILD", "genrule(name='a',", " cmd='ls',", - " outs=['!@#'])"); + " outs=['!@#:'])"); reporter.removeHandler(failFastHandler); packageFactory.createPackageForTesting( @@ -175,7 +175,7 @@ public class OutputFileTest extends PackageLoadingTestCase { buildfile, getPackageManager(), reporter); - assertContainsEvent("illegal output file name '!@#' in rule //bad_out_name:a"); + assertContainsEvent("illegal output file name '!@#:' in rule //bad_out_name:a"); } @Test diff --git a/src/test/java/com/google/devtools/build/lib/pkgcache/PackageCacheTest.java b/src/test/java/com/google/devtools/build/lib/pkgcache/PackageCacheTest.java index e4729d3516..ba07b6841a 100644 --- a/src/test/java/com/google/devtools/build/lib/pkgcache/PackageCacheTest.java +++ b/src/test/java/com/google/devtools/build/lib/pkgcache/PackageCacheTest.java @@ -236,10 +236,10 @@ public class PackageCacheTest extends FoundationTestCase { @Test public void testGetPackageWithInvalidName() throws Exception { - scratch.file("invalidpackagename&42/BUILD", "cc_library(name = 'foo') # a BUILD file"); + scratch.file("invalidpackagename:42/BUILD", "cc_library(name = 'foo') # a BUILD file"); checkGetPackageFails( - "invalidpackagename&42", - "no such package 'invalidpackagename&42': Invalid package name 'invalidpackagename&42'"); + "invalidpackagename:42", + "no such package 'invalidpackagename:42': Invalid package name 'invalidpackagename:42'"); } @Test diff --git a/src/test/java/com/google/devtools/build/lib/pkgcache/TargetPatternEvaluatorTest.java b/src/test/java/com/google/devtools/build/lib/pkgcache/TargetPatternEvaluatorTest.java index f6ec361cd6..a7f81a23e0 100644 --- a/src/test/java/com/google/devtools/build/lib/pkgcache/TargetPatternEvaluatorTest.java +++ b/src/test/java/com/google/devtools/build/lib/pkgcache/TargetPatternEvaluatorTest.java @@ -712,8 +712,6 @@ public class TargetPatternEvaluatorTest extends AbstractTargetPatternEvaluatorTe public void testFailingValidations() { expectValidationFail(""); expectValidationFail("\\"); - expectValidationFail("foo:**"); - expectValidationFail("//foo/*"); } private void expectValidationFail(String target) { diff --git a/src/test/java/com/google/devtools/build/lib/skyframe/PackageLookupFunctionTest.java b/src/test/java/com/google/devtools/build/lib/skyframe/PackageLookupFunctionTest.java index 195d987fca..4d6339922f 100644 --- a/src/test/java/com/google/devtools/build/lib/skyframe/PackageLookupFunctionTest.java +++ b/src/test/java/com/google/devtools/build/lib/skyframe/PackageLookupFunctionTest.java @@ -243,8 +243,8 @@ public abstract class PackageLookupFunctionTest extends FoundationTestCase { @Test public void testInvalidPackageName() throws Exception { - scratch.file("parentpackage/invalidpackagename%42/BUILD"); - PackageLookupValue packageLookupValue = lookupPackage("parentpackage/invalidpackagename%42"); + scratch.file("parentpackage/invalidpackagename:42/BUILD"); + PackageLookupValue packageLookupValue = lookupPackage("parentpackage/invalidpackagename:42"); assertThat(packageLookupValue.packageExists()).isFalse(); assertThat(packageLookupValue.getErrorReason()).isEqualTo(ErrorReason.INVALID_PACKAGE_NAME); assertThat(packageLookupValue.getErrorMsg()).isNotNull(); |