Generate ADMX template for Chrome OS policies

components/policy/tools/template_writers/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 writers.doc_writer'''
 
 
 import json
 import os
@@ skipping 21 matching lines @@
 
   def setUp(self):
     # Create a writer for the tests.
     self.writer = doc_writer.GetWriter(
       config={
         'app_name': 'Chrome',
         'frame_name': 'Chrome Frame',
         'os_name': 'Chrome OS',
         'webview_name': 'WebView',
         'android_webview_restriction_prefix': 'mock.prefix:',
-        'win_reg_mandatory_key_name': 'MockKey',
-        'win_reg_recommended_key_name': 'MockKeyRec',
+        'win_config' : {
+          'win' : {
+            'reg_mandatory_key_name': 'MockKey',
+            'reg_recommended_key_name': 'MockKeyRec',
+          },
+          'chrome_os' : {
+            'reg_mandatory_key_name': 'MockKeyCrOS',
+            'reg_recommended_key_name': 'MockKeyCrOSRec',
+          },
+        },
         'build': 'test_product',
       })
     self.writer.messages = {
       'doc_back_to_top': {'text': '_test_back_to_top'},
       'doc_complex_policies_on_windows': {'text': '_test_complex_policies_win'},
       'doc_data_type': {'text': '_test_data_type'},
       'doc_description': {'text': '_test_description'},
       'doc_arc_support': {'text': '_test_arc_support'},
       'doc_description_column_title': {
         'text': '_test_description_column_title'
       },
       'doc_example_value': {'text': '_test_example_value'},
+      'doc_win_example_value': {'text': '_test_example_value_win'},
+      'doc_chrome_os_example_value': {'text': '_test_example_value_chrome_os'},
       '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_android_webview_restriction_name': {
         'text': '_test_android_webview_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_chrome_os_reg_loc': {'text': '_test_chrome_os_reg_loc'},
 
       'doc_bla': {'text': '_test_bla'},
     }
     self.writer.Init()
 
     # It is not worth testing the exact content of style attributes.
     # Therefore we override them here with shorter texts.
     for key in self.writer._STYLE.keys():
       self.writer._STYLE[key] = 'style_%s;' % key
     # Add some more style attributes for additional testing.
@@ skipping 163 matching lines @@
         '<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'],
-      'supported_on': [ { 'platforms': ['win', 'mac', 'linux'] } ]
+      'supported_on': [ { 'platforms': ['win', 'mac', 'linux', 'chrome_os'] } ]
     }
     self.writer._AddListExample(self.doc_root, policy)
     self.assertEquals(
       self.doc_root.toxml(),
       '<root>'
         '<dl style="style_dd dl;">'
-          '<dt>Windows:</dt>'
+          '<dt>_test_example_value_win</dt>'
           '<dd style="style_.monospace;style_.pre;">'
             'MockKey\\PolicyName\\1 = &quot;Foo&quot;\n'
             'MockKey\\PolicyName\\2 = &quot;Bar&quot;'
           '</dd>'
+          '<dt>_test_example_value_chrome_os</dt>'
+          '<dd style="style_.monospace;style_.pre;">'
+            'MockKeyCrOS\\PolicyName\\1 = &quot;Foo&quot;\n'
+            'MockKeyCrOS\\PolicyName\\2 = &quot;Bar&quot;'
+          '</dd>'
           '<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;'
@@ skipping 141 matching lines @@
       }, {
         'product': 'chrome',
         'platforms': ['android'],
         'since_version': '30',
         'until_version': '',
       }, {
         'product': 'webview',
         'platforms': ['android'],
         'since_version': '47',
         'until_version': '',
+      }, {
+        'product': 'chrome',
+        'platforms': ['chrome_os'],
+        'since_version': '55',
+        'until_version': '',
       }],
       'features': {'dynamic_refresh': False},
       'example_value': False,
       'arc_support': 'TestArcSupportNote'
     }
     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 [Windows:REG_DWORD]</dd>'
       '<dt style="style_dt;">_test_win_reg_loc</dt>'
-      '<dd style="style_.monospace;">MockKey\TestPolicyName</dd>'
+        '<dd style="style_.monospace;">MockKey\TestPolicyName</dd>'
+      '<dt style="style_dt;">_test_chrome_os_reg_loc</dt>'
+        '<dd style="style_.monospace;">MockKeyCrOS\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_android_webview_restriction_name</dt>'
         '<dd style="style_.monospace;">mock.prefix: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>WebView (Android) ...47...</li>'
+          '<li>Chrome (Chrome OS) ...55...</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><p>TestPolicyDesc</p></dd>'
       '<dt style="style_dt;">_test_arc_support</dt>'
         '<dd><p>TestArcSupportNote</p></dd>'
       '<dt style="style_dt;">_test_example_value</dt>'
         '<dd>0x00000000 (Windows), false (Linux),'
         ' false (Android), &lt;false /&gt; (Mac)</dd>'
@@ skipping 42 matching lines @@
   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'],
+        'platforms': ['win', 'mac', 'linux', 'chrome_os'],
         '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 [Windows:REG_SZ] (_test_complex_policies_win)</dd>'
       '<dt style="style_dt;">_test_win_reg_loc</dt>'
-      '<dd style="style_.monospace;">MockKey\TestPolicyName</dd>'
+        '<dd style="style_.monospace;">MockKey\TestPolicyName</dd>'
+      '<dt style="style_dt;">_test_chrome_os_reg_loc</dt>'
+        '<dd style="style_.monospace;">MockKeyCrOS\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>'
+          '<li>Chrome (Windows, Mac, Linux, Chrome OS) ...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><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>_test_example_value_win</dt>'
+              '<dd style="style_.monospace;style_.pre;">'
+                'MockKey\TestPolicyName = {&quot;foo&quot;: 123}</dd>'
+            '<dt>_test_example_value_chrome_os</dt>'
+              '<dd style="style_.monospace;style_.pre;">'
+                'MockKeyCrOS\TestPolicyName = {&quot;foo&quot;: 123}</dd>'
             '<dt>Android/Linux:</dt>'
-            '<dd style="style_.monospace;">TestPolicyName: {&quot;foo&quot;: 123}</dd>'
+              '<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>'
         '</dd>'
       '</dl></root>')
 
   def testAddPolicyDetailsRecommendedOnly(self):
     policy = {
       'type': 'main',
       'name': 'TestPolicyName',
       'caption': 'TestPolicyCaption',
       'desc': 'TestPolicyDesc',
       'supported_on': [{
         'product': 'chrome',
         'platforms': ['win', 'mac', 'linux'],
         'since_version': '8',
         'until_version': '',
       }, {
         'product': 'chrome',
         'platforms': ['android'],
         'since_version': '30',
         'until_version': '',
+      }, {
+        'product': 'chrome',
+        'platforms': ['chrome_os'],
+        'since_version': '53',
+        'until_version': '',
       }],
       'features': {
         'dynamic_refresh': False,
         '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 [Windows:REG_DWORD]</dd>'
       '<dt style="style_dt;">_test_win_reg_loc</dt>'
-      '<dd style="style_.monospace;">MockKeyRec\TestPolicyName</dd>'
+        '<dd style="style_.monospace;">MockKeyRec\TestPolicyName</dd>'
+      '<dt style="style_dt;">_test_chrome_os_reg_loc</dt>'
+        '<dd style="style_.monospace;">MockKeyCrOSRec\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 (Chrome OS) ...53...</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><p>TestPolicyDesc</p></dd>'
       '<dt style="style_dt;">_test_example_value</dt>'
         '<dd>0x00000000 (Windows), false (Linux),'
         ' false (Android), &lt;false /&gt; (Mac)</dd>'
@@ skipping 49 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', 'mac'],
+        'platforms': ['win', 'mac', 'chrome_os'],
         'since_version': '7',
         'until_version': '',
       }],
       'features': {'dynamic_refresh': 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 [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_chrome_os_reg_loc</dt>'
+            '<dd style="style_.monospace;">MockKeyCrOS\\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>'
+                '<li>Chrome (Windows, Mac, Chrome OS) ..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><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>'
@@ skipping 222 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>'
+          '<dt>_test_example_value_win</dt>'
           '<dd style="style_.monospace;style_.pre;">MockKey\PolicyName = '
               + value +
           '</dd>'
           '<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'
@@ skipping 32 matching lines @@
 
   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()