src/test/java/com/google/devtools/build/lib/analysis/LocationFunctionTest.java

// 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.analysis;

import static com.google.common.truth.Truth.assertThat;
import static org.junit.Assert.assertThrows;

import com.google.common.collect.ImmutableMap;
import com.google.devtools.build.lib.analysis.LocationExpander.LocationFunction;
import com.google.devtools.build.lib.cmdline.RepositoryMapping;
import com.google.devtools.build.lib.cmdline.RepositoryName;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

/** Unit tests for {@link LocationExpander.LocationFunction}. */
@RunWith(JUnit4.class)
public class LocationFunctionTest {

  @Test
  public void absoluteAndRelativeLabels() throws Exception {
    LocationFunction func =
        new LocationFunctionBuilder("//foo", false).add("//foo", "/exec/src/bar").build();
    assertThat(func.apply("//foo", RepositoryMapping.EMPTY, null)).isEqualTo("src/bar");
    assertThat(func.apply(":foo", RepositoryMapping.EMPTY, null)).isEqualTo("src/bar");
    assertThat(func.apply("foo", RepositoryMapping.EMPTY, null)).isEqualTo("src/bar");
  }

  @Test
  public void pathUnderExecRootUsesDotSlash() throws Exception {
    LocationFunction func =
        new LocationFunctionBuilder("//foo", false).add("//foo", "/exec/bar").build();
    assertThat(func.apply("//foo", RepositoryMapping.EMPTY, null)).isEqualTo("./bar");
  }

  @Test
  public void noSuchLabel() throws Exception {
    LocationFunction func = new LocationFunctionBuilder("//foo", false).build();
    IllegalStateException expected =
        assertThrows(
            IllegalStateException.class, () -> func.apply("//bar", RepositoryMapping.EMPTY, null));
    assertThat(expected)
        .hasMessageThat()
        .isEqualTo(
            "label '//bar:bar' in $(location) expression is not a declared prerequisite of this "
                + "rule");
  }

  @Test
  public void emptyList() throws Exception {
    LocationFunction func = new LocationFunctionBuilder("//foo", false).add("//foo").build();
    IllegalStateException expected =
        assertThrows(
            IllegalStateException.class, () -> func.apply("//foo", RepositoryMapping.EMPTY, null));
    assertThat(expected)
        .hasMessageThat()
        .isEqualTo("label '//foo:foo' in $(location) expression expands to no files");
  }

  @Test
  public void tooMany() throws Exception {
    LocationFunction func =
        new LocationFunctionBuilder("//foo", false).add("//foo", "/exec/1", "/exec/2").build();
    IllegalStateException expected =
        assertThrows(
            IllegalStateException.class, () -> func.apply("//foo", RepositoryMapping.EMPTY, null));
    assertThat(expected)
        .hasMessageThat()
        .isEqualTo(
            "label '//foo:foo' in $(location) expression expands to more than one file, "
                + "please use $(locations //foo:foo) instead.  Files (at most 5 shown) are: "
                + "[./1, ./2]");
  }

  @Test
  public void tooManyExecpath() throws Exception {
    LocationFunction func =
        new LocationFunctionBuilder("//foo", false)
            .setPathType(LocationFunction.PathType.EXEC)
            .add("//foo", "/exec/1", "/exec/2")
            .build();
    IllegalStateException expected =
        assertThrows(
            IllegalStateException.class, () -> func.apply("//foo", RepositoryMapping.EMPTY, null));
    assertThat(expected)
        .hasMessageThat()
        .isEqualTo(
            "label '//foo:foo' in $(execpath) expression expands to more than one file, "
                + "please use $(execpaths //foo:foo) instead.  Files (at most 5 shown) are: "
                + "[./1, ./2]");
  }

  @Test
  public void tooManyRootpath() throws Exception {
    LocationFunction func =
        new LocationFunctionBuilder("//foo", false)
            .setName("rootpath")
            .add("//foo", "/exec/1", "/exec/2")
            .build();
    IllegalStateException expected =
        assertThrows(
            IllegalStateException.class, () -> func.apply("//foo", RepositoryMapping.EMPTY, null));
    assertThat(expected)
        .hasMessageThat()
        .isEqualTo(
            "label '//foo:foo' in $(rootpath) expression expands to more than one file, "
                + "please use $(rootpaths //foo:foo) instead.  Files (at most 5 shown) are: "
                + "[./1, ./2]");
  }

  @Test
  public void tooManyRlocationpath() throws Exception {
    LocationFunction func =
        new LocationFunctionBuilder("//foo", false)
            .setPathType(LocationFunction.PathType.RLOCATION)
            .add("//foo", "/exec/1", "/exec/2")
            .build();
    IllegalStateException expected =
        assertThrows(
            IllegalStateException.class,
            () -> func.apply("//foo", RepositoryMapping.EMPTY, "workspace"));
    assertThat(expected)
        .hasMessageThat()
        .isEqualTo(
            "label '//foo:foo' in $(rlocationpath) expression expands to more than one file, "
                + "please use $(rlocationpaths //foo:foo) instead.  Files (at most 5 shown) are: "
                + "[workspace/1, workspace/2]");
  }

  @Test
  public void noSuchLabelMultiple() throws Exception {
    LocationFunction func = new LocationFunctionBuilder("//foo", true).build();
    IllegalStateException expected =
        assertThrows(
            IllegalStateException.class, () -> func.apply("//bar", RepositoryMapping.EMPTY, null));
    assertThat(expected)
        .hasMessageThat()
        .isEqualTo(
            "label '//bar:bar' in $(locations) expression is not a declared prerequisite of this "
                + "rule");
  }

  @Test
  public void fileWithSpace() throws Exception {
    LocationFunction func =
        new LocationFunctionBuilder("//foo", false).add("//foo", "/exec/file/with space").build();
    assertThat(func.apply("//foo", RepositoryMapping.EMPTY, null)).isEqualTo("'file/with space'");
  }

  @Test
  public void multipleFiles() throws Exception {
    LocationFunction func =
        new LocationFunctionBuilder("//foo", true)
            .add("//foo", "/exec/foo/bar", "/exec/out/foo/foobar")
            .build();
    assertThat(func.apply("//foo", RepositoryMapping.EMPTY, null)).isEqualTo("foo/bar foo/foobar");
  }

  @Test
  public void filesWithSpace() throws Exception {
    LocationFunction func =
        new LocationFunctionBuilder("//foo", true)
            .add("//foo", "/exec/file/with space", "/exec/file/with spaces ")
            .build();
    assertThat(func.apply("//foo", RepositoryMapping.EMPTY, null))
        .isEqualTo("'file/with space' 'file/with spaces '");
  }

  @Test
  public void execPath() throws Exception {
    LocationFunction func =
        new LocationFunctionBuilder("//foo", true)
            .setPathType(LocationFunction.PathType.EXEC)
            .add("//foo", "/exec/bar", "/exec/out/foobar")
            .build();
    assertThat(func.apply("//foo", RepositoryMapping.EMPTY, null)).isEqualTo("./bar out/foobar");
  }

  @Test
  public void rlocationPath() throws Exception {
    LocationFunction func =
        new LocationFunctionBuilder("//foo", true)
            .setPathType(LocationFunction.PathType.RLOCATION)
            .add("//foo", "/exec/bar", "/exec/out/foobar")
            .build();
    assertThat(func.apply("//foo", RepositoryMapping.EMPTY, "workspace"))
        .isEqualTo("workspace/bar workspace/foobar");
  }

  @Test
  public void locationFunctionWithMappingReplace() throws Exception {
    RepositoryName b = RepositoryName.create("b");
    var repositoryMapping = RepositoryMapping.create(ImmutableMap.of("a", b), RepositoryName.MAIN);
    LocationFunction func =
        new LocationFunctionBuilder("//foo", false).add("@b//foo", "/exec/src/bar").build();
    assertThat(func.apply("@a//foo", repositoryMapping, null)).isEqualTo("src/bar");
  }

  @Test
  public void locationFunctionWithMappingIgnoreRepo() throws Exception {
    RepositoryName b = RepositoryName.create("b");
    var repositoryMapping = RepositoryMapping.create(ImmutableMap.of("a", b), RepositoryName.MAIN);
    LocationFunction func =
        new LocationFunctionBuilder("//foo", false).add("@@potato//foo", "/exec/src/bar").build();
    assertThat(func.apply("@@potato//foo", repositoryMapping, null)).isEqualTo("src/bar");
  }
}