src/tools/grit/grit/format/policy_templates/writers/admx_writer_unittest.py

   1 #!/usr/bin/env python
   2 # Copyright (c) 2012 The Chromium Authors. All rights reserved.
   3 # Use of this source code is governed by a BSD-style license that can be
   4 # found in the LICENSE file.
   5
   6
   7 """Unittests for grit.format.policy_templates.writers.admx_writer."""
   8
   9
  10 import os
  11 import sys
  12 import unittest
  13 if __name__ == '__main__':
  14   sys.path.append(os.path.join(os.path.dirname(__file__), '../../../..'))
  15
  16
  17 from grit.format.policy_templates.writers import admx_writer
  18 from grit.format.policy_templates.writers import xml_writer_base_unittest
  19 from xml.dom import minidom
  20
  21
  22 class AdmxWriterUnittest(xml_writer_base_unittest.XmlWriterBaseTest):
  23
  24   def _CreateDocumentElement(self):
  25     dom_impl = minidom.getDOMImplementation('')
  26     doc = dom_impl.createDocument(None, 'root', None)
  27     return doc.documentElement
  28
  29   def setUp(self):
  30     # Writer configuration. This dictionary contains parameter used by the ADMX
  31     # Writer
  32     config = {
  33       'win_group_policy_class': 'TestClass',
  34       'win_supported_os': 'SUPPORTED_TESTOS',
  35       'win_reg_mandatory_key_name': 'Software\\Policies\\Test',
  36       'win_reg_recommended_key_name': 'Software\\Policies\\Test\\Recommended',
  37       'win_mandatory_category_path': ['test_category'],
  38       'win_recommended_category_path': ['test_recommended_category'],
  39       'admx_namespace': 'ADMXWriter.Test.Namespace',
  40       'admx_prefix': 'test_prefix'
  41     }
  42     self.writer = admx_writer.GetWriter(config)
  43     self.writer.Init()
  44
  45   def _GetPoliciesElement(self, doc):
  46     node_list = doc.getElementsByTagName('policies')
  47     self.assertTrue(node_list.length == 1)
  48     return node_list.item(0)
  49
  50   def _GetCategoriesElement(self, doc):
  51     node_list = doc.getElementsByTagName('categories')
  52     self.assertTrue(node_list.length == 1)
  53     return node_list.item(0)
  54
  55   def testEmpty(self):
  56     self.writer.BeginTemplate()
  57     self.writer.EndTemplate()
  58
  59     output = self.writer.GetTemplateText()
  60     expected_output = (
  61         '<?xml version="1.0" ?>\n'
  62         '<policyDefinitions revision="1.0" schemaVersion="1.0">\n'
  63         '  <policyNamespaces>\n'
  64         '    <target namespace="ADMXWriter.Test.Namespace"'
  65         ' prefix="test_prefix"/>\n'
  66         '    <using namespace="Microsoft.Policies.Windows" prefix="windows"/>\n'
  67         '  </policyNamespaces>\n'
  68         '  <resources minRequiredRevision="1.0"/>\n'
  69         '  <supportedOn>\n'
  70         '    <definitions>\n'
  71         '      <definition displayName="'
  72         '$(string.SUPPORTED_TESTOS)" name="SUPPORTED_TESTOS"/>\n'
  73         '    </definitions>\n'
  74         '  </supportedOn>\n'
  75         '  <categories>\n'
  76         '    <category displayName="$(string.test_category)"'
  77         ' name="test_category"/>\n'
  78         '    <category displayName="$(string.test_recommended_category)"'
  79         ' name="test_recommended_category"/>\n'
  80         '  </categories>\n'
  81         '  <policies/>\n'
  82         '</policyDefinitions>')
  83     self.AssertXMLEquals(output, expected_output)
  84
  85   def testEmptyPolicyGroup(self):
  86     empty_policy_group = {
  87       'name': 'PolicyGroup',
  88       'policies': []
  89     }
  90     # Initialize writer to write a policy group.
  91     self.writer.BeginTemplate()
  92     # Write policy group
  93     self.writer.BeginPolicyGroup(empty_policy_group)
  94     self.writer.EndPolicyGroup()
  95
  96     output = self.GetXMLOfChildren(self._GetPoliciesElement(self.writer._doc))
  97     expected_output = ''
  98     self.AssertXMLEquals(output, expected_output)
  99
 100     output = self.GetXMLOfChildren(
 101         self._GetCategoriesElement(self.writer._doc))
 102     expected_output = (
 103         '<category displayName="$(string.test_category)"'
 104         ' name="test_category"/>\n'
 105         '<category displayName="$(string.test_recommended_category)"'
 106         ' name="test_recommended_category"/>\n'
 107         '<category displayName="$(string.PolicyGroup_group)"'
 108         ' name="PolicyGroup">\n'
 109         '  <parentCategory ref="test_category"/>\n'
 110         '</category>')
 111
 112     self.AssertXMLEquals(output, expected_output)
 113
 114   def testPolicyGroup(self):
 115     empty_policy_group = {
 116       'name': 'PolicyGroup',
 117       'policies': [
 118           {'name': 'PolicyStub2',
 119           'type': 'main'},
 120           {'name': 'PolicyStub1',
 121           'type': 'main'},
 122       ]
 123     }
 124     # Initialize writer to write a policy group.
 125     self.writer.BeginTemplate()
 126     # Write policy group
 127     self.writer.BeginPolicyGroup(empty_policy_group)
 128     self.writer.EndPolicyGroup()
 129
 130     output = self.GetXMLOfChildren(self._GetPoliciesElement(self.writer._doc))
 131     expected_output = ''
 132     self.AssertXMLEquals(output, expected_output)
 133
 134     output = self.GetXMLOfChildren(
 135         self._GetCategoriesElement(self.writer._doc))
 136     expected_output = (
 137         '<category displayName="$(string.test_category)"'
 138         ' name="test_category"/>\n'
 139         '<category displayName="$(string.test_recommended_category)"'
 140         ' name="test_recommended_category"/>\n'
 141         '<category displayName="$(string.PolicyGroup_group)"'
 142         ' name="PolicyGroup">\n'
 143         '  <parentCategory ref="test_category"/>\n'
 144         '</category>')
 145     self.AssertXMLEquals(output, expected_output)
 146
 147
 148   def _initWriterForPolicy(self, writer, policy):
 149     '''Initializes the writer to write the given policy next.
 150     '''
 151     policy_group = {
 152       'name': 'PolicyGroup',
 153       'policies': [policy]
 154     }
 155     writer.BeginTemplate()
 156     writer.BeginPolicyGroup(policy_group)
 157
 158   def testMainPolicy(self):
 159     main_policy = {
 160       'name': 'DummyMainPolicy',
 161       'type': 'main',
 162     }
 163
 164     self._initWriterForPolicy(self.writer, main_policy)
 165
 166     self.writer.WritePolicy(main_policy)
 167
 168     output = self.GetXMLOfChildren(self._GetPoliciesElement(self.writer._doc))
 169     expected_output = (
 170         '<policy class="TestClass" displayName="$(string.DummyMainPolicy)"'
 171         ' explainText="$(string.DummyMainPolicy_Explain)"'
 172         ' key="Software\\Policies\\Test" name="DummyMainPolicy"'
 173         ' presentation="$(presentation.DummyMainPolicy)"'
 174         ' valueName="DummyMainPolicy">\n'
 175         '  <parentCategory ref="PolicyGroup"/>\n'
 176         '  <supportedOn ref="SUPPORTED_TESTOS"/>\n'
 177         '  <enabledValue>\n'
 178         '    <decimal value="1"/>\n'
 179         '  </enabledValue>\n'
 180         '  <disabledValue>\n'
 181         '    <decimal value="0"/>\n'
 182         '  </disabledValue>\n'
 183         '</policy>')
 184
 185     self.AssertXMLEquals(output, expected_output)
 186
 187   def testRecommendedPolicy(self):
 188     main_policy = {
 189       'name': 'DummyMainPolicy',
 190       'type': 'main',
 191     }
 192
 193     policy_group = {
 194       'name': 'PolicyGroup',
 195       'policies': [main_policy],
 196     }
 197     self.writer.BeginTemplate()
 198     self.writer.BeginRecommendedPolicyGroup(policy_group)
 199
 200     self.writer.WriteRecommendedPolicy(main_policy)
 201
 202     output = self.GetXMLOfChildren(self._GetPoliciesElement(self.writer._doc))
 203     expected_output = (
 204         '<policy class="TestClass" displayName="$(string.DummyMainPolicy)"'
 205         ' explainText="$(string.DummyMainPolicy_Explain)"'
 206         ' key="Software\\Policies\\Test\\Recommended"'
 207         ' name="DummyMainPolicy_recommended"'
 208         ' presentation="$(presentation.DummyMainPolicy)"'
 209         ' valueName="DummyMainPolicy">\n'
 210         '  <parentCategory ref="PolicyGroup_recommended"/>\n'
 211         '  <supportedOn ref="SUPPORTED_TESTOS"/>\n'
 212         '  <enabledValue>\n'
 213         '    <decimal value="1"/>\n'
 214         '  </enabledValue>\n'
 215         '  <disabledValue>\n'
 216         '    <decimal value="0"/>\n'
 217         '  </disabledValue>\n'
 218         '</policy>')
 219
 220     self.AssertXMLEquals(output, expected_output)
 221
 222   def testStringPolicy(self):
 223     string_policy = {
 224       'name': 'SampleStringPolicy',
 225       'type': 'string',
 226     }
 227     self._initWriterForPolicy(self.writer, string_policy)
 228
 229     self.writer.WritePolicy(string_policy)
 230     output = self.GetXMLOfChildren(self._GetPoliciesElement(self.writer._doc))
 231     expected_output = (
 232         '<policy class="TestClass" displayName="$(string.SampleStringPolicy)"'
 233         ' explainText="$(string.SampleStringPolicy_Explain)"'
 234         ' key="Software\\Policies\\Test" name="SampleStringPolicy"'
 235         ' presentation="$(presentation.SampleStringPolicy)">\n'
 236         '  <parentCategory ref="PolicyGroup"/>\n'
 237         '  <supportedOn ref="SUPPORTED_TESTOS"/>\n'
 238         '  <elements>\n'
 239         '    <text id="SampleStringPolicy" valueName="SampleStringPolicy"/>\n'
 240         '  </elements>\n'
 241         '</policy>')
 242     self.AssertXMLEquals(output, expected_output)
 243
 244   def testIntPolicy(self):
 245     int_policy = {
 246       'name': 'SampleIntPolicy',
 247       'type': 'int',
 248     }
 249     self._initWriterForPolicy(self.writer, int_policy)
 250
 251     self.writer.WritePolicy(int_policy)
 252     output = self.GetXMLOfChildren(self._GetPoliciesElement(self.writer._doc))
 253     expected_output = (
 254         '<policy class="TestClass" displayName="$(string.SampleIntPolicy)"'
 255         ' explainText="$(string.SampleIntPolicy_Explain)"'
 256         ' key="Software\\Policies\\Test" name="SampleIntPolicy"'
 257         ' presentation="$(presentation.SampleIntPolicy)">\n'
 258         '  <parentCategory ref="PolicyGroup"/>\n'
 259         '  <supportedOn ref="SUPPORTED_TESTOS"/>\n'
 260         '  <elements>\n'
 261         '    <decimal id="SampleIntPolicy" maxValue="2000000000" '
 262         'valueName="SampleIntPolicy"/>\n'
 263         '  </elements>\n'
 264         '</policy>')
 265     self.AssertXMLEquals(output, expected_output)
 266
 267   def testIntEnumPolicy(self):
 268     enum_policy = {
 269       'name': 'SampleEnumPolicy',
 270       'type': 'int-enum',
 271         'items': [
 272           {'name': 'item_1', 'value': 0},
 273           {'name': 'item_2', 'value': 1},
 274         ]
 275     }
 276
 277     self._initWriterForPolicy(self.writer, enum_policy)
 278     self.writer.WritePolicy(enum_policy)
 279     output = self.GetXMLOfChildren(self._GetPoliciesElement(self.writer._doc))
 280     expected_output = (
 281         '<policy class="TestClass" displayName="$(string.SampleEnumPolicy)"'
 282         ' explainText="$(string.SampleEnumPolicy_Explain)"'
 283         ' key="Software\\Policies\\Test" name="SampleEnumPolicy"'
 284         ' presentation="$(presentation.SampleEnumPolicy)">\n'
 285         '  <parentCategory ref="PolicyGroup"/>\n'
 286         '  <supportedOn ref="SUPPORTED_TESTOS"/>\n'
 287         '  <elements>\n'
 288         '    <enum id="SampleEnumPolicy" valueName="SampleEnumPolicy">\n'
 289         '      <item displayName="$(string.item_1)">\n'
 290         '        <value>\n'
 291         '          <decimal value="0"/>\n'
 292         '        </value>\n'
 293         '      </item>\n'
 294         '      <item displayName="$(string.item_2)">\n'
 295         '        <value>\n'
 296         '          <decimal value="1"/>\n'
 297         '        </value>\n'
 298         '      </item>\n'
 299         '    </enum>\n'
 300         '  </elements>\n'
 301         '</policy>')
 302     self.AssertXMLEquals(output, expected_output)
 303
 304   def testStringEnumPolicy(self):
 305     enum_policy = {
 306       'name': 'SampleEnumPolicy',
 307       'type': 'string-enum',
 308         'items': [
 309           {'name': 'item_1', 'value': 'one'},
 310           {'name': 'item_2', 'value': 'two'},
 311         ]
 312     }
 313
 314     # This test is different than the others because it also tests that space
 315     # usage inside <string> nodes is correct.
 316     dom_impl = minidom.getDOMImplementation('')
 317     self.writer._doc = dom_impl.createDocument(None, 'policyDefinitions', None)
 318     self.writer._active_policies_elem = self.writer._doc.documentElement
 319     self.writer._active_mandatory_policy_group_name = 'PolicyGroup'
 320     self.writer.WritePolicy(enum_policy)
 321     output = self.writer.GetTemplateText()
 322     expected_output = (
 323         '<?xml version="1.0" ?>\n'
 324         '<policyDefinitions>\n'
 325         '  <policy class="TestClass" displayName="$(string.SampleEnumPolicy)"'
 326           ' explainText="$(string.SampleEnumPolicy_Explain)"'
 327           ' key="Software\\Policies\\Test" name="SampleEnumPolicy"'
 328           ' presentation="$(presentation.SampleEnumPolicy)">\n'
 329         '    <parentCategory ref="PolicyGroup"/>\n'
 330         '    <supportedOn ref="SUPPORTED_TESTOS"/>\n'
 331         '    <elements>\n'
 332         '      <enum id="SampleEnumPolicy" valueName="SampleEnumPolicy">\n'
 333         '        <item displayName="$(string.item_1)">\n'
 334         '          <value>\n'
 335         '            <string>one</string>\n'
 336         '          </value>\n'
 337         '        </item>\n'
 338         '        <item displayName="$(string.item_2)">\n'
 339         '          <value>\n'
 340         '            <string>two</string>\n'
 341         '          </value>\n'
 342         '        </item>\n'
 343         '      </enum>\n'
 344         '    </elements>\n'
 345         '  </policy>\n'
 346         '</policyDefinitions>')
 347     self.AssertXMLEquals(output, expected_output)
 348
 349   def testListPolicy(self):
 350     list_policy = {
 351       'name': 'SampleListPolicy',
 352       'type': 'list',
 353     }
 354     self._initWriterForPolicy(self.writer, list_policy)
 355     self.writer.WritePolicy(list_policy)
 356     output = self.GetXMLOfChildren(self._GetPoliciesElement(self.writer._doc))
 357     expected_output = (
 358         '<policy class="TestClass" displayName="$(string.SampleListPolicy)"'
 359         ' explainText="$(string.SampleListPolicy_Explain)"'
 360         ' key="Software\\Policies\\Test" name="SampleListPolicy"'
 361         ' presentation="$(presentation.SampleListPolicy)">\n'
 362         '  <parentCategory ref="PolicyGroup"/>\n'
 363         '  <supportedOn ref="SUPPORTED_TESTOS"/>\n'
 364         '  <elements>\n'
 365         '    <list id="SampleListPolicyDesc"'
 366         ' key="Software\Policies\Test\SampleListPolicy" valuePrefix=""/>\n'
 367         '  </elements>\n'
 368         '</policy>')
 369
 370     self.AssertXMLEquals(output, expected_output)
 371
 372   def testDictionaryPolicy(self):
 373     dict_policy = {
 374       'name': 'SampleDictionaryPolicy',
 375       'type': 'dict',
 376     }
 377     self._initWriterForPolicy(self.writer, dict_policy)
 378
 379     self.writer.WritePolicy(dict_policy)
 380     output = self.GetXMLOfChildren(self._GetPoliciesElement(self.writer._doc))
 381     expected_output = (
 382         '<policy class="TestClass" displayName="$(string.'
 383             'SampleDictionaryPolicy)"'
 384         ' explainText="$(string.SampleDictionaryPolicy_Explain)"'
 385         ' key="Software\\Policies\\Test" name="SampleDictionaryPolicy"'
 386         ' presentation="$(presentation.SampleDictionaryPolicy)">\n'
 387         '  <parentCategory ref="PolicyGroup"/>\n'
 388         '  <supportedOn ref="SUPPORTED_TESTOS"/>\n'
 389         '  <elements>\n'
 390         '    <text id="SampleDictionaryPolicy" '
 391             'valueName="SampleDictionaryPolicy"/>\n'
 392         '  </elements>\n'
 393         '</policy>')
 394     self.AssertXMLEquals(output, expected_output)
 395
 396   def testPlatform(self):
 397     # Test that the writer correctly chooses policies of platform Windows.
 398     self.assertTrue(self.writer.IsPolicySupported({
 399       'supported_on': [
 400         {'platforms': ['win', 'zzz']}, {'platforms': ['aaa']}
 401       ]
 402     }))
 403     self.assertFalse(self.writer.IsPolicySupported({
 404       'supported_on': [
 405         {'platforms': ['mac', 'linux']}, {'platforms': ['aaa']}
 406       ]
 407     }))
 408
 409
 410 if __name__ == '__main__':
 411   unittest.main()