src/google/protobuf/compiler/java/java_doc_comment_unittest.cc

   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 #include <google/protobuf/compiler/java/java_doc_comment.h>
  34
  35 #include <gtest/gtest.h>
  36
  37 namespace google {
  38 namespace protobuf {
  39 namespace compiler {
  40 namespace java {
  41 namespace {
  42
  43 TEST(JavaDocCommentTest, Escaping) {
  44   EXPECT_EQ("foo /&#42; bar *&#47; baz", EscapeJavadoc("foo /* bar */ baz"));
  45   EXPECT_EQ("foo /&#42;&#47; baz", EscapeJavadoc("foo /*/ baz"));
  46   EXPECT_EQ("{&#64;foo}", EscapeJavadoc("{@foo}"));
  47   EXPECT_EQ("&lt;i&gt;&amp;&lt;/i&gt;", EscapeJavadoc("<i>&</i>"));
  48   EXPECT_EQ("foo&#92;u1234bar", EscapeJavadoc("foo\\u1234bar"));
  49   EXPECT_EQ("&#64;deprecated", EscapeJavadoc("@deprecated"));
  50 }
  51
  52 // TODO(kenton):  It's hard to write a robust test of the doc comments -- we
  53 //   can only really compare the output against a golden value, which is a
  54 //   fairly tedious and fragile testing strategy.  If we want to go that route,
  55 //   it probably makes sense to bite the bullet and write a test that compares
  56 //   the whole generated output for unittest.proto against a golden value, with
  57 //   a very simple script that can be run to regenerate it with the latest code.
  58 //   This would mean that updates to the golden file would have to be included
  59 //   in any change to the code generator, which would actually be fairly useful
  60 //   as it allows the reviewer to see clearly how the generated code is
  61 //   changing.
  62
  63 }  // namespace
  64 }  // namespace java
  65 }  // namespace compiler
  66 }  // namespace protobuf
  67 }  // namespace google