Add a merged upstream test for pull and push
[stgit] / stgit / git.py
index 55f06c1..40d54ef 100644 (file)
@@ -18,7 +18,7 @@ along with this program; if not, write to the Free Software
 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
 """
 
-import sys, os, glob, popen2
+import sys, os, popen2
 
 from stgit.utils import *
 
@@ -27,13 +27,6 @@ class GitException(Exception):
     pass
 
 
-# Different start-up variables read from the environment
-if 'GIT_DIR' in os.environ:
-    base_dir = os.environ['GIT_DIR']
-else:
-    base_dir = '.git'
-
-head_link = os.path.join(base_dir, 'HEAD')
 
 #
 # Classes
@@ -88,6 +81,15 @@ __commits = dict()
 #
 # Functions
 #
+
+def get_base_dir():
+    """Different start-up variables read from the environment
+    """
+    if 'GIT_DIR' in os.environ:
+        return os.environ['GIT_DIR']
+    else:
+        return _output_one_line('git-rev-parse --git-dir')
+
 def get_commit(id_hash):
     """Commit objects factory. Save/look-up them in the __commits
     dictionary
@@ -104,7 +106,7 @@ def get_commit(id_hash):
 def get_conflicts():
     """Return the list of file conflicts
     """
-    conflicts_file = os.path.join(base_dir, 'conflicts')
+    conflicts_file = os.path.join(get_base_dir(), 'conflicts')
     if os.path.isfile(conflicts_file):
         f = file(conflicts_file)
         names = [line.strip() for line in f.readlines()]
@@ -114,7 +116,7 @@ def get_conflicts():
         return None
 
 def _input(cmd, file_desc):
-    p = popen2.Popen3(cmd)
+    p = popen2.Popen3(cmd, True)
     while True:
         line = file_desc.readline()
         if not line:
@@ -125,25 +127,25 @@ def _input(cmd, file_desc):
         raise GitException, '%s failed' % str(cmd)
 
 def _output(cmd):
-    p=popen2.Popen3(cmd)
-    string = p.fromchild.read()
+    p=popen2.Popen3(cmd, True)
+    output = p.fromchild.read()
     if p.wait():
         raise GitException, '%s failed' % str(cmd)
-    return string
+    return output
 
 def _output_one_line(cmd, file_desc = None):
-    p=popen2.Popen3(cmd)
+    p=popen2.Popen3(cmd, True)
     if file_desc != None:
         for line in file_desc:
             p.tochild.write(line)
         p.tochild.close()
-    string = p.fromchild.readline().strip()
+    output = p.fromchild.readline().strip()
     if p.wait():
         raise GitException, '%s failed' % str(cmd)
-    return string
+    return output
 
 def _output_lines(cmd):
-    p=popen2.Popen3(cmd)
+    p=popen2.Popen3(cmd, True)
     lines = p.fromchild.readlines()
     if p.wait():
         raise GitException, '%s failed' % str(cmd)
@@ -168,20 +170,19 @@ def __run(cmd, args=None):
         return r
     return 0
 
-def __check_base_dir():
-    return os.path.isdir(base_dir)
-
-def __tree_status(files = [], tree_id = 'HEAD', unknown = False,
+def __tree_status(files = None, tree_id = 'HEAD', unknown = False,
                   noexclude = True):
     """Returns a list of pairs - [status, filename]
     """
-    os.system('git-update-index --refresh > /dev/null')
+    refresh_index()
 
+    if not files:
+        files = []
     cache_files = []
 
     # unknown files
     if unknown:
-        exclude_file = os.path.join(base_dir, 'info', 'exclude')
+        exclude_file = os.path.join(get_base_dir(), 'info', 'exclude')
         base_exclude = ['--exclude=%s' % s for s in
                         ['*.[ao]', '*.pyc', '.*', '*~', '#*', 'TAGS', 'tags']]
         base_exclude.append('--exclude-per-directory=.gitignore')
@@ -204,7 +205,7 @@ def __tree_status(files = [], tree_id = 'HEAD', unknown = False,
     cache_files += [('C', filename) for filename in conflicts]
 
     # the rest
-    for line in _output_lines(['git-diff-index', '-r', tree_id] + files):
+    for line in _output_lines(['git-diff-index', tree_id] + files):
         fs = tuple(line.rstrip().split(' ',4)[-1].split('\t',1))
         if fs[1] not in conflicts:
             cache_files.append(fs)
@@ -236,6 +237,9 @@ def get_head_file():
 def set_head_file(ref):
     """Resets HEAD to point to a new ref
     """
+    # head cache flushing is needed since we might have a different value
+    # in the new head
+    __clear_head_cache()
     if __run('git-symbolic-ref HEAD', [ref]) != 0:
         raise GitException, 'Could not set head to "%s"' % ref
 
@@ -249,6 +253,9 @@ def __set_head(val):
             raise GitException, 'Could not update HEAD to "%s".' % val
         __head = val
 
+    # only allow SHA1 hashes
+    assert(len(__head) == 40)
+
 def __clear_head_cache():
     """Sets the __head to None so that a re-read is forced
     """
@@ -256,6 +263,11 @@ def __clear_head_cache():
 
     __head = None
 
+def refresh_index():
+    """Refresh index with stat() information from the working directory.
+    """
+    __run('git-update-index -q --unmerged --refresh')
+
 def rev_parse(git_id):
     """Parse the string and return a verified SHA1 id
     """
@@ -265,7 +277,7 @@ def rev_parse(git_id):
         raise GitException, 'Unknown revision: %s' % git_id
 
 def branch_exists(branch):
-    """Existance check for the named branch
+    """Existence check for the named branch
     """
     for line in _output_lines(['git-rev-parse', '--symbolic', '--all']):
         if line.strip() == branch:
@@ -285,27 +297,30 @@ def create_branch(new_branch, tree_id = None):
 
     # a checkout isn't needed if new branch points to the current head
     if tree_id:
-        git.switch(tree_id)
+        switch(tree_id)
 
-    if os.path.isfile(os.path.join(base_dir, 'MERGE_HEAD')):
-        os.remove(os.path.join(base_dir, 'MERGE_HEAD'))
+    if os.path.isfile(os.path.join(get_base_dir(), 'MERGE_HEAD')):
+        os.remove(os.path.join(get_base_dir(), 'MERGE_HEAD'))
 
 def switch_branch(name):
     """Switch to a git branch
     """
+    global __head
+
     new_head = os.path.join('refs', 'heads', name)
     if not branch_exists(new_head):
         raise GitException, 'Branch "%s" does not exist' % name
 
-    tree_id = rev_parse(new_head + '^0')
+    tree_id = rev_parse(new_head + '^{commit}')
     if tree_id != get_head():
+        refresh_index()
         if __run('git-read-tree -u -m', [get_head(), tree_id]) != 0:
             raise GitException, 'git-read-tree failed (local changes maybe?)'
         __head = tree_id
     set_head_file(new_head)
 
-    if os.path.isfile(os.path.join(base_dir, 'MERGE_HEAD')):
-        os.remove(os.path.join(base_dir, 'MERGE_HEAD'))
+    if os.path.isfile(os.path.join(get_base_dir(), 'MERGE_HEAD')):
+        os.remove(os.path.join(get_base_dir(), 'MERGE_HEAD'))
 
 def delete_branch(name):
     """Delete a git branch
@@ -313,21 +328,22 @@ def delete_branch(name):
     branch_head = os.path.join('refs', 'heads', name)
     if not branch_exists(branch_head):
         raise GitException, 'Branch "%s" does not exist' % name
-    os.remove(os.path.join(base_dir, branch_head))
+    os.remove(os.path.join(get_base_dir(), branch_head))
 
 def rename_branch(from_name, to_name):
     """Rename a git branch
     """
-    from_head = os.path.join(base_dir, 'refs', 'heads', from_name)
+    from_head = os.path.join('refs', 'heads', from_name)
     if not branch_exists(from_head):
         raise GitException, 'Branch "%s" does not exist' % from_name
-    to_head = os.path.join(base_dir, 'refs', 'heads', to_name)
+    to_head = os.path.join('refs', 'heads', to_name)
     if branch_exists(to_head):
         raise GitException, 'Branch "%s" already exists' % to_name
 
     if get_head_file() == from_name:
-        set_head_file(os.path.join('refs', 'heads', to_name))
-    os.rename(from_head, to_head)
+        set_head_file(to_head)
+    os.rename(os.path.join(get_base_dir(), from_head), \
+              os.path.join(get_base_dir(), to_head))
 
 def add(names):
     """Add the files or recursively add the directory contents
@@ -356,11 +372,6 @@ def add(names):
 def rm(files, force = False):
     """Remove a file from the repository
     """
-    if force:
-        git_opt = '--force-remove'
-    else:
-        git_opt = '--remove'
-
     if not force:
         for f in files:
             if os.path.exists(f):
@@ -371,9 +382,12 @@ def rm(files, force = False):
         if files:
             __run('git-update-index --force-remove --', files)
 
-def update_cache(files = [], force = False):
+def update_cache(files = None, force = False):
     """Update the cache information for the given files
     """
+    if not files:
+        files = []
+
     cache_files = __tree_status(files)
 
     # everything is up-to-date
@@ -399,12 +413,17 @@ def update_cache(files = [], force = False):
 
     return True
 
-def commit(message, files = [], parents = [], allowempty = False,
+def commit(message, files = None, parents = None, allowempty = False,
            cache_update = True, tree_id = None,
            author_name = None, author_email = None, author_date = None,
            committer_name = None, committer_email = None):
     """Commit the current tree to repository
     """
+    if not files:
+        files = []
+    if not parents:
+        parents = []
+
     # Get the tree status
     if cache_update and parents != []:
         changes = update_cache(files)
@@ -446,30 +465,40 @@ def commit(message, files = [], parents = [], allowempty = False,
 
     return commit_id
 
-def apply_diff(rev1, rev2):
+def apply_diff(rev1, rev2, check_index = True):
     """Apply the diff between rev1 and rev2 onto the current
     index. This function doesn't need to raise an exception since it
     is only used for fast-pushing a patch. If this operation fails,
     the pushing would fall back to the three-way merge.
     """
-    return os.system('git-diff-tree -p %s %s | git-apply --index 2> /dev/null'
-                     % (rev1, rev2)) == 0
+    if check_index:
+        index_opt = '--index'
+    else:
+        index_opt = ''
+    cmd = 'git-diff-tree -p %s %s | git-apply %s 2> /dev/null' \
+          % (rev1, rev2, index_opt)
+
+    return os.system(cmd) == 0
 
 def merge(base, head1, head2):
     """Perform a 3-way merge between base, head1 and head2 into the
     local tree
     """
+    refresh_index()
     if __run('git-read-tree -u -m', [base, head1, head2]) != 0:
         raise GitException, 'git-read-tree failed (local changes maybe?)'
 
     # this can fail if there are conflicts
-    if os.system('git-merge-index -o -q gitmergeonefile.py -a') != 0:
-        raise GitException, 'git-merge-cache failed (possible conflicts)'
+    if __run('git-merge-index -o -q gitmergeonefile.py -a') != 0:
+        raise GitException, 'git-merge-index failed (possible conflicts)'
 
-def status(files = [], modified = False, new = False, deleted = False,
+def status(files = None, modified = False, new = False, deleted = False,
            conflict = False, unknown = False, noexclude = False):
     """Show the tree status
     """
+    if not files:
+        files = []
+
     cache_files = __tree_status(files, unknown = True, noexclude = noexclude)
     all = not (modified or new or deleted or conflict or unknown)
 
@@ -494,56 +523,68 @@ def status(files = [], modified = False, new = False, deleted = False,
         else:
             print '%s' % fs[1]
 
-def diff(files = [], rev1 = 'HEAD', rev2 = None, out_fd = None):
+def diff(files = None, rev1 = 'HEAD', rev2 = None, out_fd = None):
     """Show the diff between rev1 and rev2
     """
+    if not files:
+        files = []
 
-    if rev2:
+    if rev1 and rev2:
         diff_str = _output(['git-diff-tree', '-p', rev1, rev2] + files)
+    elif rev1 or rev2:
+        refresh_index()
+        if rev2:
+            diff_str = _output(['git-diff-index', '-p', '-R', rev2] + files)
+        else:
+            diff_str = _output(['git-diff-index', '-p', rev1] + files)
     else:
-        os.system('git-update-index --refresh > /dev/null')
-        diff_str = _output(['git-diff-index', '-p', rev1] + files)
+        diff_str = ''
 
     if out_fd:
         out_fd.write(diff_str)
     else:
         return diff_str
 
-def diffstat(files = [], rev1 = 'HEAD', rev2 = None):
+def diffstat(files = None, rev1 = 'HEAD', rev2 = None):
     """Return the diffstat between rev1 and rev2
     """
+    if not files:
+        files = []
 
     p=popen2.Popen3('git-apply --stat')
     diff(files, rev1, rev2, p.tochild)
     p.tochild.close()
-    str = p.fromchild.read().rstrip()
+    diff_str = p.fromchild.read().rstrip()
     if p.wait():
         raise GitException, 'git.diffstat failed'
-    return str
+    return diff_str
 
 def files(rev1, rev2):
     """Return the files modified between rev1 and rev2
     """
 
-    str = ''
+    result = ''
     for line in _output_lines('git-diff-tree -r %s %s' % (rev1, rev2)):
-        str += '%s %s\n' % tuple(line.rstrip().split(' ',4)[-1].split('\t',1))
+        result += '%s %s\n' % tuple(line.rstrip().split(' ',4)[-1].split('\t',1))
 
-    return str.rstrip()
+    return result.rstrip()
 
 def barefiles(rev1, rev2):
     """Return the files modified between rev1 and rev2, without status info
     """
 
-    str = ''
+    result = ''
     for line in _output_lines('git-diff-tree -r %s %s' % (rev1, rev2)):
-        str += '%s\n' % line.rstrip().split(' ',4)[-1].split('\t',1)[-1]
+        result += '%s\n' % line.rstrip().split(' ',4)[-1].split('\t',1)[-1]
 
-    return str.rstrip()
+    return result.rstrip()
 
-def checkout(files = [], tree_id = None, force = False):
+def checkout(files = None, tree_id = None, force = False):
     """Check out the given or all files
     """
+    if not files:
+        files = []
+
     if tree_id and __run('git-read-tree -m', [tree_id]) != 0:
         raise GitException, 'Failed git-read-tree -m %s' % tree_id
 
@@ -561,26 +602,24 @@ def checkout(files = [], tree_id = None, force = False):
 def switch(tree_id):
     """Switch the tree to the given id
     """
+    refresh_index()
     if __run('git-read-tree -u -m', [get_head(), tree_id]) != 0:
         raise GitException, 'git-read-tree failed (local changes maybe?)'
 
     __set_head(tree_id)
 
-def reset(tree_id = None):
+def reset(files = None, tree_id = None):
     """Revert the tree changes relative to the given tree_id. It removes
     any local changes
     """
     if not tree_id:
         tree_id = get_head()
 
-    cache_files = __tree_status(tree_id = tree_id)
-    rm_files =  [x[1] for x in cache_files if x[0] in ['D']]
+    checkout(files, tree_id, True)
 
-    checkout(tree_id = tree_id, force = True)
-    __set_head(tree_id)
-
-    # checkout doesn't remove files
-    map(os.remove, rm_files)
+    # if the reset refers to the whole tree, switch the HEAD as well
+    if not files:
+        __set_head(tree_id)
 
 def pull(repository = 'origin', refspec = None):
     """Pull changes from the remote repository. At the moment, just
@@ -610,11 +649,11 @@ def apply_patch(filename = None, base = None):
                 return False
             return True
 
-    os.system('git-update-index --refresh > /dev/null')
-
     if base:
         orig_head = get_head()
         switch(base)
+    else:
+        refresh_index()         # needed since __apply_patch() doesn't do it
 
     if not __apply_patch():
         if base:
@@ -633,3 +672,11 @@ def clone(repository, local_dir):
     if __run('git clone', [repository, local_dir]) != 0:
         raise GitException, 'Failed "git clone %s %s"' \
               % (repository, local_dir)
+
+def modifying_revs(files, base_rev):
+    """Return the revisions from the list modifying the given files
+    """
+    cmd = ['git-rev-list', '%s..' % base_rev, '--']
+    revs = [line.strip() for line in _output_lines(cmd + files)]
+
+    return revs