Added testing frame for proper fetch testing to be very sure this works as expected. Plenty of cases still to be tested

Author: Byron

TODO

@@ -96,6 +96,9 @@ Refs
   - NO: The reference dosnt need to know - in fact it does not know about the 
   main HEAD, so it may not use it. This is to be done in client code only. 
   Remove me
+* Reference.from_path may return a symbolic reference although it is not related 
+  to the reference type. Split that up into two from_path on each of the types, 
+  and provide a general method outside of the type  that tries both.
 
 Remote
 ------
@@ -104,6 +107,10 @@ Remote
 * Fetch should return heads that where updated, pull as well.
 * Creation and deletion methods for references should be part of the interface, allowing
   repo.create_head(...) instaed of Head.create(repo, ...). Its a convenience thing, clearly
+* When parsing fetch-info, the regex will have problems properly handling white-space in the
+  actual head or tag name as it does not know when the optional additional message will begin.
+  This can possibly improved by making stronger assumptions about the possible messages or 
+  by using the data from FETCH_HEAD instead or as additional source of information
 
 Repo
 ----

lib/git/remote.py

@@ -8,7 +8,9 @@
 """
 
 from git.utils import LazyMixin, Iterable, IterableList
-from refs import RemoteReference
+from refs import Reference, RemoteReference
+import re
+import os
 
 class _SectionConstraint(object):
 	"""
@@ -54,29 +56,70 @@ class FetchInfo(object):
 		Carries information about the results of a fetch operation::
 		
 		 info = remote.fetch()[0]
-		 info.local_ref		# None, or Reference object to the local head or tag which was moved
 		 info.remote_ref	# Symbolic Reference or RemoteReference to the changed remote head or FETCH_HEAD
 		 info.flags 		# additional flags to be & with enumeration members, i.e. info.flags & info.REJECTED
+		 info.note			# additional notes given by git-fetch intended for the user 
 		"""
-		__slots__ = tuple()
-		BRANCH_UPTODATE, REJECTED, FORCED_UPDATED, FAST_FORWARD, NEW_TAG, \
-		TAG_UPDATE, NEW_BRANCH = [ 1 << x for x in range(1,8) ]
+		__slots__ = ('remote_ref', 'flags', 'note') 
+		BRANCH_UPTODATE, REJECTED, FORCED_UPDATE, FAST_FORWARD, NEW_TAG, \
+		TAG_UPDATE, NEW_BRANCH, ERROR = [ 1 << x for x in range(1,9) ]
+		#                             %c    %-*s %-*s             -> %s       (%s)
+		re_fetch_result = re.compile("^(.) (\[?[\w\s]+\]?)\s+(.+) -> (.+/.+)(  \(.*\)?$)?")
 
-		def __init__(self, local_ref, remote_ref, flags):
+		_flag_map = { 	'!' : ERROR, '+' : FORCED_UPDATE, '-' : TAG_UPDATE, '*' : 0,
+						'=' : BRANCH_UPTODATE, ' ' : FAST_FORWARD } 
+		
+		def __init__(self, remote_ref, flags, note = ''):
 			"""
 			Initialize a new instance
 			"""
-			self.local_ref = local_ref
 			self.remote_ref = remote_ref
 			self.flags = flags
+			self.note = note
 
 		@classmethod
-		def _from_line(cls, line):
+		def _from_line(cls, repo, line):
 			"""
 			Parse information from the given line as returned by git-fetch -v
 			and return a new FetchInfo object representing this information.
+			
+			We can handle a line as follows
+			"%c %-*s %-*s -> %s%s"
+			
+			Where c is either ' ', !, +, -, *, or =
+			! means error
+			+ means success forcing update
+			- means a tag was updated
+			* means birth of new branch or tag
+			= means the head was up to date ( and not moved )
+			' ' means a fast-forward
 			"""
-			raise NotImplementedError("todo")
+			line = line.strip()
+			match = cls.re_fetch_result.match(line)
+			if match is None:
+				raise ValueError("Failed to parse line: %r" % line)
+			control_character, operation, local_remote_ref, remote_local_ref, note = match.groups()
+			
+			remote_local_ref = Reference.from_path(repo, os.path.join(RemoteReference._common_path_default, remote_local_ref.strip()))
+			note = ( note and note.strip() ) or ''
+			
+			# parse flags from control_character
+			flags = 0
+			try:
+				flags |= cls._flag_map[control_character]
+			except KeyError:
+				raise ValueError("Control character %r unknown as parsed from line %r" % (control_character, line))
+			# END control char exception hanlding 
+			
+			# parse operation string for more info
+			if 'rejected' in operation:
+				flags |= cls.REJECTED
+			if 'new tag' in operation:
+				flags |= cls.NEW_TAG
+			if 'new branch' in operation:
+				flags |= cls.NEW_BRANCH
+			
+			return cls(remote_local_ref, flags, note)
 
 	# END FetchInfo definition 
 
@@ -230,6 +273,10 @@ def update(self, **kwargs):
 		self.repo.git.remote("update", self.name)
 		return self
 
+	def _get_fetch_info_from_stderr(self, stderr):
+		# skip first line as it is some remote info we are not interested in
+		return [ self.FetchInfo._from_line(self.repo, line) for line in stderr.splitlines()[1:] ]
+	
 	def fetch(self, refspec=None, **kwargs):
 		"""
 		Fetch the latest changes for this remote
@@ -253,8 +300,8 @@ def fetch(self, refspec=None, **kwargs):
 			list(FetchInfo, ...) list of FetchInfo instances providing detailed 
 			information about the fetch results
 		"""
-		lines = self.repo.git.fetch(self, refspec, v=True, **kwargs).splitlines()
-		return [ self.FetchInfo._from_line(line) for line in lines ]
+		status, stdout, stderr = self.repo.git.fetch(self, refspec, with_extended_output=True, v=True, **kwargs)
+		return self._get_fetch_info_from_stderr(stderr)
 
 	def pull(self, refspec=None, **kwargs):
 		"""
@@ -270,8 +317,8 @@ def pull(self, refspec=None, **kwargs):
 		Returns
 			list(Fetch
 		"""
-		lines = self.repo.git.pull(self, refspec, v=True, **kwargs).splitlines()
-		return [ self.FetchInfo._from_line(line) for line in lines ]
+		status, stdout, stderr = self.repo.git.pull(self, refspec, v=True, with_extended_output=True, **kwargs)
+		return self._get_fetch_info_from_stderr(stderr)
 
 	def push(self, refspec=None, **kwargs):
 		"""

test/git/test_remote.py

@@ -7,8 +7,46 @@
 from test.testlib import *
 from git import *
 
+import os
+
 class TestRemote(TestBase):
 
+	def _print_fetchhead(self, repo):
+		fp = open(os.path.join(repo.path, "FETCH_HEAD"))
+		print fp.read()
+		fp.close()
+		
+		
+	def _check_fetch_results(self, results, remote):
+		self._print_fetchhead(remote.repo)
+		assert len(results) > 0 and isinstance(results[0], remote.FetchInfo)
+		for result in results:
+			assert result.flags != 0
+			assert isinstance(result.remote_ref, (SymbolicReference, Reference))
+		# END for each result
+		
+	def _test_fetch_info(self, repo):
+		self.failUnlessRaises(ValueError, Remote.FetchInfo._from_line, repo, "nonsense")
+		self.failUnlessRaises(ValueError, Remote.FetchInfo._from_line, repo, "? [up to date]      0.1.7RC    -> origin/0.1.7RC")
+		
+	def _test_fetch(self,remote, rw_repo, remote_repo):
+		# specialized fetch testing to de-clutter the main test
+		self._test_fetch_info(rw_repo)
+		
+		fetch_result = remote.fetch()
+		self._check_fetch_results(fetch_result, remote)
+		
+		self.fail("rejected parsing")
+		self.fail("test parsing of each individual flag")
+		self.fail("tag handling")
+		
+	def _test_pull(self,remote, rw_repo, remote_repo):
+		# pull is essentially a fetch + merge, hence we just do a light 
+		# test here, leave the reset to the actual merge testing
+		# fails as we did not specify a branch and there is no configuration for it
+		self.failUnlessRaises(GitCommandError, remote.pull)
+		remote.pull('master')
+	
 	@with_rw_and_rw_remote_repo('0.1.6')
 	def test_base(self, rw_repo, remote_repo):
 		num_remotes = 0
@@ -60,18 +98,14 @@ def test_base(self, rw_repo, remote_repo):
 			# END for each rename ( back to prev_name )
 
 			# FETCH TESTING
-			assert len(remote.fetch()) == 1
-			
+			self._test_fetch(remote, rw_repo, remote_repo)
 
-			self.fail("rejected parsing")
-			self.fail("test parsing of each individual flag")
 			# PULL TESTING
-			# fails as we did not specify a branch and there is no configuration for it
-			self.failUnlessRaises(GitCommandError, remote.pull)
-			remote.pull('master')
-			remote.update()
+			self._test_pull(remote, rw_repo, remote_repo)
 
+			remote.update()
 		# END for each remote
+		
 		assert num_remotes
 		assert num_remotes == len(remote_set)