new script for careful git update
[feisty_meow.git] / scripts / rev_control / version_control.sh
index be183ae1bf3cf1c82b6250a2c99f4fd95bac53a1..9e314d2ea36f4263eaf3c01f2f0a1a904fc8c009 100644 (file)
@@ -3,6 +3,9 @@
 # these are helper functions for doing localized revision control.
 # this script should be sourced into other scripts that use it.
 
+# Author: Chris Koeritz
+# Author: Kevin Wentworth
+
 source "$FEISTY_MEOW_SCRIPTS/core/launch_feisty_meow.sh"
 source "$FEISTY_MEOW_SCRIPTS/tty/terminal_titler.sh"
 
@@ -11,6 +14,15 @@ source "$FEISTY_MEOW_SCRIPTS/tty/terminal_titler.sh"
 # the maximum depth that the recursive functions will try to go below the starting directory.
 export MAX_DEPTH=5
 
+# use our splitter tool for lengthy output if it's available.
+if [ ! -z "$(which splitter)" ]; then
+  TO_SPLITTER="$(which splitter)"
+else
+  TO_SPLITTER=cat
+fi
+
+##############
+
 # one unpleasantry to take care of first; cygwin barfs aggressively if the TMP directory
 # is a DOS path, but we need it to be a DOS path for our GFFS testing, so that blows.
 # to get past this, TMP gets changed below to a hopefully generic and safe place.
@@ -25,8 +37,6 @@ if [ ! -d "$TMP" ]; then
   echo "could not create the temporary directory TMP in: $TMP"
   echo "this script will not work properly without an existing TMP directory."
 fi
-#hmmm: re-address the above code, since it doesn't make a lot of sense to me right now...
-
 
 ##############
 
@@ -44,11 +54,8 @@ function do_checkin()
   fi
   local blatt="echo checking in '$nicedir'..."
 
-  local retval=0  # normally successful.
-
   do_update "$directory"
-  retval=$?
-  test_or_die "repository update failed; this should be fixed before check-in."
+  test_or_die "repository update--this should be fixed before check-in."
 
   pushd "$directory" &>/dev/null
   if [ -f ".no-checkin" ]; then
@@ -57,44 +64,49 @@ function do_checkin()
     if test_writeable "CVS"; then
       $blatt
       cvs ci .
-      retval=$?
+      test_or_die "cvs checkin"
     fi
   elif [ -d ".svn" ]; then
     if test_writeable ".svn"; then
       $blatt
       svn ci .
-      retval=$?
+      test_or_die "svn checkin"
     fi
   elif [ -d ".git" ]; then
     if test_writeable ".git"; then
       $blatt
-      # snag all new files.  not to everyone's liking.
+
+      # put all changed and new files in the commit.  not to everyone's liking.
       git add --all .
-      retval=$?
+      test_or_die "git add all new files"
 
       # see if there are any changes in the local repository.
       if ! git diff-index --quiet HEAD --; then
         # tell git about all the files and get a check-in comment.
         git commit .
-        retval+=$?
+        test_or_die "git commit"
       fi
-      # catch if the diff-index failed somehow.
-      retval+=$?
+
+      # a new set of steps we have to take to make sure the branch integrity is good.
+      do_careful_git_update 
+
+      # we continue on to the push, even if there were no changes this time, because
+      # there could already be committed changes that haven't been pushed yet.
 
       # upload any changes to the upstream repo so others can see them.
-      git push 2>&1 | grep -v "X11 forwarding request failed" | squash_first_few_crs
-      retval+=${PIPESTATUS[0]}
+      git push origin "$(my_branch_name)" 2>&1 | grep -v "X11 forwarding request failed" | $TO_SPLITTER
+      test_or_die "git push"
+
     fi
   else
     # nothing there.  it's not an error though.
     echo no repository in $directory
-    retval=0
   fi
   popd &>/dev/null
 
   restore_terminal_title
 
-  return $retval
+  return 0
 }
 
 # shows the local changes in a repository.
@@ -105,25 +117,24 @@ function do_diff
   save_terminal_title
 
   pushd "$directory" &>/dev/null
-  local retval=0  # normally successful.
 
   # only update if we see a repository living there.
   if [ -d ".svn" ]; then
     svn diff .
-    retval+=$?
+    test_or_die "subversion diff"
   elif [ -d ".git" ]; then
     git diff 
-    retval+=$?
+    test_or_die "git diff"
   elif [ -d "CVS" ]; then
     cvs diff .
-    retval+=$?
+    test_or_die "cvs diff"
   fi
 
   popd &>/dev/null
 
   restore_terminal_title
 
-  return $retval
+  return 0
 }
 
 # reports any files that are not already known to the upstream repository.
@@ -134,7 +145,6 @@ function do_report_new
   save_terminal_title
 
   pushd "$directory" &>/dev/null
-  local retval=0  # normally successful.
 
   # only update if we see a repository living there.
   if [ -f ".no-checkin" ]; then
@@ -142,17 +152,17 @@ function do_report_new
   elif [ -d ".svn" ]; then
     # this action so far only makes sense and is needed for svn.
     bash $FEISTY_MEOW_SCRIPTS/rev_control/svnapply.sh \? echo
-    retval=$?
+    test_or_die "svn diff"
   elif [ -d ".git" ]; then
     git status -u
-    retval=$?
+    test_or_die "git status -u"
   fi
 
   popd &>/dev/null
 
   restore_terminal_title
 
-  return $retval
+  return 0
 }
 
 # checks in all the folders in a specified list.
@@ -174,7 +184,7 @@ function checkin_list()
       # yep, this path is absolute.  just handle it directly.
       if [ ! -d "$outer" ]; then continue; fi
       do_checkin $outer
-      test_or_die "running check-in on: $outer"
+      test_or_die "running check-in (absolute) on path: $outer"
       sep 28
     else
       for inner in $list; do
@@ -182,7 +192,7 @@ function checkin_list()
         local path="$inner/$outer"
         if [ ! -d "$path" ]; then continue; fi
         do_checkin $path
-        test_or_die "running check-in on: $path"
+        test_or_die "running check-in (relative) on path: $path"
         sep 28
       done
     fi
@@ -209,11 +219,109 @@ function squash_first_few_crs()
   fi
 }
 
+#hmmm: the below are git specific and should be named that way.
+
+function all_branch_names()
+{
+  echo "$(git branch -vv | cut -d ' ' -f2)"
+}
+
 # a helpful method that reports the git branch for the current directory's
 # git repository.
-function git_branch_name()
+function my_branch_name()
 {
-  echo "$(git branch | grep \* | cut -d ' ' -f2-)"
+  echo "$(git branch -vv | grep '\*' | cut -d ' ' -f2)"
+}
+
+#this had a -> in it at one point for not matching, didn't it?
+# this reports the upstream branch for the current repo.
+##function parent_branch_name()
+##{
+  ##echo "$(git branch -vv | grep \* | cut -d ' ' -f2)"
+##}
+
+# reports the status of the branch by echoing one of these values:
+#   okay: up to date and everything is good.
+#   needs_pull: this branch needs to be pulled from origins.
+#   needs_push: there are unsaved changes on this branch to push to remote store.
+#   diverged: the branches diverged and are going to need a merge.
+# reference: https://stackoverflow.com/questions/3258243/check-if-pull-needed-in-git
+function check_branch_state()
+{
+  local branch="$1"; shift
+
+  local to_return=120  # unknown issue.
+
+  local local_branch=$(git rev-parse @)
+  local remote_branch=$(git rev-parse "$branch")
+  local merge_base=$(git merge-base @ "$branch")
+
+  if [ "$local_branch" == "$remote_branch" ]; then
+    echo "okay"
+  elif [ "$local_branch" == "$merge_base" ]; then
+    echo "needs_pull"
+  elif [ "$remote_branch" == "$merge_base" ]; then
+    echo "needs_push"
+  else
+    echo "diverged"
+  fi
+
+  return $to_return
+}
+
+# the git update process just gets more and more complex when you bring in
+# branches, so we've moved this here to avoid having a ton of code in the
+# other methods.
+function do_careful_git_update()
+{
+  local directory="$1"; shift
+  pushd "$directory" &>/dev/null
+  test_or_die "changing to directory: $directory"
+
+  if [ ! -d ".git" ]; then
+    # we ignore if they're jumping into a non-useful folder, but also tell them.
+    echo "Directory is not a git repository: $directory"
+    return 0
+  fi
+
+  # first update all our remote branches to their current state from the repos.
+  git remote update
+  test_or_die "git remote update"
+
+  local this_branch="$(my_branch_name)"
+#appears to be useless; reports no changes when we need to know about remote changes that do exist:
+#hmmm: trying it out again now that things are better elsewhere.  let's see what it says.
+  state=$(check_branch_state "$this_branch")
+  echo "=> branch '$this_branch' state is: $state"
+
+  # this code is now doing what i have to do when i repair the repo.  and it seems to be good so far.
+  local branch_list=$(all_branch_names)
+  local bran
+  for bran in $branch_list; do
+#    echo "synchronizing remote branch: $bran"
+    git checkout "$bran"
+    test_or_die "git switching checkout to remote branch: $bran"
+
+    state=$(check_branch_state "$bran")
+    echo "=> branch '$bran' state is: $state"
+
+    remote_branch_info=$(git ls-remote --heads origin $bran 2>/dev/null)
+    if [ ! -z "$remote_branch_info" ]; then
+      # we are pretty sure the remote branch does exist.
+      git pull --no-ff origin "$bran"
+    fi
+    test_or_die "git pull of remote branch: $bran"
+  done
+  # now switch back to our branch.
+  git checkout "$this_branch"
+  test_or_die "git checking out our current branch: $this_branch"
+
+  # now pull down any changes in our own origin in the repo, to stay in synch
+  # with any changes from others.
+  git pull --no-ff --all
+  test_or_die "git pulling all upstream"
+
+  popd &>/dev/null
 }
 
 # gets the latest versions of the assets from the upstream repository.
@@ -230,32 +338,25 @@ function do_update()
   fi
   local blatt="echo retrieving '$nicedir'..."
 
-  local retval=0  # plan on success for now.
   pushd "$directory" &>/dev/null
   if [ -d "CVS" ]; then
     if test_writeable "CVS"; then
       $blatt
-      cvs update . | squash_first_few_crs
-      retval=${PIPESTATUS[0]}
+      cvs update . | $TO_SPLITTER
+      test_or_die "cvs update"
     fi
   elif [ -d ".svn" ]; then
     if test_writeable ".svn"; then
       $blatt
-      svn update . | squash_first_few_crs
-      retval=${PIPESTATUS[0]}
+      svn update . | $TO_SPLITTER
+      test_or_die "svn update"
     fi
   elif [ -d ".git" ]; then
     if test_writeable ".git"; then
       $blatt
-      retval=0
-
-      if [ "$(git_branch_name)" != "master" ]; then
-        git pull origin master 2>&1 | grep -v "X11 forwarding request failed" | squash_first_few_crs
-        retval+=${PIPESTATUS[0]}
-      fi
-
-      git pull 2>&1 | grep -v "X11 forwarding request failed" | squash_first_few_crs
-      retval+=${PIPESTATUS[0]}
+      git pull --no-ff 2>&1 | grep -v "X11 forwarding request failed" | $TO_SPLITTER
+      if [ ${PIPESTATUS[0]} -ne 0 ]; then false; fi
+      test_or_die "git pull of origin without fast forwards"
     fi
   else
     # this is not an error necessarily; we'll just pretend they planned this.
@@ -265,7 +366,7 @@ function do_update()
 
   restore_terminal_title
 
-  return $retval
+  return 0
 }
 
 # gets all the updates for a list of folders under revision control.
@@ -338,8 +439,14 @@ function perform_revctrl_action_on_file()
 
   save_terminal_title
 
+  local did_anything=
+
   while read -u 3 dirname; do
-    if [ -z "$dirname" ]; then continue; fi
+    if [ -z "$dirname" ]; then
+      # we often have blank lines in the input file for some reason.
+      continue
+    fi
+    did_anything=yes
     pushd "$dirname" &>/dev/null
     echo "[$(pwd)]"
     $action .
@@ -348,9 +455,12 @@ function perform_revctrl_action_on_file()
     popd &>/dev/null
   done 3<"$tempfile"
 
+  if [ -z "$did_anything" ]; then
+    echo "There was nothing to do the action '$action' on."
+  fi
+
   restore_terminal_title
 
   rm $tempfile
 }
 
-