Merge lp:~allanlesage/qa-coverage-dashboard/test-jenkins-pull-coverage into lp:qa-coverage-dashboard

[Allan LeSage]

Some unit tests for util/jenkins_pull.py , in preparation for possible refaxtoring.

[Allan LeSage (allanlesage)]

Run these test by ./manage.py test gaps .

[lp:~allanlesage/qa-coverage-dashboard/test-jenkins-pull-coverage]

762. By Allan LeSage on 2014-04-09

Merge trunk, resolving conflicts.

[Chris Gagnon (chris.gagnon)]

There are some issues with code style

 gaps/tests/test_jenkins_pull.py|7 col 1| F401 'time' imported but unused
  2 gaps/tests/test_jenkins_pull.py|34 col 71| E231 missing whitespace after ','
  3 gaps/tests/test_jenkins_pull.py|45 col 61| E231 missing whitespace after ','
  4 gaps/tests/test_jenkins_pull.py|58 col 80| E231 missing whitespace after ','
  5 gaps/tests/test_jenkins_pull.py|58 col 80| E501 line too long (82 > 79 characters)
  6 gaps/tests/test_jenkins_pull.py|106 col 43| E225 missing whitespace around operator

review: Needs Fixing

[lp:~allanlesage/qa-coverage-dashboard/test-jenkins-pull-coverage]

763. By Allan LeSage on 2014-04-09

Some flake8 fixes.

764. By Allan LeSage on 2014-04-09

Last teensy #noqa for tests/__init__.py .

[Chris Gagnon (chris.gagnon)]

lgtm

review: Approve

=== modified file 'gaps/tests/__init__.py'
--- gaps/tests/__init__.py	2014-04-04 20:34:26 +0000
+++ gaps/tests/__init__.py	2014-04-09 19:08:53 +0000
@@ -1,77 +1,6 @@
 
-import datetime
-from mock import Mock
-from os import path
-
-from django.test import TestCase
-
-import common
-from gaps.models import (
-    CoverageBuild,
-    CoverageData,
-    CoverageProject,
-    CoverageStack
+from gaps.tests.test_jenkins_pull_coverage import TestJenkinsPullCoverage  # noqa
+from gaps.tests.test_jenkins_pull import (  # noqa
+    GetArtifactUrlsTestCase,
+    UrlArtifactListTestCase,
 )
-from gaps.util import add, jenkins_pull
-
-
-class TestJenkinsPullCoverage(TestCase):
-    def setUp(self):
-        self.url_list = [
-            {
-                'url': 'http://jenkins.qa.ubuntu.com/job/libqtdbustest-trusty'
-                '-i386-ci/10/artifact/work/results/coverage.xml',
-                'build_id': 10,
-                'ran_at': datetime.datetime(
-                    2014, 3, 18, 17, 31, 24)
-            }
-        ]
-
-        localdir = path.dirname(__file__)
-        with open(path.join(localdir, 'data/coverage.xml'), 'r') as f:
-            jenkins_get_data = f.read()
-        f.close()
-        self.jdata = jenkins_get_data
-
-    def test_jenkins_get_data_from_common_exists(self):
-        """Verify jenkins_get method is in common.managment"""
-        from common.management import jenkins_get  # NOQA
-
-    def test_added_data_are_correct(self):
-        jenkins_pull.url_artifact_list = Mock(return_value=self.url_list)
-        common.management.jenkins_get = Mock(return_value=self.jdata)
-        add.records(
-            'qa',
-            'libqtdbustest',
-            'libqtdbustest-trusty-amd64-ci',
-            'coverage.xml',
-        )
-
-        self.assertEquals(1, CoverageData.objects.count())
-        coveragedata = CoverageData.objects.all()[0]
-        self.assertEquals(
-            'http://jenkins.qa.ubuntu.com/job/libqtdbustest-trusty-i386-ci'
-            '/10/artifact/work/results/coverage.xml',
-            coveragedata.url
-        )
-        self.assertEquals('coverage.xml', coveragedata.name)
-        self.assertEquals('', coveragedata.xml_file)
-        self.assertEquals('0.514', str(coveragedata.branch_coverage))
-        self.assertEquals('0.884', str(coveragedata.line_coverage))
-        self.assertEquals('107', str(coveragedata.hit_count))
-        self.assertEquals('121', str(coveragedata.line_count))
-        self.assertEquals('75', str(coveragedata.taken_count))
-        self.assertEquals('146', str(coveragedata.total_count))
-
-        self.assertEquals(1, CoverageBuild.objects.count())
-        build = CoverageBuild.objects.all()[0]
-        self.assertEquals('10', str(build.build_number))
-        self.assertEquals('None', build.build_description)
-
-        self.assertEquals(1, CoverageProject.objects.count())
-        project = CoverageProject.objects.all()[0]
-        self.assertEquals('libqtdbustest', project.name)
-
-        self.assertEqual(1, CoverageStack.objects.count())
-        stack = CoverageStack.objects.all()[0]
-        self.assertEquals('qa', stack.name)

=== added file 'gaps/tests/test_jenkins_pull.py'
--- gaps/tests/test_jenkins_pull.py	1970-01-01 00:00:00 +0000
+++ gaps/tests/test_jenkins_pull.py	2014-04-09 19:08:53 +0000
@@ -0,0 +1,179 @@
+
+import datetime
+from mock import patch, MagicMock
+
+from django.test import TestCase
+
+from gaps.util.jenkins_pull import (
+    _get_artifact_urls,
+    build,
+    JenkinsAPIException,
+    job,
+    url_artifact_list,
+)
+from jenkinsapi.api import Jenkins
+
+
+class GetArtifactUrlsTestCase(TestCase):
+
+    def setUp(self):
+        jenkinsapi_build_mock = MagicMock(
+            spec=build.Build,
+            return_value=None)
+        jenkinsapi_build_patch = patch.object(
+            build.Build,
+            '__init__',
+            new=jenkinsapi_build_mock)
+        jenkinsapi_build_patch.start()
+        self.addCleanup(jenkinsapi_build_patch.stop)
+        self.jenkinsapi_build = build.Build()
+
+    def test_get_artifact_urls_can_match(self):
+        self.jenkinsapi_build.get_artifacts = MagicMock(
+            return_value=[MagicMock(url='http://foo.com/coverage.xml'), ])
+        urls = _get_artifact_urls(
+            self.jenkinsapi_build,
+            'coverage.xml')
+        self.assertEquals(['http://foo.com/coverage.xml'], urls)
+
+    def test_get_artifact_urls_is_selective(self):
+        self.jenkinsapi_build.get_artifacts = MagicMock(
+            return_value=[
+                MagicMock(url='http://foo.com/coverage.xml'),
+                MagicMock(url='http://dungeonofdelight.com/foo'),
+                MagicMock(url='http://jenkins/coverage.xml'), ])
+        urls = _get_artifact_urls(
+            self.jenkinsapi_build,
+            'coverage.xml')
+        self.assertEquals([
+            'http://foo.com/coverage.xml',
+            'http://jenkins/coverage.xml'], urls)
+
+    def test_get_artifact_urls_returns_empty_list(self):
+        self.jenkinsapi_build.get_artifacts = MagicMock(
+            return_value=[
+                MagicMock(url='http://cnn.com/this-url-has-no-match'),
+                MagicMock(
+                    url='http://zombo.com/match-is-not-possible'), ])
+        urls = _get_artifact_urls(
+            self.jenkinsapi_build,
+            'coverage.xml')
+        self.assertEquals([], urls)
+
+
+class UrlArtifactListTestCase(TestCase):
+
+    def setUp(self):
+        super(UrlArtifactListTestCase, self).setUp()
+
+        self.jenkinsapi_jenkins_mock = MagicMock(
+            spec=Jenkins)
+        jenkinsapi_jenkins_patch = patch(
+            'gaps.util.jenkins_pull.Jenkins',
+            new=self.jenkinsapi_jenkins_mock)
+        jenkinsapi_jenkins_patch.start()
+        self.addCleanup(jenkinsapi_jenkins_patch.stop)
+
+        self.jenkinsapi_job_mock = MagicMock(
+            spec=job.Job)
+        jenkinsapi_job_patch = patch(
+            'gaps.util.jenkins_pull.job.Job',
+            new=self.jenkinsapi_job_mock)
+        jenkinsapi_job_patch.start()
+        self.addCleanup(jenkinsapi_job_patch.stop)
+
+        self.jenkinsapi_build_mock = MagicMock(
+            spec=build.Build)
+        jenkinsapi_build_patch = patch(
+            'gaps.util.jenkins_pull.job.Job',
+            new=self.jenkinsapi_build_mock)
+        jenkinsapi_build_patch.start()
+        self.addCleanup(jenkinsapi_build_patch.stop)
+
+        # set up a few fake constants
+        self.fake_build_ids = [1, 2, 3]
+        self.fake_datetime = datetime.datetime.now()
+        self.fake_baseurl = 'http://www.fake-baseurl.com'
+
+        self.jenkinsapi_build_mock.get_timestamp = MagicMock(
+            return_value=self.fake_datetime
+        )
+        self.jenkinsapi_job_mock.baseurl = self.fake_baseurl
+        self.jenkinsapi_job_mock.get_build_ids = MagicMock(
+            return_value=self.fake_build_ids
+        )
+        self.jenkinsapi_job_mock.get_build = MagicMock(
+            return_value=self.jenkinsapi_build_mock
+        )
+
+        self.jenkinsapi_jenkins_mock.return_value.get_job = MagicMock(
+            return_value=self.jenkinsapi_job_mock
+        )
+
+    def test_url_artifact_list_is_correct_if_no_artifact_urls(self):
+        result = url_artifact_list(
+            'mir-trusty-amd64-ci',
+            'coverage.xml'
+        )
+        self.assertEqual(
+            [{'url': self.fake_baseurl,
+              'build_id': self.fake_build_ids[0],
+              'ran_at': self.fake_datetime},
+             {'url': self.fake_baseurl,
+              'build_id': self.fake_build_ids[1],
+              'ran_at': self.fake_datetime},
+             {'url': self.fake_baseurl,
+              'build_id': self.fake_build_ids[2],
+              'ran_at': self.fake_datetime}],
+            result)
+
+    @patch('gaps.util.jenkins_pull._get_artifact_urls')
+    def test_url_artifact_list_is_correct_if_normal_artifact_urls(
+            self, get_artifact_urls_mock):
+        get_artifact_urls_mock.return_value = [
+            'http://foo.com/coverage.xml',
+            'http://dungeonofdelight.com/foo',
+            'http://jenkins/coverage.xml',
+        ]
+        result = url_artifact_list(
+            'mir-trusty-amd64-ci',
+            'coverage.xml')
+        self.assertEqual(
+            [{'url': self.fake_baseurl,
+              'build_id': self.fake_build_ids[0],
+              'ran_at': self.fake_datetime},
+             {'url': self.fake_baseurl,
+              'build_id': self.fake_build_ids[1],
+              'ran_at': self.fake_datetime},
+             {'url': self.fake_baseurl,
+              'build_id': self.fake_build_ids[2],
+              'ran_at': self.fake_datetime}],
+            result)
+
+    def test_return_false_if_job_not_found(self):
+        self.jenkinsapi_jenkins_mock.return_value.get_job = MagicMock(
+            return_value=self.jenkinsapi_job_mock,
+            side_effect=OSError,
+        )
+        result = url_artifact_list(
+            'mir-trusty-amd64-ci',
+            'coverage.xml')
+        self.assertFalse(result)
+
+    def test_return_false_if_jenkinsapi_exception_on_get_build_ids(self):
+        jenkinsapi_job = MagicMock(
+            baseurl=self.fake_baseurl,
+            get_build_ids=MagicMock(
+                return_value=self.fake_build_ids,
+                side_effect=JenkinsAPIException
+            ),
+            get_build=MagicMock(return_value=self.jenkinsapi_build_mock)
+        )
+        self.jenkinsapi_jenkins_mock.return_value.get_job = MagicMock(
+            return_value=jenkinsapi_job
+        )
+        result = url_artifact_list(
+            'mir-trusty-amd64-ci',
+            'coverage.xml'
+        )
+        self.assertFalse(result)

=== added file 'gaps/tests/test_jenkins_pull_coverage.py'
--- gaps/tests/test_jenkins_pull_coverage.py	1970-01-01 00:00:00 +0000
+++ gaps/tests/test_jenkins_pull_coverage.py	2014-04-09 19:08:53 +0000
@@ -0,0 +1,82 @@
+import datetime
+
+import common
+
+from django.test import TestCase
+
+from gaps.models import (
+    CoverageBuild,
+    CoverageData,
+    CoverageProject,
+    CoverageStack,
+)
+from gaps.util import add, jenkins_pull
+
+from mock import Mock
+from os import path
+
+
+class TestJenkinsPullCoverage(TestCase):
+    def setUp(self):
+        self.url_list = [
+            {
+                'url': 'http://jenkins.qa.ubuntu.com/job/libqtdbustest-trusty'
+                '-i386-ci/10/artifact/work/results/coverage.xml',
+                'build_id': 10,
+                'ran_at': datetime.datetime(
+                    2014, 3, 18, 17, 31, 24)
+            }
+        ]
+
+        localdir = path.dirname(__file__)
+        with open(path.join(localdir, 'data/coverage.xml'), 'r') as f:
+            jenkins_get_data = f.read()
+        f.close()
+        self.jdata = jenkins_get_data
+
+    def test_jenkins_get_data_from_common_exists(self):
+        """Verify jenkins_get method is in common.managment"""
+        from common.management import jenkins_get
+
+    def test_jenkins_pull_coverage_add_to_database(self):
+        jenkins_pull.url_artifact_list = Mock(return_value=self.url_list)
+        common.management.jenkins_get = Mock(return_value=self.jdata)
+        add.records(
+            'qa',
+            'libqtdbustest',
+            'libqtdbustest-trusty-amd64-ci',
+            'coverage.xml',
+        )
+
+        data_result = CoverageData.objects.filter(
+            url__contains='coverage.xml').latest('coverage_build')
+
+        self.assertEquals(
+            data_result.url,
+            'http://jenkins.qa.ubuntu.com/job/libqtdbustest-trusty-i386-ci'
+            '/10/artifact/work/results/coverage.xml'
+        )
+        self.assertEquals(data_result.name, 'coverage.xml')
+        self.assertEquals(data_result.xml_file, '')
+        self.assertEquals(str(data_result.branch_coverage), '0.514')
+        self.assertEquals(str(data_result.line_coverage), '0.884')
+        self.assertEquals(str(data_result.hit_count), '107')
+        self.assertEquals(str(data_result.line_count), '121')
+        self.assertEquals(str(data_result.taken_count), '75')
+        self.assertEquals(str(data_result.total_count), '146')
+
+        build_result = CoverageBuild.objects.filter(
+            build_number='10').latest('ran_at')
+
+        self.assertEquals(str(build_result.build_number), '10')
+        self.assertEqual(build_result.build_description, 'None')
+
+        project_result = CoverageProject.objects.filter(
+            name='libqtdbustest').latest('name')
+
+        self.assertEquals(project_result.name, 'libqtdbustest')
+
+        stack_result = CoverageStack.objects.filter(
+            name='qa').latest('name')
+
+        self.assertEquals(stack_result.name, 'qa')

=== modified file 'gaps/util/jenkins_pull.py'
--- gaps/util/jenkins_pull.py	2014-03-20 21:19:09 +0000
+++ gaps/util/jenkins_pull.py	2014-04-09 19:08:53 +0000
@@ -1,6 +1,12 @@
-import jenkinsapi
+
 import time
-from jenkinsapi import *
+from jenkinsapi import (
+    #api,
+    build,
+    job,
+)
+from jenkinsapi.api import Jenkins
+from jenkinsapi.custom_exceptions import JenkinsAPIException
 from qa_dashboard.settings import JENKINS_URL
 
 
@@ -31,13 +37,13 @@
         'armhf-ci',
         'coverage.xml')
 
-    return: List of urls
+    :return: List of urls
     """
     try:
-        jenkapi = jenkinsapi.api.Jenkins(JENKINS_URL)
+        jenkapi = Jenkins(JENKINS_URL)
     except:
         time.sleep(5)
-        jenkapi = jenkinsapi.api.Jenkins(JENKINS_URL)
+        jenkapi = Jenkins(JENKINS_URL)
     try:
         job = jenkapi.get_job(jenkins_job_name)
     except: