1 //===- unittest/Format/FormatTestProto.cpp --------------------------------===//
3 // 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
7 //===----------------------------------------------------------------------===//
9 #include "FormatTestUtils.h"
10 #include "clang/Format/Format.h"
11 #include "llvm/Support/Debug.h"
12 #include "gtest/gtest.h"
14 #define DEBUG_TYPE "format-test"
19 class FormatTestProto
: public testing::Test
{
21 static std::string
format(StringRef Code
, unsigned Offset
, unsigned Length
,
22 const FormatStyle
&Style
) {
23 LLVM_DEBUG(llvm::errs() << "---\n");
24 LLVM_DEBUG(llvm::errs() << Code
<< "\n\n");
25 std::vector
<tooling::Range
> Ranges(1, tooling::Range(Offset
, Length
));
26 tooling::Replacements Replaces
= reformat(Style
, Code
, Ranges
);
27 auto Result
= applyAllReplacements(Code
, Replaces
);
28 EXPECT_TRUE(static_cast<bool>(Result
));
29 LLVM_DEBUG(llvm::errs() << "\n" << *Result
<< "\n\n");
33 static std::string
format(StringRef Code
) {
34 FormatStyle Style
= getGoogleStyle(FormatStyle::LK_Proto
);
35 Style
.ColumnLimit
= 60; // To make writing tests easier.
36 return format(Code
, 0, Code
.size(), Style
);
39 static void verifyFormat(StringRef Code
) {
40 EXPECT_EQ(Code
.str(), format(Code
)) << "Expected code is not stable";
41 EXPECT_EQ(Code
.str(), format(test::messUp(Code
)));
45 TEST_F(FormatTestProto
, FormatsMessages
) {
46 verifyFormat("message SomeMessage {\n"
47 " required int32 field1 = 1;\n"
49 verifyFormat("message SomeMessage {\n"
50 " required .absolute.Reference field1 = 1;\n"
52 verifyFormat("message SomeMessage {\n"
53 " required int32 field1 = 1;\n"
54 " optional string field2 = 2 [default = \"2\"]\n"
57 verifyFormat("message SomeMessage {\n"
58 " optional really.really.long.qualified.type.aaa.aaaaaaa\n"
59 " fiiiiiiiiiiiiiiiiiiiiiiiiield = 1;\n"
61 " really.really.long.qualified.type.aaa.aaaaaaa.aaaaaaaa\n"
62 " another_fiiiiiiiiiiiiiiiiiiiiield = 2;\n"
64 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"
69 " map<int, really.really.really.really.long.qualified.type\n"
70 " .nameeee> projects = 4;\n"
72 " reallyreallyreallyreallyreallyreallyreallylongname>\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"
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"
89 TEST_F(FormatTestProto
, KeywordsInOtherLanguages
) {
90 verifyFormat("optional string operator = 1;");
93 TEST_F(FormatTestProto
, FormatsEnums
) {
94 verifyFormat("enum Type {\n"
99 verifyFormat("enum Type {\n"
100 " UNKNOWN = 0 [(some_options) = { a: aa, b: bb }];\n"
102 verifyFormat("enum Type {\n"
103 " UNKNOWN = 0 [(some_options) = {\n"
110 TEST_F(FormatTestProto
, EnumAsFieldName
) {
111 verifyFormat("message SomeMessage {\n"
112 " required int32 enum = 1;\n"
116 TEST_F(FormatTestProto
, CaseAsFieldName
) {
117 verifyFormat("message SomeMessage {\n"
118 " required string case = 1;\n"
119 " repeated int32 fizz = 2;\n"
123 TEST_F(FormatTestProto
, UnderstandsReturns
) {
124 verifyFormat("rpc Search(SearchRequest) returns (SearchResponse);");
127 TEST_F(FormatTestProto
, MessageFieldAttributes
) {
128 verifyFormat("optional string test = 1 [default = \"test\"];");
129 verifyFormat("optional bool a = 1 [default = true, deprecated = true];");
130 verifyFormat("optional LongMessageType long_proto_field = 1 [\n"
131 " default = REALLY_REALLY_LONG_CONSTANT_VALUE,\n"
132 " deprecated = true\n"
134 verifyFormat("optional LongMessageType long_proto_field = 1\n"
135 " [default = REALLY_REALLY_LONG_CONSTANT_VALUE];");
136 verifyFormat("repeated double value = 1\n"
137 " [(aaaaaaa.aaaaaaaaa) = { aaaaaaaaaaaaaaaaa: AAAAAAAA }];");
138 verifyFormat("repeated double value = 1 [(aaaaaaa.aaaaaaaaa) = {\n"
139 " aaaaaaaaaaaaaaaa: AAAAAAAAAA,\n"
140 " bbbbbbbbbbbbbbbb: BBBBBBBBBB\n"
142 verifyFormat("repeated double value = 1 [(aaaaaaa.aaaaaaaaa) = {\n"
143 " aaaaaaaaaaaaaaaa: AAAAAAAAAA\n"
144 " bbbbbbbbbbbbbbbb: BBBBBBBBBB\n"
146 verifyFormat("repeated double value = 1 [\n"
147 " (aaaaaaa.aaaaaaaaa) = {\n"
148 " aaaaaaaaaaaaaaaa: AAAAAAAAAA\n"
149 " bbbbbbbbbbbbbbbb: BBBBBBBBBB\n"
151 " (bbbbbbb.bbbbbbbbb) = {\n"
152 " aaaaaaaaaaaaaaaa: AAAAAAAAAA\n"
153 " bbbbbbbbbbbbbbbb: BBBBBBBBBB\n"
156 verifyFormat("repeated double value = 1 [(aaaaaaa.aaaaaaaaa) = {\n"
157 " type: \"AAAAAAAAAA\"\n"
158 " is: \"AAAAAAAAAA\"\n"
159 " or: \"BBBBBBBBBB\"\n"
161 verifyFormat("repeated double value = 1 [(aaaaaaa.aaaaaaaaa) = {\n"
162 " aaaaaaaaaaaaaaaa: AAAAAAAAAA,\n"
166 verifyFormat("optional AAA aaa = 1 [\n"
174 verifyFormat("optional string test = 1 [default = \"test\"\n"
176 verifyFormat("optional Aaaaaaaa aaaaaaaa = 12 [\n"
178 " (bbbbbbbbbbbbbbbbbbbbbbbbbb) = {\n"
179 " aaaaaaaaaaaaaaaaa: true,\n"
180 " aaaaaaaaaaaaaaaa: true\n"
183 verifyFormat("extensions 20 [(proto2.type) = 'Aaaa.bbbb'];");
184 verifyFormat("extensions 20\n"
185 " [(proto3.type) = 'Aaaa.bbbb', (aaa.Aaa) = 'aaa.bbb'];");
186 verifyFormat("extensions 123 [\n"
188 " (bbbbbbbbbbbbbbbbbbbbbbbbbb) = {\n"
189 " aaaaaaaaaaaaaaaaa: true,\n"
190 " aaaaaaaaaaaaaaaa: true\n"
193 verifyFormat("repeated A a = 1 [(annotation).int32.repeated.test = true];");
196 TEST_F(FormatTestProto
, DoesntWrapFileOptions
) {
198 "option java_package = "
199 "\"some.really.long.package.that.exceeds.the.column.limit\";",
200 format("option java_package = "
201 "\"some.really.long.package.that.exceeds.the.column.limit\";"));
204 TEST_F(FormatTestProto
, TrailingCommentAfterFileOption
) {
205 verifyFormat("option java_package = \"foo.pkg\"; // comment");
208 TEST_F(FormatTestProto
, FormatsOptions
) {
209 verifyFormat("option (MyProto.options) = {\n"
213 " msg_field: { field_d: 123 }\n"
215 verifyFormat("option (MyProto.options) = {\n"
219 " msg_field: { field_d: 123 field_e: OK }\n"
221 verifyFormat("option (MyProto.options) = {\n"
222 " field_a: OK // Comment\n"
225 " msg_field: { field_d: 123 }\n"
227 verifyFormat("option (MyProto.options) = {\n"
229 " msg_field { field_d: 123 }\n"
231 verifyFormat("option (MyProto.options) = {\n"
233 " field_b { field_c: OK }\n"
238 // Support syntax with <> instead of {}.
239 verifyFormat("option (MyProto.options) = {\n"
240 " field_c: \"OK\",\n"
241 " msg_field: < field_d: 123 >\n"
246 verifyFormat("option (MyProto.options) = {\n"
248 " field_b < field_c: OK >\n"
253 verifyFormat("option (MyProto.options) = {\n"
255 " field_c: \"OK\",\n"
256 " msg_field: < field_d: 123 >\n"
258 " msg_field: < field_d: 12 >\n"
261 verifyFormat("option (MyProto.options) = <\n"
269 verifyFormat("option (MyProto.options) = <\n"
271 " field_b: \"OK\",\n"
277 verifyFormat("option (MyProto.options) = <\n"
279 " msg_field: { field_b: OK }\n"
285 verifyFormat("option (MyProto.options) = <\n"
297 verifyFormat("option (MyProto.options) = <\n"
309 verifyFormat("option (MyProto.options) = <\n"
321 verifyFormat("option (MyProto.options) = <\n"
333 verifyFormat("option (MyProto.options) = <\n"
345 verifyFormat("option (MyProto.options) = {\n"
357 verifyFormat("option (MyProto.options) = {\n"
369 verifyFormat("option (MyProto.options) = <\n"
382 " msg_field < field_A: 1 field_B: 2 field_C: 3 f_D: 4 >\n"
389 verifyFormat("option (MyProto.options) = <\n"
390 " data1 < key1: value1 >\n"
391 " data2 { key2: value2 }\n"
394 verifyFormat("option (MyProto.options) = <\n"
395 " app_id: 'com.javax.swing.salsa.latino'\n"
397 " data < key: value >\n"
400 verifyFormat("option (MyProto.options) = {\n"
401 " app_id: 'com.javax.swing.salsa.latino'\n"
403 " headheadheadheadheadhead_id: 1\n"
404 " product_data { product { 1 } }\n"
408 TEST_F(FormatTestProto
, DoesntWrapPackageStatements
) {
411 " some.really.long.package.that.exceeds.the.column.limit00000000;");
414 TEST_F(FormatTestProto
, TrailingCommentAfterPackage
) {
415 verifyFormat("package foo.pkg; // comment");
418 TEST_F(FormatTestProto
, FormatsService
) {
419 verifyFormat("service SearchService {\n"
420 " rpc Search(SearchRequest) returns (SearchResponse) {\n"
421 " option foo = true;\n"
426 TEST_F(FormatTestProto
, ExtendingMessage
) {
427 verifyFormat("extend .foo.Bar {}");
430 TEST_F(FormatTestProto
, FormatsImports
) {
431 verifyFormat("import \"a.proto\";\n"
432 "import \"b.proto\";\n"
436 verifyFormat("import public \"a.proto\";\n"
437 "import \"b.proto\";\n"
441 // Missing semicolons should not confuse clang-format.
442 verifyFormat("import \"a.proto\"\n"
443 "import \"b.proto\"\n"
448 TEST_F(FormatTestProto
, KeepsLongStringLiteralsOnSameLine
) {
450 "option (MyProto.options) = {\n"
452 " text: \"aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaasaaaaaaaa\"\n"
457 TEST_F(FormatTestProto
, FormatsOptionsExtensions
) {
458 verifyFormat("option (MyProto.options) = {\n"
459 " msg_field: { field_d: 123 }\n"
460 " [ext.t/u] { key: value }\n"
463 " [ext] { key: value }\n"
468 TEST_F(FormatTestProto
, SpacesAroundPercents
) {
469 verifyFormat("option (MyProto.options) = {\n"
476 TEST_F(FormatTestProto
, FormatsRepeatedListInitializersInOptions
) {
477 verifyFormat("option (MyProto.options) = {\n"
506 TEST_F(FormatTestProto
, AcceptsOperatorAsKeyInOptions
) {
507 verifyFormat("option (MyProto.options) = {\n"
509 " ccccccccccccccccccccccc: <\n"
513 " operator { key: value }\n"
519 TEST_F(FormatTestProto
, BreaksEntriesOfSubmessagesContainingSubmessages
) {
520 // The column limit allows for the keys submessage to be put on 1 line, but we
521 // break it since it contains a submessage an another entry.
522 verifyFormat("option (MyProto.options) = {\n"
523 " key: valueeeeeeee\n"
525 " item: 'aaaaaaaaaaaaaaaa'\n"
529 verifyFormat("option (MyProto.options) = {\n"
530 " key: valueeeeeeee\n"
532 " item: 'aaaaaaaaaaaaaaaa'\n"
536 verifyFormat("option (MyProto.options) = {\n"
537 " key: valueeeeeeee\n"
544 verifyFormat("option (MyProto.options) = {\n"
545 " key: valueeeeeeee\n"
547 " item: 'aaaaaaaaaaa'\n"
551 verifyFormat("option (MyProto.options) = {\n"
552 " key: valueeeeeeee\n"
554 " item: 'aaaaaaaaaaa'\n"
558 verifyFormat("option (MyProto.options) = {\n"
559 " key: valueeeeeeee\n"
561 " item: 'aaaaaaaaaaa'\n"
565 verifyFormat("option (MyProto.options) = {\n"
566 " key: valueeeeeeee\n"
568 " item: 'aaaaaaaaaaa'\n"
572 verifyFormat("option (MyProto.options) = {\n"
573 " key: valueeeeeeee\n"
575 " item: 'aaaaaaaaaaa'\n"
579 verifyFormat("option (MyProto.options) = {\n"
580 " key: valueeeeeeee\n"
583 " item: 'aaaaaaaaaaaaaaaa'\n"
586 verifyFormat("option (MyProto.options) = {\n"
587 " key: valueeeeeeee\n"
590 " item: 'aaaaaaaaaaaaaaaa'\n"
593 verifyFormat("option (MyProto.options) = {\n"
594 " key: valueeeeeeee\n"
597 " item: 'aaaaaaaaaaaaaaaa'\n"
600 verifyFormat("option (MyProto.options) = {\n"
601 " key: valueeeeeeee\n"
603 " sub { key: value }\n"
604 " item: 'aaaaaaaaaaaaaaaa'\n"
607 verifyFormat("option (MyProto.options) = {\n"
608 " key: valueeeeeeee\n"
611 " item: 'aaaaaaaaaaaaaaaa'\n"
614 verifyFormat("option (MyProto.options) = {\n"
615 " key: valueeeeeeee\n"
617 " sub < sub_2: {} >\n"
618 " item: 'aaaaaaaaaaaaaaaa'\n"
621 verifyFormat("option (MyProto.options) = {\n"
622 " key: valueeeeeeee\n"
626 " item: 'aaaaaaaaaaaaaaaa'\n"
629 verifyFormat("option (MyProto.options) = {\n"
630 " key: valueeeeeeee\n"
633 " sub < sub_2: {} >\n"
634 " item: 'aaaaaaaaaaaaaaaa'\n"
637 verifyFormat("option (MyProto.options) = {\n"
639 " key: valueeeeeeee\n"
642 " item: 'aaaaaaaaaaaaaaaa'\n"
648 TEST_F(FormatTestProto
, PreventBreaksBetweenKeyAndSubmessages
) {
649 verifyFormat("option (MyProto.options) = {\n"
651 " key: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'\n"
654 verifyFormat("option (MyProto.options) = {\n"
656 " key: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'\n"
659 verifyFormat("option (MyProto.options) = {\n"
661 " key: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'\n"
664 verifyFormat("option (MyProto.options) = {\n"
666 " key: 'aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'\n"
669 verifyFormat("option (MyProto.options) = {\n"
671 " 'eyaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa'\n"
676 } // namespace format
677 } // end namespace clang