Skip to content

Commit

Permalink
Refactor WorkspaceFactoryTestHelper to be able to add a setSkylarkSem…
Browse files Browse the repository at this point in the history 
…antics method.

RELNOTES: None
PiperOrigin-RevId: 199366685
  • Loading branch information
@dkelmer
dkelmer authored and Copybara-Service committed Jun 5, 2018
1 parent 073b808 commit 216afa1
Show file tree
Hide file tree
Showing 2 changed files with 94 additions and 84 deletions.
137 changes: 62 additions & 75 deletions src/test/java/com/google/devtools/build/lib/packages/WorkspaceFactoryTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,175 +27,166 @@
@RunWith(JUnit4.class)
public class WorkspaceFactoryTest {

private WorkspaceFactoryTestHelper helper = new WorkspaceFactoryTestHelper();

@Test
public void testLoadError() throws Exception {
// WS with a syntax error: '//a' should end with .bzl.
WorkspaceFactoryTestHelper helper = parse("load('//a', 'a')");
helper.parse("load('//a', 'a')");
helper.assertLexingExceptionThrown();
assertThat(helper.getLexerError())
.contains("The label must reference a file with extension '.bzl'");
}

@Test
public void testWorkspaceName() throws Exception {
WorkspaceFactoryTestHelper helper = parse("workspace(name = 'my_ws')");
helper.parse("workspace(name = 'my_ws')");
assertThat(helper.getPackage().getWorkspaceName()).isEqualTo("my_ws");
}

@Test
public void testWorkspaceStartsWithNumber() throws Exception {
WorkspaceFactoryTestHelper helper = parse("workspace(name = '123abc')");
helper.parse("workspace(name = '123abc')");
assertThat(helper.getParserError()).contains("123abc is not a legal workspace name");
}

@Test
public void testWorkspaceWithIllegalCharacters() throws Exception {
WorkspaceFactoryTestHelper helper = parse("workspace(name = 'a.b.c')");
helper.parse("workspace(name = 'a.b.c')");
assertThat(helper.getParserError()).contains("a.b.c is not a legal workspace name");
}

@Test
public void testIllegalRepoName() throws Exception {
WorkspaceFactoryTestHelper helper =
parse("local_repository(", " name = 'foo/bar',", " path = '/foo/bar',", ")");
helper.parse("local_repository(", " name = 'foo/bar',", " path = '/foo/bar',", ")");
assertThat(helper.getParserError()).contains(
"local_repository rule //external:foo/bar's name field must be a legal workspace name");
}

@Test
public void testIllegalWorkspaceFunctionPosition() throws Exception {
WorkspaceFactoryTestHelper helper =
new WorkspaceFactoryTestHelper(false, "workspace(name = 'foo')");
helper = new WorkspaceFactoryTestHelper(/*allowOverride=*/ false);
helper.parse("workspace(name = 'foo')");
assertThat(helper.getParserError()).contains(
"workspace() function should be used only at the top of the WORKSPACE file");
}

@Test
public void testRegisterExecutionPlatforms() throws Exception {
WorkspaceFactoryTestHelper helper = parse("register_execution_platforms('//platform:ep1')");
helper.parse("register_execution_platforms('//platform:ep1')");
assertThat(helper.getPackage().getRegisteredExecutionPlatforms())
.containsExactly("//platform:ep1");
}

@Test
public void testRegisterExecutionPlatforms_multipleLabels() throws Exception {
WorkspaceFactoryTestHelper helper =
parse("register_execution_platforms(", " '//platform:ep1',", " '//platform:ep2')");
helper.parse("register_execution_platforms(", " '//platform:ep1',", " '//platform:ep2')");
assertThat(helper.getPackage().getRegisteredExecutionPlatforms())
.containsExactly("//platform:ep1", "//platform:ep2");
}

@Test
public void testRegisterExecutionPlatforms_multipleCalls() throws Exception {
WorkspaceFactoryTestHelper helper =
parse(
"register_execution_platforms('//platform:ep1')",
"register_execution_platforms('//platform:ep2')",
"register_execution_platforms('//platform/...')");
helper.parse(
"register_execution_platforms('//platform:ep1')",
"register_execution_platforms('//platform:ep2')",
"register_execution_platforms('//platform/...')");
assertThat(helper.getPackage().getRegisteredExecutionPlatforms())
.containsExactly("//platform:ep1", "//platform:ep2", "//platform/...");
}

@Test
public void testRegisterToolchains() throws Exception {
WorkspaceFactoryTestHelper helper = parse("register_toolchains('//toolchain:tc1')");
helper.parse("register_toolchains('//toolchain:tc1')");
assertThat(helper.getPackage().getRegisteredToolchains()).containsExactly("//toolchain:tc1");
}

@Test
public void testRegisterToolchains_multipleLabels() throws Exception {
WorkspaceFactoryTestHelper helper =
parse("register_toolchains(", " '//toolchain:tc1',", " '//toolchain:tc2')");
helper.parse("register_toolchains(", " '//toolchain:tc1',", " '//toolchain:tc2')");
assertThat(helper.getPackage().getRegisteredToolchains())
.containsExactly("//toolchain:tc1", "//toolchain:tc2");
}

@Test
public void testRegisterToolchains_multipleCalls() throws Exception {
WorkspaceFactoryTestHelper helper =
parse(
"register_toolchains('//toolchain:tc1')",
"register_toolchains('//toolchain:tc2')",
"register_toolchains('//toolchain/...')");
helper.parse(
"register_toolchains('//toolchain:tc1')",
"register_toolchains('//toolchain:tc2')",
"register_toolchains('//toolchain/...')");
assertThat(helper.getPackage().getRegisteredToolchains())
.containsExactly("//toolchain:tc1", "//toolchain:tc2", "//toolchain/...");
}

@Test
public void testWorkspaceMappings() throws Exception {
WorkspaceFactoryTestHelper helper =
parse(
"local_repository(",
" name = 'foo',",
" path = '/foo',",
" repo_mapping = {'@x' : '@y'},",
")");
helper.parse(
"local_repository(",
" name = 'foo',",
" path = '/foo',",
" repo_mapping = {'@x' : '@y'},",
")");
assertMapping(helper, "@foo", "@x", "@y");
}

@Test
public void testMultipleRepositoriesWithMappings() throws Exception {
WorkspaceFactoryTestHelper helper =
parse(
"local_repository(",
" name = 'foo',",
" path = '/foo',",
" repo_mapping = {'@x' : '@y'},",
")",
"local_repository(",
" name = 'bar',",
" path = '/bar',",
" repo_mapping = {'@a' : '@b'},",
")");
helper.parse(
"local_repository(",
" name = 'foo',",
" path = '/foo',",
" repo_mapping = {'@x' : '@y'},",
")",
"local_repository(",
" name = 'bar',",
" path = '/bar',",
" repo_mapping = {'@a' : '@b'},",
")");
assertMapping(helper, "@foo", "@x", "@y");
assertMapping(helper, "@bar", "@a", "@b");
}

@Test
public void testMultipleMappings() throws Exception {
WorkspaceFactoryTestHelper helper =
parse(
"local_repository(",
" name = 'foo',",
" path = '/foo',",
" repo_mapping = {'@a' : '@b', '@c' : '@d', '@e' : '@f'},",
")");
helper.parse(
"local_repository(",
" name = 'foo',",
" path = '/foo',",
" repo_mapping = {'@a' : '@b', '@c' : '@d', '@e' : '@f'},",
")");
assertMapping(helper, "@foo", "@a", "@b");
assertMapping(helper, "@foo", "@c", "@d");
assertMapping(helper, "@foo", "@e", "@f");
}

@Test
public void testEmptyMappings() throws Exception {
WorkspaceFactoryTestHelper helper =
parse(
"local_repository(",
" name = 'foo',",
" path = '/foo',",
" repo_mapping = {},",
")");
helper.parse(
"local_repository(",
" name = 'foo',",
" path = '/foo',",
" repo_mapping = {},",
")");
assertThat(helper.getPackage().getRepositoryMapping("@foo")).isEmpty();
}

@Test
public void testMappingsNotAMap() throws Exception {
WorkspaceFactoryTestHelper helper =
parse(
"local_repository(",
" name = 'foo',",
" path = '/foo',",
" repo_mapping = 1",
")");
helper.parse(
"local_repository(",
" name = 'foo',",
" path = '/foo',",
" repo_mapping = 1",
")");
assertThat(helper.getParserError())
.contains("Invalid value for 'repo_mapping': '1'. Value must be a map.");

helper =
parse(
"local_repository(",
" name = 'foo',",
" path = '/foo',",
" repo_mapping = 'hello'",
")");
helper.parse(
"local_repository(",
" name = 'foo',",
" path = '/foo',",
" repo_mapping = 'hello'",
")");
assertThat(helper.getParserError())
.contains("Invalid value for 'repo_mapping': 'hello'. Value must be a map.");
}
Expand All @@ -209,8 +200,4 @@ private void assertMapping(
.containsEntry(localRepoName, globalRepoName);
}

private WorkspaceFactoryTestHelper parse(String... args) {
return new WorkspaceFactoryTestHelper(args);
}

}
41 changes: 32 additions & 9 deletions src/test/java/com/google/devtools/build/lib/packages/WorkspaceFactoryTestHelper.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,24 +27,31 @@
import com.google.devtools.build.lib.testutil.TestRuleClassProvider;
import com.google.devtools.build.lib.vfs.FileSystemUtils;
import com.google.devtools.build.lib.vfs.Path;
import com.google.devtools.common.options.OptionsParser;
import java.io.IOException;
import java.util.List;

/** Parses a WORKSPACE file with the given content. */
class WorkspaceFactoryTestHelper {
private final Package.Builder builder;
private final Exception exception;
private final ImmutableList<Event> events;
private Package.Builder builder;
private Exception exception;
private ImmutableList<Event> events;
private SkylarkSemantics skylarkSemantics;

WorkspaceFactoryTestHelper(String... args) {
this(true, args);
private final boolean allowOverride;

WorkspaceFactoryTestHelper() {
this(true);
}

WorkspaceFactoryTestHelper(boolean allowOverride, String... args) {
this(new Scratch("/"), allowOverride, args);
WorkspaceFactoryTestHelper(boolean allowOverride) {
this.exception = null;
this.events = null;
this.allowOverride = allowOverride;
this.skylarkSemantics = SkylarkSemantics.DEFAULT_SEMANTICS;
}

WorkspaceFactoryTestHelper(Scratch scratch, boolean allowOverride, String... args) {
void parse(Scratch scratch, String... args) {
Path root = null;
Path workspaceFilePath = null;
try {
Expand Down Expand Up @@ -73,7 +80,7 @@ class WorkspaceFactoryTestHelper {
FileSystemUtils.readWithKnownFileSize(workspaceFilePath, workspaceFilePath.getFileSize());
factory.parse(
ParserInputSource.create(bytes, workspaceFilePath.asFragment()),
SkylarkSemantics.DEFAULT_SEMANTICS,
skylarkSemantics,
eventHandler);
} catch (BuildFileContainsErrorsException e) {
exception = e;
Expand All @@ -84,6 +91,10 @@ class WorkspaceFactoryTestHelper {
this.exception = exception;
}

void parse(String... args) {
parse(new Scratch("/"), args);
}

public Package getPackage() throws InterruptedException, NoSuchPackageException {
return builder.build();
}
Expand All @@ -103,4 +114,16 @@ public String getParserError() {
assertThat(events.size()).isGreaterThan(0);
return events.get(0).getMessage();
}

protected void setSkylarkSemantics(String... options) throws Exception {
skylarkSemantics = parseSkylarkSemanticsOptions(options);
}

private static SkylarkSemantics parseSkylarkSemanticsOptions(String... options)
throws Exception {
OptionsParser parser = OptionsParser.newOptionsParser(SkylarkSemanticsOptions.class);
parser.parse(options);
return parser.getOptions(SkylarkSemanticsOptions.class).toSkylarkSemantics();
}

}

0 comments on commit 216afa1

Please sign in to comment.