More enhancements to build_nmh.

[nmh] / docs / contrib / build_nmh

diff --git a/docs/contrib/build_nmh b/docs/contrib/build_nmh
index 499fadea11c4998a5ac2823a825abaf19bf24066..90e733a5b2edc25a60a2239a041d19ea126aaf7f 100755 (executable)
--- a/docs/contrib/build_nmh
+++ b/docs/contrib/build_nmh
@@ -1,12 +1,17 @@
 #! /bin/sh
 #
 # Configures and builds nmh.
 #! /bin/sh
 #
 # Configures and builds nmh.

-# * This script must be invoked from an nmh source directory.
+# * If this script is not invoked from an nmh source directory, it
+#   will attempt to download the nmh sources.

 # * This script retrieves configuration from the first existing nmh
 #   installation on your $PATH, if any.
 # * Unless the -y option is provided, this script then interactively
 #   walks you through confirmation of common configuration settings.
 #
 # * This script retrieves configuration from the first existing nmh
 #   installation on your $PATH, if any.
 # * Unless the -y option is provided, this script then interactively
 #   walks you through confirmation of common configuration settings.
 #

+# This file can be downloaded and immediately run using, e.g.,
+#   wget http://git.savannah.gnu.org/cgit/nmh.git/plain/docs/contrib/build_nmh
+#   sh build_nmh
+#

 # Typical usage:
 # The first time you invoke this script, use the -i option to install
 # nmh in the specified location.  The script will walk you through the
 # Typical usage:
 # The first time you invoke this script, use the -i option to install
 # nmh in the specified location.  The script will walk you through the


@@ -19,12 +24,13 @@
 #
 # Option summary:
 #   First time use:
 #
 # Option summary:
 #   First time use:

+#     -b <branch> to specify branch to check out, only if downloading sources

 #     -i to install nmh
 #     -v to display progress
 #   Subsequent uses, assuming installed nmh bin directory is on $PATH:
 #     -y to accept all configuration options without confirmation
 #   Output control:
 #     -i to install nmh
 #     -v to display progress
 #   Subsequent uses, assuming installed nmh bin directory is on $PATH:
 #     -y to accept all configuration options without confirmation
 #   Output control:

-#     -l <logfile name>, default 'build_nmh.log'
+#     -l <logfile name>, default 'build_nmh.log', - for stdout/stderr

 #   Advanced/developer use:
 #     -c to run 'make distcheck' instead of 'make check'
 #     -d to build nmh with debug enabled
 #   Advanced/developer use:
 #     -c to run 'make distcheck' instead of 'make check'
 #     -d to build nmh with debug enabled


@@ -32,18 +38,65 @@
 #        see docs/README.developers
 #     -r to build rpm
 #
 #        see docs/README.developers
 #     -r to build rpm
 #

-# On Fedora, at least these rpms must be installed:
-#   gdbm-devel
-#   ncurses-devel
-#   cyrus-sasl-devel, if using sasl
-#   openssl-devel, if using TLS
-#   autoconf and automake, with -s (see docs/README.developers for versions)
-#   rpm-build, with -r
+# To disable colorization of the test summary, either unset the TERM
+# environment variable or set it to dumb, e.g., TERM=dumb build_nmh.
+#
+# See the nmh MACHINES file for build prerequisites.  In addition, the rpmbuild
+# is required to be available if the -r option is used.
+
+usage="usage: $0
+  [-b <branch>, only if downloading]
+  [-c to run 'make distcheck' instead of 'make check']
+  [-d to build nmh with debug enabled]
+  [-i to install nmh]
+  [-l <logfile name>, default '$logfile']
+  [-r to build rpm]
+  [-s to use 'make superclean': requires recent autoconf and automake]
+  [-v to display progress]
+  [-y to accept all configuration options without confirmation]"
+
+#### Exit with error message.
+die() {
+  status=1
+  exec 1>&3 3>&- 2>&4 4>&-
+  cat "$tmpfile" 1>&2
+  echo "$0: $*" 1>&2
+  exit 1
+}
+
+#### Find location of a program.  Bourne shell just puts the name in
+#### $0 if it's found from the PATH, so search that if necessary.
+finddir() {
+  case $1 in
+    */*) dirname "$1" ;;
+    *  ) IFS=:
+         for d in $PATH; do
+           [ -f "${d:=.}/$1"  -a  -x "$d/$1" ]  &&  printf %s "$d"  &&  break
+         done ;;
+  esac
+}
+
+#### Make sure user sees error output even on early termination.  Assumes
+#### that called programs exit with non-zero status when terminated.
+cleanup() {
+  if [ $status -eq 0 ]; then
+    rm -f "$tmpfile"
+  else
+    [ $logfile = - ] && cat "$tmpfile" 1>&3 || mv "$tmpfile" "$logfile"
+  fi
+}
+trap cleanup EXIT
+
+directory=
+gitrepo=git.savannah.nongnu.org
+invocation="$0 $*"
+tmpfile=/tmp/build_nmh-$$.log

 
 
 ####
 #### Interpret command arguments.
 ####
 
 
 ####
 #### Interpret command arguments.
 ####

+branch=master

 check=check
 debug=0
 install=0
 check=check
 debug=0
 install=0


@@ -52,18 +105,10 @@ build_rpm=0
 superclean=0
 verbose=0
 yes=0
 superclean=0
 verbose=0
 yes=0

-usage="usage: $0
-  [-c to run 'make distcheck' instead of 'make check']
-  [-d to build nmh with debug enabled]
-  [-i to install nmh]
-  [-l <logfile name>, default '$logfile']
-  [-r to build rpm]
-  [-s to use 'make superclean': requires recent autoconf and automake]
-  [-v to display progress]
-  [-y to accept all configuration options without confirmation]"

 
 

-while getopts 'cdil:rsvy?' arg; do
+while getopts 'cb:dil:rsvy?' arg; do

   case $arg in
   case $arg in

+    b  ) branch="$OPTARG" ;;

     c  ) check=distcheck ;;
     d  ) debug=1 ;;
     i  ) install=1 ;;
     c  ) check=distcheck ;;
     d  ) debug=1 ;;
     i  ) install=1 ;;


@@ -77,18 +122,59 @@ while getopts 'cdil:rsvy?' arg; do
 done
 shift `expr $OPTIND - 1`
 
 done
 shift `expr $OPTIND - 1`
 

-#### No command line arguments are supported.
-if [ $# -gt 0 ]; then
-  echo "usage: $0"
-  exit 1
-fi
+#### Redirect all output to tmp file.  Then at end of script, copy
+#### it to either logfile or stdout.  Also, grep it for errors and
+#### warnings.
+exec 3>&1 4>&2 >"$tmpfile" 2>&1
+
+echo "$invocation"
+
+#### No non-option command line arguments are supported.
+[ $# -gt 0 ]  &&  die "$usage"

 
 #### Check to see that we're in a nmh source directory.
 
 #### Check to see that we're in a nmh source directory.

-if grep 'the authors of nmh' COPYRIGHT >/dev/null; then
+if grep 'the authors of nmh' COPYRIGHT >/dev/null 2>&1; then

   :
 else
   :
 else

-  echo "$0: not in nmh source directory"
-  exit 1
+  #### Download sources from repo.
+  [ $verbose -ge 1 ]  &&  echo downloading . . . >&3
+  gitdir=`finddir git`
+  if [ "$gitdir" ]; then
+    #### Use git repo.
+    [ "$verbose" -eq 0 ]  &&  git_opts=--quiet
+    [ "$branch" == master ]  ||
+      git_opts="${git_opts:+$git_opts }--branch $branch"
+    if "$gitdir"/git clone --depth 1 $git_opts "git://$gitrepo/nmh.git" >&3; then
+      directory=nmh
+      cd "$directory"  ||  die "failed to clone $directory"
+      printf "commit %s\n" `git log --max-count=1 --pretty=format:%H`
+    else
+      die 'failed to clone git repo'
+    fi
+  else
+    [ -e nmh-"$branch" ]  &&  die "nmh-$branch exists, will not overrwrite"
+
+    #### Use snapshot.
+    tarball="nmh-$branch.tar.gz"
+    repo="http://$gitrepo/cgit/nmh.git/snapshot"
+    snapshot="$repo/$tarball"
+    if [ "`finddir wget`" ]; then
+      [ "$verbose" -eq 0 ] && wget_opts='--quiet'
+      wget --output-document - $wget_opts "$snapshot" 2>&3 | gzip -d | tar xf -
+    elif [ "`finddir curl`" ]; then
+      [ "$verbose" -eq 0 ] && curl_opts='--silent --show-error'
+      curl --location $curl_opts "$snapshot" 2>&3 | gzip -d | tar xf -
+    else
+      die 'unable to find program to download nmh sources'
+    fi
+
+    if [ -d nmh-"$branch" ]; then
+      directory=nmh-"$branch"
+      cd "$directory"  ||  die "failed to download and extract $directory"
+    else
+      die "failed to download nmh-$branch sources"
+    fi
+  fi

 fi
 
 ####
 fi
 
 ####


@@ -104,21 +190,10 @@ config_mts=smtp
 config_smtpservers=localhost
 config_sasl=n
 config_tls=n
 config_smtpservers=localhost
 config_sasl=n
 config_tls=n

+config_oauth=n

 config_debug=n
 
 
 config_debug=n
 
 

-#### Find location of a program.  Bourne shell just puts the name in
-#### $0 if it's found from the PATH, so search that if necessary.
-finddir() {
-  case $1 in
-    */*) dirname "$1" ;;
-    *  ) IFS=:
-         for d in $PATH; do
-           [ -f "${d:=.}/$1"  -a  -x "$d/$1" ]  &&  printf %s "$d"  &&  break
-         done ;;
-  esac
-}
-

 #### Figure out whether or not to use -n with tail.
 case `printf 'OK\n' | tail -n 1 2>&1` in
   OK) tail='tail -n ' ;;
 #### Figure out whether or not to use -n with tail.
 case `printf 'OK\n' | tail -n 1 2>&1` in
   OK) tail='tail -n ' ;;


@@ -126,7 +201,7 @@ case `printf 'OK\n' | tail -n 1 2>&1` in
 esac
 
 if install-mh -check >/dev/null 2>&1; then
 esac
 
 if install-mh -check >/dev/null 2>&1; then

-  # Determine config options from installed nmh.
+  #### Determine config options from installed nmh.

   mhbin=`finddir install-mh`
 
   config_prefix=`cd $mhbin/.. && pwd`
   mhbin=`finddir install-mh`
 
   config_prefix=`cd $mhbin/.. && pwd`


@@ -158,10 +233,14 @@ if install-mh -check >/dev/null 2>&1; then
       case `$mhbin/mhparam tls` in
         *tls*) config_tls=y ;;
       esac
       case `$mhbin/mhparam tls` in
         *tls*) config_tls=y ;;
       esac

+
+      case `$mhbin/mhparam oauth` in
+        *oauth*) config_oauth=y ;;
+      esac

     else
       tput smso
     else
       tput smso

-      echo "$0: SASL and TLS detection not supported with current nmh"
-      [ $yes -eq 1 ]  &&  echo "will not configure either one in"
+      echo "$0: SASL, TLS, and OAuth2 detection not supported with current nmh"
+      [ $yes -eq 1 ]  &&  echo "will not configure them in"

       tput rmso
     fi
   fi
       tput rmso
     fi
   fi


@@ -171,40 +250,36 @@ fi
 
 if [ $yes -eq 0 ]; then
   #### Confirm each config setting with user.
 
 if [ $yes -eq 0 ]; then
   #### Confirm each config setting with user.

-  printf 'Install prefix [%s]: ' $config_prefix
+  printf 'Install prefix [%s]: ' $config_prefix >&3

   read prefix
   [ "$prefix" ]  &&  config_prefix="$prefix"
 
   read prefix
   [ "$prefix" ]  &&  config_prefix="$prefix"
 

-  printf 'Locking type (dot|fcntl|flock|lockf) [determined by configure]: '
+  printf 'Locking type (dot|fcntl|flock|lockf) [determined by configure]: ' >&3

   read locking
   [ "$locking" ]  &&  config_locking="$locking"
 
   read locking
   [ "$locking" ]  &&  config_locking="$locking"
 

-  printf 'MTS (smtp|sendmail/smtp|sendmail/pipe) [%s]: ' $config_mts
+  printf 'MTS (smtp|sendmail/smtp|sendmail/pipe) [%s]: ' $config_mts >&3

   read mts
   [ "$mts" ]  &&  config_mts="$mts"
 
   if [ "$config_mts" = smtp ]; then
   read mts
   [ "$mts" ]  &&  config_mts="$mts"
 
   if [ "$config_mts" = smtp ]; then

-    printf 'SMTP server(s), space separated [%s]: ' $config_smtpservers
+    printf 'SMTP server(s), space separated [%s]: ' $config_smtpservers >&3

     read response
     servers=`echo $response | sed -e 's/ /\\\ /g'`
     [ "$servers" ]  &&  config_smtpservers="$servers"
   fi
 
     read response
     servers=`echo $response | sed -e 's/ /\\\ /g'`
     [ "$servers" ]  &&  config_smtpservers="$servers"
   fi
 

-  printf 'Cyrus SASL support [%s]: ' $config_sasl
+  printf 'Cyrus SASL support [%s]: ' $config_sasl >&3

   read response
   read response

-  if [ "$response" = y  -o  "$response" = Y ]; then
-    config_sasl=y
-  elif [ "$response" = n  -o  "$response" = N ]; then
-    config_sasl=n
-  fi
+  [ "$response" = y  -o  "$response" = Y ]  &&  config_sasl=y

 
 

-  printf 'TLS support [%s]: ' $config_tls
+  printf 'TLS support [%s]: ' $config_tls >&3

   read response
   read response

-  if [ "$response" = y  -o  "$response" = Y ]; then
-    config_tls=y
-  elif [ "$response" = n  -o  "$response" = N ]; then
-    config_tls=n
-  fi
+  [ "$response" = y  -o  "$response" = Y ]  &&  config_tls=y
+
+  printf 'OAuth2 support [%s]: ' $config_oauth >&3
+  read response
+  [ "$response" = y  -o  "$response" = Y ]  &&  config_oauth=y

 
   #### Don't confirm debug here:  obey the -d option to this script.
 fi
 
   #### Don't confirm debug here:  obey the -d option to this script.
 fi


@@ -212,23 +287,20 @@ fi
 smtpservers=
 config_opts="--prefix=$config_prefix"
 
 smtpservers=
 config_opts="--prefix=$config_prefix"
 

-[ "$config_locking" ]  &&  \
+[ "$config_locking" ]  &&

   config_opts="$config_opts --with-locking=$config_locking"
   config_opts="$config_opts --with-locking=$config_locking"

-[ "$config_mts"  -a  "$config_mts" != smtp ]  &&  \
+[ "$config_mts"  -a  "$config_mts" != smtp ]  &&

   config_opts="$config_opts --with-mts=$config_mts"
   config_opts="$config_opts --with-mts=$config_mts"

-[ "$config_smtpservers"  -a  "$config_smtpservers" != localhost ]  &&  \
+[ "$config_smtpservers"  -a  "$config_smtpservers" != localhost ]  &&

   smtpservers="--with-smtpservers=$config_smtpservers"
   smtpservers="--with-smtpservers=$config_smtpservers"

-[ "$config_sasl" = y ]  &&  \
-  config_opts="$config_opts --with-cyrus-sasl"
-[ "$config_tls" = y ]  &&  \
-  config_opts="$config_opts --with-tls"
-[ $config_debug = y ]  &&  \
-  config_opts="$config_opts --enable-debug --enable-assert"
-
+[ "$config_sasl" = y ]  &&  config_opts="$config_opts --with-cyrus-sasl"
+[ "$config_tls" = y ]  &&  config_opts="$config_opts --with-tls"
+[ "$config_oauth" = y ]  &&  config_opts="$config_opts --with-oauth"
+[ $config_debug = y ]  &&  config_opts="$config_opts --enable-assert"

 
 #### dotlocking, the usual default, requires chgrp and chmod of inc.
 installpriv=
 
 #### dotlocking, the usual default, requires chgrp and chmod of inc.
 installpriv=

-if [ $install -ge 1  -a  `id -u` -ne 0 ]; then
+if [ $install -ge 1  -a  "$LOGNAME" != root ]; then

   if [ "$config_locking" = dot ]; then
     echo "$0: "'install requires chgrp and chmod 2755'
     echo 'so will sudo to install.  Terminate with Ctrl-C if unacceptable.'
   if [ "$config_locking" = dot ]; then
     echo "$0: "'install requires chgrp and chmod 2755'
     echo 'so will sudo to install.  Terminate with Ctrl-C if unacceptable.'


@@ -236,12 +308,14 @@ if [ $install -ge 1  -a  `id -u` -ne 0 ]; then
   fi
 fi
 
   fi
 fi
 

+printf '\n%s %s %s %s\n\n' "`uname -m`" "`uname -s`" "`uname -r`" "`uname -v`"
+[ -f /etc/os-release ]  &&  printf '%s\n\n' "`cat /etc/os-release`"

 
 ####
 
 ####

-#### Clean up, and set up with autoconfig if necessary.
+#### Set up with autoconfig if necessary.

 ####
 if [ -f Makefile ]; then
 ####
 if [ -f Makefile ]; then

-  [ $verbose -ge 1 ]  &&  echo cleaning . . .
+  [ $verbose -ge 1 ]  &&  echo cleaning . . . >&3

   if [ $superclean -ge 1 ]; then
     make superclean >/dev/null
   else
   if [ $superclean -ge 1 ]; then
     make superclean >/dev/null
   else


@@ -249,26 +323,35 @@ if [ -f Makefile ]; then
   fi
 fi
 
   fi
 fi
 

-/bin/rm -f "$logfile"
-if [ -f configure  -a  -f Makefile.in ]; then
-  :
-else
-  [ $verbose -ge 1 ]  &&  echo autoconfiguring . . .
-  ./autogen.sh >>"$logfile" 2>&1
+if [ ! -f configure  -o  ! -f Makefile.in ]; then
+  [ $verbose -ge 1 ]  &&  echo autoconfiguring . . . >&3
+  ./autogen.sh
+  [ $? -ne 0 ]  &&
+    die "autogen failed, see MACHINES file for autoconf,
+automake, flex, and bison requirements"

 fi
 
 
 ####
 #### Build.
 ####
 fi
 
 
 ####
 #### Build.
 ####

-[ $verbose -ge 1 ]  &&  echo configuring . . .
-echo ./configure $config_opts ${smtpservers:+"$smtpservers"} >>"$logfile" 2>&1
-./configure $config_opts ${smtpservers:+"$smtpservers"} >>"$logfile" 2>&1
+[ $verbose -ge 1 ]  &&  echo configuring . . . >&3
+if [ -z "$CFLAGS" ]; then
+  #### Only use these flags with gcc.
+  if cc -dM -E - </dev/null 2>&1 | grep __GNUC__ >/dev/null; then
+    #### configure will supply -g -O2 with gcc, but only if CFLAGS
+    #### isn't defined.
+    CFLAGS='-g -O2 -ansi -pedantic'
+  fi
+fi
+
+printf '\n./configure %s\n' "$config_opts${smtpservers:+ $smtpservers}"
+./configure CFLAGS="${CFLAGS}" $config_opts${smtpservers:+" $smtpservers"}

 status=$?
 
 if [ $status -eq 0 ]; then
 status=$?
 
 if [ $status -eq 0 ]; then

-  [ $verbose -ge 1 ]  &&  echo building . . .
-  make >>"$logfile" 2>&1
+  [ $verbose -ge 1 ]  &&  echo building . . . >&3
+  make

   status=$?
 
   if [ $status -eq 0 ]; then
   status=$?
 
   if [ $status -eq 0 ]; then


@@ -279,10 +362,18 @@ if [ $status -eq 0 ]; then
       if [ -x "$heirloom_shell" ]; then
         TESTS_SHELL="$heirloom_shell"; export TESTS_SHELL
       fi
       if [ -x "$heirloom_shell" ]; then
         TESTS_SHELL="$heirloom_shell"; export TESTS_SHELL
       fi

-   fi
+    fi

 
 

-    [ $verbose -ge 1 ]  &&  echo testing . . .
-    checkoutput=`make $check AM_COLOR_TESTS=always 2>>"$logfile"`
+    if [ "$CFLAGS" ]; then
+        #### Pass DISTCHECK_CONFIGURE_FLAGS through an environment
+        #### variable to avoid automake's quoting.
+        DISTCHECK_CONFIGURE_FLAGS="CFLAGS='${CFLAGS}'"
+        export DISTCHECK_CONFIGURE_FLAGS
+    fi
+
+    [ $verbose -ge 1 ]  &&  echo testing . . . >&3
+    [ "${TERM:-dumb}" = dumb ]  &&  color=no  ||  color=always
+    checkoutput=`make $check AM_COLOR_TESTS=$color`

     status=$?
 
     tests_summary=`echo "$checkoutput" | grep tests`
     status=$?
 
     tests_summary=`echo "$checkoutput" | grep tests`


@@ -291,39 +382,53 @@ if [ $status -eq 0 ]; then
     test_not_run=`echo "$checkoutput" | grep 'test was not run'`
     fails=`echo "$checkoutput" | grep FAIL`
     if [ "$tests_summary" ]; then
     test_not_run=`echo "$checkoutput" | grep 'test was not run'`
     fails=`echo "$checkoutput" | grep FAIL`
     if [ "$tests_summary" ]; then

-      echo '===================' >>"$logfile"
-      [ "$test_not_run" ]  &&  echo "$test_not_run" >>"$logfile"
-      [ "$fails" ]  &&  echo "$fails" >>"$logfile"
-      echo "$tests_summary" >>"$logfile"
-      echo '===================' >>"$logfile"
-      [ "$check" = distcheck ]  &&  \
-        echo "$checkoutput" | ${tail}4 >>"$logfile"
+      echo '==================='
+      [ "$test_not_run" ]  &&  echo "$test_not_run"
+      [ "$fails" ]  &&  echo "$fails"
+      echo "$tests_summary"
+      echo '==================='
+      [ "$check" = distcheck ]  &&  echo "$checkoutput" | ${tail}4

     fi
 
     if [ $status -eq 0 ]; then
       if [ $install -ge 1 ]; then
     fi
 
     if [ $status -eq 0 ]; then
       if [ $install -ge 1 ]; then

-        [ $verbose -ge 1 ]  &&  echo installing . . .
-        ($installpriv make install) >/dev/null 2>>"$logfile"
+        [ $verbose -ge 1 ]  &&  echo installing . . . >&3
+        ($installpriv make install) >/dev/null

         status=$?
       fi
 
       if [ $status -eq 0  -a  $build_rpm -ge 1 ]; then
         status=$?
       fi
 
       if [ $status -eq 0  -a  $build_rpm -ge 1 ]; then

-        [ $verbose -ge 1 ]  &&  echo building rpm . . .
-        make rpm >/dev/null 2>>"$logfile"
+        [ $verbose -ge 1 ]  &&  echo building rpm . . . >&3
+        make rpm >/dev/null

         status=$?
       fi
     fi
   fi
         status=$?
       fi
     fi
   fi

+else
+  echo "see nmh MACHINES file for build dependences"

 fi
 
 fi
 

-grep Error "$logfile"
-grep warn "$logfile"
+####
+#### Report results.
+####

 
 

-if [ $status -eq 0 ]; then
-  [ $verbose -ge 1 ]  &&  echo build completed successfully
-else
-  echo build failed!
-  echo build log is in "$logfile"
+#### Disable output redirection (and flush) so that we can grep.
+exec 1>&3 3>&- 2>&4 4>&-
+
+if [ "$logfile" != - ]; then
+  rm -f "$logfile"
+  exec 3>&1 >"$logfile" 2>&1
+fi
+
+[ -f "$tmpfile" ]  &&  cat "$tmpfile"
+[ -f "$tmpfile" ]  &&  grep -E 'Error|warn' "$tmpfile"
+
+#### Put message on stdout, and in log if different.
+if [ $status -ne 0  -o  $verbose -ge 1  -o  "$directory" ]; then
+  [ $status -eq 0 ]  &&  indication=succeeded  ||  indication=failed
+  message="build $indication, build log is in ${directory:+$directory/}$logfile"
+  echo "$message"
+  [ "$logfile" = - ]  ||  echo "$message" >&3

 fi
 
 exit $status
 fi
 
 exit $status