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.
7 """Unittests for grit.format.policy_templates.writers.admx_writer."""
13 if __name__ == '__main__':
14 sys.path.append(os.path.join(os.path.dirname(__file__), '../../../..'))
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
22 class AdmxWriterUnittest(xml_writer_base_unittest.XmlWriterBaseTest):
24 def _CreateDocumentElement(self):
25 dom_impl = minidom.getDOMImplementation('')
26 doc = dom_impl.createDocument(None, 'root', None)
27 return doc.documentElement
30 # Writer configuration. This dictionary contains parameter used by the ADMX
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 'build': 'test_product',
43 self.writer = admx_writer.GetWriter(config)
46 def _GetPoliciesElement(self, doc):
47 node_list = doc.getElementsByTagName('policies')
48 self.assertTrue(node_list.length == 1)
49 return node_list.item(0)
51 def _GetCategoriesElement(self, doc):
52 node_list = doc.getElementsByTagName('categories')
53 self.assertTrue(node_list.length == 1)
54 return node_list.item(0)
57 self.writer.BeginTemplate()
58 self.writer.EndTemplate()
60 output = self.writer.GetTemplateText()
62 '<?xml version="1.0" ?>\n'
63 '<policyDefinitions revision="1.0" schemaVersion="1.0">\n'
64 ' <policyNamespaces>\n'
65 ' <target namespace="ADMXWriter.Test.Namespace"'
66 ' prefix="test_prefix"/>\n'
67 ' <using namespace="Microsoft.Policies.Windows" prefix="windows"/>\n'
68 ' </policyNamespaces>\n'
69 ' <resources minRequiredRevision="1.0"/>\n'
72 ' <definition displayName="'
73 '$(string.SUPPORTED_TESTOS)" name="SUPPORTED_TESTOS"/>\n'
77 ' <category displayName="$(string.test_category)"'
78 ' name="test_category"/>\n'
79 ' <category displayName="$(string.test_recommended_category)"'
80 ' name="test_recommended_category"/>\n'
83 '</policyDefinitions>')
84 self.AssertXMLEquals(output, expected_output)
86 def testEmptyVersion(self):
87 self.writer.config['version'] = '39.0.0.0'
88 self.writer.BeginTemplate()
89 self.writer.EndTemplate()
91 output = self.writer.GetTemplateText()
93 '<?xml version="1.0" ?>\n'
94 '<policyDefinitions revision="1.0" schemaVersion="1.0">\n'
95 ' <!--test_product version: 39.0.0.0-->\n'
96 ' <policyNamespaces>\n'
97 ' <target namespace="ADMXWriter.Test.Namespace"'
98 ' prefix="test_prefix"/>\n'
99 ' <using namespace="Microsoft.Policies.Windows" prefix="windows"/>\n'
100 ' </policyNamespaces>\n'
101 ' <resources minRequiredRevision="1.0"/>\n'
104 ' <definition displayName="'
105 '$(string.SUPPORTED_TESTOS)" name="SUPPORTED_TESTOS"/>\n'
109 ' <category displayName="$(string.test_category)"'
110 ' name="test_category"/>\n'
111 ' <category displayName="$(string.test_recommended_category)"'
112 ' name="test_recommended_category"/>\n'
115 '</policyDefinitions>')
116 self.AssertXMLEquals(output, expected_output)
118 def testEmptyPolicyGroup(self):
119 empty_policy_group = {
120 'name': 'PolicyGroup',
123 # Initialize writer to write a policy group.
124 self.writer.BeginTemplate()
126 self.writer.BeginPolicyGroup(empty_policy_group)
127 self.writer.EndPolicyGroup()
129 output = self.GetXMLOfChildren(self._GetPoliciesElement(self.writer._doc))
131 self.AssertXMLEquals(output, expected_output)
133 output = self.GetXMLOfChildren(
134 self._GetCategoriesElement(self.writer._doc))
136 '<category displayName="$(string.test_category)"'
137 ' name="test_category"/>\n'
138 '<category displayName="$(string.test_recommended_category)"'
139 ' name="test_recommended_category"/>\n'
140 '<category displayName="$(string.PolicyGroup_group)"'
141 ' name="PolicyGroup">\n'
142 ' <parentCategory ref="test_category"/>\n'
145 self.AssertXMLEquals(output, expected_output)
147 def testPolicyGroup(self):
148 empty_policy_group = {
149 'name': 'PolicyGroup',
151 {'name': 'PolicyStub2',
153 {'name': 'PolicyStub1',
157 # Initialize writer to write a policy group.
158 self.writer.BeginTemplate()
160 self.writer.BeginPolicyGroup(empty_policy_group)
161 self.writer.EndPolicyGroup()
163 output = self.GetXMLOfChildren(self._GetPoliciesElement(self.writer._doc))
165 self.AssertXMLEquals(output, expected_output)
167 output = self.GetXMLOfChildren(
168 self._GetCategoriesElement(self.writer._doc))
170 '<category displayName="$(string.test_category)"'
171 ' name="test_category"/>\n'
172 '<category displayName="$(string.test_recommended_category)"'
173 ' name="test_recommended_category"/>\n'
174 '<category displayName="$(string.PolicyGroup_group)"'
175 ' name="PolicyGroup">\n'
176 ' <parentCategory ref="test_category"/>\n'
178 self.AssertXMLEquals(output, expected_output)
181 def _initWriterForPolicy(self, writer, policy):
182 '''Initializes the writer to write the given policy next.
185 'name': 'PolicyGroup',
188 writer.BeginTemplate()
189 writer.BeginPolicyGroup(policy_group)
191 def testMainPolicy(self):
193 'name': 'DummyMainPolicy',
197 self._initWriterForPolicy(self.writer, main_policy)
199 self.writer.WritePolicy(main_policy)
201 output = self.GetXMLOfChildren(self._GetPoliciesElement(self.writer._doc))
203 '<policy class="TestClass" displayName="$(string.DummyMainPolicy)"'
204 ' explainText="$(string.DummyMainPolicy_Explain)"'
205 ' key="Software\\Policies\\Test" name="DummyMainPolicy"'
206 ' presentation="$(presentation.DummyMainPolicy)"'
207 ' valueName="DummyMainPolicy">\n'
208 ' <parentCategory ref="PolicyGroup"/>\n'
209 ' <supportedOn ref="SUPPORTED_TESTOS"/>\n'
211 ' <decimal value="1"/>\n'
214 ' <decimal value="0"/>\n'
215 ' </disabledValue>\n'
218 self.AssertXMLEquals(output, expected_output)
220 def testRecommendedPolicy(self):
222 'name': 'DummyMainPolicy',
227 'name': 'PolicyGroup',
228 'policies': [main_policy],
230 self.writer.BeginTemplate()
231 self.writer.BeginRecommendedPolicyGroup(policy_group)
233 self.writer.WriteRecommendedPolicy(main_policy)
235 output = self.GetXMLOfChildren(self._GetPoliciesElement(self.writer._doc))
237 '<policy class="TestClass" displayName="$(string.DummyMainPolicy)"'
238 ' explainText="$(string.DummyMainPolicy_Explain)"'
239 ' key="Software\\Policies\\Test\\Recommended"'
240 ' name="DummyMainPolicy_recommended"'
241 ' presentation="$(presentation.DummyMainPolicy)"'
242 ' valueName="DummyMainPolicy">\n'
243 ' <parentCategory ref="PolicyGroup_recommended"/>\n'
244 ' <supportedOn ref="SUPPORTED_TESTOS"/>\n'
246 ' <decimal value="1"/>\n'
249 ' <decimal value="0"/>\n'
250 ' </disabledValue>\n'
253 self.AssertXMLEquals(output, expected_output)
255 def testRecommendedOnlyPolicy(self):
257 'name': 'DummyMainPolicy',
260 'can_be_recommended': True,
261 'can_be_mandatory': False,
266 'name': 'PolicyGroup',
267 'policies': [main_policy],
269 self.writer.BeginTemplate()
270 self.writer.BeginRecommendedPolicyGroup(policy_group)
272 self.writer.WritePolicy(main_policy)
273 self.writer.WriteRecommendedPolicy(main_policy)
275 output = self.GetXMLOfChildren(self._GetPoliciesElement(self.writer._doc))
277 '<policy class="TestClass" displayName="$(string.DummyMainPolicy)"'
278 ' explainText="$(string.DummyMainPolicy_Explain)"'
279 ' key="Software\\Policies\\Test\\Recommended"'
280 ' name="DummyMainPolicy_recommended"'
281 ' presentation="$(presentation.DummyMainPolicy)"'
282 ' valueName="DummyMainPolicy">\n'
283 ' <parentCategory ref="PolicyGroup_recommended"/>\n'
284 ' <supportedOn ref="SUPPORTED_TESTOS"/>\n'
286 ' <decimal value="1"/>\n'
289 ' <decimal value="0"/>\n'
290 ' </disabledValue>\n'
293 self.AssertXMLEquals(output, expected_output)
295 def testStringPolicy(self):
297 'name': 'SampleStringPolicy',
300 self._initWriterForPolicy(self.writer, string_policy)
302 self.writer.WritePolicy(string_policy)
303 output = self.GetXMLOfChildren(self._GetPoliciesElement(self.writer._doc))
305 '<policy class="TestClass" displayName="$(string.SampleStringPolicy)"'
306 ' explainText="$(string.SampleStringPolicy_Explain)"'
307 ' key="Software\\Policies\\Test" name="SampleStringPolicy"'
308 ' presentation="$(presentation.SampleStringPolicy)">\n'
309 ' <parentCategory ref="PolicyGroup"/>\n'
310 ' <supportedOn ref="SUPPORTED_TESTOS"/>\n'
312 ' <text id="SampleStringPolicy" maxLength="1000000"'
313 ' valueName="SampleStringPolicy"/>\n'
316 self.AssertXMLEquals(output, expected_output)
318 def testIntPolicy(self):
320 'name': 'SampleIntPolicy',
323 self._initWriterForPolicy(self.writer, int_policy)
325 self.writer.WritePolicy(int_policy)
326 output = self.GetXMLOfChildren(self._GetPoliciesElement(self.writer._doc))
328 '<policy class="TestClass" displayName="$(string.SampleIntPolicy)"'
329 ' explainText="$(string.SampleIntPolicy_Explain)"'
330 ' key="Software\\Policies\\Test" name="SampleIntPolicy"'
331 ' presentation="$(presentation.SampleIntPolicy)">\n'
332 ' <parentCategory ref="PolicyGroup"/>\n'
333 ' <supportedOn ref="SUPPORTED_TESTOS"/>\n'
335 ' <decimal id="SampleIntPolicy" maxValue="2000000000" '
336 'valueName="SampleIntPolicy"/>\n'
339 self.AssertXMLEquals(output, expected_output)
341 def testIntEnumPolicy(self):
343 'name': 'SampleEnumPolicy',
346 {'name': 'item_1', 'value': 0},
347 {'name': 'item_2', 'value': 1},
351 self._initWriterForPolicy(self.writer, enum_policy)
352 self.writer.WritePolicy(enum_policy)
353 output = self.GetXMLOfChildren(self._GetPoliciesElement(self.writer._doc))
355 '<policy class="TestClass" displayName="$(string.SampleEnumPolicy)"'
356 ' explainText="$(string.SampleEnumPolicy_Explain)"'
357 ' key="Software\\Policies\\Test" name="SampleEnumPolicy"'
358 ' presentation="$(presentation.SampleEnumPolicy)">\n'
359 ' <parentCategory ref="PolicyGroup"/>\n'
360 ' <supportedOn ref="SUPPORTED_TESTOS"/>\n'
362 ' <enum id="SampleEnumPolicy" valueName="SampleEnumPolicy">\n'
363 ' <item displayName="$(string.item_1)">\n'
365 ' <decimal value="0"/>\n'
368 ' <item displayName="$(string.item_2)">\n'
370 ' <decimal value="1"/>\n'
376 self.AssertXMLEquals(output, expected_output)
378 def testStringEnumPolicy(self):
380 'name': 'SampleEnumPolicy',
381 'type': 'string-enum',
383 {'name': 'item_1', 'value': 'one'},
384 {'name': 'item_2', 'value': 'two'},
388 # This test is different than the others because it also tests that space
389 # usage inside <string> nodes is correct.
390 dom_impl = minidom.getDOMImplementation('')
391 self.writer._doc = dom_impl.createDocument(None, 'policyDefinitions', None)
392 self.writer._active_policies_elem = self.writer._doc.documentElement
393 self.writer._active_mandatory_policy_group_name = 'PolicyGroup'
394 self.writer.WritePolicy(enum_policy)
395 output = self.writer.GetTemplateText()
397 '<?xml version="1.0" ?>\n'
398 '<policyDefinitions>\n'
399 ' <policy class="TestClass" displayName="$(string.SampleEnumPolicy)"'
400 ' explainText="$(string.SampleEnumPolicy_Explain)"'
401 ' key="Software\\Policies\\Test" name="SampleEnumPolicy"'
402 ' presentation="$(presentation.SampleEnumPolicy)">\n'
403 ' <parentCategory ref="PolicyGroup"/>\n'
404 ' <supportedOn ref="SUPPORTED_TESTOS"/>\n'
406 ' <enum id="SampleEnumPolicy" valueName="SampleEnumPolicy">\n'
407 ' <item displayName="$(string.item_1)">\n'
409 ' <string>one</string>\n'
412 ' <item displayName="$(string.item_2)">\n'
414 ' <string>two</string>\n'
420 '</policyDefinitions>')
421 self.AssertXMLEquals(output, expected_output)
423 def testListPolicy(self):
425 'name': 'SampleListPolicy',
428 self._initWriterForPolicy(self.writer, list_policy)
429 self.writer.WritePolicy(list_policy)
430 output = self.GetXMLOfChildren(self._GetPoliciesElement(self.writer._doc))
432 '<policy class="TestClass" displayName="$(string.SampleListPolicy)"'
433 ' explainText="$(string.SampleListPolicy_Explain)"'
434 ' key="Software\\Policies\\Test" name="SampleListPolicy"'
435 ' presentation="$(presentation.SampleListPolicy)">\n'
436 ' <parentCategory ref="PolicyGroup"/>\n'
437 ' <supportedOn ref="SUPPORTED_TESTOS"/>\n'
439 ' <list id="SampleListPolicyDesc"'
440 ' key="Software\Policies\Test\SampleListPolicy" valuePrefix=""/>\n'
444 self.AssertXMLEquals(output, expected_output)
446 def testStringEnumListPolicy(self):
448 'name': 'SampleListPolicy',
449 'type': 'string-enum-list',
451 {'name': 'item_1', 'value': 'one'},
452 {'name': 'item_2', 'value': 'two'},
455 self._initWriterForPolicy(self.writer, list_policy)
456 self.writer.WritePolicy(list_policy)
457 output = self.GetXMLOfChildren(self._GetPoliciesElement(self.writer._doc))
459 '<policy class="TestClass" displayName="$(string.SampleListPolicy)"'
460 ' explainText="$(string.SampleListPolicy_Explain)"'
461 ' key="Software\\Policies\\Test" name="SampleListPolicy"'
462 ' presentation="$(presentation.SampleListPolicy)">\n'
463 ' <parentCategory ref="PolicyGroup"/>\n'
464 ' <supportedOn ref="SUPPORTED_TESTOS"/>\n'
466 ' <list id="SampleListPolicyDesc"'
467 ' key="Software\Policies\Test\SampleListPolicy" valuePrefix=""/>\n'
471 self.AssertXMLEquals(output, expected_output)
473 def testDictionaryPolicy(self):
475 'name': 'SampleDictionaryPolicy',
478 self._initWriterForPolicy(self.writer, dict_policy)
480 self.writer.WritePolicy(dict_policy)
481 output = self.GetXMLOfChildren(self._GetPoliciesElement(self.writer._doc))
483 '<policy class="TestClass" displayName="$(string.'
484 'SampleDictionaryPolicy)"'
485 ' explainText="$(string.SampleDictionaryPolicy_Explain)"'
486 ' key="Software\\Policies\\Test" name="SampleDictionaryPolicy"'
487 ' presentation="$(presentation.SampleDictionaryPolicy)">\n'
488 ' <parentCategory ref="PolicyGroup"/>\n'
489 ' <supportedOn ref="SUPPORTED_TESTOS"/>\n'
491 ' <text id="SampleDictionaryPolicy" maxLength="1000000"'
492 ' valueName="SampleDictionaryPolicy"/>\n'
495 self.AssertXMLEquals(output, expected_output)
497 def testPlatform(self):
498 # Test that the writer correctly chooses policies of platform Windows.
499 self.assertTrue(self.writer.IsPolicySupported({
501 {'platforms': ['win', 'zzz']}, {'platforms': ['aaa']}
504 self.assertFalse(self.writer.IsPolicySupported({
506 {'platforms': ['mac', 'linux']}, {'platforms': ['aaa']}
510 def testStringEncodings(self):
512 'name': 'SampleEnumPolicy.A',
513 'type': 'string-enum',
515 {'name': 'tls1.2', 'value': 'tls1.2'}
519 'name': 'SampleEnumPolicy.B',
520 'type': 'string-enum',
522 {'name': 'tls1.2', 'value': 'tls1.2'}
526 dom_impl = minidom.getDOMImplementation('')
527 self.writer._doc = dom_impl.createDocument(None, 'policyDefinitions', None)
528 self.writer._active_policies_elem = self.writer._doc.documentElement
529 self.writer._active_mandatory_policy_group_name = 'PolicyGroup'
530 self.writer.WritePolicy(enum_policy_a)
531 self.writer.WritePolicy(enum_policy_b)
532 output = self.writer.GetTemplateText()
534 '<?xml version="1.0" ?>\n'
535 '<policyDefinitions>\n'
536 ' <policy class="TestClass" displayName="$(string.SampleEnumPolicy_A)"'
537 ' explainText="$(string.SampleEnumPolicy_A_Explain)"'
538 ' key="Software\\Policies\\Test" name="SampleEnumPolicy.A"'
539 ' presentation="$(presentation.SampleEnumPolicy.A)">\n'
540 ' <parentCategory ref="PolicyGroup"/>\n'
541 ' <supportedOn ref="SUPPORTED_TESTOS"/>\n'
543 ' <enum id="SampleEnumPolicy.A" valueName="SampleEnumPolicy.A">\n'
544 ' <item displayName="$(string.tls1_2)">\n'
546 ' <string>tls1.2</string>\n'
552 ' <policy class="TestClass" displayName="$(string.SampleEnumPolicy_B)"'
553 ' explainText="$(string.SampleEnumPolicy_B_Explain)"'
554 ' key="Software\\Policies\\Test" name="SampleEnumPolicy.B"'
555 ' presentation="$(presentation.SampleEnumPolicy.B)">\n'
556 ' <parentCategory ref="PolicyGroup"/>\n'
557 ' <supportedOn ref="SUPPORTED_TESTOS"/>\n'
559 ' <enum id="SampleEnumPolicy.B" valueName="SampleEnumPolicy.B">\n'
560 ' <item displayName="$(string.tls1_2)">\n'
562 ' <string>tls1.2</string>\n'
568 '</policyDefinitions>')
569 self.AssertXMLEquals(output, expected_output)
572 if __name__ == '__main__':