Process 'repo_mapping' attribute from WORKSPACE rules. 'repo_mapping' is a way to remap references to repositories within an external repository by another name. This CL only adds the mappings to the Package object, but it does not actually enable the reassignments.

Example usage (in a WORKSPACE file):
local_repository(
  name = ?a?,
  path = ?../a?,
  repo_mapping = {?@x? : ?@y?}
)

This change also creates a new SkyKey which represents the mappings. This is to prevent all packages from depending on the external package, and instead depending just on the mappings. i.e. a change to the WORKSPACE file that does not touch the mappings shouldn't cause a reload of the package.

RELNOTES:None
PiperOrigin-RevId: 199187963

1 files changed, 198 insertions, 0 deletions

diff --git a/src/test/java/com/google/devtools/build/lib/skyframe/RepositoryMappingFunctionTest.java b/src/test/java/com/google/devtools/build/lib/skyframe/RepositoryMappingFunctionTest.java
new file mode 100644
index 0000000000..971b1e81fe
--- /dev/null
+++ b/src/test/java/com/google/devtools/build/lib/skyframe/RepositoryMappingFunctionTest.java
@@ -0,0 +1,198 @@
+// Copyright 2018 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.skyframe;
+
+import static com.google.common.truth.Truth.assertThat;
+import static com.google.devtools.build.skyframe.EvaluationResultSubjectFactory.assertThatEvaluationResult;
+
+import com.google.common.collect.ImmutableMap;
+import com.google.common.testing.EqualsTester;
+import com.google.devtools.build.lib.analysis.util.BuildViewTestCase;
+import com.google.devtools.build.lib.cmdline.RepositoryName;
+import com.google.devtools.build.lib.packages.NoSuchPackageException;
+import com.google.devtools.build.lib.skyframe.util.SkyframeExecutorTestUtils;
+import com.google.devtools.build.lib.vfs.ModifiedFileSet;
+import com.google.devtools.build.lib.vfs.PathFragment;
+import com.google.devtools.build.lib.vfs.Root;
+import com.google.devtools.build.skyframe.EvaluationResult;
+import com.google.devtools.build.skyframe.SkyKey;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+/** Tests for {@link RepositoryMappingFunction} and {@link RepositoryMappingValue}. */
+@RunWith(JUnit4.class)
+public class RepositoryMappingFunctionTest extends BuildViewTestCase {
+
+  private EvaluationResult<RepositoryMappingValue> eval(SkyKey key) throws InterruptedException {
+    getSkyframeExecutor()
+        .invalidateFilesUnderPathForTesting(
+            reporter,
+            ModifiedFileSet.builder().modify(PathFragment.create("WORKSPACE")).build(),
+            Root.fromPath(rootDirectory));
+    return SkyframeExecutorTestUtils.evaluate(
+        getSkyframeExecutor(), key, /*keepGoing=*/ false, reporter);
+  }
+
+  @Test
+  public void testSimpleMapping() throws Exception {
+    scratch.overwriteFile(
+        "WORKSPACE",
+        "workspace(name = 'good')",
+        "local_repository(",
+        "    name = 'a_remote_repo',",
+        "    path = '/a_remote_repo',",
+        "    repo_mapping = {'@a' : '@b'},",
+        ")");
+    RepositoryName name = RepositoryName.create("@a_remote_repo");
+    SkyKey skyKey = RepositoryMappingValue.key(name);
+    EvaluationResult<RepositoryMappingValue> result = eval(skyKey);
+
+    assertThat(result.hasError()).isFalse();
+    assertThatEvaluationResult(result)
+        .hasEntryThat(skyKey)
+        .isEqualTo(
+            RepositoryMappingValue.withMapping(
+                ImmutableMap.of(RepositoryName.create("@a"), RepositoryName.create("@b"))));
+  }
+
+  @Test
+  public void testMultipleRepositoriesWithMapping() throws Exception {
+    scratch.overwriteFile(
+        "WORKSPACE",
+        "workspace(name = 'good')",
+        "local_repository(",
+        "    name = 'a_remote_repo',",
+        "    path = '/a_remote_repo',",
+        "    repo_mapping = {'@a' : '@b'},",
+        ")",
+        "local_repository(",
+        "    name = 'other_remote_repo',",
+        "    path = '/other_remote_repo',",
+        "    repo_mapping = {'@x' : '@y'},",
+        ")");
+    RepositoryName name1 = RepositoryName.create("@a_remote_repo");
+    SkyKey skyKey1 = RepositoryMappingValue.key(name1);
+    RepositoryName name2 = RepositoryName.create("@other_remote_repo");
+    SkyKey skyKey2 = RepositoryMappingValue.key(name2);
+
+    assertThatEvaluationResult(eval(skyKey1))
+        .hasEntryThat(skyKey1)
+        .isEqualTo(
+            RepositoryMappingValue.withMapping(
+                ImmutableMap.of(RepositoryName.create("@a"), RepositoryName.create("@b"))));
+    assertThatEvaluationResult(eval(skyKey2))
+        .hasEntryThat(skyKey2)
+        .isEqualTo(
+            RepositoryMappingValue.withMapping(
+                ImmutableMap.of(RepositoryName.create("@x"), RepositoryName.create("@y"))));
+  }
+
+  @Test
+  public void testRepositoryWithMultipleMappings() throws Exception {
+    scratch.overwriteFile(
+        "WORKSPACE",
+        "workspace(name = 'good')",
+        "local_repository(",
+        "    name = 'a_remote_repo',",
+        "    path = '/a_remote_repo',",
+        "    repo_mapping = {'@a' : '@b', '@x' : '@y'},",
+        ")");
+    RepositoryName name = RepositoryName.create("@a_remote_repo");
+    SkyKey skyKey = RepositoryMappingValue.key(name);
+
+    assertThatEvaluationResult(eval(skyKey))
+        .hasEntryThat(skyKey)
+        .isEqualTo(
+            RepositoryMappingValue.withMapping(
+                ImmutableMap.of(
+                    RepositoryName.create("@a"), RepositoryName.create("@b"),
+                    RepositoryName.create("@x"), RepositoryName.create("@y"))));
+  }
+
+  @Test
+  public void testErrorWithMapping() throws Exception {
+    reporter.removeHandler(failFastHandler);
+    scratch.overwriteFile(
+        "WORKSPACE",
+        "workspace(name = 'good')",
+        "local_repository(",
+        "    name = 'a_remote_repo',",
+        "    path = '/a_remote_repo',",
+        "    repo_mapping = {'x' : '@b'},",
+        ")");
+    RepositoryName name = RepositoryName.create("@a_remote_repo");
+    SkyKey skyKey = RepositoryMappingValue.key(name);
+
+    assertThatEvaluationResult(eval(skyKey))
+        .hasErrorEntryForKeyThat(skyKey)
+        .hasExceptionThat()
+        .isInstanceOf(NoSuchPackageException.class);
+    assertContainsEvent("invalid repository name 'x': workspace names must start with '@'");
+  }
+
+  @Test
+  public void testEmptyMapping() throws Exception {
+    scratch.overwriteFile(
+        "WORKSPACE",
+        "workspace(name = 'good')",
+        "local_repository(",
+        "    name = 'a_remote_repo',",
+        "    path = '/a_remote_repo',",
+        "    repo_mapping = {},",
+        ")");
+    RepositoryName name = RepositoryName.create("@a_remote_repo");
+    SkyKey skyKey = RepositoryMappingValue.key(name);
+
+    assertThatEvaluationResult(eval(skyKey))
+        .hasEntryThat(skyKey)
+        .isEqualTo(
+            RepositoryMappingValue.withMapping(
+                ImmutableMap.of()));
+  }
+
+  @Test
+  public void testNoMappings() throws Exception {
+    scratch.overwriteFile(
+        "WORKSPACE",
+        "workspace(name = 'good')",
+        "local_repository(",
+        "    name = 'a_remote_repo',",
+        "    path = '/a_remote_repo',",
+        ")");
+    RepositoryName name = RepositoryName.create("@a_remote_repo");
+    SkyKey skyKey = RepositoryMappingValue.key(name);
+
+    assertThatEvaluationResult(eval(skyKey))
+        .hasEntryThat(skyKey)
+        .isEqualTo(
+            RepositoryMappingValue.withMapping(ImmutableMap.of()));
+  }
+
+  @Test
+  public void testEqualsAndHashCode() throws Exception {
+    new EqualsTester()
+        .addEqualityGroup(
+            RepositoryMappingValue.withMapping(
+                ImmutableMap.of(RepositoryName.create("@foo"), RepositoryName.create("@bar"))),
+            RepositoryMappingValue.withMapping(
+                ImmutableMap.of(RepositoryName.create("@foo"), RepositoryName.create("@bar"))))
+        .addEqualityGroup(
+            RepositoryMappingValue.withMapping(
+                ImmutableMap.of(RepositoryName.create("@fizz"), RepositoryName.create("@buzz"))),
+            RepositoryMappingValue.withMapping(
+                ImmutableMap.of(RepositoryName.create("@fizz"), RepositoryName.create("@buzz"))));
+  }
+}