Add tox (#10)

jaschultz · web-flow · commit 40f01ad589b8 · 2017-06-13T11:14:34.000-07:00
* add tox to run pytest

* remove testcase custom data

* update annotation link and tests

* add annotation as buffer

* fix python 2.7 gzip compress

* add metric data

* add tox to travis

* fix pip syntax error
diff --git a/.coveragerc b/.coveragerc
@@ -0,0 +1,3 @@
+# .coveragerc to control coverage.py
+[run]
+branch = True
diff --git a/.travis.yml b/.travis.yml
@@ -9,15 +9,14 @@ before_install:
   - testspace config url s2.testspace.com
 
 install:
-  - pip install -r requirements.txt
+  - pip install tox
 
 script:
   - export PYTHONPATH=$PYTHONPATH:$TRAVIS_BUILD_DIR
-  - py.test --junit-xml=testresults.xml --cov=python_testspace_xml --cov-report xml:coverage.xml --cov-report term
+  - tox -e py
 
 after_script:
   - if [ "${TRAVIS_PYTHON_VERSION}" = "3.5" ]; then
-      flake8 --max-line-length=100 --output-file=flake8.txt --exit-zero;
       testspace [${TRAVIS_PYTHON_VERSION}]flake8.txt{lint} [${TRAVIS_PYTHON_VERSION}/tests]testresults.xml{tests} [${TRAVIS_PYTHON_VERSION}]coverage.xml;
     else
       testspace [${TRAVIS_PYTHON_VERSION}/tests]testresults.xml{tests};
diff --git a/python_testspace_xml/testspace_xml.py b/python_testspace_xml/testspace_xml.py
@@ -1,7 +1,6 @@
 from __future__ import print_function
 import base64
 import gzip
-import re
 import os
 import io
 from io import BytesIO
@@ -10,10 +9,6 @@
 from xml.dom.minidom import parseString
 
 
-def make_file_href_link(file_path):
-    return "<a href='file://" + file_path.replace('\\', '/') + "'>" + file_path + '</a>'
-
-
 class CustomData:
     def __init__(self, name, value):
         self.name = name
@@ -48,7 +43,7 @@ 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'):
+    def set_file_annotation(self, file_path=None, mime_type='text/plain', string_buffer=None):
         self.file_path = file_path
         self.mimeType = mime_type
         if file_path is not None:
@@ -63,15 +58,23 @@ def add_file_annotation(self, file_path=None, mime_type='text/plain'):
                         f.writelines(inFile)
                     f.close()
                     self.gzip_data = out.getvalue()
-
-    def add_link_annotation(self, file_path=None):
+        elif string_buffer is not None:
+            byte_string_buffer = string_buffer.encode()
+            out = BytesIO()
+            with gzip.GzipFile(fileobj=out, mode="wb") as f:
+                f.write(byte_string_buffer)
+            f.close()
+            self.gzip_data = out.getvalue()
+
+    def set_link_annotation(self, 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('\\', '/')
+        if path.startswith(r'\\'):
+            self.file_path = "file://" + path.replace('\\', '/')
+        elif path.startswith(r'https') or path.startswith(r'http://'):
+            self.file_path = path
         else:
             self.level = 'error'
-            self.description = 'Invalid network file path given:' + file_path
+            self.description = 'Invalid path given:' + path
 
     def write_xml(self, parent_element, dom):
         annotation = dom.createElement("annotation")
@@ -84,10 +87,11 @@ def write_xml(self, parent_element, dom):
                 annotation.setAttribute("link_file", "true")
                 annotation.setAttribute("file", self.file_path)
             else:
-                annotation.setAttribute("link_file", "false")
                 annotation.setAttribute("file", self.file_path)
-                annotation.setAttribute("mime_type", self.mimeType)
-                if self.gzip_data is not None:
+
+        if self.gzip_data is not None:
+                    annotation.setAttribute("link_file", "false")
+                    annotation.setAttribute("mime_type", self.mimeType)
                     b64_data = base64.b64encode(self.gzip_data)
                     b64_data_string = b64_data.decode()
                     cdata = dom.createCDATASection(b64_data_string)
@@ -143,21 +147,23 @@ def add_error_annotation(self, message):
         ta = self.add_text_annotation('Error', 'error')
         ta.description = message
 
-    def add_custom_data(self, name, value):
-        d = CustomData(name, value)
-        self.custom_data.append(d)
-        return d
-
     def add_file_annotation(self, name, level='info', description='',
                             file_path=None, mime_type='text/plain'):
         fa = Annotation(name, level, description)
-        fa.add_file_annotation(file_path, mime_type)
+        fa.set_file_annotation(file_path, mime_type)
+        self.annotations.append(fa)
+        return fa
+
+    def add_string_buffer_annotation(self, name, level='info', description='',
+                                     string_buffer=None, mime_type='text/plain'):
+        fa = Annotation(name, level, description)
+        fa.set_file_annotation(string_buffer=string_buffer, mime_type='text/plain')
         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)
+    def add_link_annotation(self, level='info', description='', path=None):
+        fa = Annotation(path, level, description)
+        fa.set_link_annotation(path)
         self.annotations.append(fa)
         return fa
 
@@ -166,6 +172,11 @@ def add_text_annotation(self, name, level='info', description=''):
         self.annotations.append(ta)
         return ta
 
+    def add_custom_metric(self, name, value):
+        d = CustomData(name, value)
+        self.custom_data.append(d)
+        return d
+
     def add_annotation(self, annotation):
         self.annotations.append(annotation)
 
@@ -200,21 +211,28 @@ def add_test_suite(self, name):
         self.sub_suites[str(name)] = new_suite
         return new_suite
 
-    def add_custom_data(self, name, value):
+    def add_custom_metric(self, name, value):
         d = CustomData(name, value)
         self.custom_data.append(d)
         return d
 
     def add_file_annotation(self, name, level='info', description='',
                             file_path=None, mime_type='text/plain'):
         fa = Annotation(name, level, description)
-        fa.add_file_annotation(file_path, mime_type)
+        fa.set_file_annotation(file_path, mime_type)
+        self.annotations.append(fa)
+        return fa
+
+    def add_string_buffer_annotation(self, name, level='info', description='',
+                                     string_buffer=None, mime_type='text/plain'):
+        fa = Annotation(name, level, description)
+        fa.set_file_annotation(string_buffer=string_buffer, mime_type='text/plain')
         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)
+    def add_link_annotation(self, level='info', description='', path=None):
+        fa = Annotation(path, level, description)
+        fa.set_link_annotation(path)
         self.annotations.append(fa)
         return fa
 
diff --git a/setup.py b/setup.py
@@ -0,0 +1,19 @@
+from setuptools import setup, find_packages
+
+setup(
+    name='testspace_api',
+    version='',
+    packages=find_packages(),
+    url='',
+    license='',
+    author='jaschultz',
+    author_email='',
+    description='',
+    install_requires=[
+        'lxml',
+        'pytest',
+        'pytest-cov',
+        'flake8',
+        'pep8-naming',
+    ]
+)
diff --git a/tests/test_testspace_report.py b/tests/test_testspace_report.py
@@ -11,9 +11,24 @@ def create_simple_testspace_xml(self):
         ('annotation info example', 'info', 'description of annotation'),
         ('aannotation error example', 'error', 'to confirm order of annotations')]
 
+    string_buffer = 'Text content to be displayed in Testspace\n' \
+                    'Additional line of content'
+
+    test_annotation = testspace_xml.Annotation('annotation with comment')
+    test_annotation.add_comment("comment", "annotation comment")
+
     testspace_report = testspace_xml.TestspaceReport()
 
     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(
+        'Suite string annotation as file', string_buffer=string_buffer)
+    example_suite.add_text_annotation(
+        'Suite Text Annotation', description='This is a string annotation only')
+    example_suite.add_file_annotation('tests/report_v1.xsd', file_path='tests/report_v1.xsd')
+    example_suite.add_custom_metric('suite stats', '0, 3, 4')
+    example_suite.add_annotation(test_annotation)
+
     test_case = testspace_xml.TestCase('passing case 1', 'passed')
     for annotation in self.annotation_tuple:
         test_case.add_text_annotation(
@@ -23,17 +38,20 @@ def create_simple_testspace_xml(self):
     test_case = testspace_xml.TestCase('passing case 2', 'passed')
     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_string_buffer_annotation(
+        'Case string annotation as file', string_buffer=string_buffer)
+    test_case.add_link_annotation(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')
     test_case.fail('failing testcase')  # adds annotation to testcase
+    test_case.add_custom_metric('suite stats', '0, 3, 4')
+    test_case.add_annotation(test_annotation)
     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')
@@ -55,6 +73,14 @@ 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
+
+    def test_number_testsuite_annotations(self):
+        test_cases = self.testspace_xml_root.xpath("//test_suite/annotation")
+        assert len(test_cases) is 5
+
     def test_number_testcases(self):
         test_cases = self.testspace_xml_root.xpath("//test_suite/test_case")
         assert len(test_cases) is 3
@@ -67,15 +93,15 @@ def test_number_failed_testcases(self):
         test_cases = self.testspace_xml_root.xpath("//test_suite/test_case[@status='failed']")
         assert len(test_cases) is 1
 
-    def test_number_annotations(self):
+    def test_number_testcase_annotations(self):
         test_cases = self.testspace_xml_root.xpath("//test_suite/test_case/annotation")
-        assert len(test_cases) is 11
+        assert len(test_cases) is 12
 
-    def test_number_file_annotations(self):
+    def test_number_testcase_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):
+    def test_number_testcase_annotation_comments(self):
         test_cases = self.testspace_xml_root.xpath("//test_suite/test_case/annotation/comment")
         assert len(test_cases) is 1
 
diff --git a/tox.ini b/tox.ini
@@ -0,0 +1,9 @@
+[testenv]
+deps=lxml
+     pytest
+     pytest-cov
+     flake8
+     pep8-naming
+
+commands=py.test tests --junit-xml=testresults.xml --cov-report term --cov-report xml:coverage.xml  --cov {envsitepackagesdir}/python_testspace_xml --cov-config .coveragerc
+    flake8 --max-line-length=120 --output-file=flake8.txt --exit-zero

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# .coveragerc to control coverage.py`
	`2`	`+[run]`
	`3`	`+branch = True`