Merge lp:~mvo/click/lp1219912-build-exclude into lp:click

[Michael Vogt]

This branch adds a new "--ignore" option to click {build,buildsource} to fix #1219912.

[lp:~mvo/click/lp1219912-build-exclude]

431. By Michael Vogt on 2014-09-29

merged lp:click/devel

432. By Michael Vogt on 2014-09-30

merged lp:click/devel

Unmerged revisions

=== modified file 'click/build.py'
--- click/build.py	2014-05-05 13:10:19 +0000
+++ click/build.py	2014-05-14 11:49:16 +0000
@@ -83,6 +83,42 @@
 class ClickBuilderBase:
     def __init__(self):
         self.file_map = {}
+        # From @Dpkg::Source::Package::tar_ignore_default_pattern.
+        # (more in ClickSourceBuilder)
+        self._ignore_patterns = [
+            "*.click",
+            ".*.sw?",
+            "*~",
+            ",,*",
+            ".[#~]*",
+            ".arch-ids",
+            ".arch-inventory",
+            ".bzr",
+            ".bzr-builddeb",
+            ".bzr.backup",
+            ".bzr.tags",
+            ".bzrignore",
+            ".cvsignore",
+            ".git",
+            ".gitattributes",
+            ".gitignore",
+            ".gitmodules",
+            ".hg",
+            ".hgignore",
+            ".hgsigs",
+            ".hgtags",
+            ".shelf",
+            ".svn",
+            "CVS",
+            "DEADJOE",
+            "RCS",
+            "_MTN",
+            "_darcs",
+            "{arch}",
+        ]
+
+    def add_ignore_pattern(self, pattern):
+        self._ignore_patterns.append(pattern)
 
     def add_file(self, source_path, dest_path):
         self.file_map[source_path] = dest_path
@@ -132,39 +168,6 @@
 
 
 class ClickBuilder(ClickBuilderBase):
-    # TODO: This should be configurable, or at least extensible.
-    _ignore_patterns = [
-        "*.click",
-        ".*.sw?",
-        "*~",
-        ",,*",
-        ".[#~]*",
-        ".arch-ids",
-        ".arch-inventory",
-        ".be",
-        ".bzr",
-        ".bzr-builddeb",
-        ".bzr.backup",
-        ".bzr.tags",
-        ".bzrignore",
-        ".cvsignore",
-        ".git",
-        ".gitattributes",
-        ".gitignore",
-        ".gitmodules",
-        ".hg",
-        ".hgignore",
-        ".hgsigs",
-        ".hgtags",
-        ".shelf",
-        ".svn",
-        "CVS",
-        "DEADJOE",
-        "RCS",
-        "_MTN",
-        "_darcs",
-        "{arch}",
-        ]
 
     def list_files(self, root_path):
         for dirpath, _, filenames in os.walk(root_path):
@@ -295,44 +298,18 @@
 
 
 class ClickSourceBuilder(ClickBuilderBase):
-    # From @Dpkg::Source::Package::tar_ignore_default_pattern.
-    # TODO: This should be configurable, or at least extensible.
-    _ignore_patterns = [
-        "*.a",
-        "*.click",
-        "*.la",
-        "*.o",
-        "*.so",
-        ".*.sw?",
-        "*~",
-        ",,*",
-        ".[#~]*",
-        ".arch-ids",
-        ".arch-inventory",
-        ".be",
-        ".bzr",
-        ".bzr-builddeb",
-        ".bzr.backup",
-        ".bzr.tags",
-        ".bzrignore",
-        ".cvsignore",
-        ".deps",
-        ".git",
-        ".gitattributes",
-        ".gitignore",
-        ".gitmodules",
-        ".hg",
-        ".hgignore",
-        ".hgsigs",
-        ".hgtags",
-        ".shelf",
-        ".svn",
-        "CVS",
-        "DEADJOE",
-        "RCS",
-        "_MTN",
-        "_darcs",
-        "{arch}",
+
+    def __init__(self):
+        super(ClickSourceBuilder, self).__init__()
+        # From @Dpkg::Source::Package::tar_ignore_default_pattern.
+        # (more in ClickBuilderBase)
+        self._ignore_patterns += [
+            "*.a",
+            ".be",
+            ".deps",
+            "*.la",
+            "*.o",
+            "*.so",
         ]
 
     def build(self, dest_dir, manifest_path=None):

=== modified file 'click/commands/build.py'
--- click/commands/build.py	2013-12-06 11:04:47 +0000
+++ click/commands/build.py	2014-05-14 11:49:16 +0000
@@ -29,6 +29,9 @@
     parser.add_option(
         "-m", "--manifest", metavar="PATH", default="manifest.json",
         help="read package manifest from PATH (default: manifest.json)")
+    parser.add_option(
+        "-I", "--ignore", metavar="file-pattern", action='append',
+        help="Ignore the given pattern when building the package")
     options, args = parser.parse_args(argv)
     if len(args) < 1:
         parser.error("need directory")
@@ -43,6 +46,8 @@
             (directory, options.manifest))
     builder = ClickBuilder()
     builder.add_file(directory, "./")
+    for ignore in options.ignore:
+        builder.add_ignore_pattern(ignore)
     try:
         path = builder.build(".", manifest_path=options.manifest)
     except ClickBuildError as e:

=== modified file 'click/commands/buildsource.py'
--- click/commands/buildsource.py	2013-12-06 11:04:47 +0000
+++ click/commands/buildsource.py	2014-05-14 11:49:16 +0000
@@ -29,6 +29,9 @@
     parser.add_option(
         "-m", "--manifest", metavar="PATH",
         help="read package manifest from PATH")
+    parser.add_option(
+        "-I", "--ignore", metavar="file-pattern", action='append',
+        help="Ignore the given pattern when building the package")
     options, args = parser.parse_args(argv)
     if len(args) < 1:
         parser.error("need directory")
@@ -43,6 +46,8 @@
             (directory, options.manifest))
     builder = ClickSourceBuilder()
     builder.add_file(directory, "./")
+    for ignore in options.ignore:
+        builder.add_ignore_pattern(ignore)
     try:
         path = builder.build(".", manifest_path=options.manifest)
     except ClickBuildError as e:

=== modified file 'click/tests/test_build.py'
--- click/tests/test_build.py	2014-05-05 13:10:19 +0000
+++ click/tests/test_build.py	2014-05-14 11:49:16 +0000
@@ -199,38 +199,45 @@
         self.assertEqual(
             "foo", os.readlink(os.path.join(extract_path, "bin", "bar")))
 
+    def _make_scratch_dir(self, manifest_override={}):
+        self.use_temp_dir()
+        scratch = os.path.join(self.temp_dir, "scratch")
+        manifest = {
+                "name": "com.ubuntu.test",
+                "version": "1.0",
+                "maintainer": "Foo Bar <[e-mail]>",
+                "title": "test title",
+                "architecture": "all",
+                "framework": "ubuntu-sdk-13.10",
+        }
+        manifest.update(manifest_override)
+        with mkfile(os.path.join(scratch, "manifest.json")) as f:
+            json.dump(manifest, f)
+        self.builder.add_file(scratch, "/")
+        return scratch
+
     def test_build_excludes_dot_click(self):
-        self.use_temp_dir()
-        scratch = os.path.join(self.temp_dir, "scratch")
+        scratch = self._make_scratch_dir()
         touch(os.path.join(scratch, ".click", "evil-file"))
-        with mkfile(os.path.join(scratch, "manifest.json")) as f:
-            json.dump({
-                "name": "com.ubuntu.test",
-                "version": "1.0",
-                "maintainer": "Foo Bar <[e-mail]>",
-                "title": "test title",
-                "architecture": "all",
-                "framework": "ubuntu-sdk-13.10",
-            }, f)
+        path = self.builder.build(self.temp_dir)
+        extract_path = os.path.join(self.temp_dir, "extract")
+        subprocess.check_call(["dpkg-deb", "-x", path, extract_path])
+        self.assertEqual([], os.listdir(extract_path))
+
+    def test_build_ignore_pattern(self):
+        scratch = self._make_scratch_dir()
+        touch(os.path.join(scratch, "build", "foo.o"))
         self.builder.add_file(scratch, "/")
+        self.builder.add_ignore_pattern("build")
         path = self.builder.build(self.temp_dir)
         extract_path = os.path.join(self.temp_dir, "extract")
         subprocess.check_call(["dpkg-deb", "-x", path, extract_path])
         self.assertEqual([], os.listdir(extract_path))
 
     def test_build_multiple_architectures(self):
-        self.use_temp_dir()
-        scratch = os.path.join(self.temp_dir, "scratch")
-        with mkfile(os.path.join(scratch, "manifest.json")) as f:
-            json.dump({
-                "name": "com.ubuntu.test",
-                "version": "1.0",
-                "maintainer": "Foo Bar <[e-mail]>",
-                "title": "test title",
+        scratch = self._make_scratch_dir(manifest_override={
                 "architecture": ["armhf", "i386"],
-                "framework": "ubuntu-sdk-13.10",
-            }, f)
-        self.builder.add_file(scratch, "/")
+        })
         path = os.path.join(self.temp_dir, "com.ubuntu.test_1.0_multi.click")
         self.assertEqual(path, self.builder.build(self.temp_dir))
         self.assertTrue(os.path.exists(path))
@@ -245,21 +252,11 @@
             del target_json["installed-size"]
             self.assertEqual(source_json, target_json)
 
-    # FIXME: DRY violation with test_build_multiple_architectures etc
     def test_build_multiple_frameworks(self):
-        self.use_temp_dir()
-        scratch = os.path.join(self.temp_dir, "scratch")
-        with mkfile(os.path.join(scratch, "manifest.json")) as f:
-            json.dump({
-                "name": "com.ubuntu.test",
-                "version": "1.0",
-                "maintainer": "Foo Bar <[e-mail]>",
-                "title": "test title",
-                "architecture": "all",
+        scratch = self._make_scratch_dir(manifest_override={
                 "framework":
                     "ubuntu-sdk-14.04-basic, ubuntu-sdk-14.04-webapps",
-            }, f)
-        self.builder.add_file(scratch, "/")
+        })
         path = self.builder.build(self.temp_dir)
         control_path = os.path.join(self.temp_dir, "control")
         subprocess.check_call(["dpkg-deb", "-e", path, control_path])
@@ -311,6 +308,8 @@
         scratch = os.path.join(self.temp_dir, "scratch")
         touch(os.path.join(scratch, "bin", "foo"))
         touch(os.path.join(scratch, ".git", "config"))
+        touch(os.path.join(scratch, "foo.so"))
+        touch(os.path.join(scratch, "build", "meep.goah"))
         with mkfile(os.path.join(scratch, "manifest.json")) as f:
             json.dump({
                 "name": "com.ubuntu.test",
@@ -323,6 +322,7 @@
             # build() overrides this back to 0o644
             os.fchmod(f.fileno(), 0o600)
         self.builder.add_file(scratch, "./")
+        self.builder.add_ignore_pattern("build")
         path = os.path.join(self.temp_dir, "com.ubuntu.test_1.0.tar.gz")
         self.assertEqual(path, self.builder.build(self.temp_dir))
         self.assertTrue(os.path.exists(path))

=== modified file 'doc/manpage.rst'
--- doc/manpage.rst	2014-03-18 11:47:21 +0000
+++ doc/manpage.rst	2014-05-14 11:49:16 +0000
@@ -70,8 +70,14 @@
 
 Options:
 
--m PATH, --manifest=PATH    Read package manifest from PATH
-                            (default: ``manifest.json``).
+-m PATH, --manifest=PATH                   Read package manifest from PATH
+                                           (default: ``manifest.json``).
+-I file-pattern, --ignore=file-pattern     Ignore the given shell-pattern
+                                           when building the package.
+                                           The option may be repeated multiple
+                                           times to list multiple patterns to
+                                           exclude.
+
 
 click buildsource DIRECTORY
 ---------------------------
@@ -87,8 +93,13 @@
 
 Options:
 
--m PATH, --manifest=PATH    Read package manifest from PATH
-                            (default: ``manifest.json``).
+-m PATH, --manifest=PATH                   Read package manifest from PATH
+                                           (default: ``manifest.json``).
+-I file-pattern, --ignore=file-pattern     Ignore the given shell-pattern
+                                           when building the package.
+                                           The option may be repeated multiple
+                                           times to list multiple patterns to
+                                           exclude.
 
 click chroot
 ------------