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