Improve platform support indications for policy documentation.

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 os
 import sys
@@ skipping 197 matching lines @@
         self.doc_root.toxml(),
         '<root>'
           'Can Be Recommended: _test_supported, '
           'Dynamic Refresh: _test_supported, '
           'Spaceship Docking: _test_not_supported'
         '</root>')
 
   def testAddListExample(self):
     policy = {
       'name': 'PolicyName',
-      'example_value': ['Foo', 'Bar']
+      'example_value': ['Foo', 'Bar'],
+      'supported_on': [ { 'platforms': ['win', 'mac', 'linux'] } ]
     }
     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;'
@@ skipping 10 matching lines @@
             '&lt;/array&gt;'
           '</dd>'
         '</dl>'
       '</root>')
 
   def testBoolExample(self):
     # Test representation of boolean example values.
     policy = {
       'name': 'PolicyName',
       'type': 'main',
-      'example_value': True
+      'example_value': True,
+      'supported_on': [ { 'platforms': ['win', 'mac', 'linux'] } ]
     }
     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>')
 
     policy = {
       'name': 'PolicyName',
       'type': 'main',
-      'example_value': False
+      'example_value': False,
+      'supported_on': [ { 'platforms': ['win', 'mac', 'linux'] } ]
     }
     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>')
 
   def testIntEnumExample(self):
     # Test representation of 'int-enum' example values.
     policy = {
       'name': 'PolicyName',
       'type': 'int-enum',
-      'example_value': 16
+      'example_value': 16,
+      'supported_on': [ { 'platforms': ['win', 'mac', 'linux'] } ]
     }
     self.writer._AddExample(self.doc_root, policy)
     self.assertEquals(
         self.doc_root.toxml(),
-        '<root>0x00000010 (Windows), 16 (Linux/Mac)</root>')
+        '<root>0x00000010 (Windows), 16 (Linux), 16 (Mac)</root>')
 
   def testStringEnumExample(self):
     # Test representation of 'int-enum' example values.
     policy = {
       'name': 'PolicyName',
       'type': 'string-enum',
       'example_value': "wacky"
     }
     self.writer._AddExample(self.doc_root, policy)
     self.assertEquals(
@@ skipping 10 matching lines @@
     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
+      'example_value': 26,
+      'supported_on': [ { 'platforms': ['win', 'mac', 'linux'] } ]
     }
     self.writer._AddExample(self.doc_root, policy)
     self.assertEquals(
         self.doc_root.toxml(),
-        '<root>0x0000001a (Windows), 26 (Linux/Mac)</root>')
+        '<root>0x0000001a (Windows), 26 (Linux), 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>'
         '</root>')
 
   def testAddPolicyDetails(self):
     # Test if the definition list (<dl>) of policy details is created correctly.
     policy = {
       'type': 'main',
       'name': 'TestPolicyName',
       'caption': 'TestPolicyCaption',
       'desc': 'TestPolicyDesc',
       'supported_on': [{
         'product': 'chrome',
-        'platforms': ['win'],
+        'platforms': ['win', 'mac', 'linux'],
         'since_version': '8',
         '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_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) ...8...</li>'
+          '<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>0x00000000 (Windows), false (Linux), &lt;false /&gt; (Mac)</dd>'
       '</dl></root>')
 
   def testAddPolicyNote(self):
@@ skipping 46 matching lines @@
 
   def testAddPolicySection(self):
     # Test if policy details are correctly added to the document.
     policy = {
       'name': 'PolicyName',
       'caption': 'PolicyCaption',
       'desc': 'PolicyDesc',
       'type': 'string',
       'supported_on': [{
         'product': 'chrome',
-        'platforms': ['win'],
+        'platforms': ['win', 'mac'],
         'since_version': '7',
         'until_version': '',
       }],
       'features': {'dynamic_refresh': False},
-      'example_value': False
+      'example_value': 'False'
     }
     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>'
             '<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) ..7..</li>'
+                '<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>'
             '<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)
     self.assertEquals(
       self.doc_root.toxml(),
       '<root>'
         '<div style="margin-left: 0px">'
           '<h2><a name="PolicyName"/>PolicyCaption</h2>'
           '<div style="style_div.group_desc;">PolicyDesc</div>'
           '<a href="#top">_test_back_to_top</a>'
         '</div>'
       '</root>')
 
+  def testAddPolicySectionForWindowsOnly(self):
+    policy = {
+      'name': 'PolicyName',
+      'caption': 'PolicyCaption',
+      'desc': 'PolicyDesc',
+      'type': 'int',
+      'supported_on': [{
+        'product': 'chrome',
+        'platforms': ['win'],
+        '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.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>'
+            '<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>'
+            '<dt style="style_dt;">_test_description</dt>'
+            '<dd>PolicyDesc</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',
+      'caption': 'PolicyCaption',
+      'desc': 'PolicyDesc',
+      'type': 'int',
+      'supported_on': [{
+        'product': 'chrome',
+        'platforms': ['mac'],
+        '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.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_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 (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>'
+            '<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',
+      'caption': 'PolicyCaption',
+      'desc': 'PolicyDesc',
+      'type': 'int',
+      'supported_on': [{
+        'product': 'chrome',
+        'platforms': ['linux'],
+        '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.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_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 (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>'
+            '<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',
       'caption': 'PolicyCaption',
       'desc': 'PolicyDesc',
       'type': 'dict',
       'supported_on': [{
         'product': 'chrome',
-        'platforms': ['win'],
+        'platforms': ['win', 'mac', 'linux'],
         'since_version': '7',
         'until_version': '',
       }],
       'features': {'dynamic_refresh': False},
       'example_value': {
         "ProxyMode": "direct",
         "List": ["1", "2", "3"],
         "True": True,
         "False": False,
         "Integer": 123,
@@ skipping 53 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()