Modify java_cpp_enum.py to preserve comments

build/android/gyp/java_cpp_enum_tests.py

 #!/usr/bin/env python
 # Copyright 2014 The Chromium Authors. All rights reserved.
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
 """Tests for enum_preprocess.py.
 
 This test suite containss various tests for the C++ -> Java enum generator.
 """
 
 import collections
 from datetime import date
 import optparse
 import os
 import sys
 import unittest
 
 import java_cpp_enum
 from java_cpp_enum import EnumDefinition, GenerateOutput, GetScriptName
 from java_cpp_enum import HeaderParser
 
 sys.path.append(os.path.join(os.path.dirname(__file__), "gyp"))
 from util import build_utils
 
 class TestPreprocess(unittest.TestCase):
   def testOutput(self):
     definition = EnumDefinition(original_enum_name='ClassName',
                                 enum_package='some.package',
-                                entries=[('E1', 1), ('E2', '2 << 2')])
+                                entries=[('E1', 1), ('E2', '2 << 2')],
+                                comments=[('E2', 'This is a comment.'),
+                                          ('E1', 'This is a multiple line '
+                                                 'comment that is really long. '
+                                                 'This is a multiple line '
+                                                 'comment that is really '
+                                                 'really long.')])
     output = GenerateOutput('path/to/file', definition)
     expected = """
 // Copyright %d The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 // This file is autogenerated by
 //     %s
 // From
 //     path/to/file
 
 package some.package;
 
 import android.support.annotation.IntDef;
 
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
 
 public class ClassName {
   @IntDef({
       E1, E2
   })
   @Retention(RetentionPolicy.SOURCE)
   public @interface ClassNameEnum {}
+  /**
+   * This is a multiple line comment that is really long. This is a multiple line comment that is

[xunjieli, 2016/08/04 14:19:31]

Is there a way to bypass the "Found lines longer than 80 characters" error from
Presubmit?

Is adding "#pylint: disable" the way to go? or is there a way to break up this
string?

Thanks!

[agrieve, 2016/08/04 16:39:39]

Another option would be to use %s%s or str.format() to put in longer line via
substitution. 

I'm fine if you can get pylint:disable to work as well though.

[xunjieli, 2016/08/04 19:34:02]

Done. I couldn't get pylint:disable to work for the string block. It works on a
single line. I used str.format() approach.

+   * really really long.
+   */
   public static final int E1 = 1;
+  /**
+   * This is a comment.
+   */
   public static final int E2 = 2 << 2;
 }
 """
     self.assertEqual(expected % (date.today().year, GetScriptName()), output)
 
   def testParseSimpleEnum(self):
     test_data = """
       // GENERATED_JAVA_ENUM_PACKAGE: test.namespace
       enum EnumName {
         VALUE_ZERO,
@@ skipping 62 matching lines @@
       };
 
       enum EnumIgnore {
         C, D, E
       };
 
       // GENERATED_JAVA_ENUM_PACKAGE: other.package
       // GENERATED_JAVA_PREFIX_TO_STRIP: P_
       enum EnumTwo {
         P_A,
+        // This comment spans
+        // two lines.
         P_B
       };
     """.split('\n')
     definitions = HeaderParser(test_data).ParseDefinitions()
     self.assertEqual(2, len(definitions))
     definition = definitions[0]
     self.assertEqual('EnumOne', definition.class_name)
     self.assertEqual('test.namespace', definition.enum_package)
     self.assertEqual(collections.OrderedDict([('A', '1'),
                                               ('B', 'A')]),
                      definition.entries)
-
+    self.assertEqual(collections.OrderedDict([('ENUM_ONE_B', 'Comment there')]),
+                     definition.comments)
     definition = definitions[1]
     self.assertEqual('EnumTwo', definition.class_name)
     self.assertEqual('other.package', definition.enum_package)
+    self.assertEqual(collections.OrderedDict(
+        [('P_B', 'This comment spans two lines.')]), definition.comments)
     self.assertEqual(collections.OrderedDict([('A', 0),
                                               ('B', 1)]),
                      definition.entries)
 
   def testParseThrowsOnUnknownDirective(self):
     test_data = """
       // GENERATED_JAVA_UNKNOWN: Value
       enum EnumName {
         VALUE_ONE,
       };
@@ skipping 277 matching lines @@
   options, _ = parser.parse_args(argv)
 
   suite = unittest.TestLoader().loadTestsFromTestCase(TestPreprocess)
   unittest.TextTestRunner(verbosity=0).run(suite)
 
   if options.stamp:
     build_utils.Touch(options.stamp)
 
 if __name__ == '__main__':
   main(sys.argv[1:])