Pretty and sanitizier xml

kpet/run.py

@@ -16,6 +16,8 @@
 import tempfile
 import shutil
 import os
+import subprocess
+import distutils
 from kpet import utils, targeted
 
 
@@ -50,6 +52,28 @@ def print_test_cases(patches, dbdir, pw_cookie=None):
         print(test_case)
 
 
+def pretty_xml(xml_content):
+    """
+    Check, reformat and reindent the xml content if xmllint is available,
+    otherwise return the content unchanged.
+    Args:
+        xml_content: Jinja template rendered
+    Returns:
+        An xml reformatted and reindented if xmllint is available.
+    """
+    cmd = distutils.spawn.find_executable('xmllint')
+    if not cmd:
+        return xml_content
+    args = [cmd, '--format', '-']
+    proc = subprocess.Popen(args, stdin=subprocess.PIPE,
+                            stdout=subprocess.PIPE)
+    proc.stdin.write(xml_content.encode('utf-8'))
+    stdout, _ = proc.communicate()
+    if proc.poll() != 0:
+        raise subprocess.CalledProcessError(proc.returncode, ' '.join(args))
+    return stdout.decode('utf-8')
+
+
 # pylint: disable=too-many-arguments
 def generate(template, template_params, patches, dbdir, output,
              pw_cookie=None):
@@ -78,7 +102,7 @@ def generate(template, template_params, patches, dbdir, output,
     template_params['TEST_CASES_KICKSTART'] = sorted(
         targeted.get_property('kickstart', test_names, dbdir)
     )
-    content = template.render(template_params)
+    content = pretty_xml(template.render(template_params))
     if not output:
         print(content)
     else:

tests/test_kpet.py

@@ -100,7 +100,8 @@ def test_exec_command(self):
                 mock.call('Not implemented yet'),
             )
 
-    def test_main(self):
+    @mock.patch('distutils.spawn.find_executable', return_value=None)
+    def test_main(self, mock_find_executable):
         """
         Check --db is required and also run generate command executes
         successfully

tests/test_run.py

@@ -15,13 +15,15 @@
 import os
 import tempfile
 import unittest
+import subprocess
 import mock
 from kpet import run, utils, exceptions
 
 
 class RunTest(unittest.TestCase):
     """Test cases for run module."""
-    def test_generate(self):
+    @mock.patch('distutils.spawn.find_executable', return_value=None)
+    def test_generate(self, mock_find_executable):
         """
         Check the success case, if it raises the proper exception when
         the type is not found and if it saves the output in a file instead
@@ -113,3 +115,20 @@ def test_get_test_cases(self, mock_get_test_cases):
         mock_get_test_cases.return_value = ['default/ltplite', 'fs/xfs']
         test_cases = run.get_test_cases("", "")
         self.assertEqual(mock_get_test_cases.return_value, test_cases)
+
+    @mock.patch('subprocess.Popen')
+    @mock.patch('distutils.spawn.find_executable')
+    def test_pretty_xml(self, mock_find_executable, mock_popen):
+        """
+        Check command (xmllint mocked) is called if it is available and content
+        is modified.
+        """
+        mock_find_executable.return_value = None
+        self.assertEqual('foobar', run.pretty_xml('foobar'))
+
+        mock_find_executable.return_value = 'binary'
+        mock_popen().communicate.return_value = (b'stdout', b'')
+        self.assertRaises(subprocess.CalledProcessError, run.pretty_xml, 'bar')
+
+        mock_popen().poll.return_value = 0
+        self.assertEqual('stdout', run.pretty_xml('foobar'))