first attempt to use careful code
[feisty_meow.git] / scripts / rev_control / version_control.sh
index 475ae748c05363a71e510e2be185664ecfa6dc9c..c50ff7a85bd471d12c65f2c53dc28be74e27357e 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"
 
@@ -15,7 +18,9 @@ export MAX_DEPTH=5
 
 # use our splitter tool for lengthy output if it's available.
 if [ ! -z "$(which splitter)" ]; then
-  TO_SPLITTER='| splitter'
+  TO_SPLITTER="$(which splitter)"
+else
+  TO_SPLITTER=cat
 fi
 
 ##############
@@ -34,8 +39,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...
-
 
 ##############
 
@@ -53,11 +56,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
@@ -66,54 +66,54 @@ 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+=$?
 
-      local myself="$(my_branch_name)"
-      local parent="$(parent_branch_name)"
+#      # upload the files to the server so others can see them.
+#      git push 2>&1 | grep -v "X11 forwarding request failed"
+#      if [ ${PIPESTATUS[0]} -ne 0 ]; then false; fi
+#      test_or_die "git push"
+
+      # a new set of steps we have to take to make sure the branch integrity is good.
+      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.
-      if [ "$myself" != "$parent" ]; then
-        git push origin "$(myself)" 2>&1 | grep -v "X11 forwarding request failed" $TO_SPLITTER
-        retval+=${PIPESTATUS[0]}
-      else
-        # this branch is the same as the parent, so just push.
-        git push 2>&1 | grep -v "X11 forwarding request failed" $TO_SPLITTER
-        retval+=${PIPESTATUS[0]}
-      fi
+      git push 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.
@@ -124,25 +124,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.
@@ -153,7 +152,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
@@ -161,17 +159,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.
@@ -193,7 +191,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
@@ -201,7 +199,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
@@ -232,13 +230,97 @@ function squash_first_few_crs()
 # git repository.
 function my_branch_name()
 {
-  echo "$(git branch | grep \* | cut -d ' ' -f2)"
+  echo "$(git branch | 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()
+##function parent_branch_name()
+##{
+  ##echo "$(git branch -vv | grep \* | cut -d ' ' -f2)"
+##}
+
+# this exits with 0 for success (normal bash behavior) when up to date.  if the branch is not up to date,
+# then these values are returned:
+#DOCUMENT THE VALUES
+# 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.
+
+sep
+
+  LOCAL=$(git rev-parse @)
+  REMOTE=$(git rev-parse "$branch")
+  BASE=$(git merge-base @ "$branch")
+var branch LOCAL REMOTE BASE
+
+  if [ "$LOCAL" == "$REMOTE" ]; then
+    echo "Up-to-date"
+    to_return=0
+  elif [ "$LOCAL" == "$BASE" ]; then
+    echo "Need to pull"
+    to_return=1
+  elif [ "$REMOTE" == "$BASE" ]; then
+    echo "Need to push"
+    to_return=2
+  else
+    echo "Diverged"
+    to_return=3
+  fi
+
+sep
+
+  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
+# do_checkin method.
+function careful_git_update()
 {
-  echo "$(git branch -vv | grep \* | cut -d ' ' -f2)"
+
+  local this_branch="$(my_branch_name)"
+
+#we want my branch here, don't we?  not like parent or anything?
+  check_branch_state "$this_branch"
+  state=$?
+  test_or_continue "branch state check"
+  echo the branch state is $state
+#need to instead do something here if fails.
+# above is worse than useless code; in the situations i'm seeing fail, it reports no changes.  *&@#*&@#
+
+echo DOING BRANCH WALKER
+  # the above are just not enough.  this code is now doing what i have to do when i repair the repo.
+  local branch_list=$(git branch |grep -v '^\*')
+  local bran
+  for bran in $branch_list; do
+echo GETTING LATEST ON: $bran
+    git checkout "$bran"
+    test_or_die "git checking out remote branch: $bran"
+    git pull --no-ff
+    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"
+
+echo NOW REMOTE UPDATE
+
+  # first update all our remote branches to their current state from the repos.
+  git remote update
+  test_or_die "git remote update"
+
+echo NOW THE FULL PULL
+  # 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"
+
+echo DONE CAREFUL UPDATE
+
 }
 
 # gets the latest versions of the assets from the upstream repository.
@@ -255,40 +337,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
-
-      # from very helpful page:
-      # https://stackoverflow.com/questions/10312521/how-to-fetch-all-git-branches
-      git branch -r | grep -v '\->' |
-          while read remote; do
-            git branch --track "${remote#origin/}" "$remote"
-            # ensure we notice a failure when adding tracking.
-            retval+=$?
-          done
-      retval+=${PIPESTATUS[0]}$?
-
-      git fetch --all 2>&1 | grep -v "X11 forwarding request failed" $TO_SPLITTER
-      retval+=${PIPESTATUS[0]}
-
-      git pull --all 2>&1 | grep -v "X11 forwarding request failed" $TO_SPLITTER
-      retval+=${PIPESTATUS[0]}
+      git pull --no-ff origin 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.
@@ -298,7 +365,7 @@ function do_update()
 
   restore_terminal_title
 
-  return $retval
+  return 0
 }
 
 # gets all the updates for a list of folders under revision control.
@@ -386,4 +453,3 @@ function perform_revctrl_action_on_file()
   rm $tempfile
 }
 
-