Move file encoding (#7)

* remove b64 of file from xml creation

* update b64 attribute name and check for data

* store data as gzip

* move file annotation out of init

* update link annotation api

Author: jaschultz

python_testspace_xml/testspace_xml.py

@@ -1,6 +1,7 @@
 from __future__ import print_function
 import base64
 import gzip
+import re
 import os
 import io
 from io import BytesIO
@@ -33,44 +34,62 @@ def __init__(self, name, comment):
 
 
 class Annotation:
-    def __init__(self, name='unknown', level='info', description='',
-                 file_path=None, mime_type='text/plain'):
+    def __init__(self, name='unknown', level='info', description=''):
         self.name = name
         self.level = level
         self.description = description
-        self.mimeType = mime_type
-        self.file_path = file_path
+        self.mimeType = None
+        self.file_path = None
+        self.link_file = False
+        self.gzip_data = None
         self.comments = []
 
     def add_comment(self, name, comment):
         comment = AnnotationComment(name, comment)
         self.comments.append(comment)
 
+    def add_file_annotation(self, file_path=None, mime_type='text/plain'):
+        self.file_path = file_path
+        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)
+            else:
+                with io.open(self.file_path, 'rb') as inFile:
+                    out = BytesIO()
+                    with gzip.GzipFile(fileobj=out, mode="wb") as f:
+                        f.writelines(inFile)
+                    f.close()
+                    self.gzip_data = out.getvalue()
+
+    def add_link_annotation(self, file_path=None):
+        self.link_file = True
+        match_path = re.search(r'\\\w', file_path)
+        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)
+
     def write_xml(self, parent_element, dom):
         annotation = dom.createElement("annotation")
         annotation.setAttribute("description", self.description)
         annotation.setAttribute("level", self.level)
         annotation.setAttribute("name", self.name)
 
         if self.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.'
-                for com in self.comments:
-                    ta.comments.append(com)
-                ta.write_xml(parent_element, dom)
-                return
+            if self.link_file:
+                annotation.setAttribute("link_file", "true")
+                annotation.setAttribute("file", self.file_path)
             else:
                 annotation.setAttribute("link_file", "false")
-                annotation.setAttribute("file", "file://" + self.file_path)
+                annotation.setAttribute("file", self.file_path)
                 annotation.setAttribute("mime_type", self.mimeType)
-                with io.open(self.file_path, 'rb') as inFile:
-                    out = BytesIO()
-                    with gzip.GzipFile(fileobj=out, mode="wb") as f:
-                        f.writelines(inFile)
-                    f.close()
-                    gzip_data = out.getvalue()
-                    b64_data = base64.b64encode(gzip_data)
+                if self.gzip_data is not None:
+                    b64_data = base64.b64encode(self.gzip_data)
                     b64_data_string = b64_data.decode()
                     cdata = dom.createCDATASection(b64_data_string)
                     annotation.appendChild(cdata)
@@ -132,7 +151,14 @@ def add_custom_data(self, name, value):
 
     def add_file_annotation(self, name, level='info', description='',
                             file_path=None, mime_type='text/plain'):
-        fa = Annotation(name, level, description, file_path, mime_type)
+        fa = Annotation(name, level, description)
+        fa.add_file_annotation(file_path, mime_type)
+        self.annotations.append(fa)
+        return fa
+
+    def add_link_annotation(self, level='info', description='', file_path=None):
+        fa = Annotation(file_path, level, description)
+        fa.add_link_annotation(file_path)
         self.annotations.append(fa)
         return fa
 
@@ -178,7 +204,14 @@ def add_custom_data(self, name, value):
 
     def add_file_annotation(self, name, level='info', description='',
                             file_path=None, mime_type='text/plain'):
-        fa = Annotation(name, level, description, file_path, mime_type)
+        fa = Annotation(name, level, description)
+        fa.add_file_annotation(file_path, mime_type)
+        self.annotations.append(fa)
+        return fa
+
+    def add_link_annotation(self, level='info', description='', file_path=None):
+        fa = Annotation(file_path, level, description)
+        fa.add_link_annotation(file_path)
         self.annotations.append(fa)
         return fa
 

tests/test_TestspaceReport.py

@@ -14,6 +14,7 @@ def create_simple_testspace_xml(self):
     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_link_annotation(file_path=r'\\machine/public')
     example_suite.add_test_case(test_case)
     test_case = testspace_xml.TestCase('failing case 1', 'failed')
     example_suite.add_test_case(test_case)
@@ -52,11 +53,11 @@ 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 2
+        assert len(test_cases) is 3
 
     def test_number_file_annotations(self):
         test_cases = self.testspace_xml_root.xpath("//test_suite/test_case/annotation[@file]")
-        assert len(test_cases) is 1
+        assert len(test_cases) is 2
 
     def test_validate_xsd(self):
         assert xml_validator(self.testspace_xml_string, 'tests/report_v1.xsd')