blob: 1cc4ed918fcffa3dfd73b0504022a42c980fc94d [file] [log] [blame]
// 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.skyframe;
import static com.google.common.truth.Truth.assertThat;
import static org.junit.Assert.assertThrows;
import com.google.common.collect.Interner;
import com.google.devtools.build.lib.concurrent.BlazeInterners;
import com.google.devtools.build.skyframe.NodeEntry.DependencyState;
import java.util.ArrayList;
import java.util.List;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.Parameterized;
import org.junit.runners.Parameterized.Parameters;
/** Test for {@code ReverseDepsUtility}. */
@RunWith(Parameterized.class)
public final class ReverseDepsUtilityTest {
private static final SkyKey KEY = GraphTester.skyKey("KEY");
private final int numElements;
@Parameters(name = "numElements-{0}")
public static List<Object[]> parameters() {
List<Object[]> params = new ArrayList<>();
for (int i = 0; i < 20; i++) {
params.add(new Object[] {i});
}
return params;
}
public ReverseDepsUtilityTest(int numElements) {
this.numElements = numElements;
}
@Test
public void testAddAndRemove() {
for (int numRemovals = 0; numRemovals <= numElements; numRemovals++) {
var example = new IncrementalInMemoryNodeEntry(KEY);
for (int j = 0; j < numElements; j++) {
ReverseDepsUtility.addReverseDep(example, Key.create(j));
}
// Not a big test but at least check that it does not blow up.
assertThat(ReverseDepsUtility.toString(example)).isNotEmpty();
assertThat(
ReverseDepsUtility.consolidateAndGetReverseDeps(
example, /* checkConsistency= */ true))
.hasSize(numElements);
for (int i = 0; i < numRemovals; i++) {
ReverseDepsUtility.removeReverseDep(example, Key.create(i));
}
assertThat(
ReverseDepsUtility.consolidateAndGetReverseDeps(
example, /* checkConsistency= */ true))
.hasSize(numElements - numRemovals);
assertThat(example.getReverseDepsDataToConsolidateForReverseDepsUtil()).isNull();
}
}
// Same as testAdditionAndRemoval but we add all the reverse deps in one call.
@Test
public void testAddAllAndRemove() {
for (int numRemovals = 0; numRemovals <= numElements; numRemovals++) {
var example = new IncrementalInMemoryNodeEntry(KEY);
for (int j = 0; j < numElements; j++) {
ReverseDepsUtility.addReverseDep(example, Key.create(j));
}
assertThat(
ReverseDepsUtility.consolidateAndGetReverseDeps(
example, /* checkConsistency= */ true))
.hasSize(numElements);
for (int i = 0; i < numRemovals; i++) {
ReverseDepsUtility.removeReverseDep(example, Key.create(i));
}
assertThat(
ReverseDepsUtility.consolidateAndGetReverseDeps(
example, /* checkConsistency= */ true))
.hasSize(numElements - numRemovals);
assertThat(example.getReverseDepsDataToConsolidateForReverseDepsUtil()).isNull();
}
}
@Test
public void testDuplicateCheckOnGetReverseDeps() {
var example = new IncrementalInMemoryNodeEntry(KEY);
for (int i = 0; i < numElements; i++) {
ReverseDepsUtility.addReverseDep(example, Key.create(i));
}
// Should only fail when we call getReverseDeps().
ReverseDepsUtility.addReverseDep(example, Key.create(0));
if (numElements == 0) {
// Will not throw.
assertThat(
ReverseDepsUtility.consolidateAndGetReverseDeps(
example, /* checkConsistency= */ true))
.hasSize(1);
} else {
assertThrows(
RuntimeException.class,
() ->
ReverseDepsUtility.consolidateAndGetReverseDeps(
example, /* checkConsistency= */ true));
}
}
@Test
public void duplicateAddNoThrowWithoutCheck() {
var example = new IncrementalInMemoryNodeEntry(KEY);
for (int i = 0; i < numElements; i++) {
ReverseDepsUtility.addReverseDep(example, Key.create(i));
}
ReverseDepsUtility.addReverseDep(example, Key.create(0));
assertThat(
ReverseDepsUtility.consolidateAndGetReverseDeps(example, /* checkConsistency= */ false))
.hasSize(numElements + 1);
}
@Test
public void doubleAddThenRemove() {
var example = new IncrementalInMemoryNodeEntry(KEY);
SkyKey key = Key.create(0);
ReverseDepsUtility.addReverseDep(example, key);
// Should only fail when we call getReverseDeps().
ReverseDepsUtility.addReverseDep(example, key);
ReverseDepsUtility.removeReverseDep(example, key);
assertThrows(
IllegalStateException.class,
() ->
ReverseDepsUtility.consolidateAndGetReverseDeps(example, /* checkConsistency= */ true));
}
@Test
public void doubleAddThenRemoveCheckedOnSize() {
var example = new IncrementalInMemoryNodeEntry(KEY);
SkyKey fixedKey = Key.create(0);
ReverseDepsUtility.addReverseDep(example, fixedKey);
SkyKey key = Key.create(1);
ReverseDepsUtility.addReverseDep(example, key);
// Should only fail when we reach the limit.
ReverseDepsUtility.addReverseDep(example, key);
example.addReverseDepAndCheckIfDone(null);
assertThat(example.checkIfDoneForDirtyReverseDep(fixedKey))
.isEqualTo(DependencyState.ALREADY_EVALUATING);
assertThat(example.checkIfDoneForDirtyReverseDep(key))
.isEqualTo(DependencyState.ALREADY_EVALUATING);
var e =
assertThrows(
IllegalStateException.class, () -> ReverseDepsUtility.removeReverseDep(example, key));
assertThat(e).hasMessageThat().contains("1 duplicate");
}
@Test
public void addRemoveAdd() {
var example = new IncrementalInMemoryNodeEntry(KEY);
SkyKey fixedKey = Key.create(0);
ReverseDepsUtility.addReverseDep(example, fixedKey);
SkyKey key = Key.create(1);
ReverseDepsUtility.addReverseDep(example, key);
ReverseDepsUtility.removeReverseDep(example, key);
ReverseDepsUtility.addReverseDep(example, key);
assertThat(
ReverseDepsUtility.consolidateAndGetReverseDeps(example, /* checkConsistency= */ true))
.containsExactly(fixedKey, key);
}
private static class Key extends AbstractSkyKey<Integer> {
private static final Interner<Key> interner = BlazeInterners.newWeakInterner();
private Key(Integer arg) {
super(arg);
}
private static Key create(Integer arg) {
return interner.intern(new Key(arg));
}
@Override
public SkyFunctionName functionName() {
return SkyFunctionName.FOR_TESTING;
}
}
}