Skip to content

Commit ead88f5

Browse files
fmeumfmeum
committed
Add tests
1 parent d2176dc commit ead88f5

File tree

4 files changed

+292
-89
lines changed

4 files changed

+292
-89
lines changed

‎src/test/java/com/google/devtools/common/options/OptionsParserTest.java

Lines changed: 85 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
import com.google.common.collect.ImmutableMap;
2424
import com.google.devtools.common.options.Converters.CommaSeparatedOptionListConverter;
2525
import com.google.devtools.common.options.OptionPriority.PriorityCategory;
26+
import com.google.devtools.common.options.OptionsParser.ConstructionException;
2627
import java.util.ArrayList;
2728
import java.util.Collections;
2829
import java.util.HashMap;
@@ -209,20 +210,74 @@ public static class ExampleInternalOptions extends OptionsBase {
209210
public boolean privateBoolean;
210211

211212
@Option(
212-
name = "internal_string",
213-
metadataTags = {OptionMetadataTag.INTERNAL},
214-
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
215-
effectTags = {OptionEffectTag.NO_OP},
216-
defaultValue = "super secret"
213+
name = "internal_string",
214+
metadataTags = {OptionMetadataTag.INTERNAL},
215+
documentationCategory = OptionDocumentationCategory.UNDOCUMENTED,
216+
effectTags = {OptionEffectTag.NO_OP},
217+
defaultValue = "super secret"
217218
)
218219
public String privateString;
219220
}
220221

222+
public static class ExampleEquivalentWithFoo extends OptionsBase {
223+
224+
@Option(
225+
name = "foo",
226+
category = "one",
227+
documentationCategory = OptionDocumentationCategory.UNCATEGORIZED,
228+
effectTags = {OptionEffectTag.NO_OP},
229+
defaultValue = "differentDefault"
230+
)
231+
public String foo;
232+
233+
@Option(
234+
name = "bar",
235+
category = "one",
236+
documentationCategory = OptionDocumentationCategory.UNCATEGORIZED,
237+
effectTags = {OptionEffectTag.NO_OP},
238+
defaultValue = "differentDefault"
239+
)
240+
public String bar;
241+
242+
@Option(
243+
name = "not_foo",
244+
category = "one",
245+
documentationCategory = OptionDocumentationCategory.UNCATEGORIZED,
246+
effectTags = {OptionEffectTag.NO_OP},
247+
defaultValue = "differentDefault"
248+
)
249+
public String notFoo;
250+
251+
@Option(
252+
name = "not_bar",
253+
category = "one",
254+
documentationCategory = OptionDocumentationCategory.UNCATEGORIZED,
255+
effectTags = {OptionEffectTag.NO_OP},
256+
defaultValue = "differentDefault"
257+
)
258+
public String notBar;
259+
}
260+
261+
public static class ExampleIncompatibleWithFoo extends OptionsBase {
262+
263+
@Option(
264+
name = "foo",
265+
category = "one",
266+
documentationCategory = OptionDocumentationCategory.UNCATEGORIZED,
267+
effectTags = {OptionEffectTag.NO_OP},
268+
defaultValue = "true"
269+
)
270+
public boolean foo;
271+
}
272+
273+
221274
public static class StringConverter extends Converter.Contextless<String> {
275+
222276
@Override
223277
public String convert(String input) {
224278
return input;
225279
}
280+
226281
@Override
227282
public String getTypeDescription() {
228283
return "a string";
@@ -2401,6 +2456,31 @@ public void negativeExternalTargetPatternsInOptions_failsDistinctively() {
24012456
.contains("Flags corresponding to Starlark-defined build settings always start with '--'");
24022457
}
24032458

2459+
@Test
2460+
public void fallbackOptions_optionsParsingEquivalently()
2461+
throws OptionsParsingException {
2462+
OpaqueOptionsData fallbackData = OptionsParser.getFallbackOptionsData(
2463+
ImmutableList.of(ExampleFoo.class, ExampleEquivalentWithFoo.class));
2464+
OptionsParser parser = OptionsParser.builder().optionsClasses(ExampleFoo.class).build();
2465+
parser.parseWithSourceFunction(PriorityCategory.RC_FILE, o -> ".bazelrc",
2466+
ImmutableList.of("--foo=bar", "--not_foo=baz", "--bar", "1", "--not_bar", "baz"),
2467+
fallbackData);
2468+
2469+
assertThat(parser.getOptions(ExampleFoo.class)).isNotNull();
2470+
assertThat(parser.getOptions(ExampleFoo.class).foo).isEqualTo("bar");
2471+
assertThat(parser.getOptions(ExampleFoo.class).bar).isEqualTo(1);
2472+
2473+
assertThat(parser.getOptions(ExampleEquivalentWithFoo.class)).isNull();
2474+
}
2475+
2476+
@Test
2477+
public void fallbackOptions_optionsParsingDifferently() {
2478+
Exception e = assertThrows(ConstructionException.class,
2479+
() -> OptionsParser.getFallbackOptionsData(
2480+
ImmutableList.of(ExampleFoo.class, ExampleIncompatibleWithFoo.class)));
2481+
assertThat(e).hasCauseThat().isInstanceOf(DuplicateOptionDeclarationException.class);
2482+
}
2483+
24042484
private static OptionInstanceOrigin createInvocationPolicyOrigin() {
24052485
return createInvocationPolicyOrigin(/*implicitDependent=*/ null, /*expandedFrom=*/ null);
24062486
}

‎src/test/py/bazel/BUILD

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -331,8 +331,8 @@ py_test(
331331
)
332332

333333
py_test(
334-
name = "starlark_options_test",
335-
srcs = ["starlark_options_test.py"],
334+
name = "options_test",
335+
srcs = ["options_test.py"],
336336
deps = [":test_base"],
337337
)
338338

‎src/test/py/bazel/options_test.py

Lines changed: 205 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,205 @@
1+
# Copyright 2022 The Bazel Authors. All rights reserved.
2+
#
3+
# Licensed under the Apache License, Version 2.0 (the "License");
4+
# you may not use this file except in compliance with the License.
5+
# You may obtain a copy of the License at
6+
#
7+
# http://www.apache.org/licenses/LICENSE-2.0
8+
#
9+
# Unless required by applicable law or agreed to in writing, software
10+
# distributed under the License is distributed on an "AS IS" BASIS,
11+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12+
# See the License for the specific language governing permissions and
13+
# limitations under the License.
14+
15+
import unittest
16+
17+
from src.test.py.bazel import test_base
18+
19+
20+
class OptionsTest(test_base.TestBase):
21+
22+
def testCanOverrideStarlarkFlagInBazelrcConfigStanza(self):
23+
self.ScratchFile("WORKSPACE.bazel")
24+
self.ScratchFile("bazelrc", [
25+
"build:red --//f:color=red",
26+
])
27+
self.ScratchFile("f/BUILD.bazel", [
28+
'load(":f.bzl", "color", "r")',
29+
"color(",
30+
' name = "color",',
31+
' build_setting_default = "white",',
32+
")",
33+
'r(name = "r")',
34+
])
35+
self.ScratchFile("f/f.bzl", [
36+
'ColorValue = provider("color")',
37+
"def _color_impl(ctx):",
38+
" return [ColorValue(color = ctx.build_setting_value)]",
39+
"color = rule(",
40+
" implementation = _color_impl,",
41+
"build_setting = config.string(flag = True),",
42+
")",
43+
"def _r_impl(ctx):",
44+
" print(ctx.attr._color[ColorValue].color)",
45+
" return [DefaultInfo()]",
46+
"r = rule(",
47+
" implementation = _r_impl,",
48+
' attrs = {"_color": attr.label(default = "//f:color")},',
49+
")",
50+
])
51+
52+
exit_code, _, stderr = self.RunBazel([
53+
"--bazelrc=bazelrc",
54+
"build",
55+
"--nobuild",
56+
"//f:r",
57+
"--config=red",
58+
"--//f:color=green",
59+
])
60+
self.AssertExitCode(exit_code, 0, stderr)
61+
self.assertTrue(
62+
any("/f/f.bzl:9:10: green" in line for line in stderr),
63+
"\n".join(stderr),
64+
)
65+
66+
exit_code, _, stderr = self.RunBazel([
67+
"--bazelrc=bazelrc",
68+
"build",
69+
"--nobuild",
70+
"//f:r",
71+
"--//f:color=green",
72+
"--config=red",
73+
])
74+
self.AssertExitCode(exit_code, 0, stderr)
75+
self.assertTrue(
76+
any("/f/f.bzl:9:10: red" in line for line in stderr),
77+
"\n".join(stderr),
78+
)
79+
80+
def testAllSupportedPseudoCommand(self):
81+
self.ScratchFile("WORKSPACE.bazel")
82+
self.ScratchFile(".bazelrc", [
83+
"all-supported --copt=-Dfoo",
84+
"all-supported --copt -Dbar",
85+
"all-supported --force_pic",
86+
"all-supported:my-config --copt=-Dbaz",
87+
"all-supported:my-config --copt -Dquz",
88+
"all-supported:my-config --noforce_pic",
89+
])
90+
self.ScratchFile("pkg/BUILD.bazel", [
91+
"cc_binary(name='main',srcs=['main.cc'])",
92+
])
93+
self.ScratchFile("pkg/main.cc", [
94+
"#include <stdio.h>",
95+
"int main() {",
96+
"#ifdef foo",
97+
" printf(\"foo\\n\");",
98+
"#endif",
99+
"#ifdef bar",
100+
" printf(\"bar\\n\");",
101+
"#endif",
102+
"#ifdef baz",
103+
" printf(\"baz\\n\");",
104+
"#endif",
105+
"#ifdef quz",
106+
" printf(\"quz\\n\");",
107+
"#endif",
108+
" return 0;",
109+
"}",
110+
])
111+
112+
# Check that run honors the all-supported flags.
113+
exit_code, stdout, stderr = self.RunBazel([
114+
"run",
115+
"//pkg:main",
116+
])
117+
self.AssertExitCode(exit_code, 0, stderr)
118+
self.assertEquals(
119+
["foo", "bar"],
120+
stdout,
121+
)
122+
123+
exit_code, stdout, stderr = self.RunBazel([
124+
"run",
125+
"--config=my-config",
126+
"//pkg:main",
127+
])
128+
self.AssertExitCode(exit_code, 0, stderr)
129+
self.assertEquals(
130+
["foo", "bar", "baz", "quz"],
131+
stdout,
132+
)
133+
134+
# Check that aquery honors the all-supported flags.
135+
exit_code, stdout, stderr = self.RunBazel([
136+
"aquery",
137+
"mnemonic(CppLink, //pkg:main)",
138+
])
139+
self.AssertExitCode(exit_code, 0, stderr)
140+
self.assertTrue(
141+
any("-pie" in line for line in stdout),
142+
stdout,
143+
)
144+
145+
exit_code, stdout, stderr = self.RunBazel([
146+
"aquery",
147+
"--config=my-config",
148+
"mnemonic(CppLink, //pkg:main)",
149+
])
150+
self.AssertExitCode(exit_code, 0, stderr)
151+
self.assertFalse(
152+
any("-pie" in line for line in stdout),
153+
stdout,
154+
)
155+
156+
# Check that query ignores the unsupported all-supported flags.
157+
exit_code, stdout, stderr = self.RunBazel([
158+
"query",
159+
"//pkg:main",
160+
])
161+
self.AssertExitCode(exit_code, 0, stderr)
162+
163+
exit_code, stdout, stderr = self.RunBazel([
164+
"query",
165+
"--config=my-config",
166+
"//pkg:main",
167+
])
168+
self.AssertExitCode(exit_code, 0, stderr)
169+
170+
def testAllSupportedPseudoCommand_unsupportedOptionValue(self):
171+
self.ScratchFile("WORKSPACE.bazel")
172+
self.ScratchFile(".bazelrc", [
173+
"all-supported --output=starlark",
174+
])
175+
self.ScratchFile("pkg/BUILD.bazel", [
176+
"cc_binary(name='main',srcs=['main.cc'])",
177+
])
178+
179+
# Check that cquery honors the all-supported flag.
180+
exit_code, stdout, stderr = self.RunBazel([
181+
"cquery",
182+
"--starlark:expr=target.label.name",
183+
"//pkg:main",
184+
])
185+
self.AssertExitCode(exit_code, 0, stderr)
186+
self.assertEquals(
187+
["main"],
188+
stdout,
189+
)
190+
191+
# Check that query fails as it supports the --output flag, but not its
192+
# value.
193+
exit_code, stdout, stderr = self.RunBazel([
194+
"query",
195+
"//pkg:main",
196+
])
197+
self.AssertExitCode(exit_code, 2, stderr)
198+
self.assertTrue(
199+
any("ERROR: Invalid output format 'starlark'." in line for line in stderr),
200+
stderr,
201+
)
202+
203+
204+
if __name__ == "__main__":
205+
unittest.main()

0 commit comments

Comments
 (0)