blob: 4258c169e884efd7f0ae385814cb5281fa48d40a [file] [log] [blame]
Daniel Jasper7052ce62014-01-19 09:04:08 +00001//===- unittest/Format/FormatTestProto.cpp --------------------------------===//
2//
Chandler Carruth2946cd72019-01-19 08:50:56 +00003// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4// See https://llvm.org/LICENSE.txt for license information.
5// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
Daniel Jasper7052ce62014-01-19 09:04:08 +00006//
7//===----------------------------------------------------------------------===//
8
Daniel Jasper7052ce62014-01-19 09:04:08 +00009#include "FormatTestUtils.h"
10#include "clang/Format/Format.h"
11#include "llvm/Support/Debug.h"
12#include "gtest/gtest.h"
13
Chandler Carruth10346662014-04-22 03:17:02 +000014#define DEBUG_TYPE "format-test"
15
Daniel Jasper7052ce62014-01-19 09:04:08 +000016namespace clang {
17namespace format {
18
19class FormatTestProto : public ::testing::Test {
20protected:
21 static std::string format(llvm::StringRef Code, unsigned Offset,
Krasimir Georgievd6824872018-04-23 08:50:36 +000022 unsigned Length, const FormatStyle &Style) {
Nicola Zaghen3538b392018-05-15 13:30:56 +000023 LLVM_DEBUG(llvm::errs() << "---\n");
24 LLVM_DEBUG(llvm::errs() << Code << "\n\n");
Daniel Jasper7052ce62014-01-19 09:04:08 +000025 std::vector<tooling::Range> Ranges(1, tooling::Range(Offset, Length));
Krasimir Georgievd6824872018-04-23 08:50:36 +000026 tooling::Replacements Replaces = reformat(Style, Code, Ranges);
Eric Liu4f8d9942016-07-11 13:53:12 +000027 auto Result = applyAllReplacements(Code, Replaces);
28 EXPECT_TRUE(static_cast<bool>(Result));
Nicola Zaghen3538b392018-05-15 13:30:56 +000029 LLVM_DEBUG(llvm::errs() << "\n" << *Result << "\n\n");
Eric Liu4f8d9942016-07-11 13:53:12 +000030 return *Result;
Daniel Jasper7052ce62014-01-19 09:04:08 +000031 }
32
33 static std::string format(llvm::StringRef Code) {
Nico Weber514ecc82014-02-02 20:50:45 +000034 FormatStyle Style = getGoogleStyle(FormatStyle::LK_Proto);
Daniel Jasper215d6c82014-01-22 08:04:52 +000035 Style.ColumnLimit = 60; // To make writing tests easier.
36 return format(Code, 0, Code.size(), Style);
Daniel Jasper7052ce62014-01-19 09:04:08 +000037 }
38
39 static void verifyFormat(llvm::StringRef Code) {
Mark Zerenc9a918c2018-04-04 21:09:00 +000040 EXPECT_EQ(Code.str(), format(Code)) << "Expected code is not stable";
Daniel Jasper7052ce62014-01-19 09:04:08 +000041 EXPECT_EQ(Code.str(), format(test::messUp(Code)));
42 }
43};
44
45TEST_F(FormatTestProto, FormatsMessages) {
46 verifyFormat("message SomeMessage {\n"
47 " required int32 field1 = 1;\n"
48 "}");
49 verifyFormat("message SomeMessage {\n"
Daniel Jasper9c2820c2014-06-23 07:36:25 +000050 " required .absolute.Reference field1 = 1;\n"
51 "}");
52 verifyFormat("message SomeMessage {\n"
Daniel Jasper7052ce62014-01-19 09:04:08 +000053 " required int32 field1 = 1;\n"
54 " optional string field2 = 2 [default = \"2\"]\n"
55 "}");
Daniel Jasper215d6c82014-01-22 08:04:52 +000056
57 verifyFormat("message SomeMessage {\n"
Nikola Smiljanice08a91e2014-05-08 00:05:13 +000058 " optional really.really.long.qualified.type.aaa.aaaaaaa\n"
Daniel Jasper215d6c82014-01-22 08:04:52 +000059 " fiiiiiiiiiiiiiiiiiiiiiiiiield = 1;\n"
60 " optional\n"
Nikola Smiljanice08a91e2014-05-08 00:05:13 +000061 " really.really.long.qualified.type.aaa.aaaaaaa.aaaaaaaa\n"
Daniel Jasper215d6c82014-01-22 08:04:52 +000062 " another_fiiiiiiiiiiiiiiiiiiiiield = 2;\n"
63 "}");
Krasimir Georgiev9451e672017-06-27 10:06:40 +000064 verifyFormat("message SomeMessage {\n"
65 " map<string, Project> projects = 1;\n"
66 " optional map<string, int32> size_projects = 2;\n"
67 " map<int, really.really.really.long.qualified.type.nameeee>\n"
68 " projects = 3;\n"
69 " map<int, really.really.really.really.long.qualified.type\n"
70 " .nameeee> projects = 4;\n"
71 " map<int,\n"
72 " reallyreallyreallyreallyreallyreallyreallylongname>\n"
73 " projects = 5;\n"
74 " map<int, Project>\n"
75 " longlonglonglonglonglonglonglonglonglongonglon = 6;\n"
76 " map<releleallyreallyreallyreallyreallyreallyreallylongname,\n"
77 " int> projects = 7;\n"
78 " map<releleallyreallyreallyreallyreallyreallyreallylongname,\n"
79 " releleallyreallyreallyreallyreallyreallyreallylongname>\n"
80 " releleallyreallyreallyreallyreallyreallyreallylongnam =\n"
81 " 8;\n"
82 " map<relele.llyreal.yreallyr.allyreally.eallyreal\n"
83 " .sauenirylongname,\n"
84 " really.really.really.really.long.qualified.type\n"
85 " .nameeee> projects = 9;\n"
86 "}");
Daniel Jasper7052ce62014-01-19 09:04:08 +000087}
88
Daniel Jasper23d3bcf2015-06-25 08:38:46 +000089TEST_F(FormatTestProto, KeywordsInOtherLanguages) {
90 verifyFormat("optional string operator = 1;");
91}
92
Daniel Jasper7052ce62014-01-19 09:04:08 +000093TEST_F(FormatTestProto, FormatsEnums) {
94 verifyFormat("enum Type {\n"
95 " UNKNOWN = 0;\n"
96 " TYPE_A = 1;\n"
97 " TYPE_B = 2;\n"
98 "};");
Daniel Jasperc6dd2732015-07-16 14:25:43 +000099 verifyFormat("enum Type {\n"
Krasimir Georgievc2091802018-01-31 10:14:10 +0000100 " UNKNOWN = 0 [(some_options) = { a: aa, b: bb }];\n"
Daniel Jasper7f3b99f2016-06-23 09:40:19 +0000101 "};");
102 verifyFormat("enum Type {\n"
Daniel Jasperc6dd2732015-07-16 14:25:43 +0000103 " UNKNOWN = 0 [(some_options) = {\n"
Daniel Jasper7f3b99f2016-06-23 09:40:19 +0000104 " a: aa, // wrap\n"
Daniel Jasperc6dd2732015-07-16 14:25:43 +0000105 " b: bb\n"
106 " }];\n"
107 "};");
Daniel Jasper7052ce62014-01-19 09:04:08 +0000108}
109
Paul Hoada87ba1c2019-03-23 14:24:30 +0000110TEST_F(FormatTestProto, EnumAsFieldName) {
111 verifyFormat("message SomeMessage {\n"
112 " required int32 enum = 1;\n"
113 "}");
114}
115
Daniel Jasper7052ce62014-01-19 09:04:08 +0000116TEST_F(FormatTestProto, UnderstandsReturns) {
117 verifyFormat("rpc Search(SearchRequest) returns (SearchResponse);");
118}
119
120TEST_F(FormatTestProto, MessageFieldAttributes) {
121 verifyFormat("optional string test = 1 [default = \"test\"];");
Daniel Jaspera0e9be22014-01-28 18:51:11 +0000122 verifyFormat("optional bool a = 1 [default = true, deprecated = true];");
Daniel Jasperccff4d12016-01-04 07:27:33 +0000123 verifyFormat("optional LongMessageType long_proto_field = 1 [\n"
124 " default = REALLY_REALLY_LONG_CONSTANT_VALUE,\n"
125 " deprecated = true\n"
126 "];");
Daniel Jasper7052ce62014-01-19 09:04:08 +0000127 verifyFormat("optional LongMessageType long_proto_field = 1\n"
128 " [default = REALLY_REALLY_LONG_CONSTANT_VALUE];");
Daniel Jasper6e58fee2014-01-29 18:43:40 +0000129 verifyFormat("repeated double value = 1\n"
Krasimir Georgievc2091802018-01-31 10:14:10 +0000130 " [(aaaaaaa.aaaaaaaaa) = { aaaaaaaaaaaaaaaaa: AAAAAAAA }];");
Daniel Jasperce2fdb02014-10-27 13:25:59 +0000131 verifyFormat("repeated double value = 1 [(aaaaaaa.aaaaaaaaa) = {\n"
132 " aaaaaaaaaaaaaaaa: AAAAAAAAAA,\n"
133 " bbbbbbbbbbbbbbbb: BBBBBBBBBB\n"
134 "}];");
135 verifyFormat("repeated double value = 1 [(aaaaaaa.aaaaaaaaa) = {\n"
136 " aaaaaaaaaaaaaaaa: AAAAAAAAAA\n"
137 " bbbbbbbbbbbbbbbb: BBBBBBBBBB\n"
138 "}];");
Daniel Jasperccff4d12016-01-04 07:27:33 +0000139 verifyFormat("repeated double value = 1 [\n"
140 " (aaaaaaa.aaaaaaaaa) = {\n"
141 " aaaaaaaaaaaaaaaa: AAAAAAAAAA\n"
142 " bbbbbbbbbbbbbbbb: BBBBBBBBBB\n"
143 " },\n"
144 " (bbbbbbb.bbbbbbbbb) = {\n"
145 " aaaaaaaaaaaaaaaa: AAAAAAAAAA\n"
146 " bbbbbbbbbbbbbbbb: BBBBBBBBBB\n"
147 " }\n"
148 "];");
Daniel Jasperce2fdb02014-10-27 13:25:59 +0000149 verifyFormat("repeated double value = 1 [(aaaaaaa.aaaaaaaaa) = {\n"
Daniel Jasper1662bfe2015-04-03 21:15:46 +0000150 " type: \"AAAAAAAAAA\"\n"
151 " is: \"AAAAAAAAAA\"\n"
152 " or: \"BBBBBBBBBB\"\n"
153 "}];");
154 verifyFormat("repeated double value = 1 [(aaaaaaa.aaaaaaaaa) = {\n"
Daniel Jasperce2fdb02014-10-27 13:25:59 +0000155 " aaaaaaaaaaaaaaaa: AAAAAAAAAA,\n"
156 " bbbbbbb: BBBB,\n"
157 " bbbb: BBB\n"
158 "}];");
Daniel Jasperccff4d12016-01-04 07:27:33 +0000159 verifyFormat("optional AAA aaa = 1 [\n"
160 " foo = {\n"
161 " key: 'a' //\n"
162 " },\n"
163 " bar = {\n"
164 " key: 'a' //\n"
165 " }\n"
166 "];");
Daniel Jasper9c95dfe2018-03-12 10:32:18 +0000167 verifyFormat("optional string test = 1 [default = \"test\"\n"
168 " \"test\"];");
Daniel Jasperc79e4d22017-03-14 00:40:32 +0000169 verifyFormat("optional Aaaaaaaa aaaaaaaa = 12 [\n"
170 " (aaa) = aaaa,\n"
171 " (bbbbbbbbbbbbbbbbbbbbbbbbbb) = {\n"
172 " aaaaaaaaaaaaaaaaa: true,\n"
173 " aaaaaaaaaaaaaaaa: true\n"
174 " }\n"
175 "];");
Krasimir Georgiev9b2aa422018-02-19 15:31:25 +0000176 verifyFormat("extensions 20 [(proto2.type) = 'Aaaa.bbbb'];");
177 verifyFormat("extensions 20\n"
178 " [(proto3.type) = 'Aaaa.bbbb', (aaa.Aaa) = 'aaa.bbb'];");
179 verifyFormat("extensions 123 [\n"
180 " (aaa) = aaaa,\n"
181 " (bbbbbbbbbbbbbbbbbbbbbbbbbb) = {\n"
182 " aaaaaaaaaaaaaaaaa: true,\n"
183 " aaaaaaaaaaaaaaaa: true\n"
184 " }\n"
185 "];");
Daniel Jasper7052ce62014-01-19 09:04:08 +0000186}
187
Daniel Jasper1b998812015-04-23 09:54:10 +0000188TEST_F(FormatTestProto, DoesntWrapFileOptions) {
189 EXPECT_EQ(
190 "option java_package = "
191 "\"some.really.long.package.that.exceeds.the.column.limit\";",
192 format("option java_package = "
193 "\"some.really.long.package.that.exceeds.the.column.limit\";"));
194}
195
Krasimir Georgiev69150462019-04-12 10:11:34 +0000196TEST_F(FormatTestProto, TrailingCommentAfterFileOption) {
197 verifyFormat("option java_package = \"foo.pkg\"; // comment\n");
198}
199
Daniel Jasper929b1db2014-01-20 16:47:22 +0000200TEST_F(FormatTestProto, FormatsOptions) {
Daniel Jaspera382cbe2014-07-28 14:08:09 +0000201 verifyFormat("option (MyProto.options) = {\n"
202 " field_a: OK\n"
203 " field_b: \"OK\"\n"
204 " field_c: \"OK\"\n"
Krasimir Georgievc2091802018-01-31 10:14:10 +0000205 " msg_field: { field_d: 123 }\n"
Daniel Jaspera382cbe2014-07-28 14:08:09 +0000206 "};");
Daniel Jaspera382cbe2014-07-28 14:08:09 +0000207 verifyFormat("option (MyProto.options) = {\n"
208 " field_a: OK\n"
209 " field_b: \"OK\"\n"
210 " field_c: \"OK\"\n"
Krasimir Georgievc2091802018-01-31 10:14:10 +0000211 " msg_field: { field_d: 123 field_e: OK }\n"
Daniel Jaspera382cbe2014-07-28 14:08:09 +0000212 "};");
Daniel Jaspera382cbe2014-07-28 14:08:09 +0000213 verifyFormat("option (MyProto.options) = {\n"
214 " field_a: OK // Comment\n"
215 " field_b: \"OK\"\n"
216 " field_c: \"OK\"\n"
Krasimir Georgievc2091802018-01-31 10:14:10 +0000217 " msg_field: { field_d: 123 }\n"
Daniel Jaspera382cbe2014-07-28 14:08:09 +0000218 "};");
Daniel Jasper497d9fd2014-08-15 05:00:35 +0000219 verifyFormat("option (MyProto.options) = {\n"
220 " field_c: \"OK\"\n"
Krasimir Georgievc2091802018-01-31 10:14:10 +0000221 " msg_field { field_d: 123 }\n"
Daniel Jasper497d9fd2014-08-15 05:00:35 +0000222 "};");
Krasimir Georgievfeeba612017-06-29 13:30:41 +0000223 verifyFormat("option (MyProto.options) = {\n"
224 " field_a: OK\n"
Krasimir Georgievc2091802018-01-31 10:14:10 +0000225 " field_b { field_c: OK }\n"
Krasimir Georgievfeeba612017-06-29 13:30:41 +0000226 " field_d: OKOKOK\n"
227 " field_e: OK\n"
228 "}");
Daniel Jasperffbad0e2016-01-04 07:28:12 +0000229
230 // Support syntax with <> instead of {}.
231 verifyFormat("option (MyProto.options) = {\n"
232 " field_c: \"OK\",\n"
Krasimir Georgieva79d62d2018-02-06 11:34:34 +0000233 " msg_field: < field_d: 123 >\n"
234 " empty: <>\n"
235 " empty <>\n"
Daniel Jasperffbad0e2016-01-04 07:28:12 +0000236 "};");
Krasimir Georgievff747be2017-06-27 13:43:07 +0000237
238 verifyFormat("option (MyProto.options) = {\n"
Krasimir Georgievfeeba612017-06-29 13:30:41 +0000239 " field_a: OK\n"
Krasimir Georgieva79d62d2018-02-06 11:34:34 +0000240 " field_b < field_c: OK >\n"
Krasimir Georgievfeeba612017-06-29 13:30:41 +0000241 " field_d: OKOKOK\n"
242 " field_e: OK\n"
243 "}");
244
245 verifyFormat("option (MyProto.options) = {\n"
Krasimir Georgievff747be2017-06-27 13:43:07 +0000246 " msg_field: <>\n"
247 " field_c: \"OK\",\n"
Krasimir Georgieva79d62d2018-02-06 11:34:34 +0000248 " msg_field: < field_d: 123 >\n"
Krasimir Georgievff747be2017-06-27 13:43:07 +0000249 " field_e: OK\n"
Krasimir Georgieva79d62d2018-02-06 11:34:34 +0000250 " msg_field: < field_d: 12 >\n"
Krasimir Georgievff747be2017-06-27 13:43:07 +0000251 "};");
252
253 verifyFormat("option (MyProto.options) = <\n"
254 " field_a: OK\n"
255 " field_b: \"OK\"\n"
256 " field_c: 1\n"
257 " field_d: 12.5\n"
258 " field_e: OK\n"
259 ">;");
260
261 verifyFormat("option (MyProto.options) = <\n"
262 " field_a: OK,\n"
263 " field_b: \"OK\",\n"
264 " field_c: 1,\n"
265 " field_d: 12.5,\n"
266 " field_e: OK,\n"
267 ">;");
268
269 verifyFormat("option (MyProto.options) = <\n"
270 " field_a: \"OK\"\n"
Krasimir Georgievc2091802018-01-31 10:14:10 +0000271 " msg_field: { field_b: OK }\n"
Krasimir Georgievff747be2017-06-27 13:43:07 +0000272 " field_g: OK\n"
273 " field_g: OK\n"
274 " field_g: OK\n"
275 ">;");
276
277 verifyFormat("option (MyProto.options) = <\n"
278 " field_a: \"OK\"\n"
Krasimir Georgiev47f21ef2017-07-06 13:58:29 +0000279 " msg_field <\n"
Krasimir Georgievff747be2017-06-27 13:43:07 +0000280 " field_b: OK\n"
281 " field_c: OK\n"
282 " field_d: OK\n"
283 " field_e: OK\n"
284 " field_f: OK\n"
285 " >\n"
286 " field_g: OK\n"
287 ">;");
288
289 verifyFormat("option (MyProto.options) = <\n"
290 " field_a: \"OK\"\n"
Krasimir Georgiev47f21ef2017-07-06 13:58:29 +0000291 " msg_field <\n"
Krasimir Georgievff747be2017-06-27 13:43:07 +0000292 " field_b: OK,\n"
293 " field_c: OK,\n"
294 " field_d: OK,\n"
295 " field_e: OK,\n"
296 " field_f: OK\n"
297 " >\n"
298 " field_g: OK\n"
299 ">;");
300
301 verifyFormat("option (MyProto.options) = <\n"
302 " field_a: \"OK\"\n"
303 " msg_field: <\n"
304 " field_b: OK\n"
305 " field_c: OK\n"
306 " field_d: OK\n"
307 " field_e: OK\n"
308 " field_f: OK\n"
309 " >\n"
310 " field_g: OK\n"
311 ">;");
312
313 verifyFormat("option (MyProto.options) = <\n"
314 " field_a: \"OK\"\n"
315 " msg_field: {\n"
316 " field_b: OK\n"
317 " field_c: OK\n"
318 " field_d: OK\n"
319 " field_e: OK\n"
320 " field_f: OK\n"
321 " }\n"
322 " field_g: OK\n"
323 ">;");
324
325 verifyFormat("option (MyProto.options) = <\n"
326 " field_a: \"OK\"\n"
Krasimir Georgiev47f21ef2017-07-06 13:58:29 +0000327 " msg_field {\n"
Krasimir Georgievff747be2017-06-27 13:43:07 +0000328 " field_b: OK\n"
329 " field_c: OK\n"
330 " field_d: OK\n"
331 " field_e: OK\n"
332 " field_f: OK\n"
333 " }\n"
334 " field_g: OK\n"
335 ">;");
336
337 verifyFormat("option (MyProto.options) = {\n"
338 " field_a: \"OK\"\n"
Krasimir Georgiev47f21ef2017-07-06 13:58:29 +0000339 " msg_field <\n"
Krasimir Georgievff747be2017-06-27 13:43:07 +0000340 " field_b: OK\n"
341 " field_c: OK\n"
342 " field_d: OK\n"
343 " field_e: OK\n"
344 " field_f: OK\n"
345 " >\n"
346 " field_g: OK\n"
347 "};");
348
349 verifyFormat("option (MyProto.options) = {\n"
350 " field_a: \"OK\"\n"
351 " msg_field: <\n"
352 " field_b: OK\n"
353 " field_c: OK\n"
354 " field_d: OK\n"
355 " field_e: OK\n"
356 " field_f: OK\n"
357 " >\n"
358 " field_g: OK\n"
359 "};");
360
361 verifyFormat("option (MyProto.options) = <\n"
362 " field_a: \"OK\"\n"
Krasimir Georgiev47f21ef2017-07-06 13:58:29 +0000363 " msg_field {\n"
Krasimir Georgievff747be2017-06-27 13:43:07 +0000364 " field_b: OK\n"
365 " field_c: OK\n"
366 " field_d: OK\n"
Krasimir Georgiev47f21ef2017-07-06 13:58:29 +0000367 " msg_field <\n"
Krasimir Georgievff747be2017-06-27 13:43:07 +0000368 " field_A: 1\n"
369 " field_B: 2\n"
370 " field_C: 3\n"
371 " field_D: 4\n"
372 " field_E: 5\n"
373 " >\n"
Krasimir Georgieva79d62d2018-02-06 11:34:34 +0000374 " msg_field < field_A: 1 field_B: 2 field_C: 3 f_D: 4 >\n"
Krasimir Georgievff747be2017-06-27 13:43:07 +0000375 " field_e: OK\n"
376 " field_f: OK\n"
377 " }\n"
378 " field_g: OK\n"
379 ">;");
Krasimir Georgievfa4dbb62017-08-03 13:43:45 +0000380
381 verifyFormat("option (MyProto.options) = <\n"
Krasimir Georgieva79d62d2018-02-06 11:34:34 +0000382 " data1 < key1: value1 >\n"
Krasimir Georgievc2091802018-01-31 10:14:10 +0000383 " data2 { key2: value2 }\n"
Krasimir Georgievfa4dbb62017-08-03 13:43:45 +0000384 ">;");
Krasimir Georgievddb19242017-08-03 14:17:29 +0000385
386 verifyFormat("option (MyProto.options) = <\n"
387 " app_id: 'com.javax.swing.salsa.latino'\n"
388 " head_id: 1\n"
Krasimir Georgieva79d62d2018-02-06 11:34:34 +0000389 " data < key: value >\n"
Krasimir Georgievddb19242017-08-03 14:17:29 +0000390 ">;");
391
392 verifyFormat("option (MyProto.options) = {\n"
393 " app_id: 'com.javax.swing.salsa.latino'\n"
394 " head_id: 1\n"
395 " headheadheadheadheadhead_id: 1\n"
Krasimir Georgievc2091802018-01-31 10:14:10 +0000396 " product_data { product { 1 } }\n"
Krasimir Georgievddb19242017-08-03 14:17:29 +0000397 "};");
Daniel Jasper929b1db2014-01-20 16:47:22 +0000398}
399
Krasimir Georgiev4dea1372019-05-10 09:15:11 +0000400TEST_F(FormatTestProto, DoesntWrapPackageStatements) {
401 verifyFormat(
402 "package"
403 " some.really.long.package.that.exceeds.the.column.limit00000000;");
404}
405
406TEST_F(FormatTestProto, TrailingCommentAfterPackage) {
407 verifyFormat("package foo.pkg; // comment\n");
408}
409
Daniel Jasper220c0d12014-04-10 07:27:12 +0000410TEST_F(FormatTestProto, FormatsService) {
411 verifyFormat("service SearchService {\n"
412 " rpc Search(SearchRequest) returns (SearchResponse) {\n"
413 " option foo = true;\n"
414 " }\n"
415 "};");
416}
417
Daniel Jasperd8d98392015-11-20 14:32:54 +0000418TEST_F(FormatTestProto, ExtendingMessage) {
Daniel Jasper67e65212018-08-15 19:07:55 +0000419 verifyFormat("extend .foo.Bar {}");
Daniel Jasperd8d98392015-11-20 14:32:54 +0000420}
421
Daniel Jasper3d5a7d62016-06-20 18:20:38 +0000422TEST_F(FormatTestProto, FormatsImports) {
423 verifyFormat("import \"a.proto\";\n"
424 "import \"b.proto\";\n"
425 "// comment\n"
Daniel Jasper67e65212018-08-15 19:07:55 +0000426 "message A {}");
Daniel Jasper3d5a7d62016-06-20 18:20:38 +0000427
Daniel Jasper8b61d142016-06-20 20:39:53 +0000428 verifyFormat("import public \"a.proto\";\n"
429 "import \"b.proto\";\n"
430 "// comment\n"
Daniel Jasper67e65212018-08-15 19:07:55 +0000431 "message A {}");
Daniel Jasper8b61d142016-06-20 20:39:53 +0000432
Daniel Jasper3d5a7d62016-06-20 18:20:38 +0000433 // Missing semicolons should not confuse clang-format.
434 verifyFormat("import \"a.proto\"\n"
435 "import \"b.proto\"\n"
436 "// comment\n"
Daniel Jasper67e65212018-08-15 19:07:55 +0000437 "message A {}");
Daniel Jasper3d5a7d62016-06-20 18:20:38 +0000438}
439
Krasimir Georgiev374e6de2018-02-08 10:47:12 +0000440TEST_F(FormatTestProto, KeepsLongStringLiteralsOnSameLine) {
441 verifyFormat(
442 "option (MyProto.options) = {\n"
443 " foo: {\n"
444 " text: \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaasaaaaaaaa\"\n"
445 " }\n"
446 "}");
447}
448
Krasimir Georgiev4e2906482018-02-13 10:20:39 +0000449TEST_F(FormatTestProto, FormatsOptionsExtensions) {
450 verifyFormat("option (MyProto.options) = {\n"
451 " msg_field: { field_d: 123 }\n"
452 " [ext.t/u] { key: value }\n"
453 " key: value\n"
454 " [t.u/v] <\n"
455 " [ext] { key: value }\n"
456 " >\n"
457 "};");
458}
459
Krasimir Georgiev44e2e9f2018-04-05 09:33:03 +0000460TEST_F(FormatTestProto, SpacesAroundPercents) {
Krasimir Georgiev76064a42018-02-14 19:47:58 +0000461 verifyFormat("option (MyProto.options) = {\n"
462 " key: %lld\n"
Krasimir Georgiev44e2e9f2018-04-05 09:33:03 +0000463 " key: 0x%04x\n"
464 " key: \"%d %d\"\n"
Krasimir Georgiev76064a42018-02-14 19:47:58 +0000465 "};");
466}
467
Krasimir Georgievb79987a2018-02-15 15:30:22 +0000468TEST_F(FormatTestProto, FormatsRepeatedListInitializersInOptions) {
469 verifyFormat("option (MyProto.options) = {\n"
470 " key: item\n"
471 " keys: [\n"
472 " 'ala',\n"
473 " 'bala',\n"
474 " 'porto',\n"
475 " 'kala',\n"
476 " 'too',\n"
477 " 'long',\n"
478 " 'long',\n"
479 " 'long'\n"
480 " ]\n"
481 " key: [ item ]\n"
482 " msg {\n"
483 " key: item\n"
484 " keys: [\n"
485 " 'ala',\n"
486 " 'bala',\n"
487 " 'porto',\n"
488 " 'kala',\n"
489 " 'too',\n"
490 " 'long',\n"
491 " 'long'\n"
492 " ]\n"
493 " }\n"
494 " key: value\n"
495 "};");
496}
497
Krasimir Georgiev0aa4b4c2018-02-27 19:07:47 +0000498TEST_F(FormatTestProto, AcceptsOperatorAsKeyInOptions) {
499 verifyFormat("option (MyProto.options) = {\n"
500 " bbbbbbbbb: <\n"
501 " ccccccccccccccccccccccc: <\n"
502 " operator: 1\n"
503 " operator: 2\n"
Krasimir Georgiev8b4bc76a232018-05-09 09:02:11 +0000504 " operator: 3\n"
Krasimir Georgiev0aa4b4c2018-02-27 19:07:47 +0000505 " operator { key: value }\n"
506 " >\n"
507 " >\n"
508 "};");
509}
510
Krasimir Georgiev8b98f552018-06-11 12:53:25 +0000511TEST_F(FormatTestProto, BreaksEntriesOfSubmessagesContainingSubmessages) {
512 FormatStyle Style = getGoogleStyle(FormatStyle::LK_TextProto);
513 Style.ColumnLimit = 60;
514 // The column limit allows for the keys submessage to be put on 1 line, but we
515 // break it since it contains a submessage an another entry.
516 verifyFormat("option (MyProto.options) = {\n"
517 " key: valueeeeeeee\n"
518 " keys: {\n"
519 " item: 'aaaaaaaaaaaaaaaa'\n"
520 " sub <>\n"
521 " }\n"
522 "}");
523 verifyFormat("option (MyProto.options) = {\n"
524 " key: valueeeeeeee\n"
525 " keys: {\n"
526 " item: 'aaaaaaaaaaaaaaaa'\n"
527 " sub {}\n"
528 " }\n"
529 "}");
530 verifyFormat("option (MyProto.options) = {\n"
531 " key: valueeeeeeee\n"
532 " keys: {\n"
533 " sub {}\n"
534 " sub: <>\n"
535 " sub: []\n"
536 " }\n"
537 "}");
538 verifyFormat("option (MyProto.options) = {\n"
539 " key: valueeeeeeee\n"
540 " keys: {\n"
541 " item: 'aaaaaaaaaaa'\n"
542 " sub { msg: 1 }\n"
543 " }\n"
544 "}");
545 verifyFormat("option (MyProto.options) = {\n"
546 " key: valueeeeeeee\n"
547 " keys: {\n"
548 " item: 'aaaaaaaaaaa'\n"
549 " sub: { msg: 1 }\n"
550 " }\n"
551 "}");
552 verifyFormat("option (MyProto.options) = {\n"
553 " key: valueeeeeeee\n"
554 " keys: {\n"
555 " item: 'aaaaaaaaaaa'\n"
556 " sub < msg: 1 >\n"
557 " }\n"
558 "}");
559 verifyFormat("option (MyProto.options) = {\n"
560 " key: valueeeeeeee\n"
561 " keys: {\n"
562 " item: 'aaaaaaaaaaa'\n"
563 " sub: [ msg: 1 ]\n"
564 " }\n"
565 "}");
566 verifyFormat("option (MyProto.options) = {\n"
567 " key: valueeeeeeee\n"
568 " keys: <\n"
569 " item: 'aaaaaaaaaaa'\n"
570 " sub: [ 1, 2 ]\n"
571 " >\n"
572 "}");
573 verifyFormat("option (MyProto.options) = {\n"
574 " key: valueeeeeeee\n"
575 " keys: {\n"
576 " sub {}\n"
577 " item: 'aaaaaaaaaaaaaaaa'\n"
578 " }\n"
579 "}");
580 verifyFormat("option (MyProto.options) = {\n"
581 " key: valueeeeeeee\n"
582 " keys: {\n"
583 " sub: []\n"
584 " item: 'aaaaaaaaaaaaaaaa'\n"
585 " }\n"
586 "}");
587 verifyFormat("option (MyProto.options) = {\n"
588 " key: valueeeeeeee\n"
589 " keys: {\n"
590 " sub <>\n"
591 " item: 'aaaaaaaaaaaaaaaa'\n"
592 " }\n"
593 "}");
594 verifyFormat("option (MyProto.options) = {\n"
595 " key: valueeeeeeee\n"
596 " keys: {\n"
597 " sub { key: value }\n"
598 " item: 'aaaaaaaaaaaaaaaa'\n"
599 " }\n"
600 "}");
601 verifyFormat("option (MyProto.options) = {\n"
602 " key: valueeeeeeee\n"
603 " keys: {\n"
604 " sub: [ 1, 2 ]\n"
605 " item: 'aaaaaaaaaaaaaaaa'\n"
606 " }\n"
607 "}");
608 verifyFormat("option (MyProto.options) = {\n"
609 " key: valueeeeeeee\n"
610 " keys: {\n"
611 " sub < sub_2: {} >\n"
612 " item: 'aaaaaaaaaaaaaaaa'\n"
613 " }\n"
614 "}");
615 verifyFormat("option (MyProto.options) = {\n"
616 " key: valueeeeeeee\n"
617 " keys: {\n"
618 " item: data\n"
619 " sub: [ 1, 2 ]\n"
620 " item: 'aaaaaaaaaaaaaaaa'\n"
621 " }\n"
622 "}");
623 verifyFormat("option (MyProto.options) = {\n"
624 " key: valueeeeeeee\n"
625 " keys: {\n"
626 " item: data\n"
627 " sub < sub_2: {} >\n"
628 " item: 'aaaaaaaaaaaaaaaa'\n"
629 " }\n"
630 "}");
631 verifyFormat("option (MyProto.options) = {\n"
632 " sub: {\n"
633 " key: valueeeeeeee\n"
634 " keys: {\n"
635 " sub: [ 1, 2 ]\n"
636 " item: 'aaaaaaaaaaaaaaaa'\n"
637 " }\n"
638 " }\n"
639 "}");
640}
641
Krasimir Georgiev70a9e472018-06-12 17:26:31 +0000642TEST_F(FormatTestProto, PreventBreaksBetweenKeyAndSubmessages) {
643 verifyFormat("option (MyProto.options) = {\n"
644 " submessage: {\n"
645 " key: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'\n"
646 " }\n"
647 "}");
648 verifyFormat("option (MyProto.options) = {\n"
649 " submessage {\n"
650 " key: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'\n"
651 " }\n"
652 "}");
653 verifyFormat("option (MyProto.options) = {\n"
654 " submessage: <\n"
655 " key: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'\n"
656 " >\n"
657 "}");
658 verifyFormat("option (MyProto.options) = {\n"
659 " submessage <\n"
660 " key: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'\n"
661 " >\n"
662 "}");
663 verifyFormat("option (MyProto.options) = {\n"
664 " repeatedd: [\n"
665 " 'eyaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'\n"
666 " ]\n"
667 "}");
668}
669
670
Alexander Kornienkoab9db512015-06-22 23:07:51 +0000671} // end namespace tooling
Daniel Jasper7052ce62014-01-19 09:04:08 +0000672} // end namespace clang