Merge lp:~jml/pkgme-devportal/explicit-copyright into lp:pkgme-devportal

[Jonathan Lange]

Provide an explicit copyright message for PDF and binary packages

This branch sets the copyright message for binary & PDF files as per
bug 1026121. See especially <https://bugs.launchpad.net/pkgme-devportal/+bug/1026121/comments/6>.

Implementation approach is pretty standard. It requires an as-yet-unreleased
version of pkgme in order to get the ExplicitCopyright info element.

While here, I cleaned up some of mvo's weird dict formatting and some trailing
whitespace business.

[James Westby (james-w)]

review: Approve

[ISD Branch Mangler (isd-branches-mangler)]

The attempt to merge lp:~jml/pkgme-devportal/explicit-copyright into lp:pkgme-devportal failed. Below is the output from the failed tests.

./bin/py -m testtools.run devportalbinary.tests.test_suite

Tree is up to date at revision 9 of branch bzr+ssh://bazaar.launchpad.net/+branch/ca-download-cache
Traceback (most recent call last):
  File "/usr/lib/python2.7/runpy.py", line 162, in _run_module_as_main
    "__main__", fname, loader, pkg_name)
  File "/usr/lib/python2.7/runpy.py", line 72, in _run_code
    exec code in run_globals
  File "/tmp/eggs/testtools-0.9.16-py2.7.egg/testtools/run.py", line 332, in <module>
    main(sys.argv, sys.stdout)
  File "/tmp/eggs/testtools-0.9.16-py2.7.egg/testtools/run.py", line 329, in main
    program = TestProgram(argv=argv, testRunner=runner, stdout=stdout)
  File "/tmp/eggs/testtools-0.9.16-py2.7.egg/testtools/run.py", line 155, in __init__
    self.parseArgs(argv)
  File "/tmp/eggs/testtools-0.9.16-py2.7.egg/testtools/run.py", line 232, in parseArgs
    self.createTests()
  File "/tmp/eggs/testtools-0.9.16-py2.7.egg/testtools/run.py", line 241, in createTests
    self.module)
  File "/usr/lib/python2.7/unittest/loader.py", line 128, in loadTestsFromNames
    suites = [self.loadTestsFromName(name, module) for name in names]
  File "/usr/lib/python2.7/unittest/loader.py", line 113, in loadTestsFromName
    test = obj()
  File "devportalbinary/tests/__init__.py", line 21, in test_suite
    tests.addTests(loader.loadTestsFromNames(module_names))
  File "/usr/lib/python2.7/unittest/loader.py", line 128, in loadTestsFromNames
    suites = [self.loadTestsFromName(name, module) for name in names]
  File "/usr/lib/python2.7/unittest/loader.py", line 100, in loadTestsFromName
    parent, obj = obj, getattr(obj, part)
AttributeError: 'module' object has no attribute 'test_metadata'
make: *** [test] Error 255

[lp:~jml/pkgme-devportal/explicit-copyright]

95. By Jonathan Lange on 2012-08-23

Guard ExplicitCopyright in test code too.

=== modified file 'devportalbinary/binary.py'
--- devportalbinary/binary.py	2012-07-26 12:48:35 +0000
+++ devportalbinary/binary.py	2012-08-23 10:52:08 +0000
@@ -354,6 +354,21 @@
         executable = guess_executable(package_name, iter_executables(self.path))
         return '/opt/%s/%s' % (package_name, executable)
 
+    def get_explicit_copyright(self, metadata):
+        # See https://bugs.launchpad.net/pkgme-devportal/+bug/1026121/.
+        maintainer = self.get_maintainer(metadata)
+        if maintainer:
+            maintainer_suffix = (
+                " or contact the submitter of the application, %s" % (
+                    maintainer,))
+        else:
+            maintainer_suffix = ''
+        return """\
+Please see the individual files in this archive for the exact copyright holders%s.
+
+This file was automatically generated.
+""" % (maintainer_suffix,)
+
     def get_extra_targets(self, metadata):
         package_name = self.get_package_name(metadata)
         return guess_extra_debian_rules_targets(package_name, self.path)

=== modified file 'devportalbinary/metadata.py'
--- devportalbinary/metadata.py	2012-07-25 08:59:43 +0000
+++ devportalbinary/metadata.py	2012-08-23 10:52:08 +0000
@@ -50,6 +50,18 @@
 from .utils import get_latest_stable_ubuntu_distroseries
 
 
+# Temporary conditional code to allow us to deploy new pkgme-devportal without
+# relying on unreleased pkgme changes.  When ExplicitCopyright is in a
+# releasea version of pkgme, we should bump our minimum dependency to that
+# released version and delete this conditional, importing ExplicitCopyright
+# directly.
+try:
+    from pkgme.info_elements import ExplicitCopyright as EC_pyflakes_sucks
+    ExplicitCopyright = EC_pyflakes_sucks
+except ImportError:
+    ExplicitCopyright = None
+
+
 # XXX: is this the right place?
 LINTIAN_OVERRIDES_TEMPLATE = """
 #Partner package contents belong in /opt
@@ -170,7 +182,7 @@
 
 def convert_icon(icon_path, new_size):
     """Takes a icon_path and converts it to the new size
-    
+
     :return: path of the newly created icon of the requested size
     """
     im = Image.open(icon_path)
@@ -184,8 +196,8 @@
 def get_icon_size_from_string(s):
     """Return a integer size from a string of the form 'WxH' ('48x48')
 
-    Raises a Value error 
-    
+    :raise ValueError: if we're given a non-square size.
+
     :return: The size of the icon.
     """
     w, h = s.split("x")
@@ -275,13 +287,15 @@
         """Return the path to the executable."""
         raise NotImplementedError(self.get_executable)
 
+    def get_explicit_copyright(self, metadata):
+        return None
+
     def get_extra_targets(self, metadata):
         """Return any extra debian/rules targets. """
         return ""
 
     def _get_lintian_overrides(self, package_name):
-        return LINTIAN_OVERRIDES_TEMPLATE % { 'package_name' : package_name, 
-                                            }
+        return LINTIAN_OVERRIDES_TEMPLATE % {'package_name' : package_name,}
 
     def get_extra_files(self, metadata, package_name):
         """Get the extra files for the package.
@@ -345,8 +359,8 @@
 
     def _ensure_required_icon_size(self, metadata, required_size):
         """ Ensure that the size "required_size" is part of the ICONS
-            metadata and create a new icon if needed. 
-            
+            metadata and create a new icon if needed.
+
             Note that this modifies metadata[self.ICONS].
         """
         icons = metadata.get(self.ICONS, {})
@@ -357,7 +371,7 @@
         new_path = convert_icon(icons[best_resolution], required_size)
         icons[required_size] = new_path
         metadata[self.ICONS] = icons
-        
+
     def _get_icon_map(self, metadata, package_name):
         """Return a dict mapping resolutions to paths.
 
@@ -448,6 +462,13 @@
             Version,
             Homepage,
             ]
+        # Temporary conditional code to allow us to deploy new pkgme-devportal
+        # without relying on unreleased pkgme changes.  When ExplicitCopyright
+        # is in a releasea version of pkgme, we should bump our minimum
+        # dependency to that released version and delete this conditional,
+        # including ExplicitCopyright in the OPTIONAL_ELEMENTS list.
+        if ExplicitCopyright:
+            OPTIONAL_ELEMENTS.append(ExplicitCopyright)
         info = {}
         for element in COMPULSORY_ELEMENTS:
             info[element] = self._calculate_info_element(element, metadata)

=== modified file 'devportalbinary/pdf.py'
--- devportalbinary/pdf.py	2012-03-30 18:46:30 +0000
+++ devportalbinary/pdf.py	2012-08-23 10:52:08 +0000
@@ -15,6 +15,20 @@
     def get_build_depends(self, metadata):
         return 'debhelper (>=7)'
 
+    def get_explicit_copyright(self, metadata):
+        # See https://bugs.launchpad.net/pkgme-devportal/+bug/1026121/.
+        maintainer = self.get_maintainer(metadata)
+        if maintainer:
+            maintainer_suffix = (
+                " or contact the submitter of the PDF, %s" % (maintainer,))
+        else:
+            maintainer_suffix = ''
+        return """\
+Please see the enclosed PDF file for the exact copyright holders%s.
+
+This file was automatically generated.
+""" % (maintainer_suffix,)
+
     def get_depends(self, metadata):
         return 'xdg-utils, ${misc:Depends}'
 

=== modified file 'devportalbinary/tests/test_binary.py'
--- devportalbinary/tests/test_binary.py	2012-08-10 15:32:32 +0000
+++ devportalbinary/tests/test_binary.py	2012-08-23 10:52:08 +0000
@@ -260,7 +260,6 @@
 
     def test_guess_dependencies_error_on_unknown_dependency(self):
         self.useFixture(DatabaseConfig(self.db_fixture))
-        db = PackageDatabase(self.db_fixture.conn)
         e = self.assertRaises(UnknownDependency,
                 guess_dependencies, get_test_data_dir_path('hello'))
         self.assertEqual('Can\'t find dependency for "libc.so.6".', str(e))
@@ -400,3 +399,25 @@
                     package_name, package_name, ld_search_path[0])),
             guess_extra_debian_rules_targets(
                 package_name, path, lambda l: ld_search_path))
+
+    def test_copyright_no_maintainer(self):
+        metadata = self.make_metadata()
+        backend = self.make_backend()
+        expected = """\
+Please see the individual files in this archive for the exact copyright holders.
+
+This file was automatically generated.
+"""
+        self.assertEqual(expected, backend.get_explicit_copyright(metadata))
+
+    def test_copyright_with_maintainer(self):
+        metadata = self.make_metadata()
+        submitter = 'Jonathan Lange <[e-mail]>'
+        metadata[MetadataBackend.MAINTAINER] = submitter
+        backend = self.make_backend()
+        expected = """\
+Please see the individual files in this archive for the exact copyright holders or contact the submitter of the application, %s.
+
+This file was automatically generated.
+""" % (submitter,)
+        self.assertEqual(expected, backend.get_explicit_copyright(metadata))

=== modified file 'devportalbinary/tests/test_metadata.py'
--- devportalbinary/tests/test_metadata.py	2012-08-10 15:37:50 +0000
+++ devportalbinary/tests/test_metadata.py	2012-08-23 10:52:08 +0000
@@ -26,7 +26,11 @@
     DEBIAN_DIR,
     )
 from pkgme.testing import AreDesktopValuesFor
-from testtools import TestCase
+from testtools import (
+    skipUnless,
+    TestCase,
+    try_import,
+    )
 from treeshape import FileTree
 
 from devportalbinary.metadata import (
@@ -43,6 +47,13 @@
     MetadataFixture,
     )
 
+# Temporary conditional code to allow us to deploy new pkgme-devportal without
+# relying on unreleased pkgme changes.  When ExplicitCopyright is in a
+# releasea version of pkgme, we should bump our minimum dependency to that
+# released version and delete this conditional, importing ExplicitCopyright
+# directly.
+ExplicitCopyright = try_import('pkgme.info_element.ExplicitCopyright')
+
 
 class DummyBackend(MetadataBackend):
     """Dummy implementations of MetadataBackend's abstract methods."""
@@ -309,6 +320,14 @@
         backend = self.make_backend()
         self.assertEqual(maintainer, backend.get_info(metadata)[Maintainer])
 
+    @skipUnless(ExplicitCopyright, "pkgme doesn't support explicit copyright")
+    def test_copyright(self):
+        metadata = self.make_metadata()
+        backend = self.make_backend()
+        info = backend.get_info(metadata)
+        marker = object()
+        self.assertIs(marker, info.get(ExplicitCopyright, marker))
+
     def test_homepage(self):
         metadata = self.make_metadata()
         homepage = 'http://www.pkgme-rocks.com/'

=== modified file 'devportalbinary/tests/test_pdf.py'
--- devportalbinary/tests/test_pdf.py	2012-08-10 15:55:46 +0000
+++ devportalbinary/tests/test_pdf.py	2012-08-23 10:52:08 +0000
@@ -104,3 +104,25 @@
         self.assertEqual(
             '/usr/bin/xdg-open /opt/%s/%s' % (package_name, 'foo.pdf'),
             executable)
+
+    def test_copyright_no_maintainer(self):
+        metadata = self.make_metadata()
+        backend = self.make_backend()
+        expected = """\
+Please see the enclosed PDF file for the exact copyright holders.
+
+This file was automatically generated.
+"""
+        self.assertEqual(expected, backend.get_explicit_copyright(metadata))
+
+    def test_copyright_with_maintainer(self):
+        metadata = self.make_metadata()
+        submitter = 'Jonathan Lange <[e-mail]>'
+        metadata[MetadataBackend.MAINTAINER] = submitter
+        backend = self.make_backend()
+        expected = """\
+Please see the enclosed PDF file for the exact copyright holders or contact the submitter of the PDF, Jonathan Lange <[e-mail]>.
+
+This file was automatically generated.
+"""
+        self.assertEqual(expected, backend.get_explicit_copyright(metadata))