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
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
// Copyright 2016 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.rules.proto;
import static com.google.common.truth.Truth.assertThat;
import static com.google.devtools.build.lib.actions.util.ActionsTestUtil.getFirstArtifactEndingWith;
import static com.google.devtools.build.lib.actions.util.ActionsTestUtil.prettyArtifactNames;
import com.google.common.collect.ImmutableList;
import com.google.devtools.build.lib.actions.Action;
import com.google.devtools.build.lib.actions.Artifact;
import com.google.devtools.build.lib.analysis.ConfiguredTarget;
import com.google.devtools.build.lib.analysis.actions.FileWriteAction;
import com.google.devtools.build.lib.analysis.util.BuildViewTestCase;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.junit.runners.JUnit4;
@RunWith(JUnit4.class)
public class BazelProtoLibraryTest extends BuildViewTestCase {
@Before
public void setUp() throws Exception {
useConfiguration("--proto_compiler=//proto:compiler");
scratch.file("proto/BUILD", "licenses(['notice'])", "exports_files(['compiler'])");
}
@Test
public void createsDescriptorSets() throws Exception {
scratch.file(
"x/BUILD",
"proto_library(name='alias', deps = ['foo'])",
"proto_library(name='foo', srcs=['foo.proto'])",
"proto_library(name='alias_to_no_srcs', deps = ['no_srcs'])",
"proto_library(name='no_srcs')");
assertThat(getDescriptorOutput("//x:alias").getRootRelativePathString())
.isEqualTo("x/alias-descriptor-set.proto.bin");
assertThat(getDescriptorOutput("//x:foo").getRootRelativePathString())
.isEqualTo("x/foo-descriptor-set.proto.bin");
assertThat(getDescriptorOutput("//x:alias_to_no_srcs").getRootRelativePathString())
.isEqualTo("x/alias_to_no_srcs-descriptor-set.proto.bin");
assertThat(getDescriptorOutput("//x:no_srcs").getRootRelativePathString())
.isEqualTo("x/no_srcs-descriptor-set.proto.bin");
}
@Test
public void descriptorSets_ruleWithSrcsCallsProtoc() throws Exception {
scratch.file("x/BUILD", "proto_library(name='foo', srcs=['foo.proto'])");
Artifact file = getDescriptorOutput("//x:foo");
assertThat(getGeneratingSpawnAction(file).getRemainingArguments())
.containsAllOf(
"-Ix/foo.proto=x/foo.proto",
"--descriptor_set_out=" + file.getExecPathString(),
"x/foo.proto");
}
/** Asserts that we register a FileWriteAction with empty contents if there are no srcs. */
@Test
public void descriptorSets_ruleWithoutSrcsWritesEmptyFile() throws Exception {
scratch.file("x/BUILD", "proto_library(name='no_srcs')");
Action action = getDescriptorWriteAction("//x:no_srcs");
assertThat(action).isInstanceOf(FileWriteAction.class);
assertThat(((FileWriteAction) action).getFileContents()).isEmpty();
}
/**
* Asserts that the actions creating descriptor sets for rule R, take as input (=depend on) all of
* the descriptor sets of the transitive dependencies of R.
*
* <p>This is needed so that building R, that has a dependency R' which violates strict proto
* deps, would break.
*/
@Test
public void descriptorSetsDependOnChildren() throws Exception {
scratch.file(
"x/BUILD",
"proto_library(name='alias', deps = ['foo'])",
"proto_library(name='foo', srcs=['foo.proto'], deps = ['bar'])",
"proto_library(name='bar', srcs=['bar.proto'])",
"proto_library(name='alias_to_no_srcs', deps = ['no_srcs'])",
"proto_library(name='no_srcs')");
assertThat(getDepsDescriptorSets(getDescriptorOutput("//x:alias")))
.containsExactly("x/foo-descriptor-set.proto.bin", "x/bar-descriptor-set.proto.bin");
assertThat(getDepsDescriptorSets(getDescriptorOutput("//x:foo")))
.containsExactly("x/bar-descriptor-set.proto.bin");
assertThat(getDepsDescriptorSets(getDescriptorOutput("//x:bar"))).isEmpty();
assertThat(getDepsDescriptorSets(getDescriptorOutput("//x:alias_to_no_srcs")))
.containsExactly("x/no_srcs-descriptor-set.proto.bin");
assertThat(getDepsDescriptorSets(getDescriptorOutput("//x:no_srcs"))).isEmpty();
}
/**
* Returns all of the inputs of the action that generated 'descriptorSet', and which are
* themselves descriptor sets.
*/
private ImmutableList<String> getDepsDescriptorSets(Artifact descriptorSet) {
ImmutableList.Builder<String> result = ImmutableList.builder();
for (String input : prettyArtifactNames(getGeneratingAction(descriptorSet).getInputs())) {
if (input.endsWith("-descriptor-set.proto.bin")) {
result.add(input);
}
}
return result.build();
}
@Test
public void descriptorSetsAreExposedInProvider() throws Exception {
scratch.file(
"x/BUILD",
"proto_library(name='alias', deps = ['foo'])",
"proto_library(name='foo', srcs=['foo.proto'], deps = ['bar'])",
"proto_library(name='bar', srcs=['bar.proto'])",
"proto_library(name='alias_to_no_srcs', deps = ['no_srcs'])",
"proto_library(name='no_srcs')");
{
ProtoSourcesProvider provider =
getConfiguredTarget("//x:alias").getProvider(ProtoSourcesProvider.class);
assertThat(provider.directDescriptorSet().getRootRelativePathString())
.isEqualTo("x/alias-descriptor-set.proto.bin");
assertThat(prettyArtifactNames(provider.transitiveDescriptorSets()))
.containsExactly(
"x/alias-descriptor-set.proto.bin",
"x/foo-descriptor-set.proto.bin",
"x/bar-descriptor-set.proto.bin");
}
{
ProtoSourcesProvider provider =
getConfiguredTarget("//x:foo").getProvider(ProtoSourcesProvider.class);
assertThat(provider.directDescriptorSet().getRootRelativePathString())
.isEqualTo("x/foo-descriptor-set.proto.bin");
assertThat(prettyArtifactNames(provider.transitiveDescriptorSets()))
.containsExactly("x/foo-descriptor-set.proto.bin", "x/bar-descriptor-set.proto.bin");
}
{
ProtoSourcesProvider provider =
getConfiguredTarget("//x:bar").getProvider(ProtoSourcesProvider.class);
assertThat(provider.directDescriptorSet().getRootRelativePathString())
.isEqualTo("x/bar-descriptor-set.proto.bin");
assertThat(prettyArtifactNames(provider.transitiveDescriptorSets()))
.containsExactly("x/bar-descriptor-set.proto.bin");
}
{
ProtoSourcesProvider provider =
getConfiguredTarget("//x:alias_to_no_srcs").getProvider(ProtoSourcesProvider.class);
assertThat(provider.directDescriptorSet().getRootRelativePathString())
.isEqualTo("x/alias_to_no_srcs-descriptor-set.proto.bin");
assertThat(prettyArtifactNames(provider.transitiveDescriptorSets()))
.containsExactly(
"x/alias_to_no_srcs-descriptor-set.proto.bin", "x/no_srcs-descriptor-set.proto.bin");
}
{
ProtoSourcesProvider provider =
getConfiguredTarget("//x:no_srcs").getProvider(ProtoSourcesProvider.class);
assertThat(provider.directDescriptorSet().getRootRelativePathString())
.isEqualTo("x/no_srcs-descriptor-set.proto.bin");
assertThat(prettyArtifactNames(provider.transitiveDescriptorSets()))
.containsExactly("x/no_srcs-descriptor-set.proto.bin");
}
}
@Test
public void testDescriptorSetOutput_strictDeps() throws Exception {
useConfiguration("--proto_compiler=//proto:compiler", "--strict_proto_deps=error");
scratch.file(
"x/BUILD",
"proto_library(name='nodeps', srcs=['nodeps.proto'])",
"proto_library(name='withdeps', srcs=['withdeps.proto'], deps=[':dep1', ':dep2'])",
"proto_library(name='depends_on_alias', srcs=['depends_on_alias.proto'], deps=[':alias'])",
"proto_library(name='alias', deps=[':dep1', ':dep2'])",
"proto_library(name='dep1', srcs=['dep1.proto'])",
"proto_library(name='dep2', srcs=['dep2.proto'])");
assertThat(getGeneratingSpawnAction(getDescriptorOutput("//x:nodeps")).getRemainingArguments())
.containsAllOf("--direct_dependencies", "x/nodeps.proto")
.inOrder();
assertThat(
getGeneratingSpawnAction(getDescriptorOutput("//x:withdeps")).getRemainingArguments())
.containsAllOf("--direct_dependencies", "x/dep1.proto:x/dep2.proto:x/withdeps.proto")
.inOrder();
assertThat(
getGeneratingSpawnAction(getDescriptorOutput("//x:depends_on_alias"))
.getRemainingArguments())
.containsAllOf(
"--direct_dependencies", "x/dep1.proto:x/dep2.proto:x/depends_on_alias.proto")
.inOrder();
}
/**
* When building a proto_library with multiple srcs (say foo.proto and bar.proto), we should allow
* foo.proto to import bar.proto without tripping strict-deps checking. This means that
* --direct_dependencies should list the srcs.
*/
@Test
public void testDescriptorSetOutput_strict_deps_multipleSrcs() throws Exception {
useConfiguration("--proto_compiler=//proto:compiler", "--strict_proto_deps=error");
ConfiguredTarget target =
scratchConfiguredTarget(
"x", "foo", "proto_library(name='foo', srcs=['foo.proto', 'bar.proto'])");
Artifact file = getFirstArtifactEndingWith(getFilesToBuild(target), ".proto.bin");
assertThat(file.getRootRelativePathString()).isEqualTo("x/foo-descriptor-set.proto.bin");
assertThat(getGeneratingSpawnAction(file).getRemainingArguments())
.containsAllOf("--direct_dependencies", "x/foo.proto:x/bar.proto")
.inOrder();
}
@Test
public void testDescriptorSetOutput_strictDeps_disabled() throws Exception {
useConfiguration("--proto_compiler=//proto:compiler", "--strict_proto_deps=off");
scratch.file("x/BUILD", "proto_library(name='foo', srcs=['foo.proto'])");
for (String arg :
getGeneratingSpawnAction(getDescriptorOutput("//x:foo")).getRemainingArguments()) {
assertThat(arg).doesNotContain("--direct_dependencies=");
}
}
private Artifact getDescriptorOutput(String label) throws Exception {
return getFirstArtifactEndingWith(getFilesToBuild(getConfiguredTarget(label)), ".proto.bin");
}
private Action getDescriptorWriteAction(String label) throws Exception {
return getGeneratingAction(getDescriptorOutput(label));
}
}
|
