Fixed bug with paragraphs in policy description

grit/format/policy_templates/writers/doc_writer_unittest.py

 #!/usr/bin/env python
 # Copyright (c) 2012 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.
 
 '''Unit tests for grit.format.policy_templates.writers.doc_writer'''
 
 
 import json
 import os
@@ skipping 70 matching lines @@
     self.doc = dom_impl.createDocument(None, 'root', None)
     self.doc_root = self.doc.documentElement
 
   def testSkeleton(self):
     # Test if DocWriter creates the skeleton of the document correctly.
     self.writer.BeginTemplate()
     self.assertEquals(
         self.writer._main_div.toxml(),
         '<div>'
           '<div>'
-            '<a name="top"/><br/>_test_intro<br/><br/><br/>'
+            '<a name="top"/><br/><p>_test_intro</p><br/><br/><br/>'
             '<table style="style_table;">'
               '<thead><tr style="style_tr;">'
                 '<td style="style_td;style_td.left;style_thead td;">'
                   '_test_name_column_title'
                 '</td>'
                 '<td style="style_td;style_td.right;style_thead td;">'
                   '_test_description_column_title'
                 '</td>'
               '</tr></thead>'
               '<tbody/>'
             '</table>'
           '</div>'
           '<div/>'
         '</div>')
 
   def testVersionAnnotation(self):
     # Test if DocWriter creates the skeleton of the document correctly.
     self.writer.config['version'] = '39.0.0.0'
     self.writer.BeginTemplate()
     self.assertEquals(
         self.writer._main_div.toxml(),
         '<div>'
           '<!--test_product version: 39.0.0.0-->'
           '<div>'
-            '<a name="top"/><br/>_test_intro<br/><br/><br/>'
+            '<a name="top"/><br/><p>_test_intro</p><br/><br/><br/>'
             '<table style="style_table;">'
               '<thead><tr style="style_tr;">'
                 '<td style="style_td;style_td.left;style_thead td;">'
                   '_test_name_column_title'
                 '</td>'
                 '<td style="style_td;style_td.right;style_thead td;">'
                   '_test_description_column_title'
                 '</td>'
               '</tr></thead>'
               '<tbody/>'
@@ skipping 60 matching lines @@
         {'value': 2, 'caption': 'Solve your problem'},
         {'value': 5, 'caption': 'Enable bar'},
       ],
       'desc': '''This policy disables foo, except in case of bar.
 See http://policy-explanation.example.com for more details.
 '''
     }
     self.writer._AddDescription(self.doc_root, policy)
     self.assertEquals(
         self.doc_root.toxml(),
-        '''<root>This policy disables foo, except in case of bar.
+        '''<root><p>This policy disables foo, except in case of bar.
 See <a href="http://policy-explanation.example.com">http://policy-explanation.example.com</a> for more details.
-<ul><li>0 = Disable foo</li><li>2 = Solve your problem</li><li>5 = Enable bar</li></ul></root>''')
+</p><ul><li>0 = Disable foo</li><li>2 = Solve your problem</li><li>5 = Enable bar</li></ul></root>''')
 
   def testAddDescriptionStringEnum(self):
     # Test if URLs are replaced and choices of 'int-enum' policies are listed
     # correctly.
     policy = {
       'type': 'string-enum',
       'items': [
         {'value': "one", 'caption': 'Disable foo'},
         {'value': "two", 'caption': 'Solve your problem'},
         {'value': "three", 'caption': 'Enable bar'},
       ],
       'desc': '''This policy disables foo, except in case of bar.
 See http://policy-explanation.example.com for more details.
 '''
     }
     self.writer._AddDescription(self.doc_root, policy)
     self.assertEquals(
         self.doc_root.toxml(),
-        '''<root>This policy disables foo, except in case of bar.
+        '''<root><p>This policy disables foo, except in case of bar.
 See <a href="http://policy-explanation.example.com">http://policy-explanation.example.com</a> for more details.
-<ul><li>&quot;one&quot; = Disable foo</li><li>&quot;two&quot; = Solve your problem</li><li>&quot;three&quot; = Enable bar</li></ul></root>''')
+</p><ul><li>&quot;one&quot; = Disable foo</li><li>&quot;two&quot; = Solve your problem</li><li>&quot;three&quot; = Enable bar</li></ul></root>''')
 
   def testAddFeatures(self):
     # Test if the list of features of a policy is handled correctly.
     policy = {
       'features': {
         'spaceship_docking': False,
         'dynamic_refresh': True,
         'can_be_recommended': True,
       }
     }
@@ skipping 201 matching lines @@
       '<dt style="style_dt;">_test_supported_on</dt>'
       '<dd>'
         '<ul style="style_ul;">'
           '<li>Chrome (Windows, Mac, Linux) ...8...</li>'
           '<li>Chrome (Android) ...30...</li>'
           '<li>Chrome (iOS) ...34...</li>'
         '</ul>'
       '</dd>'
       '<dt style="style_dt;">_test_supported_features</dt>'
         '<dd>_test_feature_dynamic_refresh: _test_not_supported</dd>'
-      '<dt style="style_dt;">_test_description</dt><dd>TestPolicyDesc</dd>'
+      '<dt style="style_dt;">_test_description</dt><dd><p>TestPolicyDesc</p></dd>'
       '<dt style="style_dt;">_test_example_value</dt>'
         '<dd>0x00000000 (Windows), false (Linux), &lt;false /&gt; (Mac)</dd>'
       '</dl></root>')
 
   def testAddDictPolicyDetails(self):
     # Test if the definition list (<dl>) of policy details is created correctly
     # for 'dict' policies.
     policy = {
       'type': 'dict',
       'name': 'TestPolicyName',
@@ skipping 19 matching lines @@
       '<dt style="style_dt;">_test_mac_linux_pref_name</dt>'
         '<dd style="style_.monospace;">TestPolicyName</dd>'
       '<dt style="style_dt;">_test_supported_on</dt>'
       '<dd>'
         '<ul style="style_ul;">'
           '<li>Chrome (Windows, Mac, Linux) ...8...</li>'
         '</ul>'
       '</dd>'
       '<dt style="style_dt;">_test_supported_features</dt>'
         '<dd>_test_feature_dynamic_refresh: _test_not_supported</dd>'
-      '<dt style="style_dt;">_test_description</dt><dd>TestPolicyDesc</dd>'
+      '<dt style="style_dt;">_test_description</dt><dd><p>TestPolicyDesc</p></dd>'
       '<dt style="style_dt;">_test_example_value</dt>'
         '<dd>'
           '<dl style="style_dd dl;">'
             '<dt>Windows:</dt>'
             '<dd style="style_.monospace;style_.pre;">MockKey\TestPolicyName = {&quot;foo&quot;: 123}</dd>'
             '<dt>Linux:</dt>'
             '<dd style="style_.monospace;">TestPolicyName: {&quot;foo&quot;: 123}</dd>'
             '<dt>Mac:</dt>'
             '<dd style="style_.monospace;style_.pre;">'
               '&lt;key&gt;TestPolicyName&lt;/key&gt;\n'
@@ skipping 50 matching lines @@
         '<ul style="style_ul;">'
           '<li>Chrome (Windows, Mac, Linux) ...8...</li>'
           '<li>Chrome (Android) ...30...</li>'
           '<li>Chrome (iOS) ...34...</li>'
         '</ul>'
       '</dd>'
       '<dt style="style_dt;">_test_supported_features</dt>'
         '<dd>_test_feature_mandatory: _test_not_supported,'
         ' _test_feature_recommended: _test_supported,'
         ' _test_feature_dynamic_refresh: _test_not_supported</dd>'
-      '<dt style="style_dt;">_test_description</dt><dd>TestPolicyDesc</dd>'
+      '<dt style="style_dt;">_test_description</dt><dd><p>TestPolicyDesc</p></dd>'
       '<dt style="style_dt;">_test_example_value</dt>'
         '<dd>0x00000000 (Windows), false (Linux), &lt;false /&gt; (Mac)</dd>'
       '</dl></root>')
 
   def testAddPolicyNote(self):
     # TODO(jkummerow): The functionality tested by this test is currently not
     # used for anything and will probably soon be removed.
     # Test if nodes are correctly added to policies.
     policy = {
       'problem_href': 'http://www.example.com/5'
     }
     self.writer.messages['doc_note'] = {'text': '...$6...'}
     self.writer._AddPolicyNote(self.doc_root, policy)
     self.assertEquals(
         self.doc_root.toxml(),
-        '<root><div style="style_div.note;">...'
+        '<root><div style="style_div.note;"><p>...'
         '<a href="http://www.example.com/5">http://www.example.com/5</a>'
-        '...</div></root>')
+        '...</p></div></root>')
 
   def testAddPolicyRow(self):
     # Test if policies are correctly added to the summary table.
     policy = {
       'name': 'PolicyName',
       'caption': 'PolicyCaption',
       'type': 'string',
     }
     self.writer._indent_level = 3
     self.writer._AddPolicyRow(self.doc_root, policy)
@@ skipping 54 matching lines @@
             '<dd style="style_.monospace;">PolicyName</dd>'
             '<dt style="style_dt;">_test_supported_on</dt>'
             '<dd>'
               '<ul style="style_ul;">'
                 '<li>Chrome (Windows, Mac) ..7..</li>'
               '</ul>'
             '</dd>'
             '<dt style="style_dt;">_test_supported_features</dt>'
             '<dd>_test_feature_dynamic_refresh: _test_not_supported</dd>'
             '<dt style="style_dt;">_test_description</dt>'
-            '<dd>PolicyDesc</dd>'
+            '<dd><p>PolicyDesc</p></dd>'
             '<dt style="style_dt;">_test_example_value</dt>'
             '<dd>&quot;False&quot;</dd>'
           '</dl>'
           '<a href="#top">_test_back_to_top</a>'
         '</div>'
       '</root>')
     # Test for groups.
     self.setUp()
     policy['type'] = 'group'
     self.writer._AddPolicySection(self.doc_root, policy)
@@ skipping 37 matching lines @@
             '<dd style="style_.monospace;">MockKey\\PolicyName</dd>'
             '<dt style="style_dt;">_test_supported_on</dt>'
             '<dd>'
               '<ul style="style_ul;">'
                 '<li>Chrome (Windows) ..33..</li>'
               '</ul>'
             '</dd>'
             '<dt style="style_dt;">_test_supported_features</dt>'
             '<dd>_test_feature_dynamic_refresh: _test_not_supported</dd>'
             '<dt style="style_dt;">_test_description</dt>'
-            '<dd>PolicyDesc</dd>'
+            '<dd><p>PolicyDesc</p></dd>'
             '<dt style="style_dt;">_test_example_value</dt>'
             '<dd>0x0000007b (Windows)</dd>'
           '</dl>'
           '<a href="#top">_test_back_to_top</a>'
         '</div>'
       '</root>')
 
   def testAddPolicySectionForMacOnly(self):
     policy = {
       'name': 'PolicyName',
@@ skipping 24 matching lines @@
             '<dd style="style_.monospace;">PolicyName</dd>'
             '<dt style="style_dt;">_test_supported_on</dt>'
             '<dd>'
               '<ul style="style_ul;">'
                 '<li>Chrome (Mac) ..33..</li>'
               '</ul>'
             '</dd>'
             '<dt style="style_dt;">_test_supported_features</dt>'
             '<dd>_test_feature_dynamic_refresh: _test_not_supported</dd>'
             '<dt style="style_dt;">_test_description</dt>'
-            '<dd>PolicyDesc</dd>'
+            '<dd><p>PolicyDesc</p></dd>'
             '<dt style="style_dt;">_test_example_value</dt>'
             '<dd>123 (Mac)</dd>'
           '</dl>'
           '<a href="#top">_test_back_to_top</a>'
         '</div>'
       '</root>')
 
   def testAddPolicySectionForLinuxOnly(self):
     policy = {
       'name': 'PolicyName',
@@ skipping 24 matching lines @@
             '<dd style="style_.monospace;">PolicyName</dd>'
             '<dt style="style_dt;">_test_supported_on</dt>'
             '<dd>'
               '<ul style="style_ul;">'
                 '<li>Chrome (Linux) ..33..</li>'
               '</ul>'
             '</dd>'
             '<dt style="style_dt;">_test_supported_features</dt>'
             '<dd>_test_feature_dynamic_refresh: _test_not_supported</dd>'
             '<dt style="style_dt;">_test_description</dt>'
-            '<dd>PolicyDesc</dd>'
+            '<dd><p>PolicyDesc</p></dd>'
             '<dt style="style_dt;">_test_example_value</dt>'
             '<dd>123 (Linux)</dd>'
           '</dl>'
           '<a href="#top">_test_back_to_top</a>'
         '</div>'
       '</root>')
 
   def testAddDictionaryExample(self):
     policy = {
       'name': 'PolicyName',
@@ skipping 66 matching lines @@
             '  &lt;/array&gt;\n'
             '  &lt;key&gt;ProxyMode&lt;/key&gt;\n'
             '  &lt;string&gt;direct&lt;/string&gt;\n'
             '  &lt;key&gt;True&lt;/key&gt;\n'
             '  &lt;true/&gt;\n'
             '&lt;/dict&gt;'
           '</dd>'
         '</dl>'
       '</root>')
 
+  def testParagraphs(self):
+    text = 'Paragraph 1\n\nParagraph 2\n\nParagraph 3'
+    self.writer._AddParagraphs(self.doc_root, text)
+    self.assertEquals(
+        self.doc_root.toxml(),
+        '<root><p>Paragraph 1</p><p>Paragraph 2</p><p>Paragraph 3</p></root>')
 
 if __name__ == '__main__':
   unittest.main()