Add suite duration (#8)

* add test_suite duration

* add annotation test order check

* revert file deletion change

* fix static analysis warning

* add annotations tests

* update annotations order

* fix flake8 errors

* add test_suite duration

* add annotation test order check

* revert file deletion change

* fix static analysis warning

* add annotations tests

* update annotations order

* fix flake8 errors

* remove redundant testcase from merge

* update missing invalid file path logic and tests

* fix flake8 errors

* add tests for annotation comments

* revent comment

* fix missing line

Author: jaschultz

python_testspace_xml/testspace_xml.py

@@ -53,9 +53,9 @@ def add_file_annotation(self, file_path=None, mime_type='text/plain'):
         self.mimeType = mime_type
         if file_path is not None:
             if not os.path.isfile(self.file_path):
-                ta = Annotation(self.file_path, level='error')
-                ta.description = 'File: ' + self.file_path + ' not found.'
-                self.comments.append(ta)
+                self.level = 'error'
+                self.description = 'File: ' + self.file_path + ' not found.'
+                self.file_path = None
             else:
                 with io.open(self.file_path, 'rb') as inFile:
                     out = BytesIO()
@@ -70,9 +70,8 @@ def add_link_annotation(self, file_path=None):
         if match_path and file_path:
             self.file_path = "file://" + file_path.replace('\\', '/')
         else:
-            ta = Annotation(self.file_path, level='error')
-            ta.description = 'Invalid network file path given:' + file_path
-            self.comments.append(ta)
+            self.level = 'error'
+            self.description = 'Invalid network file path given:' + file_path
 
     def write_xml(self, parent_element, dom):
         annotation = dom.createElement("annotation")
@@ -167,6 +166,9 @@ def add_text_annotation(self, name, level='info', description=''):
         self.annotations.append(ta)
         return ta
 
+    def add_annotation(self, annotation):
+        self.annotations.append(annotation)
+
 
 class TestSuite:
     def __init__(self, name):
@@ -175,6 +177,7 @@ def __init__(self, name):
         self.is_root_suite = False
         self.name = name
         self.description = ''
+        self.duration = 0
         self.start_time = ''
         self.test_cases = []
         self.custom_data = []
@@ -220,6 +223,12 @@ def add_text_annotation(self, name, level='info', description=''):
         self.annotations.append(ta)
         return ta
 
+    def add_annotation(self, annotation):
+        self.annotations.append(annotation)
+
+    def set_duration_ms(self, duration):
+        self.duration = duration
+
 
 class XmlWriter:
     def __init__(self, report):
@@ -251,6 +260,8 @@ def _write_suite(self, parent_node, test_suite):
             suite_elem.setAttribute('description', test_suite.description)
             suite_elem.setAttribute('start_time', str(test_suite.start_time))
             parent_node.appendChild(suite_elem)
+            if test_suite.duration > 0:
+                suite_elem.setAttribute('duration', test_suite.duration)
 
         for a in test_suite.annotations:
             a.write_xml(suite_elem, self.dom)

tests/test_TestspaceReport.py

@@ -1,4 +1,3 @@
-import pytest
 import os
 from lxml import etree, objectify
 from lxml.etree import XMLSyntaxError
@@ -7,17 +6,34 @@
 
 
 def create_simple_testspace_xml(self):
+    self.annotation_tuple = [
+        ('zannotation warning example', 'warn', 'to confirm order of annotations'),
+        ('annotation info example', 'info', 'description of annotation'),
+        ('aannotation error example', 'error', 'to confirm order of annotations')]
+
     testspace_report = testspace_xml.TestspaceReport()
+
     example_suite = testspace_report.get_or_add_test_suite('Example Suite')
     test_case = testspace_xml.TestCase('passing case 1', 'passed')
-    test_case.add_text_annotation('annotation example', description='description of annotation')
+    for annotation in self.annotation_tuple:
+        test_case.add_text_annotation(
+            annotation[0], level=annotation[1], description=annotation[2])
     example_suite.add_test_case(test_case)
+
     test_case = testspace_xml.TestCase('passing case 2', 'passed')
-    test_case.add_file_annotation('report_v1.xsd', file_path='tests/report_v1.xsd')
+    test_case.add_file_annotation('tests/report_v1.xsd', file_path='tests/report_v1.xsd')
+    test_case.add_file_annotation('report_v1.xsd', file_path='/report_v1.xsd')
     test_case.add_link_annotation(file_path=r'\\machine/public')
+    test_case.add_info_annotation(self.annotation_tuple[0][2])
+    test_case.add_error_annotation(self.annotation_tuple[1][2])
+    test_case.add_warning_annotation(self.annotation_tuple[2][2])
     example_suite.add_test_case(test_case)
-    test_case = testspace_xml.TestCase('failing case 1', 'failed')
+
+    test_case = testspace_xml.TestCase('failing case 1')
+    test_case.fail('failing testcase')  # adds annotation to testcase
     example_suite.add_test_case(test_case)
+    test_annotation = test_case.add_text_annotation('annotation with comment')
+    test_annotation.add_comment("comment", "annotation comment")
     testspace_report.write_xml('testspace.xml', to_pretty=True)
 
     xml_file = open('testspace.xml', 'r')
@@ -28,9 +44,9 @@ def create_simple_testspace_xml(self):
 
 
 class TestTestspaceXml:
-    @pytest.fixture(autouse=True)
-    def setup_class(self):
-        create_simple_testspace_xml(self)
+    @classmethod
+    def setup_class(cls):
+        create_simple_testspace_xml(cls)
 
     @classmethod
     def teardown_class(cls):
@@ -53,12 +69,22 @@ def test_number_failed_testcases(self):
 
     def test_number_annotations(self):
         test_cases = self.testspace_xml_root.xpath("//test_suite/test_case/annotation")
-        assert len(test_cases) is 3
+        assert len(test_cases) is 11
 
     def test_number_file_annotations(self):
         test_cases = self.testspace_xml_root.xpath("//test_suite/test_case/annotation[@file]")
         assert len(test_cases) is 2
 
+    def test_number_annotation_comments(self):
+        test_cases = self.testspace_xml_root.xpath("//test_suite/test_case/annotation/comment")
+        assert len(test_cases) is 1
+
+    def test_annotation_order(self):
+        annotations = self.testspace_xml_root.xpath(
+            "//test_suite/test_case[@name='passing case 1']/annotation")
+        for idx, annotation in enumerate(annotations):
+            assert annotation.get('name') == self.annotation_tuple[idx][0]
+
     def test_validate_xsd(self):
         assert xml_validator(self.testspace_xml_string, 'tests/report_v1.xsd')