src/test/java/com/google/devtools/build/lib/query2/query/output/SyntheticAttributeHashCalculatorTest.java

// Copyright 2020 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.query2.query.output;

import static com.google.common.truth.Truth.assertThat;

import com.google.common.collect.ImmutableMap;
import com.google.devtools.build.lib.cmdline.PackageIdentifier;
import com.google.devtools.build.lib.packages.Attribute;
import com.google.devtools.build.lib.packages.NoSuchPackageException;
import com.google.devtools.build.lib.packages.Package;
import com.google.devtools.build.lib.packages.Rule;
import com.google.devtools.build.lib.packages.util.PackageLoadingTestCase;
import com.google.devtools.build.lib.query2.proto.proto2api.Build;
import com.google.devtools.build.lib.query2.proto.proto2api.Build.Attribute.Discriminator;
import com.google.devtools.build.lib.vfs.Path;
import com.google.devtools.build.lib.vfs.RootedPath;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;

/** Tests for {@link SyntheticAttributeHashCalculator}. */
@RunWith(JUnit4.class)
public class SyntheticAttributeHashCalculatorTest extends PackageLoadingTestCase {

  @Test
  public void testComputeAttributeChangeChangesHash() throws Exception {
    Path buildFile = scratch.file("pkg/BUILD");

    scratch.overwriteFile("pkg/BUILD", "genrule(name='x', cmd='touch $@', outs=['y'])");
    Rule ruleBefore = getRule(buildFile, "x");

    scratch.overwriteFile("pkg/BUILD", "genrule(name='x', cmd='touch $@', outs=['z'])");
    Rule ruleAfter = getRule(buildFile, "x");

    String hashBefore =
        SyntheticAttributeHashCalculator.compute(
            ruleBefore, /*serializedAttributes=*/ ImmutableMap.of(), /*extraDataForAttrHash=*/ "");
    String hashAfter =
        SyntheticAttributeHashCalculator.compute(
            ruleAfter, /*serializedAttributes=*/ ImmutableMap.of(), /*extraDataForAttrHash=*/ "");

    assertThat(hashBefore).isNotEqualTo(hashAfter);
  }

  @Test
  public void testComputeLocationDoesntChangeHash() throws Exception {
    Path buildFile = scratch.file("pkg/BUILD");

    scratch.overwriteFile("pkg/BUILD", "genrule(name='x', cmd='touch $@', outs=['y'])");
    Rule ruleBefore = getRule(buildFile, "x");

    scratch.overwriteFile(
        "pkg/BUILD",
        "genrule(name='rule_that_moves_x', cmd='touch $@', outs=['whatever'])",
        "genrule(name='x', cmd='touch $@', outs=['y'])");
    Rule ruleAfter = getRule(buildFile, "x");

    String hashBefore =
        SyntheticAttributeHashCalculator.compute(
            ruleBefore, /*serializedAttributes=*/ ImmutableMap.of(), /*extraDataForAttrHash=*/ "");
    String hashAfter =
        SyntheticAttributeHashCalculator.compute(
            ruleAfter, /*serializedAttributes=*/ ImmutableMap.of(), /*extraDataForAttrHash=*/ "");

    assertThat(hashBefore).isEqualTo(hashAfter);
  }

  @Test
  public void testComputeSerializedAttributesUsedOverAvailable() throws Exception {
    Rule rule =
        getRule(scratch.file("pkg/BUILD", "genrule(name='x', cmd='touch $@', outs=['y'])"), "x");

    String hashBefore =
        SyntheticAttributeHashCalculator.compute(
            rule, /*serializedAttributes=*/ ImmutableMap.of(), /*extraDataForAttrHash=*/ "");

    ImmutableMap<Attribute, Build.Attribute> serializedAttributes =
        ImmutableMap.of(
            rule.getRuleClassObject().getAttributeByName("cmd"),
            Build.Attribute.newBuilder()
                .setName("dummy")
                .setType(Discriminator.STRING)
                .setStringValue("hi")
                .build());

    String hashAfter =
        SyntheticAttributeHashCalculator.compute(
            rule, serializedAttributes, /*extraDataForAttrHash*/ "");

    assertThat(hashBefore).isNotEqualTo(hashAfter);
  }

  @Test
  public void testComputeExtraDataChangesHash() throws Exception {
    Rule rule =
        getRule(scratch.file("pkg/BUILD", "genrule(name='x', cmd='touch $@', outs=['y'])"), "x");

    String hashBefore =
        SyntheticAttributeHashCalculator.compute(
            rule, /*serializedAttributes=*/ ImmutableMap.of(), /*extraDataForAttrHash=*/ "");

    String hashAfter =
        SyntheticAttributeHashCalculator.compute(
            rule,
            /*serializedAttributes=*/ ImmutableMap.of(), /*extraDataForAttrHash*/
            "blahblaah");

    assertThat(hashBefore).isNotEqualTo(hashAfter);
  }

  @Test
  public void testComputePackageErrorStatusChangesHash() throws Exception {
    Path buildFile = scratch.file("pkg/BUILD");

    scratch.overwriteFile("pkg/BUILD", "genrule(name='x', cmd='touch $@', outs=['y'])");
    Rule ruleBefore = getRule(buildFile, "x");

    // Remove fail-fast handler, we're intentionally creating a package with errors.
    reporter.removeHandler(failFastHandler);
    scratch.overwriteFile(
        "pkg/BUILD",
        "genrule(name='x', cmd='touch $@', outs=['z'])",
        "genrule(name='missing_attributes')");
    Rule ruleAfter = getRule(buildFile, "x");
    assertThat(ruleAfter.containsErrors()).isTrue();

    String hashBefore =
        SyntheticAttributeHashCalculator.compute(
            ruleBefore, /*serializedAttributes=*/ ImmutableMap.of(), /*extraDataForAttrHash=*/ "");
    String hashAfter =
        SyntheticAttributeHashCalculator.compute(
            ruleAfter, /*serializedAttributes=*/ ImmutableMap.of(), /*extraDataForAttrHash=*/ "");

    assertThat(hashBefore).isNotEqualTo(hashAfter);
  }

  private Rule getRule(Path buildFile, String rule)
      throws NoSuchPackageException, InterruptedException {
    Package pkg =
        packageFactory.createPackageForTesting(
            PackageIdentifier.createInMainRepo(buildFile.getParentDirectory().getBaseName()),
            RootedPath.toRootedPath(root, buildFile),
            getPackageManager(),
            reporter);

    return pkg.getRule(rule);
  }
}