src/test/java/com/google/devtools/build/lib/exec/FilesetManifestTest.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.exec;

import static com.google.common.truth.Truth.assertThat;
import static com.google.devtools.build.lib.actions.FilesetManifest.RelativeSymlinkBehavior.ERROR;
import static com.google.devtools.build.lib.actions.FilesetManifest.RelativeSymlinkBehavior.IGNORE;
import static com.google.devtools.build.lib.actions.FilesetManifest.RelativeSymlinkBehavior.RESOLVE;
import static com.google.devtools.build.lib.testutil.MoreAsserts.assertThrows;

import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.actions.FilesetManifest;
import com.google.devtools.build.lib.actions.FilesetOutputSymlink;
import com.google.devtools.build.lib.vfs.PathFragment;
import java.io.IOException;
import java.util.List;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

/** Tests for {@link FilesetManifest}. */
@RunWith(JUnit4.class)
public final class FilesetManifestTest {

  private static final PathFragment EXEC_ROOT = PathFragment.create("/root");

  private static FilesetOutputSymlink filesetSymlink(String from, String to) {
    return FilesetOutputSymlink.createForTesting(
        PathFragment.create(from), PathFragment.create(to), EXEC_ROOT);
  }

  @Test
  public void testEmptyManifest() throws Exception {
    List<FilesetOutputSymlink> symlinks = ImmutableList.of();

    FilesetManifest manifest =
        FilesetManifest.constructFilesetManifest(symlinks, PathFragment.create("out/foo"), IGNORE);

    assertThat(manifest.getEntries()).isEmpty();
  }

  @Test
  public void testManifestWithSingleFile() throws Exception {
    List<FilesetOutputSymlink> symlinks = ImmutableList.of(filesetSymlink("bar", "/dir/file"));

    FilesetManifest manifest =
        FilesetManifest.constructFilesetManifest(symlinks, PathFragment.create("out/foo"), IGNORE);

    assertThat(manifest.getEntries())
        .containsExactly(PathFragment.create("out/foo/bar"), "/dir/file");
  }

  @Test
  public void testManifestWithTwoFiles() throws Exception {
    List<FilesetOutputSymlink> symlinks =
        ImmutableList.of(filesetSymlink("bar", "/dir/file"), filesetSymlink("baz", "/dir/file"));

    FilesetManifest manifest =
        FilesetManifest.constructFilesetManifest(symlinks, PathFragment.create("out/foo"), IGNORE);

    assertThat(manifest.getEntries())
        .containsExactly(
            PathFragment.create("out/foo/bar"), "/dir/file",
            PathFragment.create("out/foo/baz"), "/dir/file");
  }

  @Test
  public void testManifestWithDirectory() throws Exception {
    List<FilesetOutputSymlink> symlinks = ImmutableList.of(filesetSymlink("bar", "/some"));

    FilesetManifest manifest =
        FilesetManifest.constructFilesetManifest(symlinks, PathFragment.create("out/foo"), IGNORE);

    assertThat(manifest.getEntries()).containsExactly(PathFragment.create("out/foo/bar"), "/some");
  }

  /** Regression test: code was previously crashing in this case. */
  @Test
  public void testManifestWithEmptyPath() throws Exception {
    List<FilesetOutputSymlink> symlinks = ImmutableList.of(filesetSymlink("bar", ""));

    FilesetManifest manifest =
        FilesetManifest.constructFilesetManifest(symlinks, PathFragment.create("out/foo"), IGNORE);

    assertThat(manifest.getEntries()).containsExactly(PathFragment.create("out/foo/bar"), null);
  }

  @Test
  public void testManifestWithErrorOnRelativeSymlink() throws Exception {
    List<FilesetOutputSymlink> symlinks =
        ImmutableList.of(filesetSymlink("bar", "foo"), filesetSymlink("foo", "/foo/bar"));

    IOException e =
        assertThrows(
            IOException.class,
            () ->
                FilesetManifest.constructFilesetManifest(
                    symlinks, PathFragment.create("out/foo"), ERROR));
    assertThat(e).hasMessageThat().isEqualTo("runfiles target is not absolute: foo");
  }

  @Test
  public void testManifestWithIgnoredRelativeSymlink() throws Exception {
    List<FilesetOutputSymlink> symlinks =
        ImmutableList.of(filesetSymlink("bar", "foo"), filesetSymlink("foo", "/foo/bar"));

    FilesetManifest manifest =
        FilesetManifest.constructFilesetManifest(symlinks, PathFragment.create("out/foo"), IGNORE);

    assertThat(manifest.getEntries())
        .containsExactly(PathFragment.create("out/foo/foo"), "/foo/bar");
  }

  @Test
  public void testManifestWithResolvedRelativeSymlink() throws Exception {
    List<FilesetOutputSymlink> symlinks =
        ImmutableList.of(filesetSymlink("bar", "foo"), filesetSymlink("foo", "/foo/bar"));

    FilesetManifest manifest =
        FilesetManifest.constructFilesetManifest(symlinks, PathFragment.create("out/foo"), RESOLVE);

    assertThat(manifest.getEntries())
        .containsExactly(
            PathFragment.create("out/foo/bar"), "/foo/bar",
            PathFragment.create("out/foo/foo"), "/foo/bar");
  }

  @Test
  public void testManifestWithResolvedRelativeSymlinkWithDotSlash() throws Exception {
    List<FilesetOutputSymlink> symlinks =
        ImmutableList.of(filesetSymlink("bar", "./foo"), filesetSymlink("foo", "/foo/bar"));

    FilesetManifest manifest =
        FilesetManifest.constructFilesetManifest(symlinks, PathFragment.create("out/foo"), RESOLVE);

    assertThat(manifest.getEntries())
        .containsExactly(
            PathFragment.create("out/foo/bar"), "/foo/bar",
            PathFragment.create("out/foo/foo"), "/foo/bar");
  }

  @Test
  public void testManifestWithResolvedRelativeSymlinkWithDotDotSlash() throws Exception {
    List<FilesetOutputSymlink> symlinks =
        ImmutableList.of(
            filesetSymlink("bar/bar", "../foo/foo"), filesetSymlink("foo/foo", "/foo/bar"));

    FilesetManifest manifest =
        FilesetManifest.constructFilesetManifest(symlinks, PathFragment.create("out/foo"), RESOLVE);

    assertThat(manifest.getEntries())
        .containsExactly(
            PathFragment.create("out/foo/bar/bar"), "/foo/bar",
            PathFragment.create("out/foo/foo/foo"), "/foo/bar");
  }

  @Test
  public void testManifestWithUnresolvableRelativeSymlink() throws Exception {
    List<FilesetOutputSymlink> symlinks = ImmutableList.of(filesetSymlink("bar", "foo"));

    FilesetManifest manifest =
        FilesetManifest.constructFilesetManifest(symlinks, PathFragment.create("out/foo"), RESOLVE);

    assertThat(manifest.getEntries()).isEmpty();
    assertThat(manifest.getArtifactValues()).isEmpty();
  }

  @Test
  public void testManifestWithUnresolvableRelativeSymlinkToRelativeSymlink() throws Exception {
    List<FilesetOutputSymlink> symlinks =
        ImmutableList.of(filesetSymlink("bar", "foo"), filesetSymlink("foo", "baz"));

    FilesetManifest manifest =
        FilesetManifest.constructFilesetManifest(symlinks, PathFragment.create("out/foo"), RESOLVE);

    assertThat(manifest.getEntries()).isEmpty();
    assertThat(manifest.getArtifactValues()).isEmpty();
  }

  /** Current behavior is first one wins. */
  @Test
  public void testDefactoBehaviorWithDuplicateEntries() throws Exception {
    List<FilesetOutputSymlink> symlinks =
        ImmutableList.of(filesetSymlink("bar", "/foo/bar"), filesetSymlink("bar", "/baz"));

    FilesetManifest manifest =
        FilesetManifest.constructFilesetManifest(symlinks, PathFragment.create("out/foo"), IGNORE);

    assertThat(manifest.getEntries())
        .containsExactly(PathFragment.create("out/foo/bar"), "/foo/bar");
  }

  @Test
  public void testManifestWithExecRootRelativePath() throws Exception {
    List<FilesetOutputSymlink> symlinks =
        ImmutableList.of(filesetSymlink("bar", EXEC_ROOT.getRelative("foo/bar").getPathString()));

    FilesetManifest manifest =
        FilesetManifest.constructFilesetManifest(symlinks, PathFragment.create("out/foo"), IGNORE);

    assertThat(manifest.getEntries())
        .containsExactly(PathFragment.create("out/foo/bar"), "foo/bar");
  }
}