Testsuite list (#13)

* use ordered dictionary for sub_suites

* fix flake8 issues

* minor changes from review

Author: jaschultz

python_testspace_xml/testspace_xml.py

@@ -1,6 +1,7 @@
 from __future__ import print_function
 import base64
 import gzip
+import collections
 import os
 import io
 from io import BytesIO
@@ -184,7 +185,7 @@ def add_annotation(self, annotation):
 class TestSuite:
     def __init__(self, name):
         # optional sub-suites
-        self.sub_suites = {}
+        self.sub_suites = collections.OrderedDict()
         self.is_root_suite = False
         self.name = name
         self.description = ''
@@ -290,9 +291,9 @@ def _write_suite(self, parent_node, test_suite):
         for tc in test_suite.test_cases:
             self._write_test_case(suite_elem, tc)
 
-        # write child suites, sort by name
-        for ts in sorted(test_suite.sub_suites.keys()):
-            self._write_suite(suite_elem, test_suite.sub_suites[ts])
+        # write child suites
+        for v in test_suite.sub_suites.values():
+            self._write_suite(suite_elem, v)
 
     def _write_test_case(self, parent_node, test_case):
         elem_tc = self.dom.createElement('test_case')

tests/test_testspace_report_xsd.py

@@ -6,6 +6,12 @@
 
 
 class TestTestspaceReportXsd:
+    testsuite_list = ['z testsuite',
+                      '1 testsuite',
+                      'Example Suite',
+                      'A test suite',
+                      'aa test suite']
+
     annotation_tuple = [
         ('zannotation warning example', 'warn', 'to confirm order of annotations'),
         ('annotation info example', 'info', 'description of annotation'),
@@ -23,6 +29,9 @@ class TestTestspaceReportXsd:
     def setup_class(cls):
         testspace_report = testspace_xml.TestspaceReport()
 
+        for suite in cls.testsuite_list:
+            testspace_report.add_test_suite(suite)
+
         example_suite = testspace_report.get_or_add_test_suite('Example Suite')
         example_suite.add_link_annotation(path='https://help.testspace.com')
         example_suite.add_string_buffer_annotation(
@@ -78,12 +87,17 @@ def teardown_class(cls):
         os.remove('testspace.xml')
 
     def test_number_testsuites(self):
-        test_cases = self.testspace_xml_root.xpath("//test_suite")
-        assert len(test_cases) is 1
+        test_suites = self.testspace_xml_root.xpath("//test_suite")
+        assert len(test_suites) is 5
+
+    def test_testsuites_order(self):
+        test_suites = self.testspace_xml_root.xpath("//test_suite")
+        for idx, tests_suite in enumerate(test_suites):
+            assert tests_suite.get('name') == self.testsuite_list[idx]
 
     def test_number_testsuite_annotations(self):
-        test_cases = self.testspace_xml_root.xpath("//test_suite/annotation")
-        assert len(test_cases) is 5
+        test_suites = self.testspace_xml_root.xpath("//test_suite/annotation")
+        assert len(test_suites) is 5
 
     def test_testsuite_duration(self):
         suite_element = self.testspace_xml_root.xpath("//test_suite[@duration]")
@@ -125,7 +139,8 @@ def test_annotation_order(self):
             assert annotation.get('name') == self.annotation_tuple[idx][0]
 
     def test_testcase_duration(self):
-        suite_element = self.testspace_xml_root.xpath("//test_suite/test_case[@name='passing case 2']")
+        suite_element = self.testspace_xml_root.xpath(
+            "//test_suite/test_case[@name='passing case 2']")
         assert float(suite_element[0].attrib['duration']) == self.duration
 
     def test_validate_xsd(self):