15821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Protocol Buffers - Google's data interchange format 25821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Copyright 2008 Google Inc. All rights reserved. 35821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// http://code.google.com/p/protobuf/ 45821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 55821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Redistribution and use in source and binary forms, with or without 65821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// modification, are permitted provided that the following conditions are 75821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// met: 85821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 95821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// * Redistributions of source code must retain the above copyright 105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// notice, this list of conditions and the following disclaimer. 115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// * Redistributions in binary form must reproduce the above 125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// copyright notice, this list of conditions and the following disclaimer 135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// in the documentation and/or other materials provided with the 145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// distribution. 155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// * Neither the name of Google Inc. nor the names of its 165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// contributors may be used to endorse or promote products derived from 175821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// this software without specific prior written permission. 185821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 195821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 205821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 215821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR 225821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT 235821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, 245821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT 255821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 265821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 275821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 285821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 295821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 305821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 315821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// Author: kenton@google.com (Kenton Varda) 325821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// 335821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// TODO(kenton): Share code with the versions of this test in other languages? 345821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// It seemed like parameterizing it would add more complexity than it is 355821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// worth. 365821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 375821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <google/protobuf/compiler/python/python_generator.h> 385821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <google/protobuf/compiler/command_line_interface.h> 395821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <google/protobuf/io/zero_copy_stream.h> 405821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <google/protobuf/io/printer.h> 415821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 425821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <google/protobuf/testing/googletest.h> 435821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <gtest/gtest.h> 445821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)#include <google/protobuf/testing/file.h> 455821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 465821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace google { 475821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace protobuf { 485821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace compiler { 495821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace python { 505821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)namespace { 515821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 525821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)class TestGenerator : public CodeGenerator { 535821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) public: 545821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TestGenerator() {} 555821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) ~TestGenerator() {} 565821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 575821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) virtual bool Generate(const FileDescriptor* file, 585821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const string& parameter, 595821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) GeneratorContext* context, 605821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) string* error) const { 615821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TryInsert("test_pb2.py", "imports", context); 625821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TryInsert("test_pb2.py", "module_scope", context); 635821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TryInsert("test_pb2.py", "class_scope:foo.Bar", context); 645821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TryInsert("test_pb2.py", "class_scope:foo.Bar.Baz", context); 655821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) return true; 665821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 675821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 685821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) void TryInsert(const string& filename, const string& insertion_point, 695821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) GeneratorContext* context) const { 705821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) scoped_ptr<io::ZeroCopyOutputStream> output( 715821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) context->OpenForInsert(filename, insertion_point)); 725821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) io::Printer printer(output.get(), '$'); 735821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) printer.Print("// inserted $name$\n", "name", insertion_point); 745821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) } 755821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)}; 765821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 775821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// This test verifies that all the expected insertion points exist. It does 785821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// not verify that they are correctly-placed; that would require actually 795821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)// compiling the output which is a bit more than I care to do for this test. 805821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)TEST(PythonPluginTest, PluginTest) { 815821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) File::WriteStringToFileOrDie( 825821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) "syntax = \"proto2\";\n" 835821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) "package foo;\n" 845821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) "message Bar {\n" 855821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) " message Baz {}\n" 865821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) "}\n", 875821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TestTempDir() + "/test.proto"); 885821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 895821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) google::protobuf::compiler::CommandLineInterface cli; 905821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) cli.SetInputsAreProtoPathRelative(true); 915821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 925821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) python::Generator python_generator; 935821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) TestGenerator test_generator; 945821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) cli.RegisterGenerator("--python_out", &python_generator, ""); 955821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) cli.RegisterGenerator("--test_out", &test_generator, ""); 965821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 975821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) string proto_path = "-I" + TestTempDir(); 985821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) string python_out = "--python_out=" + TestTempDir(); 995821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) string test_out = "--test_out=" + TestTempDir(); 1005821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1015821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) const char* argv[] = { 1025821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) "protoc", 1035821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) proto_path.c_str(), 1045821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) python_out.c_str(), 1055821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) test_out.c_str(), 1065821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) "test.proto" 1075821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) }; 1085821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1095821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) EXPECT_EQ(0, cli.Run(5, argv)); 1105821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} 1115821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles) 1125821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace 1135821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace python 1145821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace compiler 1155821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace protobuf 1165821806d5e7f356e8fa4b058a389a808ea183019Torne (Richard Coles)} // namespace google 117