Add a Policy template writer that generates Android resources which can be exposed through Android'…

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 37 matching lines @@
       'doc_description': {'text': '_test_description'},
       'doc_description_column_title': {
         'text': '_test_description_column_title'
       },
       'doc_example_value': {'text': '_test_example_value'},
       'doc_feature_dynamic_refresh': {'text': '_test_feature_dynamic_refresh'},
       'doc_feature_can_be_recommended': {'text': '_test_feature_recommended'},
       'doc_feature_can_be_mandatory': {'text': '_test_feature_mandatory'},
       'doc_intro': {'text': '_test_intro'},
       'doc_mac_linux_pref_name': {'text': '_test_mac_linux_pref_name'},
+      'doc_android_restriction_name': {
+        'text': '_test_android_restriction_name'
+      },
       'doc_note': {'text': '_test_note'},
       'doc_name_column_title': {'text': '_test_name_column_title'},
       'doc_not_supported': {'text': '_test_not_supported'},
       'doc_since_version': {'text': '_test_since_version'},
       'doc_supported': {'text': '_test_supported'},
       'doc_supported_features': {'text': '_test_supported_features'},
       'doc_supported_on': {'text': '_test_supported_on'},
       'doc_win_reg_loc': {'text': '_test_win_reg_loc'},
 
       'doc_bla': {'text': '_test_bla'},
@@ skipping 183 matching lines @@
     self.writer._AddListExample(self.doc_root, policy)
     self.assertEquals(
       self.doc_root.toxml(),
       '<root>'
         '<dl style="style_dd dl;">'
           '<dt>Windows:</dt>'
           '<dd style="style_.monospace;style_.pre;">'
             'MockKey\\PolicyName\\1 = &quot;Foo&quot;\n'
             'MockKey\\PolicyName\\2 = &quot;Bar&quot;'
           '</dd>'
-          '<dt>Linux:</dt>'
+          '<dt>Android/Linux:</dt>'
           '<dd style="style_.monospace;">'
             '[&quot;Foo&quot;, &quot;Bar&quot;]'
           '</dd>'
           '<dt>Mac:</dt>'
           '<dd style="style_.monospace;style_.pre;">'
             '&lt;array&gt;\n'
             '  &lt;string&gt;Foo&lt;/string&gt;\n'
             '  &lt;string&gt;Bar&lt;/string&gt;\n'
             '&lt;/array&gt;'
           '</dd>'
         '</dl>'
       '</root>')
 
   def testBoolExample(self):
     # Test representation of boolean example values.
     policy = {
       'name': 'PolicyName',
       'type': 'main',
       'example_value': True,
-      'supported_on': [ { 'platforms': ['win', 'mac', 'linux'] } ]
+      'supported_on': [ { 'platforms': ['win', 'mac', 'linux', 'android'] } ]
     }
     e1 = self.writer.AddElement(self.doc_root, 'e1')
     self.writer._AddExample(e1, policy)
     self.assertEquals(
         e1.toxml(),
-        '<e1>0x00000001 (Windows), true (Linux), &lt;true /&gt; (Mac)</e1>')
+        '<e1>0x00000001 (Windows),'
+        ' true (Linux), true (Android),'
+        ' &lt;true /&gt; (Mac)</e1>')
 
     policy = {
       'name': 'PolicyName',
       'type': 'main',
       'example_value': False,
-      'supported_on': [ { 'platforms': ['win', 'mac', 'linux'] } ]
+      'supported_on': [ { 'platforms': ['win', 'mac', 'linux', 'android'] } ]
     }
     e2 = self.writer.AddElement(self.doc_root, 'e2')
     self.writer._AddExample(e2, policy)
     self.assertEquals(
         e2.toxml(),
-        '<e2>0x00000000 (Windows), false (Linux), &lt;false /&gt; (Mac)</e2>')
+        '<e2>0x00000000 (Windows),'
+        ' false (Linux), false (Android),'
+        ' &lt;false /&gt; (Mac)</e2>')
 
   def testIntEnumExample(self):
     # Test representation of 'int-enum' example values.
     policy = {
       'name': 'PolicyName',
       'type': 'int-enum',
       'example_value': 16,
-      'supported_on': [ { 'platforms': ['win', 'mac', 'linux'] } ]
+      'supported_on': [ { 'platforms': ['win', 'mac', 'linux', 'android'] } ]
     }
     self.writer._AddExample(self.doc_root, policy)
     self.assertEquals(
         self.doc_root.toxml(),
-        '<root>0x00000010 (Windows), 16 (Linux), 16 (Mac)</root>')
+        '<root>0x00000010 (Windows), 16 (Linux), 16 (Android), 16 (Mac)</root>')
 
   def testStringEnumExample(self):
     # Test representation of 'string-enum' example values.
     policy = {
       'name': 'PolicyName',
       'type': 'string-enum',
       'example_value': "wacky"
     }
     self.writer._AddExample(self.doc_root, policy)
     self.assertEquals(
         self.doc_root.toxml(),
         '<root>&quot;wacky&quot;</root>')
 
   def testListExample(self):
     # Test representation of 'list' example values.
     policy = {
       'name': 'PolicyName',
       'type': 'list',
       'example_value': ['one', 'two'],
       'supported_on': [ { 'platforms': ['linux'] } ]
     }
     self.writer._AddExample(self.doc_root, policy)
     self.assertEquals(
         self.doc_root.toxml(),
         '<root><dl style="style_dd dl;">'
-        '<dt>Linux:</dt>'
+        '<dt>Android/Linux:</dt>'
         '<dd style="style_.monospace;">'
         '[&quot;one&quot;, &quot;two&quot;]'
         '</dd></dl></root>')
 
   def testStringEnumListExample(self):
     # Test representation of 'string-enum-list' example values.
     policy = {
       'name': 'PolicyName',
       'type': 'string-enum-list',
       'example_value': ['one', 'two'],
       'supported_on': [ { 'platforms': ['linux'] } ]
     }
     self.writer._AddExample(self.doc_root, policy)
     self.assertEquals(
         self.doc_root.toxml(),
         '<root><dl style="style_dd dl;">'
-        '<dt>Linux:</dt>'
+        '<dt>Android/Linux:</dt>'
         '<dd style="style_.monospace;">'
         '[&quot;one&quot;, &quot;two&quot;]'
         '</dd></dl></root>')
 
   def testStringExample(self):
     # Test representation of 'string' example values.
     policy = {
       'name': 'PolicyName',
       'type': 'string',
       'example_value': 'awesome-example'
     }
     self.writer._AddExample(self.doc_root, policy)
     self.assertEquals(
         self.doc_root.toxml(),
         '<root>&quot;awesome-example&quot;</root>')
 
   def testIntExample(self):
     # Test representation of 'int' example values.
     policy = {
       'name': 'PolicyName',
       'type': 'int',
       'example_value': 26,
-      'supported_on': [ { 'platforms': ['win', 'mac', 'linux'] } ]
+      'supported_on': [ { 'platforms': ['win', 'mac', 'linux', 'android'] } ]
     }
     self.writer._AddExample(self.doc_root, policy)
     self.assertEquals(
         self.doc_root.toxml(),
-        '<root>0x0000001a (Windows), 26 (Linux), 26 (Mac)</root>')
+        '<root>0x0000001a (Windows), 26 (Linux), 26 (Android), 26 (Mac)</root>')
 
   def testAddPolicyAttribute(self):
     # Test creating a policy attribute term-definition pair.
     self.writer._AddPolicyAttribute(
         self.doc_root, 'bla', 'hello, world', ['key1'])
     self.assertEquals(
         self.doc_root.toxml(),
         '<root>'
           '<dt style="style_dt;">_test_bla</dt>'
           '<dd style="style1;">hello, world</dd>'
@@ skipping 23 matching lines @@
         'until_version': '',
       }],
       'features': {'dynamic_refresh': False},
       'example_value': False
     }
     self.writer.messages['doc_since_version'] = {'text': '...$6...'}
     self.writer._AddPolicyDetails(self.doc_root, policy)
     self.assertEquals(
       self.doc_root.toxml(),
       '<root><dl>'
-      '<dt style="style_dt;">_test_data_type</dt><dd>Boolean (REG_DWORD)</dd>'
+      '<dt style="style_dt;">_test_data_type</dt>'
+        '<dd>Boolean [Windows:REG_DWORD]</dd>'
       '<dt style="style_dt;">_test_win_reg_loc</dt>'
       '<dd style="style_.monospace;">MockKey\TestPolicyName</dd>'
       '<dt style="style_dt;">_test_mac_linux_pref_name</dt>'
         '<dd style="style_.monospace;">TestPolicyName</dd>'
+      '<dt style="style_dt;">_test_android_restriction_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>'
           '<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_example_value</dt>'
-        '<dd>0x00000000 (Windows), false (Linux), &lt;false /&gt; (Mac)</dd>'
+        '<dd>0x00000000 (Windows), false (Linux),'
+        ' false (Android), &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',
       'caption': 'TestPolicyCaption',
       'desc': 'TestPolicyDesc',
       'supported_on': [{
         'product': 'chrome',
         'platforms': ['win', 'mac', 'linux'],
         'since_version': '8',
         'until_version': '',
       }],
       'features': {'dynamic_refresh': False},
       'example_value': { 'foo': 123 }
     }
     self.writer.messages['doc_since_version'] = {'text': '...$6...'}
     self.writer._AddPolicyDetails(self.doc_root, policy)
     self.assertEquals(
       self.doc_root.toxml(),
       '<root><dl>'
-      '<dt style="style_dt;">_test_data_type</dt><dd>Dictionary (REG_SZ; _test_complex_policies_win)</dd>'
+      '<dt style="style_dt;">_test_data_type</dt>'
+        '<dd>Dictionary [Windows:REG_SZ] (_test_complex_policies_win)</dd>'
       '<dt style="style_dt;">_test_win_reg_loc</dt>'
       '<dd style="style_.monospace;">MockKey\TestPolicyName</dd>'
       '<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_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>'
+            '<dt>Android/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'
               '&lt;dict&gt;\n'
               '  &lt;key&gt;foo&lt;/key&gt;\n'
               '  &lt;integer&gt;123&lt;/integer&gt;\n'
               '&lt;/dict&gt;'
             '</dd>'
           '</dl>'
@@ skipping 27 matching lines @@
         'can_be_mandatory': False,
         'can_be_recommended': True
       },
       'example_value': False
     }
     self.writer.messages['doc_since_version'] = {'text': '...$6...'}
     self.writer._AddPolicyDetails(self.doc_root, policy)
     self.assertEquals(
       self.doc_root.toxml(),
       '<root><dl>'
-      '<dt style="style_dt;">_test_data_type</dt><dd>Boolean (REG_DWORD)</dd>'
+      '<dt style="style_dt;">_test_data_type</dt>'
+        '<dd>Boolean [Windows:REG_DWORD]</dd>'
       '<dt style="style_dt;">_test_win_reg_loc</dt>'
       '<dd style="style_.monospace;">MockKeyRec\TestPolicyName</dd>'
       '<dt style="style_dt;">_test_mac_linux_pref_name</dt>'
         '<dd style="style_.monospace;">TestPolicyName</dd>'
+      '<dt style="style_dt;">_test_android_restriction_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>'
           '<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_example_value</dt>'
-        '<dd>0x00000000 (Windows), false (Linux), &lt;false /&gt; (Mac)</dd>'
+        '<dd>0x00000000 (Windows), false (Linux),'
+        ' false (Android), &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...'}
@@ skipping 56 matching lines @@
     self.writer.messages['doc_since_version'] = {'text': '..$6..'}
     self.writer._AddPolicySection(self.doc_root, policy)
     self.assertEquals(
       self.doc_root.toxml(),
       '<root>'
         '<div style="margin-left: 0px">'
           '<h3><a name="PolicyName"/>PolicyName</h3>'
           '<span>PolicyCaption</span>'
           '<dl>'
             '<dt style="style_dt;">_test_data_type</dt>'
-            '<dd>String (REG_SZ)</dd>'
+            '<dd>String [Windows:REG_SZ]</dd>'
             '<dt style="style_dt;">_test_win_reg_loc</dt>'
             '<dd style="style_.monospace;">MockKey\\PolicyName</dd>'
             '<dt style="style_dt;">_test_mac_linux_pref_name</dt>'
             '<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>'
@@ skipping 39 matching lines @@
     self.writer.messages['doc_since_version'] = {'text': '..$6..'}
     self.writer._AddPolicySection(self.doc_root, policy)
     self.assertEquals(
       self.doc_root.toxml(),
       '<root>'
         '<div style="margin-left: 0px">'
           '<h3><a name="PolicyName"/>PolicyName</h3>'
           '<span>PolicyCaption</span>'
           '<dl>'
             '<dt style="style_dt;">_test_data_type</dt>'
-            '<dd>Integer (REG_DWORD)</dd>'
+            '<dd>Integer [Windows:REG_DWORD]</dd>'
             '<dt style="style_dt;">_test_win_reg_loc</dt>'
             '<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>'
@@ skipping 89 matching lines @@
             '<dd>_test_feature_dynamic_refresh: _test_not_supported</dd>'
             '<dt style="style_dt;">_test_description</dt>'
             '<dd>PolicyDesc</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 testAddPolicySectionForAndroidOnly(self):
+    policy = {
+      'name': 'PolicyName',
+      'caption': 'PolicyCaption',
+      'desc': 'PolicyDesc',
+      'type': 'int',
+      'supported_on': [{
+        'product': 'chrome',
+        'platforms': ['android'],
+        'since_version': '33',
+        'until_version': '',
+      }],
+      'features': {'dynamic_refresh': False},
+      'example_value': 123
+    }
+    self.writer.messages['doc_since_version'] = {'text': '..$6..'}
+    self.writer._AddPolicySection(self.doc_root, policy)
+    self.assertTrue(self.writer.IsPolicySupportedOnPlatform(policy, 'android'))
+    self.assertEquals(
+      self.doc_root.toxml(),
+      '<root>'
+        '<div style="margin-left: 0px">'
+          '<h3><a name="PolicyName"/>PolicyName</h3>'
+          '<span>PolicyCaption</span>'
+          '<dl>'
+            '<dt style="style_dt;">_test_data_type</dt>'
+            '<dd>Integer</dd>'
+            '<dt style="style_dt;">_test_android_restriction_name</dt>'
+            '<dd style="style_.monospace;">PolicyName</dd>'
+            '<dt style="style_dt;">_test_supported_on</dt>'
+            '<dd>'
+              '<ul style="style_ul;">'
+                '<li>Chrome (Android) ..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>'

[Nico, 2015/03/04 19:15:23]

Changing this line to

            '<dd><p>PolicyDesc</dd>'

makes the test pass for me. That's also what other tests in this file do. Any
reason you don't have this <p>?

[knn, 2015/03/04 19:45:09]

None of tests have <p> around PolicyDesc right?

[Nico, 2015/03/04 19:56:07]

all of the other PolicyDescs in <dl>s in the test expectations in
doc_writer_unittest.py are wrapped in <p>s over here. Here's an example:
https://code.google.com/p/grit-i18n/source/browse/trunk/grit/format/policy_te...

+            '<dt style="style_dt;">_test_example_value</dt>'
+            '<dd>123 (Android)</dd>'
+          '</dl>'
+          '<a href="#top">_test_back_to_top</a>'
+        '</div>'
+      '</root>')
+
   def testAddDictionaryExample(self):
     policy = {
       'name': 'PolicyName',
       'caption': 'PolicyCaption',
       'desc': 'PolicyDesc',
       'type': 'dict',
       'supported_on': [{
         'product': 'chrome',
         'platforms': ['win', 'mac', 'linux'],
         'since_version': '7',
@@ skipping 19 matching lines @@
     self.writer._AddDictionaryExample(self.doc_root, policy)
     value = json.dumps(policy['example_value']).replace('"', '&quot;')
     self.assertEquals(
       self.doc_root.toxml(),
       '<root>'
         '<dl style="style_dd dl;">'
           '<dt>Windows:</dt>'
           '<dd style="style_.monospace;style_.pre;">MockKey\PolicyName = '
               + value +
           '</dd>'
-          '<dt>Linux:</dt>'
+          '<dt>Android/Linux:</dt>'
           '<dd style="style_.monospace;">PolicyName: ' + value + '</dd>'
           '<dt>Mac:</dt>'
           '<dd style="style_.monospace;style_.pre;">'
             '&lt;key&gt;PolicyName&lt;/key&gt;\n'
             '&lt;dict&gt;\n'
             '  &lt;key&gt;DictList&lt;/key&gt;\n'
             '  &lt;array&gt;\n'
             '    &lt;dict&gt;\n'
             '      &lt;key&gt;A&lt;/key&gt;\n'
             '      &lt;integer&gt;1&lt;/integer&gt;\n'
@@ skipping 22 matching lines @@
             '  &lt;key&gt;True&lt;/key&gt;\n'
             '  &lt;true/&gt;\n'
             '&lt;/dict&gt;'
           '</dd>'
         '</dl>'
       '</root>')
 
 
 if __name__ == '__main__':
   unittest.main()