• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1 // Protocol Buffers - Google's data interchange format
2 // Copyright 2008 Google Inc.  All rights reserved.
3 // https://developers.google.com/protocol-buffers/
4 //
5 // Redistribution and use in source and binary forms, with or without
6 // modification, are permitted provided that the following conditions are
7 // met:
8 //
9 //     * Redistributions of source code must retain the above copyright
10 // notice, this list of conditions and the following disclaimer.
11 //     * Redistributions in binary form must reproduce the above
12 // copyright notice, this list of conditions and the following disclaimer
13 // in the documentation and/or other materials provided with the
14 // distribution.
15 //     * Neither the name of Google Inc. nor the names of its
16 // contributors may be used to endorse or promote products derived from
17 // this software without specific prior written permission.
18 //
19 // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 
31 // Author: kenton@google.com (Kenton Varda)
32 //
33 // TODO(kenton):  Share code with the versions of this test in other languages?
34 //   It seemed like parameterizing it would add more complexity than it is
35 //   worth.
36 
37 #include <memory>
38 #ifndef _SHARED_PTR_H
39 #include <google/protobuf/stubs/shared_ptr.h>
40 #endif
41 
42 #include <google/protobuf/compiler/python/python_generator.h>
43 #include <google/protobuf/compiler/command_line_interface.h>
44 #include <google/protobuf/io/zero_copy_stream.h>
45 #include <google/protobuf/io/printer.h>
46 
47 #include <google/protobuf/testing/file.h>
48 #include <google/protobuf/testing/file.h>
49 #include <google/protobuf/testing/googletest.h>
50 #include <gtest/gtest.h>
51 
52 namespace google {
53 namespace protobuf {
54 namespace compiler {
55 namespace python {
56 namespace {
57 
58 class TestGenerator : public CodeGenerator {
59  public:
TestGenerator()60   TestGenerator() {}
~TestGenerator()61   ~TestGenerator() {}
62 
Generate(const FileDescriptor * file,const string & parameter,GeneratorContext * context,string * error) const63   virtual bool Generate(const FileDescriptor* file,
64                         const string& parameter,
65                         GeneratorContext* context,
66                         string* error) const {
67     TryInsert("test_pb2.py", "imports", context);
68     TryInsert("test_pb2.py", "module_scope", context);
69     TryInsert("test_pb2.py", "class_scope:foo.Bar", context);
70     TryInsert("test_pb2.py", "class_scope:foo.Bar.Baz", context);
71     return true;
72   }
73 
TryInsert(const string & filename,const string & insertion_point,GeneratorContext * context) const74   void TryInsert(const string& filename, const string& insertion_point,
75                  GeneratorContext* context) const {
76     google::protobuf::scoped_ptr<io::ZeroCopyOutputStream> output(
77         context->OpenForInsert(filename, insertion_point));
78     io::Printer printer(output.get(), '$');
79     printer.Print("// inserted $name$\n", "name", insertion_point);
80   }
81 };
82 
83 // This test verifies that all the expected insertion points exist.  It does
84 // not verify that they are correctly-placed; that would require actually
85 // compiling the output which is a bit more than I care to do for this test.
TEST(PythonPluginTest,PluginTest)86 TEST(PythonPluginTest, PluginTest) {
87   GOOGLE_CHECK_OK(File::SetContents(TestTempDir() + "/test.proto",
88                              "syntax = \"proto2\";\n"
89                              "package foo;\n"
90                              "message Bar {\n"
91                              "  message Baz {}\n"
92                              "}\n",
93                              true));
94 
95   google::protobuf::compiler::CommandLineInterface cli;
96   cli.SetInputsAreProtoPathRelative(true);
97 
98   python::Generator python_generator;
99   TestGenerator test_generator;
100   cli.RegisterGenerator("--python_out", &python_generator, "");
101   cli.RegisterGenerator("--test_out", &test_generator, "");
102 
103   string proto_path = "-I" + TestTempDir();
104   string python_out = "--python_out=" + TestTempDir();
105   string test_out = "--test_out=" + TestTempDir();
106 
107   const char* argv[] = {
108     "protoc",
109     proto_path.c_str(),
110     python_out.c_str(),
111     test_out.c_str(),
112     "test.proto"
113   };
114 
115   EXPECT_EQ(0, cli.Run(5, argv));
116 }
117 
118 }  // namespace
119 }  // namespace python
120 }  // namespace compiler
121 }  // namespace protobuf
122 }  // namespace google
123