aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/test/java/com/google/devtools/build/lib/packages/WorkspaceFactoryTest.java
blob: 84a6a29c31364d0d257f5ab6a9508fa2ca516c52 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
// Copyright 2015 The Bazel Authors. All rights reserved.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//    http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

package com.google.devtools.build.lib.packages;

import static com.google.common.truth.Truth.assertThat;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.fail;

import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.events.Event;
import com.google.devtools.build.lib.events.StoredEventHandler;
import com.google.devtools.build.lib.packages.Package.Builder;
import com.google.devtools.build.lib.syntax.Mutability;
import com.google.devtools.build.lib.syntax.ParserInputSource;
import com.google.devtools.build.lib.testutil.Scratch;
import com.google.devtools.build.lib.testutil.TestRuleClassProvider;
import com.google.devtools.build.lib.vfs.Path;
import java.io.IOException;
import java.util.List;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

/**
 * Tests for WorkspaceFactory.
 */
@RunWith(JUnit4.class)
public class WorkspaceFactoryTest {

  @Test
  public void testLoadError() throws Exception {
    // WS with a syntax error: '//a' should end with .bzl.
    WorkspaceFactoryHelper 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 {
    WorkspaceFactoryHelper helper = parse("workspace(name = 'my_ws')");
    assertEquals("my_ws", helper.getPackage().getWorkspaceName());
  }

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

  @Test
  public void testWorkspaceWithIllegalCharacters() throws Exception {
    WorkspaceFactoryHelper 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 {
    WorkspaceFactoryHelper 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 {
    WorkspaceFactoryHelper helper = new WorkspaceFactoryHelper(
        false, "workspace(name = 'foo')");
    assertThat(helper.getParserError()).contains(
        "workspace() function should be used only at the top of the WORKSPACE file");
  }

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

  /**
   * Parses a WORKSPACE file with the given content.
   */
  private class WorkspaceFactoryHelper {
    private final Builder builder;
    private final WorkspaceFactory factory;
    private final Exception exception;
    private final ImmutableList<Event> events;

    public WorkspaceFactoryHelper(String... args) {
      this(true, args);
    }

    public WorkspaceFactoryHelper(boolean allowOverride, String... args) {
      Path root = null;
      Path workspaceFilePath = null;
      try {
        Scratch scratch = new Scratch("/");
        root = scratch.dir("/workspace");
        workspaceFilePath = scratch.file("/workspace/WORKSPACE", args);
      } catch (IOException e) {
        fail("Shouldn't happen: " + e.getMessage());
      }
      StoredEventHandler eventHandler = new StoredEventHandler();
      builder = Package.newExternalPackageBuilder(
          Package.Builder.DefaultHelper.INSTANCE, workspaceFilePath, "");
      this.factory = new WorkspaceFactory(
          builder,
          TestRuleClassProvider.getRuleClassProvider(),
          ImmutableList.<PackageFactory.EnvironmentExtension>of(),
          Mutability.create("test"),
          allowOverride,
          root,
          root);
      Exception exception = null;
      try {
        factory.parse(ParserInputSource.create(workspaceFilePath), eventHandler);
      } catch (BuildFileContainsErrorsException e) {
        exception = e;
      } catch (IOException | InterruptedException e) {
        fail("Shouldn't happen: " + e.getMessage());
      }
      this.events = eventHandler.getEvents();
      this.exception = exception;
    }

    public Package getPackage() throws InterruptedException {
      return builder.build();
    }

    public void assertLexingExceptionThrown() {
      assertNotNull(exception);
      assertThat(exception.getMessage()).contains("Failed to parse /workspace/WORKSPACE");
    }

    public String getLexerError() {
      assertEquals(1, events.size());
      return events.get(0).getMessage();
    }

    public String getParserError() {
      List<Event> events = builder.getEvents();
      assertThat(events.size()).isGreaterThan(0);
      return events.get(0).getMessage();
    }
  }
}