Fix bug in URI computation in RemoteModule

Also add tests for the CAS path converter. I've also changed the code to
explicitly inject the RemoteOptions into the CasPathConverter - note that
the class is now static, so it no longer has access to the fields in the
RemoteModule class.

This change will need to be cherry-picked into 0.5.2.

PiperOrigin-RevId: 158816408

2 files changed, 81 insertions, 7 deletions

diff --git a/src/main/java/com/google/devtools/build/lib/remote/RemoteModule.java b/src/main/java/com/google/devtools/build/lib/remote/RemoteModule.java
index 9312cb2e55..fedfee1485 100644
--- a/src/main/java/com/google/devtools/build/lib/remote/RemoteModule.java
+++ b/src/main/java/com/google/devtools/build/lib/remote/RemoteModule.java
@@ -14,6 +14,7 @@
 
 package com.google.devtools.build.lib.remote;
 
+import com.google.common.annotations.VisibleForTesting;
 import com.google.common.collect.ImmutableList;
 import com.google.common.eventbus.Subscribe;
 import com.google.devtools.build.lib.authandtls.AuthAndTLSOptions;
@@ -37,9 +38,15 @@ import java.io.IOException;
 
 /** RemoteModule provides distributed cache and remote execution for Bazel. */
 public final class RemoteModule extends BlazeModule {
-  private final class CasPathConverter implements PathConverter {
-    private CasPathConverter() {
-    }
+  @VisibleForTesting
+  static final class CasPathConverter implements PathConverter {
+    // Not final; unfortunately, the Bazel startup process requires us to create this object before
+    // we have the options available, so we have to create it first, and then set the options
+    // afterwards. At the time of this writing, I believe that we aren't using the PathConverter
+    // before the options are available, so this should be safe.
+    // TODO(ulfjack): Change the Bazel startup process to make the options available when we create
+    // the PathConverter.
+    RemoteOptions options;
 
     @Override
     public String apply(Path path) {
@@ -57,7 +64,7 @@ public final class RemoteModule extends BlazeModule {
                 digest.getHash(),
                 digest.getSizeBytes())
             : String.format(
-                "//%s/projects/%s/blobs/%s/%d",
+                "//%s/%s/blobs/%s/%d",
                 server,
                 remoteInstanceName,
                 digest.getHash(),
@@ -69,13 +76,13 @@ public final class RemoteModule extends BlazeModule {
     }
   }
 
-  private RemoteOptions options;
+  private final CasPathConverter converter = new CasPathConverter();
   private CommandEnvironment env;
 
   @Override
   public void serverInit(OptionsProvider startupOptions, ServerBuilder builder)
       throws AbruptExitException {
-    builder.addPathToUriConverter(new CasPathConverter());
+    builder.addPathToUriConverter(converter);
   }
 
   @Override
@@ -86,7 +93,7 @@ public final class RemoteModule extends BlazeModule {
 
   @Override
   public void handleOptions(OptionsProvider optionsProvider) {
-    this.options = optionsProvider.getOptions(RemoteOptions.class);
+    converter.options = optionsProvider.getOptions(RemoteOptions.class);
   }
 
   @Override
diff --git a/src/test/java/com/google/devtools/build/lib/remote/CasPathConverterTest.java b/src/test/java/com/google/devtools/build/lib/remote/CasPathConverterTest.java
new file mode 100644
index 0000000000..e7b846fe70
--- /dev/null
+++ b/src/test/java/com/google/devtools/build/lib/remote/CasPathConverterTest.java
@@ -0,0 +1,67 @@
+// Copyright 2017 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.remote;
+
+import static com.google.common.truth.Truth.assertThat;
+
+import com.google.devtools.build.lib.remote.RemoteModule.CasPathConverter;
+import com.google.devtools.build.lib.vfs.FileSystem;
+import com.google.devtools.build.lib.vfs.FileSystemUtils;
+import com.google.devtools.build.lib.vfs.Path;
+import com.google.devtools.build.lib.vfs.inmemoryfs.InMemoryFileSystem;
+import com.google.devtools.common.options.Options;
+import com.google.devtools.common.options.OptionsParser;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.junit.runners.JUnit4;
+
+/** Tests for {@link CasPathConverter}. */
+@RunWith(JUnit4.class)
+public class CasPathConverterTest {
+  private final FileSystem fs = new InMemoryFileSystem();
+  private final CasPathConverter converter = new CasPathConverter();
+
+  @Test
+  public void noOptionsShouldntCrash() {
+    assertThat(converter.apply(fs.getPath("/foo"))).isNull();
+  }
+
+  @Test
+  public void disabledRemote() {
+    converter.options = Options.getDefaults(RemoteOptions.class);
+    assertThat(converter.apply(fs.getPath("/foo"))).isNull();
+  }
+
+  @Test
+  public void enabledRemoteExecutorNoRemoteInstance() throws Exception {
+    OptionsParser parser = OptionsParser.newOptionsParser(RemoteOptions.class);
+    parser.parse("--remote_cache=machine");
+    converter.options = parser.getOptions(RemoteOptions.class);
+    Path path = fs.getPath("/foo");
+    FileSystemUtils.writeContentAsLatin1(path, "foobar");
+    assertThat(converter.apply(fs.getPath("/foo")))
+        .isEqualTo("//machine/blobs/3858f62230ac3c915f300c664312c63f/6");
+  }
+
+  @Test
+  public void enabledRemoteExecutorWithRemoteInstance() throws Exception {
+    OptionsParser parser = OptionsParser.newOptionsParser(RemoteOptions.class);
+    parser.parse("--remote_cache=machine", "--remote_instance_name=projects/bazel");
+    converter.options = parser.getOptions(RemoteOptions.class);
+    Path path = fs.getPath("/foo");
+    FileSystemUtils.writeContentAsLatin1(path, "foobar");
+    assertThat(converter.apply(fs.getPath("/foo")))
+        .isEqualTo("//machine/projects/bazel/blobs/3858f62230ac3c915f300c664312c63f/6");
+  }
+}