Support continuous integration

.gitignore

@@ -1,11 +1,62 @@
+### Python template
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
 build/
+develop-eggs/
 dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+.hypothesis/
+.pytest_cache/
+
+# IntelliJ project files
+.idea
+*.iml
+out
+
 .pytest_cache/**
 .eggs/**
 *.egg-info/**
 **/.pytest_cache/**
 **/__pycache__/**
 fmfexporter.log
-.idea
 **/.pyc
-venv

.travis.yml

@@ -0,0 +1,45 @@
+sudo: false
+language: python
+python:
+ - "3.6"
+ #- "3.7-dev"
+
+install:
+ - pip install wheel codecov coverage tox-travis
+ - python setup.py bdist_wheel
+ - pip install ./dist/fmfexporter-*.whl
+
+stages:
+  - name: tests
+  - name: deploy
+
+jobs:
+  fast_finish: true
+  include:
+    - stage: tests
+      script: tox
+      after_script:
+        - codecov
+    - stage: deploy
+      name: "Deploy fmfexporter to Test PyPi"
+      python: 3.6
+      install: true
+      script: skip
+      after_success: true
+      deploy:
+        - provider: pypi
+          user: rh-messaging-qe
+          server: https://testpypi.python.org/pypi
+          password:
+            secure: "TFxPZnlE6piKSv8EbLxX4yrlyuIFuEjzvNA/aEXSqpq3qTLJtEBDdfzLyIqXLW5UFtmKsjPur/L5cdrVN+5Pw5yHdxWA7amUpm60GOf7J3Kk9RcSbfEZ2wISWuhSqIbEeounIiuRcleClPysiZOrLc9sqWXqDUjT4IxDvMIlJy3/4FIRG+0Vbj2NktMsaj0v2Byp34Ju174mFDSA/UgIw78vj4F6OEI2f18DUx17MPOFXMc9klFeGCmlM1Je1cnFIlKX/YaasHXsxeLXu+y0btACORKAAVmOkFRPt3vgxgqBw3T2I1u10Ufbj9xySLBMcXxeYJMmQGursOxAI6lXPZ3TgKPigqERb1+0XJeftr+7+b3lVcAFpa6IthIAfUed51UcmvtJEzWzj1jv5AaDYbpaK4wWrX/Rgxh7tEIJ93GxF+5D6oHyqM7bDxEzSNt4wnq83DKyE1Imq2o+9Ks/jmrT8Vk0j8yUf+BKDLuRJwjP0ZJhmpF3EBihG/DC7VXgs/a7k2DPHwi0cn8tOSlz2meDsHG6wbOVKTr9iS7uDe/MJSJRzDR5Cnbk4bM7mLJ4qm3uI42pJgEPyr3CnKZBkvMnQ+9RDNDzDp+hyhx+tlKq3EpGf/Sf68gyNLT7ACgX08om8CshXxR52JeIbF6cb5xS2UUHvHfolNvPDnvk0UA="
+          distributions: bdist_wheel
+          on:
+            all_branches: true
+        - provider: pypi
+          user: rh-messaging-qe
+          password:
+            secure: "hYxFSBJBKcYYmU/dfKzjLCh6Gpw8X2pCIQls0HTcm1wmuYa9O+HGxQivwhLWmaJAjIkdfGAQmUCF1h7H5nDQUQj/FxSZN00qwQY+vPanu0XcJ6aIv4yobM1Z67w2mylYJNQRk10qiDQ5Xm+p+cbBFgNcgrQfFkwvlN3JmuIzhIl0+iVo+mIPQu6xiXDT5Lxus6yKIhG9UNhkdytV1R2KLBKn5sOu5bUYsC6Ayqn0yyro+ncab2IMfeMFDscMNVLDk75S4JD+FzIcRGxUjg32SixTFMUvbdRBbxgupB7DQDhX+De7rHWWp8hRyMylxBFvmHE17drq3Vv57a8gA/pIS/CytTlWxPUsI5rbnznoyCxiqmE4S7QBex/Pp6ZcE14oZD6YYPS1cbzYy/JU0QpLrruqcDyklOIjRYeDASZFbwhBX9gvB+Ve9G9SlPmDzrITPxQiGh0ud/1UkQZl/j3WuQ2hiXIpvMOVK0DBb0uMWEKd9iAQcSFMKE/v+bO4reIx3fSXQ+W4zAc2EWDknusesnK9fFH1nJZl53Zv9qY3nGuh3xqnY0FZl77prnhRNR/HXzFVGvL/gHnzNzSWhrxxdPkIHcMFGu0wpWxFzxbIWTLduFPsR+GCOn/8277JSjf1dcl8UDhhlVQ5XeLSDst52/lIw+yo59g0ResRYVROF4k="
+          distributions: bdist_wheel
+          on:
+            branch: master
+            tags: true

Makefile

@@ -21,6 +21,6 @@ upload:
 
 clean:
 	python setup.py clean
-	rm -rf build dist fmfexporter.egg-info .eggs
+	rm -rf build dist fmfexporter.egg-info .eggs .tox
 	find . -type f -name "*.py[co]" -delete
 	find . -type d -name "__pycache__" -delete

README.md

@@ -1,5 +1,8 @@
 # fmfexporter
 
+[![Build Status](https://img.shields.io/travis/rh-messaging-qe/fmfexporter.svg?style=for-the-badge)](https://travis-ci.org/rh-messaging-qe/fmfexporter)
+[![Code coverage](https://img.shields.io/codecov/c/github/rh-messaging-qe/fmfexporter.svg?style=for-the-badge)](https://codecov.io/gh/rh-messaging-qe/fmfexporter)	
+
 FMF (Flexible Metadata Format) test case exporter tool.
 
 This tool can be used to convert and export Test Cases defined
@@ -13,7 +16,7 @@ Format for defining the test case is YAML (Simple example available -- *WIP* --
 
 ## Pre-requisites
 
-* python 3.6+
+* Python 3.6+
 * recommended to install fmfexporter or its requirements in a virtualenv
 
 ## Usage

setup.cfg

@@ -1,5 +1,6 @@
 [aliases]
 test = pytest
+
 [tool:pytest]
 addopts = -s -vvv
-python_files = test/*.py
+python_files = tests/*.py

setup.py

@@ -14,14 +14,15 @@
     install_requires=['fmf', 'requests', 'urllib3'],
     setup_requires=['pytest-runner', 'fmf', 'requests', 'urllib3'],
     tests_require=['pytest'],
-    author="Fernando Giorgetti, Dominik Lenoch",
-    author_email="fgiorget@redhatcom, [email protected]",
+    author='Fernando Giorgetti, Dominik Lenoch',
+    author_email='fgiorget@redhatcom, [email protected]',
     license="Apache-2.0",
     description="Flexible Metadata Format test-case exporter tool",
     long_description=long_description,
     long_description_content_type="text/markdown",
     url="https://github.com/rhmessagingqe/fmfexporter",
-    packages=setuptools.find_packages(),
+    packages=setuptools.find_packages(where="src"),
+    package_dir={'': 'src'},
     provides=['fmfexporter'],
     classifiers=[
         "Programming Language :: Python :: 3.6",

fmfexporter/__init__.py → src/fmfexporter/__init__.py

@@ -1,2 +1,4 @@
 from fmfexporter.fmf_testcase import FMFTestCase
 from fmfexporter.fmf_adapter import FMFAdapter
+
+__all__ = ['FMFTestCase', 'FMFAdapter']

fmfexporter/adapters/__init__.py → src/fmfexporter/adapters/__init__.py

@@ -2,4 +2,6 @@
 # All concrete adapters should be imported here, otherwise they
 # won't be recognized as subclasses of FMFAdapter (__subclasses__()).
 #
-from fmfexporter.adapters.polarion.fmf_adapter_polarion import *
+from fmfexporter.adapters.polarion.fmf_adapter_polarion import FMFAdapterPolarion
+
+__all__ = ['FMFAdapterPolarion']

fmfexporter/adapters/polarion/args/polarion_args_parser.py → src/fmfexporter/adapters/polarion/args/polarion_args_parser.py

@@ -4,10 +4,12 @@
 
 from fmfexporter.adapters.polarion.utils.polarion_config import PolarionConfig
 from fmfexporter.fmf_adapter import FMFAdapterArgParser
+
 """
 Argument parser for the FMF Polarion Adapter.
 """
 
+
 class PolarionArgParser(FMFAdapterArgParser):
     """
     Argument parser that is used when polarion adapter is selected.

fmfexporter/adapters/polarion/polarion_test_case.py → src/fmfexporter/adapters/polarion/polarion_test_case.py

@@ -1,6 +1,6 @@
 from fmfexporter import FMFTestCase
 import re
-import xml.etree.ElementTree as etree
+import xml.etree.ElementTree as ElTree
 from xml.dom import minidom
 
 from fmfexporter.adapters.polarion.utils.polarion_xml import PolarionXmlUtils
@@ -16,7 +16,7 @@ class PolarionTestCase(object):
     """
     # Used to define file name for test case based on
     # classname.name (keeping just characters, numbers and dot)
-    RE_FILE_NAME = re.compile(r'[^A-Za-z0-9_\.]')
+    RE_FILE_NAME = re.compile(r'[^A-Za-z0-9_.]')
 
     #
     # Regular expression used to match user part of an e-mail address
@@ -172,18 +172,18 @@ def to_xml(self):
         on current state of this instance.
         :return: str representing the test case xml
         """
-        xmltree = etree.ElementTree(element=etree.Element('testcases'))
+        xmltree = ElTree.ElementTree(element=ElTree.Element('testcases'))
 
         # root element - testcases and attributes
         xmlroot = xmltree.getroot()
         xmlroot.attrib['project-id'] = self.project
 
         # properties
-        properties = etree.SubElement(xmlroot, 'properties')
+        properties = ElTree.SubElement(xmlroot, 'properties')
         PolarionXmlUtils.new_property_sub_element(properties, 'lookup-method', self.lookup_method)
 
         # testcase and attributes
-        tc = etree.SubElement(xmlroot, 'testcase')
+        tc = ElTree.SubElement(xmlroot, 'testcase')
         tc.set('assignee-id', self.assignee)
         if self.approvals:
             tc.set('approver-ids', ",".join([ap + ":approved" for ap in self.approvals]))
@@ -192,11 +192,11 @@ def to_xml(self):
 
         # testcase child elements
         # testcase/title
-        tc_title = etree.SubElement(tc, 'title')
+        tc_title = ElTree.SubElement(tc, 'title')
         tc_title.text = self.title
 
         # testcase/description
-        tc_description = etree.SubElement(tc, 'description')
+        tc_description = ElTree.SubElement(tc, 'description')
         tc_description.text = PolarionTestCase.DESC_PREFIX_SUFFIX
         if self.description:
             tc_description.text += "<br>"
@@ -205,7 +205,7 @@ def to_xml(self):
             tc_description.text += PolarionTestCase.DESC_PREFIX_SUFFIX
 
         # testcase/custom-fields
-        tc_custom = etree.SubElement(tc, 'custom-fields')
+        tc_custom = ElTree.SubElement(tc, 'custom-fields')
         PolarionXmlUtils.new_custom_field(tc_custom, 'casecomponent', self.component)
         PolarionXmlUtils.new_custom_field(tc_custom, 'subcomponent', self.sub_component)
         PolarionXmlUtils.new_custom_field(tc_custom, 'testtype', self.type)
@@ -218,15 +218,17 @@ def to_xml(self):
 
         # testcase/linked-work-items
         if self.verifies:
-            tc_linked = etree.SubElement(tc, 'linked-work-items')
-            for verify in [verify for verify in self.verifies if isinstance(verify, dict)]:
-                PolarionXmlUtils.new_linked_work_item(tc_linked,
-                                                      verify.get('polarion', verify.get('jira', '')),
-                                                      'verifies')
+            tc_linked = ElTree.SubElement(tc, 'linked-work-items')
+            for verify in [verify for verify in self.verifies
+                           if isinstance(verify, dict)]:
+                PolarionXmlUtils.new_linked_work_item(
+                    tc_linked,
+                    verify.get('polarion', verify.get('jira', '')),
+                    'verifies')
 
         # testcase/test-steps
         if self.steps:
-            tc_steps = etree.SubElement(tc, 'test-steps')
+            tc_steps = ElTree.SubElement(tc, 'test-steps')
 
             # If test case has parameters, add them
             if self.parameters:
@@ -235,6 +237,6 @@ def to_xml(self):
             for step in self.steps:
                 PolarionXmlUtils.new_test_step(tc_steps, step.step, step.result)
 
-        xml_str = minidom.parseString(etree.tostring(xmlroot)).toprettyxml()
+        xml_str = minidom.parseString(ElTree.tostring(xmlroot)).toprettyxml()
 
         return xml_str