e5738d0852
Remove the test options suppressing ignoring differences in whitespace outputted in the XML to allow capturing of issues where the code incorrectly adds or removes significant whitespace. Add a helper function to deal with the edge case of parsing XML directly that contains non significant whitespace to avoid accidentally adding excess whitespace when minidom outputs the resulting document. Change-Id: I9936042cd82c204ba2b3c19f575703e33564f7fd
95 lines
3.3 KiB
Python
95 lines
3.3 KiB
Python
#!/usr/bin/env python
|
|
# Copyright (C) 2015 OpenStack, LLC.
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
|
|
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
|
|
# License for the specific language governing permissions and limitations
|
|
# under the License.
|
|
|
|
# Manage Jenkins XML config file output.
|
|
|
|
import hashlib
|
|
import sys
|
|
import xml
|
|
from xml.dom import minidom
|
|
import xml.etree.ElementTree as XML
|
|
|
|
|
|
# Python 2.6's minidom toprettyxml produces broken output by adding extraneous
|
|
# whitespace around data. This patches the broken implementation with one taken
|
|
# from Python > 2.7.3
|
|
def writexml(self, writer, indent="", addindent="", newl=""):
|
|
# indent = current indentation
|
|
# addindent = indentation to add to higher levels
|
|
# newl = newline string
|
|
writer.write(indent + "<" + self.tagName)
|
|
|
|
attrs = self._get_attributes()
|
|
a_names = attrs.keys()
|
|
a_names.sort()
|
|
|
|
for a_name in a_names:
|
|
writer.write(" %s=\"" % a_name)
|
|
minidom._write_data(writer, attrs[a_name].value)
|
|
writer.write("\"")
|
|
if self.childNodes:
|
|
writer.write(">")
|
|
if (len(self.childNodes) == 1 and
|
|
self.childNodes[0].nodeType == minidom.Node.TEXT_NODE):
|
|
self.childNodes[0].writexml(writer, '', '', '')
|
|
else:
|
|
writer.write(newl)
|
|
for node in self.childNodes:
|
|
node.writexml(writer, indent + addindent, addindent, newl)
|
|
writer.write(indent)
|
|
writer.write("</%s>%s" % (self.tagName, newl))
|
|
else:
|
|
writer.write("/>%s" % (newl))
|
|
|
|
# PyXML xml.__name__ is _xmlplus. Check that if we don't have the default
|
|
# system version of the minidom, then patch the writexml method
|
|
if sys.version_info[:3] < (2, 7, 3) or xml.__name__ != 'xml':
|
|
minidom.Element.writexml = writexml
|
|
|
|
|
|
def remove_ignorable_whitespace(node):
|
|
"""Remove insignificant whitespace from XML nodes
|
|
|
|
It should only remove whitespace in between elements and sub elements.
|
|
This should be safe for Jenkins due to how it's XML serialization works
|
|
but may not be valid for other XML documents. So use this method with
|
|
caution outside of this specific library.
|
|
"""
|
|
# strip tail whitespace if it's not significant
|
|
if node.tail and node.tail.strip() == "":
|
|
node.tail = None
|
|
|
|
for child in node.getchildren():
|
|
# only strip whitespace from the text node if there are subelement
|
|
# nodes as this means we are removing leading whitespace before such
|
|
# sub elements. Otherwise risk removing whitespace from an element
|
|
# that only contains whitespace
|
|
if node.text and node.text.strip() == "":
|
|
node.text = None
|
|
remove_ignorable_whitespace(child)
|
|
|
|
|
|
class XmlJob(object):
|
|
def __init__(self, xml, name):
|
|
self.xml = xml
|
|
self.name = name
|
|
|
|
def md5(self):
|
|
return hashlib.md5(self.output()).hexdigest()
|
|
|
|
def output(self):
|
|
out = minidom.parseString(XML.tostring(self.xml, encoding='UTF-8'))
|
|
return out.toprettyxml(indent=' ', encoding='utf-8')
|