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

import build.bazel.remote.execution.v2.Digest;
import build.bazel.remote.execution.v2.Tree;
import com.google.common.base.Preconditions;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.actions.ActionInput;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.FileArtifactValue;
import com.google.devtools.build.lib.actions.FileContentsProxy;
import com.google.devtools.build.lib.actions.FilesetOutputTree;
import com.google.devtools.build.lib.actions.InputMetadataProvider;
import com.google.devtools.build.lib.actions.RunfilesArtifactValue;
import com.google.devtools.build.lib.actions.RunfilesTree;
import com.google.devtools.build.lib.remote.util.DigestUtil;
import com.google.devtools.build.lib.skyframe.TreeArtifactValue;
import com.google.devtools.build.lib.vfs.FileSystemUtils;
import com.google.devtools.build.lib.vfs.Path;
import com.google.devtools.build.lib.vfs.PathFragment;
import com.google.devtools.build.lib.vfs.SyscallCache;
import java.io.IOException;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import javax.annotation.Nullable;

/** A fake implementation of the {@link InputMetadataProvider} interface. */
final class FakeActionInputFileCache implements InputMetadataProvider {
  private final Path execRoot;
  private final Map<PathFragment, FileArtifactValue> cas = new HashMap<>();
  private final Map<PathFragment, ActionInput> inputs = new HashMap<>();
  private final Map<ActionInput, RunfilesArtifactValue> runfilesMap = new HashMap<>();
  private final Map<ActionInput, TreeArtifactValue> trees = new HashMap<>();
  private final List<RunfilesTree> runfilesTrees = new ArrayList<>();
  private final DigestUtil digestUtil;

  FakeActionInputFileCache(Path execRoot) {
    this.execRoot = execRoot;
    this.digestUtil =
        new DigestUtil(SyscallCache.NO_CACHE, execRoot.getFileSystem().getDigestFunction());
  }

  @Override
  public FileArtifactValue getInputMetadataChecked(ActionInput input) {
    return Preconditions.checkNotNull(
        cas.get(input.getExecPath()),
        "No metadata for input '%s' (exec path: '%s')",
        input,
        input.getExecPath());
  }

  @Nullable
  @Override
  public TreeArtifactValue getTreeMetadata(ActionInput actionInput) {
    return trees.get(actionInput);
  }

  @Nullable
  @Override
  public TreeArtifactValue getEnclosingTreeMetadata(PathFragment execPath) {
    throw new UnsupportedOperationException();
  }

  @Override
  @Nullable
  public FilesetOutputTree getFileset(ActionInput input) {
    throw new UnsupportedOperationException();
  }

  @Override
  public Map<Artifact, FilesetOutputTree> getFilesets() {
    throw new UnsupportedOperationException();
  }

  @Override
  @Nullable
  public RunfilesArtifactValue getRunfilesMetadata(ActionInput input) {
    return runfilesMap.get(input);
  }

  @Override
  public ImmutableList<RunfilesTree> getRunfilesTrees() {
    return ImmutableList.copyOf(runfilesTrees);
  }

  @Override
  @Nullable
  public ActionInput getInput(PathFragment execPath) {
    return inputs.get(execPath);
  }

  private void setMetadata(ActionInput input, FileArtifactValue metadata) {
    cas.put(input.getExecPath(), metadata);
    inputs.put(input.getExecPath(), input);
  }

  /**
   * This test-only implementation does *not* support looking up tree artifact children via {@link
   * #getInput}.
   */
  public void addTreeArtifact(ActionInput treeArtifact, TreeArtifactValue value) {
    trees.put(treeArtifact, value);
  }

  public void addRunfilesTree(ActionInput runfilesTreeArtifact, RunfilesTree runfilesTree) {
    runfilesMap.put(
        runfilesTreeArtifact,
        new RunfilesArtifactValue(
            runfilesTree,
            ImmutableList.of(),
            ImmutableList.of(),
            ImmutableList.of(),
            ImmutableList.of(),
            ImmutableList.of(),
            ImmutableList.of()));
    runfilesTrees.add(runfilesTree);
  }

  public Digest createScratchInput(ActionInput input, String content) throws IOException {
    Path inputFile = execRoot.getRelative(input.getExecPath());
    inputFile.getParentDirectory().createDirectoryAndParents();
    FileSystemUtils.writeContentAsLatin1(inputFile, content);
    Digest digest = digestUtil.compute(inputFile, inputFile.stat());
    setMetadata(
        input,
        FileArtifactValue.createForNormalFile(
            DigestUtil.toBinaryDigest(digest),
            FileContentsProxy.create(inputFile.stat()),
            content.length()));
    return digest;
  }

  public Digest createScratchInputDirectory(ActionInput input, Tree content) throws IOException {
    Path inputFile = execRoot.getRelative(input.getExecPath());
    inputFile.createDirectoryAndParents();
    Digest digest = digestUtil.compute(content);
    setMetadata(
        input, FileArtifactValue.createForDirectoryWithHash(DigestUtil.toBinaryDigest(digest)));
    return digest;
  }

  public void createScratchInputSymlink(Artifact input, String target) throws IOException {
    Preconditions.checkArgument(input.isSymlink());
    Path inputFile = input.getPath();
    inputFile.getParentDirectory().createDirectoryAndParents();
    inputFile.createSymbolicLink(PathFragment.create(target));
    setMetadata(input, FileArtifactValue.createForUnresolvedSymlink(input));
  }
}