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/testing/file.h>
40 #include <google/protobuf/testing/file.h>
41 #include <google/protobuf/compiler/command_line_interface.h>
42 #include <google/protobuf/compiler/python/python_generator.h>
43 #include <google/protobuf/io/printer.h>
44 #include <google/protobuf/io/zero_copy_stream.h>
45 #include <google/protobuf/stubs/strutil.h>
46 #include <google/protobuf/testing/googletest.h>
47 #include <gtest/gtest.h>
48
49 namespace google {
50 namespace protobuf {
51 namespace compiler {
52 namespace python {
53 namespace {
54
55 class TestGenerator : public CodeGenerator {
56 public:
TestGenerator()57 TestGenerator() {}
~TestGenerator()58 ~TestGenerator() override {}
59
Generate(const FileDescriptor * file,const std::string & parameter,GeneratorContext * context,std::string * error) const60 bool Generate(const FileDescriptor* file, const std::string& parameter,
61 GeneratorContext* context, std::string* error) const override {
62 TryInsert("test_pb2.py", "imports", context);
63 TryInsert("test_pb2.py", "module_scope", context);
64 TryInsert("test_pb2.py", "class_scope:foo.Bar", context);
65 TryInsert("test_pb2.py", "class_scope:foo.Bar.Baz", context);
66 return true;
67 }
68
TryInsert(const std::string & filename,const std::string & insertion_point,GeneratorContext * context) const69 void TryInsert(const std::string& filename,
70 const std::string& insertion_point,
71 GeneratorContext* context) const {
72 std::unique_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 // opposed to importlib) in the usual case where the .proto file paths do not
80 // not contain any Python keywords.
TEST(PythonPluginTest,ImportTest)81 TEST(PythonPluginTest, ImportTest) {
82 // Create files test1.proto and test2.proto with the former importing the
83 // latter.
84 GOOGLE_CHECK_OK(File::SetContents(TestTempDir() + "/test1.proto",
85 "syntax = \"proto3\";\n"
86 "package foo;\n"
87 "import \"test2.proto\";"
88 "message Message1 {\n"
89 " Message2 message_2 = 1;\n"
90 "}\n",
91 true));
92 GOOGLE_CHECK_OK(File::SetContents(TestTempDir() + "/test2.proto",
93 "syntax = \"proto3\";\n"
94 "package foo;\n"
95 "message Message2 {}\n",
96 true));
97
98 compiler::CommandLineInterface cli;
99 cli.SetInputsAreProtoPathRelative(true);
100 python::Generator python_generator;
101 cli.RegisterGenerator("--python_out", &python_generator, "");
102 std::string proto_path = "-I" + TestTempDir();
103 std::string python_out = "--python_out=" + TestTempDir();
104 const char* argv[] = {"protoc", proto_path.c_str(), "-I.", python_out.c_str(),
105 "test1.proto"};
106 ASSERT_EQ(0, cli.Run(5, argv));
107
108 // Loop over the lines of the generated code and verify that we find an
109 // ordinary Python import but do not find the string "importlib".
110 std::string output;
111 GOOGLE_CHECK_OK(File::GetContents(TestTempDir() + "/test1_pb2.py", &output,
112 true));
113 std::vector<std::string> lines = Split(output, "\n");
114 std::string expected_import = "import test2_pb2";
115 bool found_expected_import = false;
116 for (int i = 0; i < lines.size(); ++i) {
117 if (lines[i].find(expected_import) != std::string::npos) {
118 found_expected_import = true;
119 }
120 EXPECT_EQ(std::string::npos, lines[i].find("importlib"));
121 }
122 EXPECT_TRUE(found_expected_import);
123 }
124
125 } // namespace
126 } // namespace python
127 } // namespace compiler
128 } // namespace protobuf
129 } // namespace google
130