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
|
// 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.analysis;
import static com.google.common.truth.Truth.assertThat;
import static org.junit.Assert.fail;
import com.google.common.collect.Iterables;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.actions.util.ActionsTestUtil;
import com.google.devtools.build.lib.actions.util.ActionsTestUtil.UncheckedActionConflictException;
import com.google.devtools.build.lib.analysis.config.BuildConfiguration;
import com.google.devtools.build.lib.analysis.util.AnalysisTestUtil;
import com.google.devtools.build.lib.analysis.util.BuildViewTestCase;
import com.google.devtools.build.lib.rules.cpp.CcToolchainProvider;
import com.google.devtools.build.lib.rules.cpp.CppHelper;
import com.google.devtools.build.lib.skyframe.ConfiguredTargetAndData;
import java.io.IOException;
import java.util.List;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
/** Unit tests for the {@link CompilationHelper} class. */
@RunWith(JUnit4.class)
public class CompilationHelperTest extends BuildViewTestCase {
private AnalysisTestUtil.CollectingAnalysisEnvironment analysisEnvironment;
@Before
public final void createAnalysisEnvironment() throws Exception {
analysisEnvironment =
new AnalysisTestUtil.CollectingAnalysisEnvironment(getTestAnalysisEnvironment());
}
private List<Artifact> getAggregatingMiddleman(
ConfiguredTarget rule, BuildConfiguration configuration, boolean withSolib) throws Exception {
RuleContext ruleContext = getRuleContext(rule, analysisEnvironment);
CcToolchainProvider toolchain =
CppHelper.getToolchainUsingDefaultCcToolchainAttribute(ruleContext);
return CppHelper.getAggregatingMiddlemanForTesting(
ruleContext,
ActionsTestUtil.NULL_ACTION_OWNER,
"middleman",
rule.getProvider(FileProvider.class).getFilesToBuild(),
withSolib,
toolchain.getSolibDirectory(),
configuration);
}
private List<Artifact> getAggregatingMiddleman(ConfiguredTargetAndData rule, boolean withSolib)
throws Exception {
return getAggregatingMiddleman(rule.getConfiguredTarget(), rule.getConfiguration(), withSolib);
}
/**
* Tests that duplicate calls to
* {@link com.google.devtools.build.lib.analysis.CompilationHelper#getAggregatingMiddleman}
* with identical parameters return the same artifact.
*/
@Test
public void testDuplicateCallsReturnSameObject() throws Exception {
ConfiguredTargetAndData rule =
scratchConfiguredTargetAndData(
"package", "a", "cc_binary(name = 'a'," + " srcs = ['a.cc'])");
List<Artifact> middleman1 = getAggregatingMiddleman(rule, false);
assertThat(middleman1).hasSize(1);
List<Artifact> middleman2 = getAggregatingMiddleman(rule, false);
assertThat(middleman2).hasSize(1);
assertThat(middleman2.get(0)).isEqualTo(middleman1.get(0));
}
/**
* Tests that
* {@link com.google.devtools.build.lib.analysis.CompilationHelper#getAggregatingMiddleman}
* returns distinct artifacts even when called with identical rules, depending on
* whether solib symlink are created.
*/
@Test
public void testMiddlemanAndSolibMiddlemanAreDistinct() throws Exception {
ConfiguredTargetAndData rule =
scratchConfiguredTargetAndData(
"package", "liba.so", "cc_binary(name = 'liba.so', srcs = ['a.cc'], linkshared = 1)");
List<Artifact> middleman = getAggregatingMiddleman(rule, false);
assertThat(middleman).hasSize(1);
List<Artifact> middlemanWithSymlinks = getAggregatingMiddleman(rule, true);
assertThat(middlemanWithSymlinks).hasSize(1);
assertThat(middlemanWithSymlinks.get(0)).isNotSameAs(middleman.get(0));
}
/**
* Regression test: tests that Python CPU configurations are taken into account
* when generating a rule's aggregating middleman, so that otherwise equivalent rules can sustain
* distinct middlemen.
*/
@Test
public void testPythonCcConfigurations() throws Exception {
setupJavaPythonCcConfigurationFiles();
// Equivalent cc / Python configurations:
ConfiguredTargetAndData ccRuleA = getConfiguredTargetAndData("//foo:liba.so");
List<Artifact> middleman1 = getAggregatingMiddleman(ccRuleA, true);
try {
ConfiguredTargetAndData ccRuleB = getConfiguredTargetAndData("//foo:libb.so");
getAggregatingMiddleman(ccRuleB, true);
analysisEnvironment.registerWith(getMutableActionGraph());
fail("Expected ActionConflictException due to same middleman artifact with different files");
} catch (UncheckedActionConflictException e) {
// Expected failure: same "purpose" and root directory sent to the middleman generator
// (which results in the same output artifact), but different rules / middleman inputs.
}
// This should succeed because the py_binary's middleman is under the Python configuration's
// internal directory, while the cc_binary's middleman is under the cc config's directory,
// and both configurations are the same.
ConfiguredTargetAndData pyRuleB =
getConfiguredTargetAndDataDirectPrerequisite(
getConfiguredTargetAndData("//foo:c"), "//foo:libb.so");
List<Artifact> middleman2 = getAggregatingMiddleman(pyRuleB, true);
assertThat(Iterables.getOnlyElement(middleman2).getExecPathString())
.isEqualTo(Iterables.getOnlyElement(middleman1).getExecPathString());
}
/**
* Regression test: tests that Java CPU configurations are taken into account when
* generating a rule's aggregating middleman, so that otherwise equivalent rules can sustain
* distinct middlemen.
*/
@Test
public void testJavaCcConfigurations() throws Exception {
setupJavaPythonCcConfigurationFiles();
// Equivalent cc / Java configurations:
ConfiguredTargetAndData ccRuleA = getConfiguredTargetAndData("//foo:liba.so");
List<Artifact> middleman1 = getAggregatingMiddleman(ccRuleA, true);
try {
ConfiguredTargetAndData ccRuleB = getConfiguredTargetAndData("//foo:libb.so");
getAggregatingMiddleman(ccRuleB, true);
analysisEnvironment.registerWith(getMutableActionGraph());
fail("Expected ActionConflictException due to same middleman artifact with different files");
} catch (UncheckedActionConflictException e) {
// Expected failure: same "purpose" and root directory sent to the middleman generator
// (which results in the same output artifact), but different rules / middleman inputs.
}
// This should succeed because the java_binary's middleman is under the Java configuration's
// internal directory, while the cc_binary's middleman is under the cc config's directory.
ConfiguredTargetAndData javaRuleB =
getConfiguredTargetAndDataDirectPrerequisite(
getConfiguredTargetAndData("//foo:d"), "//foo:libb.so");
List<Artifact> middleman2 = getAggregatingMiddleman(javaRuleB, false);
assertThat(
Iterables.getOnlyElement(middleman1)
.getExecPathString()
.equals(Iterables.getOnlyElement(middleman2).getExecPathString()))
.isFalse();
}
private void setupJavaPythonCcConfigurationFiles() throws IOException {
scratch.file(
"foo/BUILD",
"cc_binary(name = 'liba.so',",
" linkshared = 1,",
" srcs = ['a.cc'])",
"cc_binary(name = 'libb.so',",
" linkshared = 1,",
" srcs = ['b.cc'])",
"py_binary(name = 'c',",
" data = [':libb.so'],",
" srcs = ['c.py'])",
"java_binary(name = 'd',",
" srcs = ['d.java'],",
" data = [':libb.so'],",
" main_class = 'd')");
}
}
|
