| // Protocol Buffers - Google's data interchange format |
| // Copyright 2008 Google Inc. All rights reserved. |
| // https://developers.google.com/protocol-buffers/ |
| // |
| // Redistribution and use in source and binary forms, with or without |
| // modification, are permitted provided that the following conditions are |
| // met: |
| // |
| // * Redistributions of source code must retain the above copyright |
| // notice, this list of conditions and the following disclaimer. |
| // * Redistributions in binary form must reproduce the above |
| // copyright notice, this list of conditions and the following disclaimer |
| // in the documentation and/or other materials provided with the |
| // distribution. |
| // * Neither the name of Google Inc. nor the names of its |
| // contributors may be used to endorse or promote products derived from |
| // this software without specific prior written permission. |
| // |
| // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| |
| #include <memory> |
| |
| #include <google/protobuf/testing/file.h> |
| #include <google/protobuf/testing/file.h> |
| #include <google/protobuf/compiler/cpp/generator.h> |
| #include <google/protobuf/compiler/command_line_interface.h> |
| #include <google/protobuf/descriptor.pb.h> |
| #include <google/protobuf/testing/googletest.h> |
| #include <gtest/gtest.h> |
| #include <google/protobuf/compiler/annotation_test_util.h> |
| #include <google/protobuf/compiler/cpp/helpers.h> |
| |
| namespace google { |
| namespace protobuf { |
| namespace compiler { |
| namespace cpp { |
| |
| namespace atu = annotation_test_util; |
| |
| namespace { |
| |
| class CppMetadataTest : public ::testing::Test { |
| public: |
| // Tries to capture a FileDescriptorProto, GeneratedCodeInfo, and output |
| // code from the previously added file with name `filename`. Returns true on |
| // success. If pb_h is non-null, expects a .pb.h and a .pb.h.meta (copied to |
| // pb_h and pb_h_info respecfively); similarly for proto_h and proto_h_info. |
| bool CaptureMetadata(const std::string& filename, FileDescriptorProto* file, |
| std::string* pb_h, GeneratedCodeInfo* pb_h_info, |
| std::string* proto_h, GeneratedCodeInfo* proto_h_info, |
| std::string* pb_cc) { |
| CommandLineInterface cli; |
| CppGenerator cpp_generator; |
| cli.RegisterGenerator("--cpp_out", &cpp_generator, ""); |
| std::string cpp_out = |
| "--cpp_out=annotate_headers=true," |
| "annotation_pragma_name=pragma_name," |
| "annotation_guard_name=guard_name:" + |
| TestTempDir(); |
| |
| const bool result = atu::RunProtoCompiler(filename, cpp_out, &cli, file); |
| |
| if (!result) { |
| return result; |
| } |
| |
| std::string output_base = TestTempDir() + "/" + StripProto(filename); |
| |
| if (pb_cc != nullptr) { |
| GOOGLE_CHECK_OK( |
| File::GetContents(output_base + ".pb.cc", pb_cc, true)); |
| } |
| |
| if (pb_h != nullptr && pb_h_info != nullptr) { |
| GOOGLE_CHECK_OK( |
| File::GetContents(output_base + ".pb.h", pb_h, true)); |
| if (!atu::DecodeMetadata(output_base + ".pb.h.meta", pb_h_info)) { |
| return false; |
| } |
| } |
| |
| if (proto_h != nullptr && proto_h_info != nullptr) { |
| GOOGLE_CHECK_OK(File::GetContents(output_base + ".proto.h", proto_h, |
| true)); |
| if (!atu::DecodeMetadata(output_base + ".proto.h.meta", proto_h_info)) { |
| return false; |
| } |
| } |
| |
| return true; |
| } |
| }; |
| |
| const char kSmallTestFile[] = |
| "syntax = \"proto2\";\n" |
| "package foo;\n" |
| "enum Enum { VALUE = 0; }\n" |
| "message Message { }\n"; |
| |
| TEST_F(CppMetadataTest, CapturesEnumNames) { |
| FileDescriptorProto file; |
| GeneratedCodeInfo info; |
| std::string pb_h; |
| atu::AddFile("test.proto", kSmallTestFile); |
| EXPECT_TRUE(CaptureMetadata("test.proto", &file, &pb_h, &info, nullptr, |
| nullptr, nullptr)); |
| EXPECT_EQ("Enum", file.enum_type(0).name()); |
| std::vector<int> enum_path; |
| enum_path.push_back(FileDescriptorProto::kEnumTypeFieldNumber); |
| enum_path.push_back(0); |
| const GeneratedCodeInfo::Annotation* enum_annotation = |
| atu::FindAnnotationOnPath(info, "test.proto", enum_path); |
| EXPECT_TRUE(nullptr != enum_annotation); |
| EXPECT_TRUE(atu::AnnotationMatchesSubstring(pb_h, enum_annotation, "Enum")); |
| } |
| |
| TEST_F(CppMetadataTest, AddsPragma) { |
| FileDescriptorProto file; |
| GeneratedCodeInfo info; |
| std::string pb_h; |
| atu::AddFile("test.proto", kSmallTestFile); |
| EXPECT_TRUE(CaptureMetadata("test.proto", &file, &pb_h, &info, nullptr, |
| nullptr, nullptr)); |
| EXPECT_TRUE(pb_h.find("#ifdef guard_name") != std::string::npos); |
| EXPECT_TRUE(pb_h.find("#pragma pragma_name \"test.pb.h.meta\"") != |
| std::string::npos); |
| } |
| |
| TEST_F(CppMetadataTest, CapturesMessageNames) { |
| FileDescriptorProto file; |
| GeneratedCodeInfo info; |
| std::string pb_h; |
| atu::AddFile("test.proto", kSmallTestFile); |
| EXPECT_TRUE(CaptureMetadata("test.proto", &file, &pb_h, &info, nullptr, |
| nullptr, nullptr)); |
| EXPECT_EQ("Message", file.message_type(0).name()); |
| std::vector<int> message_path; |
| message_path.push_back(FileDescriptorProto::kMessageTypeFieldNumber); |
| message_path.push_back(0); |
| const GeneratedCodeInfo::Annotation* message_annotation = |
| atu::FindAnnotationOnPath(info, "test.proto", message_path); |
| EXPECT_TRUE(nullptr != message_annotation); |
| EXPECT_TRUE( |
| atu::AnnotationMatchesSubstring(pb_h, message_annotation, "Message")); |
| } |
| |
| } // namespace |
| } // namespace cpp |
| } // namespace compiler |
| } // namespace protobuf |
| } // namespace google |