Merge lp:~james-w/pkgme-service/review-click into lp:pkgme-service

[James Westby]

Add a job for reviewing click packages with a simple check.

Hi,

This proposal adds a simple check for click packages. We can add more
checks later when we've proved that a simple one works.

Thanks,

James

[Matias Bordese (matiasb)]

LGTM

review: Approve

[lp:~james-w/pkgme-service/review-click]

144. By James Westby on 2013-10-11

[r=matiasb] Add a job for reviewing click packages with a simple check.

=== modified file 'src/djpkgme/tasks.py'
--- src/djpkgme/tasks.py	2013-10-09 20:32:44 +0000
+++ src/djpkgme/tasks.py	2013-10-11 20:11:11 +0000
@@ -1,6 +1,7 @@
 import json
 import os
 import shutil
+import subprocess
 import sys
 import traceback
 
@@ -222,7 +223,11 @@
                 metadata.get('myapps_id', '<unknown myapps id>'),
                 metadata.get('package_url', '<unknown package url>'),
                 ))
-        job = PackageAppJob()
+        if 'click_framework' in metadata:
+            # It's a click package
+            job = ReviewClickJob()
+        else:
+            job = PackageAppJob()
         return self.run_with_error_handling(job, metadata, overrides)
 
     def run_with_error_handling(self, job, metadata, overrides):
@@ -358,6 +363,47 @@
                 output_dir, settings.PKGME_OUTPUT_DIRECTORY, package_name)
 
 
+class ReviewClickJob(object):
+
+    # The name of the directory that we store the downloaded file in.
+    DOWNLOAD_DIRECTORY_NAME = 'download'
+
+    def transform_results(self, generated_info, metadata):
+        return dict(pkgme_extra_data=generated_info)
+
+    def download_package(self, metadata, temp_dir, logger):
+        logger.info(
+            "Downloading package from %s", metadata['package_url'])
+        download_path = download_file(
+            metadata['package_url'], temp_dir)
+        logger.info(
+            "Downloaded package from %s", metadata['package_url'])
+        return download_path
+
+    def unpack_package(self, package_file, temp_dir):
+        dest = os.path.join(temp_dir, 'unpacked')
+        subprocess.check_call(['dpkg-deb', '-R', package_file, dest])
+        return dest
+
+    def run(self, metadata, overrides, logger):
+        working_dirs = []
+        results = []
+        with TempDir() as temp_dir:
+            package_file = self.download_package(metadata, temp_dir, logger)
+            unpacked = self.unpack_package(package_file)
+            results.append(self.check_package_name_matches(metadata, unpacked))
+            return results
+
+    def check_package_name_matches(self, metadata, package):
+        with open(os.path.join(package, 'DEBIAN/manifest')) as f:
+            manifest_content = json.loads(f.read())
+            passed = manifest_content['name'] == metadata['package_fullname']
+        return {
+            'description': 'Stated package name matches the manifest',
+            'passed': passed,
+        }
+
+
 class CauseOopsTask(Task):
     def run(self):
         raise AssertionError("Manually generated celery oops")

=== modified file 'src/djpkgme/tests/test_tasks.py'
--- src/djpkgme/tests/test_tasks.py	2013-10-09 20:32:44 +0000
+++ src/djpkgme/tests/test_tasks.py	2013-10-11 20:11:11 +0000
@@ -36,6 +36,7 @@
     PackageAppJob,
     prepare_icons,
     prepare_metadata,
+    ReviewClickJob,
     translate_dict,
     write_metadata,
     )
@@ -451,3 +452,57 @@
         basename = os.path.basename(output_tar_path)
         cleaned_package_name = PackageName.clean(name)
         self.assertEqual("%s.tar.gz" % cleaned_package_name, basename)
+
+
+class TestReviewClickJobIntegration(TestCaseWithFactory):
+
+    @patch('djpkgme.tasks.download_file')
+    def test_download_package(self, mock_download_file):
+        mock_download_file.return_value = 'some/path'
+        job = ReviewClickJob()
+        metadata = self.factory.make_metadata()
+        temp_dir = 'temp/dir'
+        logger = logging.getLogger()
+        returned_path = job.download_package(metadata, temp_dir, logger)
+        self.assertEqual(mock_download_file.return_value, returned_path)
+        self.assertTrue(mock_download_file.called)
+        mock_download_file.assert_called_with(metadata['package_url'],
+            temp_dir)
+
+    @patch('djpkgme.tasks.subprocess.check_call')
+    def test_unpack_package(self, mock_call):
+        job = ReviewClickJob()
+        package_file = 'some/package'
+        temp_dir = 'temp/dir'
+        unpack_path = os.path.join(temp_dir, 'unpacked')
+        returned_path = job.unpack_package(package_file, temp_dir)
+        self.assertEqual(unpack_path, returned_path)
+        mock_call.assert_called_with(
+            ['dpkg-deb', '-R', package_file, unpack_path])
+
+    def make_manifest_file(self, manifest_content, directory):
+        debian_dir = os.path.join(directory, 'DEBIAN')
+        os.mkdir(debian_dir)
+        with open(os.path.join(debian_dir, 'manifest'), 'w') as f:
+            f.write(json.dumps(manifest_content))
+
+    def test_check_package_name_matches(self):
+        job = ReviewClickJob()
+        package_name = 'some.package'
+        metadata = dict(package_fullname=package_name)
+        tempdir = self.useFixture(TempDir()).path
+        self.make_manifest_file(dict(name=package_name), tempdir)
+        result = job.check_package_name_matches(metadata, tempdir)
+        self.assertEqual(True, result['passed'])
+        self.assertEqual(
+            "Stated package name matches the manifest",
+            result['description'])
+
+    def test_check_package_name_doesnt_match(self):
+        job = ReviewClickJob()
+        package_name = 'some.package'
+        metadata = dict(package_fullname=package_name)
+        tempdir = self.useFixture(TempDir()).path
+        self.make_manifest_file(dict(name='some.other.package'), tempdir)
+        result = job.check_package_name_matches(metadata, tempdir)
+        self.assertEqual(False, result['passed'])