src/main/java/com/google/devtools/build/lib/actions/ArtifactPrefixConflictException.java

// Copyright 2014 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.actions;

import com.google.devtools.build.lib.cmdline.Label;
import com.google.devtools.build.lib.server.FailureDetails.Analysis;
import com.google.devtools.build.lib.server.FailureDetails.Analysis.Code;
import com.google.devtools.build.lib.server.FailureDetails.FailureDetail;
import com.google.devtools.build.lib.skyframe.DetailedException;
import com.google.devtools.build.lib.util.DetailedExitCode;
import com.google.devtools.build.lib.vfs.PathFragment;

/**
 * Exception to indicate that one {@link Action} has an output artifact whose path is a prefix of an
 * output of another action. Since the first path cannot be both a directory and a file, this would
 * lead to an error if both actions were executed in the same build.
 */
public class ArtifactPrefixConflictException extends Exception implements DetailedException {
  private final Label firstOwner;

  public ArtifactPrefixConflictException(
      PathFragment firstPath, PathFragment secondPath, Label firstOwner, Label secondOwner) {
    super(
        String.format(
            "One of the output paths '%s' (belonging to %s) and '%s' (belonging to %s) is a"
                + " prefix of the other. These actions cannot be simultaneously present; please"
                + " rename one of the output files or build just one of them",
            firstPath, firstOwner, secondPath, secondOwner));
    this.firstOwner = firstOwner;
  }

  public Label getFirstOwner() {
    return firstOwner;
  }

  @Override
  public DetailedExitCode getDetailedExitCode() {
    return DetailedExitCode.of(
        FailureDetail.newBuilder()
            .setMessage(getMessage())
            .setAnalysis(Analysis.newBuilder().setCode(Code.ARTIFACT_PREFIX_CONFLICT))
            .build());
  }
}