statab.sh not issuing nonzero return code on error

[rpguiteras]

Initially this worked as intended but recently has ceased issuing a nonzero return code when the Stata do-file exits with error.

to try to trace out what is happening, I made just a few slight changes to your statab.sh file,

adding -echo $rc- right after the rc variable is created
commenting out the
rm "$log"
line and then adding
echo "$log"
echo $rc

so that I could examine what is happening and what may be getting missed.

When I run a properly working do-file (named "reducedForm.do"), I get what we expect:

ARE10165 /cygdrive/w/BD_Sanitation_Social/analysis(checkBatch *%) $ ./code/bin/statab.sh do code/reducedForm.do
0
reducedForm.log
0

and there is no error and the log-file concludes as we would expect.

(Note that -echo "$log"- returning reducedForm.log means (I think) that statab.sh is finding the .log file correctly.)

However, when I intentionally mess up reducedForm.do to cause an error, I get the same thing:

ARE10165 /cygdrive/w/BD_Sanitation_Social/analysis(checkBatch *%) $ ./code/bin/statab.sh do co de/reducedForm.do
0
reducedForm.log
0

Even though the .log file has an error at the end:

. boom
--Break--
r(1);

end of do-file
--Break--
r(1);

So I guess something is happening when creating the rc variable

$STATABATCH $cmd "$@" 2>&1 | tail -100 > $log.extra
rc=$?

or

    if egrep --before-context=1 --max-count=1 "^r\([0-9]+\);$" "$log"
    then
        rc=1
    fi

such that rc is not picking up the error in the log-file.

I've attached the slightly modified statab.sh file. (saved as .txt so that github will allow the attachment)

statab.txt

[rpguiteras]

I notice I was using an earlier version of statab.sh, but the issue continues with the current version. The slightly modified current version - echoing some comments and current values of rc - is below.

End of log-file:

. boom
--Break--
r(1);

end of do-file
--Break--
r(1);

What I see at the terminal

$ ./code/bin/statab.sh do code/reducedForm.do
initial rc
0
Return the real error by checking the log
0
about to egrep
0

Slightly modified statab.sh follows. It looks like the problem is that the line

if egrep --before-context=1 --max-count=1 "^r\([0-9]+\);$" "$log"

is not doing what it's supposed to do.

#! /bin/bash
# Wrapper for Stata batch-mode which:
#  -issues an informative error msg and appropriate (possibly non-zero) return code
#  -allows an implicit -do- when called with just a do file
#  -fixes timezone when run under Cygwin
#  -remove the forced-generated log file
# Requirements: set $STATABATCH (e.g. 'stata-mp -b')

# updated from Phil Schumm's version at https://gist.github.com/pschumm/b967dfc7f723507ac4be

args=$#  # number of args
    

# Figure out where the log will be
cmd=""
if [ "$1" = "do" ] && [ "$args" -gt 1 ]
then
    log="`basename "$2" .do`.log"
    # mimic Stata's behavior (stata -b do "foo bar.do" -> foo.log)
    log=${log/% */.log}
# Stata requires explicit -do- command, but we relax this to permit just the
# name of a single do-file
elif [ "$args" -eq 1 ] && [ "${1##*.}" = "do" ] && [ "$1" != "do" ]
then
    cmd="do"
    log="`basename "$1" .do`.log"
    log=${log/% */.log}
else
    log="stata.log"    
fi

#MSVC-compiled programs run under Cygwin can't interpret the TZ
# var correctly so wrongly return UTC/GMT. Solution: unset TZ for this shell
# http://stackoverflow.com/questions/11655003/
if [ "$OS" = "Windows_NT" ]; then
    unset TZ
fi

# in batch mode, normally nothing sent to stdout
# but plugins can and some generate lots of comments
$STATABATCH $cmd "$@" 2>&1 | tail -100 > stata_out.log
rc=$?
echo "initial rc"
echo $rc
# delete stata_out.log if empty
if ! [ -s stata_out.log ]; then
    rm stata_out.log
else
    #checks if var is sets vs (set to "" or unset)
    if [ -z "$STATATMP" ]; then
        if [ "$OS" = "Windows_NT" ]; then
            #under Cygwin reassigns TEMP so can't get original. Use default.
            STATATMP=$LOCALAPPDATA/Temp
        else
            STATATMP=$TMPDIR
        fi
    fi
    mv stata_out.log ${STATATMP}
fi

#Return the real error by checking the log
echo "Return the real error by checking the log"
echo $rc
if [ $rc == "0" ]
then
    # use --max-count to avoid matching final line ("end of do-file") when
    # do-file terminates with error
    echo "about to egrep"
    if egrep --before-context=1 --max-count=1 "^r\([0-9]+\);$" "$log"
    then
        echo "in egrep then"
        rc=1
        echo $rc
    fi
fi

#rm "$log"
echo $rc
exit $rc

[rpguiteras]

Submitted pull request

https://github.com/bquistorff/Stata-modules/pull/2/commits/7f6b1d782cdc4a0cd0bd3a167adacc111d9288ef