src/main/java/com/google/devtools/build/lib/bazel/coverage/CoverageArgs.java

// 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.bazel.coverage;

import com.google.auto.value.AutoValue;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.ArtifactFactory;
import com.google.devtools.build.lib.actions.ArtifactOwner;
import com.google.devtools.build.lib.analysis.BlazeDirectories;
import com.google.devtools.build.lib.analysis.FilesToRunProvider;
import com.google.devtools.build.lib.bazel.coverage.CoverageReportActionBuilder.ArgsFunc;
import com.google.devtools.build.lib.bazel.coverage.CoverageReportActionBuilder.LocationFunc;
import com.google.devtools.build.lib.vfs.PathFragment;
import javax.annotation.Nullable;

/**
 * A value class that holds arguments for
 * {@link CoverageReportActionBuilder#generateCoverageReportAction}, {@link ArgsFunc} and
 * {@link LocationFunc}.
 */
@AutoValue
public abstract class CoverageArgs {
  public abstract BlazeDirectories directories();
  public abstract ImmutableList<Artifact> coverageArtifacts();
  public abstract Artifact lcovArtifact();
  public abstract ArtifactFactory factory();
  public abstract ArtifactOwner artifactOwner();
  public abstract FilesToRunProvider reportGenerator();
  public abstract String workspaceName();
  public abstract boolean htmlReport();
  @Nullable
  public abstract PathFragment coverageDir();
  @Nullable
  public abstract Artifact lcovOutput();

  public static CoverageArgs create(
      BlazeDirectories directories,
      ImmutableList<Artifact> coverageArtifacts,
      Artifact lcovArtifact,
      ArtifactFactory factory,
      ArtifactOwner artifactOwner,
      FilesToRunProvider reportGenerator,
      String workspaceName,
      boolean htmlReport) {
    return new AutoValue_CoverageArgs(directories, coverageArtifacts, lcovArtifact, factory,
        artifactOwner, reportGenerator, workspaceName, htmlReport,
        /*coverageDir=*/ null,
        /*lcovOutput=*/ null);
  }

  public static CoverageArgs createCopyWithCoverageDirAndLcovOutput(
      CoverageArgs args,
      PathFragment coverageDir,
      Artifact lcovOutput) {
    return new AutoValue_CoverageArgs(
        args.directories(), args.coverageArtifacts(), args.lcovArtifact(),
        args.factory(), args.artifactOwner(), args.reportGenerator(), args.workspaceName(),
        args.htmlReport(), coverageDir, lcovOutput);
  }
}