1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
|
// Copyright 2015 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.skyframe;
import static com.google.common.truth.Truth.assertThat;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.devtools.build.lib.analysis.util.BuildViewTestCase;
import com.google.devtools.build.lib.clock.BlazeClock;
import com.google.devtools.build.lib.cmdline.PackageIdentifier;
import com.google.devtools.build.lib.packages.ConstantRuleVisibility;
import com.google.devtools.build.lib.packages.Rule;
import com.google.devtools.build.lib.packages.SkylarkSemanticsOptions;
import com.google.devtools.build.lib.packages.Target;
import com.google.devtools.build.lib.pkgcache.PackageCacheOptions;
import com.google.devtools.build.lib.pkgcache.PathPackageLocator;
import com.google.devtools.build.lib.skyframe.util.SkyframeExecutorTestUtils;
import com.google.devtools.build.lib.util.io.TimestampGranularityMonitor;
import com.google.devtools.build.lib.vfs.Root;
import com.google.devtools.build.skyframe.EvaluationResult;
import com.google.devtools.build.skyframe.SkyKey;
import com.google.devtools.common.options.Options;
import java.util.Collection;
import java.util.UUID;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
/**
* Tests for the hash code calculated for Skylark RuleClasses based on the transitive closure
* of the imports of their respective definition SkylarkEnvironments.
*/
@RunWith(JUnit4.class)
public class SkylarkFileContentHashTests extends BuildViewTestCase {
@Before
public final void createFiles() throws Exception {
scratch.file("foo/BUILD");
scratch.file("bar/BUILD");
scratch.file("helper/BUILD");
scratch.file("helper/ext.bzl", "def rule_impl(ctx):", " return None");
scratch.file(
"foo/ext.bzl",
"load('//helper:ext.bzl', 'rule_impl')",
"",
"foo1 = rule(implementation = rule_impl)",
"foo2 = rule(implementation = rule_impl)");
scratch.file(
"bar/ext.bzl",
"load('//helper:ext.bzl', 'rule_impl')",
"",
"bar1 = rule(implementation = rule_impl)");
scratch.file(
"pkg/BUILD",
"load('//foo:ext.bzl', 'foo1')",
"load('//foo:ext.bzl', 'foo2')",
"load('//bar:ext.bzl', 'bar1')",
"",
"foo1(name = 'foo1')",
"foo2(name = 'foo2')",
"bar1(name = 'bar1')");
}
@Test
public void testHashInvariance() throws Exception {
assertThat(getHash("pkg", "foo1")).isEqualTo(getHash("pkg", "foo1"));
}
@Test
public void testHashInvarianceAfterOverwritingFileWithSameContents() throws Exception {
String bar1 = getHash("pkg", "bar1");
scratch.overwriteFile(
"bar/ext.bzl",
"load('//helper:ext.bzl', 'rule_impl')",
"",
"bar1 = rule(implementation = rule_impl)");
invalidatePackages();
assertThat(getHash("pkg", "bar1")).isEqualTo(bar1);
}
@Test
public void testHashSameForRulesDefinedInSameFile() throws Exception {
assertThat(getHash("pkg", "foo2")).isEqualTo(getHash("pkg", "foo1"));
}
@Test
public void testHashNotSameForRulesDefinedInDifferentFiles() throws Exception {
assertNotEquals(getHash("pkg", "foo1"), getHash("pkg", "bar1"));
}
@Test
public void testImmediateFileChangeChangesHash() throws Exception {
String bar1 = getHash("pkg", "bar1");
scratch.overwriteFile(
"bar/ext.bzl",
"load('//helper:ext.bzl', 'rule_impl')",
"# Some comments to change file hash",
"",
"bar1 = rule(implementation = rule_impl)");
invalidatePackages();
assertNotEquals(bar1, getHash("pkg", "bar1"));
}
@Test
public void testTransitiveFileChangeChangesHash() throws Exception {
String bar1 = getHash("pkg", "bar1");
String foo1 = getHash("pkg", "foo1");
String foo2 = getHash("pkg", "foo2");
scratch.overwriteFile(
"helper/ext.bzl",
"# Some comments to change file hash",
"def rule_impl(ctx):",
" return None");
invalidatePackages();
assertNotEquals(bar1, getHash("pkg", "bar1"));
assertNotEquals(foo1, getHash("pkg", "foo1"));
assertNotEquals(foo2, getHash("pkg", "foo2"));
}
@Test
public void testFileChangeDoesNotAffectRulesDefinedOutsideOfTransitiveClosure() throws Exception {
String foo1 = getHash("pkg", "foo1");
String foo2 = getHash("pkg", "foo2");
scratch.overwriteFile(
"bar/ext.bzl",
"load('//helper:ext.bzl', 'rule_impl')",
"# Some comments to change file hash",
"",
"bar1 = rule(implementation = rule_impl)");
invalidatePackages();
assertThat(getHash("pkg", "foo1")).isEqualTo(foo1);
assertThat(getHash("pkg", "foo2")).isEqualTo(foo2);
}
private void assertNotEquals(String hash, String hash2) {
assertThat(hash.equals(hash2)).isFalse();
}
/**
* Returns the hash code of the rule target defined by the pkg and the target name parameters.
* Asserts that the targets and it's Skylark dependencies were loaded properly.
*/
private String getHash(String pkg, String name) throws Exception {
PackageCacheOptions packageCacheOptions = Options.getDefaults(PackageCacheOptions.class);
packageCacheOptions.defaultVisibility = ConstantRuleVisibility.PUBLIC;
packageCacheOptions.showLoadingProgress = true;
packageCacheOptions.globbingThreads = 7;
getSkyframeExecutor()
.preparePackageLoading(
new PathPackageLocator(
outputBase,
ImmutableList.of(Root.fromPath(rootDirectory)),
BazelSkyframeExecutorConstants.BUILD_FILES_BY_PRIORITY),
packageCacheOptions,
Options.getDefaults(SkylarkSemanticsOptions.class),
"",
UUID.randomUUID(),
ImmutableMap.<String, String>of(),
ImmutableMap.<String, String>of(),
new TimestampGranularityMonitor(BlazeClock.instance()));
SkyKey pkgLookupKey = PackageValue.key(PackageIdentifier.parse("@//" + pkg));
EvaluationResult<PackageValue> result =
SkyframeExecutorTestUtils.evaluate(
getSkyframeExecutor(), pkgLookupKey, /*keepGoing=*/ false, reporter);
assertThat(result.hasError()).isFalse();
Collection<Target> targets = result.get(pkgLookupKey).getPackage().getTargets().values();
for (Target target : targets) {
if (target.getName().equals(name)) {
return ((Rule) target)
.getRuleClassObject()
.getRuleDefinitionEnvironment()
.getTransitiveContentHashCode();
}
}
throw new IllegalStateException("target not found: " + name);
}
}
|
