Merge lp:~beuno/bzr-upload/ignores into lp:bzr-upload

[Martin Albisetti]

[Martin Albisetti (beuno)]

This branch provides support for ignoring files specifically on upload, but not on versioning.
The file is .bzrignore-upload, and there is a test attached, I'm not sure how much to test as I'm re-using bzr's API (directories as well as files?).

[lp:~beuno/bzr-upload/ignores]

73. By Martin Albisetti on 2009-11-28

2009 tests!

74. By Martin Albisetti on 2009-11-28

Fix all the tests I broke :)

[Alexander Belchenko (bialix)]

Martin, on the last bzr sprint in Mooloolaba it was decided to keep different config and settings fro plugins in subdirectory .bzrmeta. You may want to ask Ian Clatworthy for details. So, if you change your code to use .bzrmeta/upload/ignore -- it will be first step towards this standardization.

(I've got here from your article about TDD ;-)

[Vincent Ladeuil (vila)]

It looks like you re-introduce the README file that has been moved in the __init__.py so that the documentation can be automatically generated.

I suspect that's because you started with an old branch.

The test sounds right, you may want to add one (and some code too :) for directories.

The diff is larger than it should, could it be because you introduced spurious spaces ?

195 + ignored_files = self.get_ignored()
196 + if relpath not in ignored_files:
197 + self.get_ignored()

That self.get_ignored() call seems useless.

review: Needs Fixing

[Martin Albisetti (beuno)]

On Sat, Nov 28, 2009 at 1:58 PM, Vincent Ladeuil <email address hidden> wrote:
> It looks like you re-introduce the README file that has been moved in the __init__.py so that the documentation can be automatically generated.

I did it on purpose :)
People getting the branch/tarball don't really find that information
since it's buried in the python file.
If you feel strongly about not having the duplication, I'll be happy
to drop that change.

> The test sounds right, you may want to add one (and some code too :) for directories.

That sounds sane :)
I will work on that and poke you again.

> The diff is larger than it should, could it be because you introduced spurious spaces ?

The opposite. I removed whitespace.

> 195     + ignored_files = self.get_ignored()
> 196     + if relpath not in ignored_files:
> 197     + self.get_ignored()
>
> That self.get_ignored() call seems useless.

Yes, thanks for catching that. Removed.

--
Martin

[lp:~beuno/bzr-upload/ignores]

75. By Martin Albisetti on 2009-11-28

Remove left over line

76. By Martin Albisetti on 2009-11-28

Remove duplication from README

[Vincent Ladeuil (vila)]

bialix is right, but let's file a bug for that (so we can land this fix).

[Martin Albisetti (beuno)]

Ok, updated with ignoring dirs, and a test to prove it.

I think I addressed all comments, Vincent.

[lp:~beuno/bzr-upload/ignores]

77. By Martin Albisetti on 2009-11-30

Add test for ignoring a dir

78. By Martin Albisetti on 2009-11-30

Actually ignore the dirs. Test pass!

[Vincent Ladeuil (vila)]

Well done, please land.

review: Approve

=== modified file 'README'
--- README	2009-09-05 11:35:21 +0000
+++ README	2009-11-30 21:44:09 +0000
@@ -13,7 +13,6 @@
 Please report any bugs to: http://bugs.launchpad.net/bzr-upload/
 
 Our home page is located at: https://launchpad.net/bzr-upload/
-
 The original authors are:
 
 Vincent Ladeuil <[e-mail]>
 
=== modified file '__init__.py'
--- __init__.py	2009-10-04 17:05:54 +0000
+++ __init__.py	2009-11-30 21:44:09 +0000
@@ -115,6 +115,14 @@
 Note that you will consume more bandwith this way than uploading from a local
 branch.
 
+Ignoring certain files
+-----------------------
+
+If you want to version a file, but not upload it, you can create a file called
+.bzrignore-upload, which works in the same way as the regular .bzrignore file,
+but only applies to bzr-upload.
+
+
 Collaborating
 -------------
 
@@ -122,8 +130,7 @@
 
     bzr branch lp:bzr-upload
 
-And change anything you'd like, and get in touch with any of the authors to 
-review and add the changes.
+And change anything you'd like, and file a merge proposal on Launchpad.
 
 
 Known Issues
@@ -157,6 +164,7 @@
 from bzrlib import (
     bzrdir,
     errors,
+    ignores,
     revisionspec,
     transport,
     osutils,
@@ -271,15 +279,28 @@
                 self._uploaded_revid = revision.NULL_REVISION
         return self._uploaded_revid
 
+    def get_ignored(self):
+        """Get upload-specific ignored files from the current branch"""
+        try:
+            ignore_file = self.tree.get_file_by_path('.bzrignore-upload')
+            return ignores.parse_ignore_file(ignore_file)
+        except errors.NoSuchId:
+            return []
+
     def upload_file(self, relpath, id, mode=None):
-        if mode is None:
-            if self.tree.is_executable(id):
-                mode = 0775
-            else:
-                mode = 0664
-        if not self.quiet:
-            self.outf.write('Uploading %s\n' % relpath)
-        self.to_transport.put_bytes(relpath, self.tree.get_file_text(id), mode)
+        ignored_files = self.get_ignored()
+        if relpath not in ignored_files:
+            if mode is None:
+                if self.tree.is_executable(id):
+                    mode = 0775
+                else:
+                    mode = 0664
+            if not self.quiet:
+                self.outf.write('Uploading %s\n' % relpath)
+            self.to_transport.put_bytes(relpath, self.tree.get_file_text(id), mode)
+        else:
+            if not self.quiet:
+                self.outf.write('Ignoring %s\n' % relpath)
 
     def upload_file_robustly(self, relpath, id, mode=None):
         """Upload a file, clearing the way on the remote side.
@@ -300,9 +321,14 @@
         self.upload_file(relpath, id, mode)
 
     def make_remote_dir(self, relpath, mode=None):
-        if mode is None:
-            mode = 0775
-        self.to_transport.mkdir(relpath, mode)
+        ignored_files = self.get_ignored()
+        if relpath not in ignored_files:
+            if mode is None:
+                mode = 0775
+            self.to_transport.mkdir(relpath, mode)
+        else:
+            if not self.quiet:
+                self.outf.write('Ignoring %s\n' % relpath)
 
     def make_remote_dir_robustly(self, relpath, mode=None):
         """Create a remote directory, clearing the way on the remote side.
@@ -388,7 +414,7 @@
         self.tree.lock_read()
         try:
             for relpath, ie in self.tree.inventory.iter_entries():
-                if relpath in ('', '.bzrignore'):
+                if relpath in ('', '.bzrignore', '.bzrignore-upload'):
                     # skip root ('')
                     # .bzrignore has no meaning outside of a working tree
                     # so do not upload it
@@ -407,7 +433,7 @@
         # If we can't find the revid file on the remote location, upload the
         # full tree instead
         rev_id = self.get_uploaded_revid()
-        
+
         if rev_id == revision.NULL_REVISION:
             if not self.quiet:
                 self.outf.write('No uploaded revision id found,'
@@ -528,7 +554,7 @@
 
         (wt, branch,
          relpath) = bzrdir.BzrDir.open_containing_tree_or_branch(directory)
-        
+
         if wt:
             wt.lock_read()
         else:
@@ -536,10 +562,10 @@
         try:
             if wt:
                 changes = wt.changes_from(wt.basis_tree())
-    
+
                 if revision is None and  changes.has_changed():
                     raise errors.UncommittedChanges(wt)
-    
+
             if location is None:
                 stored_loc = get_upload_location(branch)
                 if stored_loc is None:
@@ -551,9 +577,9 @@
                             self.outf.encoding)
                     self.outf.write("Using saved location: %s\n" % display_url)
                     location = stored_loc
-    
+
             to_transport = transport.get_transport(location)
-    
+
             # Check that we are not uploading to a existing working tree.
             try:
                 to_bzr_dir = bzrdir.BzrDir.open_from_transport(to_transport)
@@ -563,10 +589,10 @@
             except errors.NotLocalUrl:
                 # The exception raised is a bit weird... but that's life.
                 has_wt = True
-    
+
             if has_wt:
                 raise CannotUploadToWorkingTreeError(url=location)
-    
+
             if revision is None:
                 rev_id = branch.last_revision()
             else:
@@ -574,18 +600,18 @@
                     raise errors.BzrCommandError(
                         'bzr upload --revision takes exactly 1 argument')
                 rev_id = revision[0].in_history(branch).rev_id
-    
+
             tree = branch.repository.revision_tree(rev_id)
-    
+
             uploader = BzrUploader(branch, to_transport, self.outf, tree,
                                    rev_id, quiet=quiet)
-            
+
             if not overwrite:
                 prev_uploaded_rev_id = uploader.get_uploaded_revid()
                 graph = branch.repository.get_graph()
                 if not graph.is_ancestor(prev_uploaded_rev_id, rev_id):
                     raise DivergedError(rev_id, prev_uploaded_rev_id)
-    
+
             if full:
                 uploader.upload_full_tree()
             else:
@@ -622,7 +648,7 @@
 
     _fmt = ("The revision upload to this location is from a branch that is "
             "diverged from this branch: %(upload_revid)s")
-    
+
     # We should probably tell the user to use merge on the diverged branch,
     # but how do we explan which branch they need to merge from!
 
 
=== modified file 'tests/test_upload.py'
--- tests/test_upload.py	2009-10-05 09:31:11 +0000
+++ tests/test_upload.py	2009-11-30 21:44:09 +0000
@@ -1,4 +1,4 @@
-# Copyright (C) 2008 Canonical Ltd
+# Copyright (C) 2008, 2009 Canonical Ltd
 #
 # This program is free software; you can redistribute it and/or modify
 # it under the terms of the GNU General Public License as published by
@@ -449,6 +449,26 @@
         self.assertUpFileEqual('baz', 'dir/goodbye')
         self.assertUpFileEqual('foo', 'dir/hello')
 
+    def test_ignore_file(self):
+        self.make_branch_and_working_tree()
+        self.do_full_upload()
+        self.add_file('.bzrignore-upload','foo')
+        self.add_file('foo', 'bar')
+
+        self.do_upload()
+
+        self.failIfUpFileExists('foo')
+
+    def test_ignore_directory(self):
+        self.make_branch_and_working_tree()
+        self.do_full_upload()
+        self.add_file('.bzrignore-upload','dir')
+        self.add_dir('dir')
+
+        self.do_upload()
+
+        self.failIfUpFileExists('dir')
+
 
 class TestFullUpload(tests.TestCaseWithTransport, TestUploadMixin):