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
39 #include <google/protobuf/compiler/python/python_generator.h>
40 #include <google/protobuf/compiler/command_line_interface.h>
41 #include <google/protobuf/io/zero_copy_stream.h>
42 #include <google/protobuf/io/printer.h>
43
44 #include <google/protobuf/testing/googletest.h>
45 #include <gtest/gtest.h>
46 #include <google/protobuf/testing/file.h>
47
48 namespace google {
49 namespace protobuf {
50 namespace compiler {
51 namespace python {
52 namespace {
53
54 class TestGenerator : public CodeGenerator {
55 public:
TestGenerator()56 TestGenerator() {}
~TestGenerator()57 ~TestGenerator() {}
58
Generate(const FileDescriptor * file,const string & parameter,GeneratorContext * context,string * error) const59 virtual bool Generate(const FileDescriptor* file,
60 const string& parameter,
61 GeneratorContext* context,
62 string* error) const {
63 TryInsert("test_pb2.py", "imports", context);
64 TryInsert("test_pb2.py", "module_scope", context);
65 TryInsert("test_pb2.py", "class_scope:foo.Bar", context);
66 TryInsert("test_pb2.py", "class_scope:foo.Bar.Baz", context);
67 return true;
68 }
69
TryInsert(const string & filename,const string & insertion_point,GeneratorContext * context) const70 void TryInsert(const string& filename, const string& insertion_point,
71 GeneratorContext* context) const {
72 scoped_ptr<io::ZeroCopyOutputStream> output(
73 context->OpenForInsert(filename, insertion_point));
74 io::Printer printer(output.get(), '$');
75 printer.Print("// inserted $name$\n", "name", insertion_point);
76 }
77 };
78
79 // This test verifies that all the expected insertion points exist. It does
80 // not verify that they are correctly-placed; that would require actually
81 // compiling the output which is a bit more than I care to do for this test.
TEST(PythonPluginTest,PluginTest)82 TEST(PythonPluginTest, PluginTest) {
83 GOOGLE_CHECK_OK(File::SetContents(TestTempDir() + "/test.proto",
84 "syntax = \"proto2\";\n"
85 "package foo;\n"
86 "message Bar {\n"
87 " message Baz {}\n"
88 "}\n",
89 true));
90
91 google::protobuf::compiler::CommandLineInterface cli;
92 cli.SetInputsAreProtoPathRelative(true);
93
94 python::Generator python_generator;
95 TestGenerator test_generator;
96 cli.RegisterGenerator("--python_out", &python_generator, "");
97 cli.RegisterGenerator("--test_out", &test_generator, "");
98
99 string proto_path = "-I" + TestTempDir();
100 string python_out = "--python_out=" + TestTempDir();
101 string test_out = "--test_out=" + TestTempDir();
102
103 const char* argv[] = {
104 "protoc",
105 proto_path.c_str(),
106 python_out.c_str(),
107 test_out.c_str(),
108 "test.proto"
109 };
110
111 EXPECT_EQ(0, cli.Run(5, argv));
112 }
113
114 } // namespace
115 } // namespace python
116 } // namespace compiler
117 } // namespace protobuf
118 } // namespace google
119