Merge pull request #6 from codacy/add-coverage

Add coverage

Author: Rodrigo Fernandes

Makefile

@@ -7,7 +7,20 @@ install: build
 	python setup.py develop
 
 test: pep8 pyflakes
+	sed 's?\$$1?'`pwd`'?' tests/filepath/cobertura.xml.tpl > tests/filepath/cobertura.xml
 	python setup.py test
+	rm tests/filepath/cobertura.xml || true
+
+test-all:
+	tox
+
+coverage:
+	rm coverage.xml || true
+	sed 's?\$$1?'`pwd`'?' tests/filepath/cobertura.xml.tpl > tests/filepath/cobertura.xml
+	coverage run --source src/codacy/ setup.py test
+	rm tests/filepath/cobertura.xml || true
+	coverage xml
+	python-codacy-coverage -r coverage.xml
 
 # requires "pip install pep8"
 pep8:

README.rst

@@ -3,13 +3,19 @@ python-codacy-coverage
 
 Credits to Ryan for creating this! Python coverage reporter for Codacy https://www.codacy.com
 
+.. image:: https://api.codacy.com/project/badge/grade/3a8cf06a9db94d0ab3d55e0357bc8f9d
+   :target: https://www.codacy.com/app/Codacy/python-codacy-coverage
+   :alt: Codacy Badge
+.. image:: https://api.codacy.com/project/badge/coverage/3a8cf06a9db94d0ab3d55e0357bc8f9d
+   :target: https://www.codacy.com/app/Codacy/python-codacy-coverage
+   :alt: Codacy Badge
 .. image:: https://circleci.com/gh/codacy/python-codacy-coverage.png?style=shield&circle-token=:circle-token
    :target: https://circleci.com/gh/codacy/python-codacy-coverage
    :alt: Build Status
-.. image:: https://www.codacy.com/project/badge/3a8cf06a9db94d0ab3d55e0357bc8f9d
-   :target: https://www.codacy.com/app/Codacy/python-codacy-coverage
-   :alt: Codacy Badge
-
+.. image:: https://badge.fury.io/py/codacy-coverage.svg
+   :target: https://badge.fury.io/py/codacy-coverage
+   :alt: PyPI version
+   
 Setup
 -----
 

circle.yml

@@ -0,0 +1,16 @@
+machine:
+  python:
+    version: 2.7.10
+
+dependencies:
+  post:
+    - sudo pip install pep8 --upgrade
+    - sudo pip install pyflakes
+    - sudo pip install coverage
+    - sudo pip install virtualenv==12.0.2
+
+test:
+  override:
+    - make test-all
+    - make install
+    - make coverage

setup.py

@@ -34,7 +34,7 @@
 
         'License :: OSI Approved :: MIT License',
 
-        'Programming Language :: Python :: 2',
+        'Programming Language :: Python :: 2.7',
         'Programming Language :: Python :: 3',
     ],
 

src/codacy/__init__.py

@@ -1,4 +1,5 @@
-import reporter
+from __future__ import absolute_import
+from . import reporter
 
 
 def main():

src/codacy/reporter.py

@@ -5,7 +5,6 @@
 import logging
 import os
 from xml.dom import minidom
-
 import requests
 
 logging.basicConfig(level=logging.INFO,
@@ -20,11 +19,45 @@
 def get_git_revision_hash():
     import subprocess
 
-    return subprocess.check_output(['git', 'rev-parse', 'HEAD']).strip()
+    return subprocess.check_output(['git', 'rev-parse', 'HEAD']).decode("utf-8").strip()
+
+
+def get_git_directory():
+    import subprocess
+
+    return subprocess.check_output(['git', 'rev-parse', '--show-toplevel']).decode("utf-8").strip()
+
+
+def file_exists(rootdir, filename):
+    for root, subFolders, files in os.walk(rootdir):
+        if filename in files:
+            return True
+        else:
+            for subFolder in subFolders:
+                return file_exists(subFolder, filename)
+            return False
+
+
+def generate_filename(sources, filename):
+    def strip_prefix(line, prefix):
+        if line.startswith(prefix):
+            return line[len(prefix):]
+        else:
+            return line
+
+    git_directory = get_git_directory()
+
+    for source in sources:
+        if file_exists(source, filename):
+            return strip_prefix(source, git_directory).strip("/") + "/" + filename.strip("/")
+
+    return filename
 
 
 def parse_report_file(report_file):
-    """Parse XML file and POST it to the Codacy API"""
+    """Parse XML file and POST it to the Codacy API
+    :param report_file:
+    """
 
     # Convert decimal string to floored int percent value
     def percent(s):
@@ -39,10 +72,11 @@ def percent(s):
         'fileReports': [],
     }
 
+    sources = [x.firstChild.nodeValue for x in report_xml.getElementsByTagName('source')]
     classes = report_xml.getElementsByTagName('class')
     for cls in classes:
         file_report = {
-            'filename': cls.attributes['filename'].value,
+            'filename': generate_filename(sources, cls.attributes['filename'].value),
             'total': percent(cls.attributes['line-rate'].value),
             'coverage': {},
         }

tests.py

@@ -4,17 +4,33 @@
 
 
 class ReporterTests(unittest.TestCase):
-
-    def test_parser(self):
+    def compare_parse_result(self, generated_filename, expected_filename):
         def file_get_contents(filename):
             with open(filename) as f:
                 return f.read()
 
-        jsonContent = file_get_contents('tests/coverage.json')
-        expected = json.loads(jsonContent)
+        generated = codacy.reporter.parse_report_file(generated_filename)
+
+        json_content = file_get_contents(expected_filename)
+        expected = json.loads(json_content)
 
-        generated = codacy.reporter.parse_report_file('tests/cobertura.xml')
         self.assertEqual(generated, expected)
 
+    def test_parser_coverage3(self):
+        self.maxDiff = None
+
+        self.compare_parse_result('tests/coverage3/cobertura.xml', 'tests/coverage3/coverage.json')
+
+    def test_parser_coverage4(self):
+        self.maxDiff = None
+
+        self.compare_parse_result('tests/coverage4/cobertura.xml', 'tests/coverage4/coverage.json')
+
+    def test_parser_git_filepath(self):
+        self.maxDiff = None
+
+        self.compare_parse_result('tests/filepath/cobertura.xml', 'tests/filepath/coverage.json')
+
+
 if __name__ == '__main__':
     unittest.main()

tests/coverage.json

@@ -0,0 +1,32 @@
+{
+  "total": 87,
+  "fileReports": [
+    {
+      "total": 87,
+      "coverage": {
+        "5": 1,
+        "4": 1,
+        "6": 2
+      },
+      "filename": "src/test/resources/TestSourceFile.scala"
+    },
+    {
+      "total": 87,
+      "coverage": {
+        "9": 1,
+        "10": 1
+      },
+      "filename": "src/test/resources/TestSourceFile.scala"
+    },
+    {
+      "total": 87,
+      "coverage": {
+        "1": 1,
+        "3": 1,
+        "2": 1
+      },
+      "filename": "src/test/resources/TestSourceFile2.scala"
+    }
+  ],
+  "language": "python"
+}