{"id":182,"date":"2018-10-22T00:00:00","date_gmt":"2018-10-21T16:00:00","guid":{"rendered":"https:\/\/yeslq.com\/201810182.html"},"modified":"2019-05-07T10:43:40","modified_gmt":"2019-05-07T02:43:40","slug":"the-linux-command-line-errors-and","status":"publish","type":"post","link":"https:\/\/yeslq.com\/?p=182","title":{"rendered":"The Linux Command Line—Errors And Signals And Traps (Oh My!) – Part 1"},"content":{"rendered":"

\nThe Linux Command Line <\/a><\/i>by William Shotts<\/span><\/h1>\n
\n
<\/span><\/div>\n
\n<\/p>\n
\nIn this lesson, we’re going to look at handling errors during the execution of your scripts.<\/div>\n
\nThe difference between a good program and a poor one is often measured in terms of the program’s robustness<\/i>. That is, the program’s ability to handle situations in which something goes wrong.<\/div>\n

\nExit Status<\/h2>\n
\nAs you recall from previous lessons, every well-written program returns an exit status when it finishes. If a program finishes successfully, the exit status will be zero. If the exit status is anything other than zero, then the program failed in some way.<\/div>\n
\nIt is very important to check the exit status of programs you call in your scripts. It is also important that your scripts return a meaningful exit status when they finish. I once had a Unix system administrator who wrote a script for a production system containing the following 2 lines of code:<\/div>\n
\n
# Example of a really bad idea\n\ncd $some_directory\nrm *<\/pre>\n<\/div>\n
\nWhy is this such a bad way of doing it? It’s not, if nothing goes wrong. The two lines change the working directory to the name contained in $some_directoryand delete the files in that directory. That’s the intended behavior. But what happens if the directory named in $some_directory doesn’t exist? In that case, the cd command will fail and the script executes the rm command on the current working directory. Not the intended behavior!<\/div>\n
\nBy the way, my hapless system administrator’s script suffered this very failure and it destroyed a large portion of an important production system. Don’t let this happen to you!<\/div>\n
\nThe problem with the script was that it did not check the exit status of the cd command before proceeding with the rm command.<\/div>\n
\nChecking The Exit Status<\/h2>\n
\nThere are several ways you can get and respond to the exit status of a program. First, you can examine the contents of the $? environment variable. $? will contain the exit status of the last command executed. You can see this work with the following:<\/div>\n
\n
[me] $ true; echo $?\n0\n[me] $ false; echo $?\n1<\/pre>\n<\/div>\n
\nThe true and false commands are programs that do nothing except return an exit status of zero and one, respectively. Using them, we can see how the $?environment variable contains the exit status of the previous program.<\/div>\n
\nSo to check the exit status, we could write the script this way:<\/div>\n
\n
# Check the exit status\n\ncd $some_directory\nif [ \"$?\" = \"0\" ]; then\n rm *\nelse\n echo \"Cannot change directory!\" 1>&2\n exit 1\nfi\n<\/pre>\n<\/div>\n
\nIn this version, we examine the exit status of the cd command and if it’s not zero, we print an error message on standard error and terminate the script with an exit status of 1.<\/div>\n
\nWhile this is a working solution to the problem, there are more clever methods that will save us some typing. The next approach we can try is to use the ifstatement directly, since it evaluates the exit status of commands it is given.<\/div>\n
\nUsing if, we could write it this way:<\/div>\n
\n
# A better way\n\nif cd $some_directory; then\n rm *\nelse\n echo \"Could not change directory! Aborting.\" 1>&2\n exit 1\nfi\n<\/pre>\n<\/div>\n
\nHere we check to see if the cd command is successful. Only then does rm get executed; otherwise an error message is output and the program exits with a code of 1, indicating that an error has occurred.<\/div>\n
\nAn Error Exit Function<\/h2>\n
\nSince we will be checking for errors often in our programs, it makes sense to write a function that will display error messages. This will save more typing and promote laziness.<\/div>\n
\n
# An error exit function\n\nerror_exit()\n{\n echo \"$1\" 1>&2\n exit 1\n}\n\n# Using error_exit\n\nif cd $some_directory; then\n rm *\nelse\n error_exit \"Cannot change directory!  Aborting.\"\nfi\n<\/pre>\n<\/div>\n
\nAND And OR Lists<\/h2>\n
\nFinally, we can further simplify our script by using the AND and OR control operators. To explain how they work, I will quote from the bash<\/a> man page:<\/div>\n
\n“The control operators && and || denote AND lists and OR lists, respectively. An AND list has the form<\/div>\n
\ncommand1 && command2<\/div>\n
\ncommand2 is executed if, and only if<\/i>, command1 returns an exit status of zero.<\/div>\n
\nAn OR list has the form<\/div>\n
\ncommand1 || command2<\/div>\n
\ncommand2 is executed if, and only if, command1 returns a non-zero exit status. The exit status of AND and OR lists is the exit status of the last command executed in the list.”<\/div>\n
\nAgain, we can use the true and false commands to see this work:<\/div>\n
\n
[me] $ true || echo \"echo executed\"\n[me] $ false || echo \"echo executed\"\necho executed\n[me] $ true && echo \"echo executed\"\necho executed\n[me] $ false && echo \"echo executed\"\n[me] $<\/pre>\n<\/div>\n
\nUsing this technique, we can write an even simpler version:<\/div>\n
\n
# Simplest of all\n\ncd $some_directory || error_exit \"Cannot change directory! Aborting\"\nrm *\n<\/pre>\n<\/div>\n
\nIf an exit is not required in case of error, then you can even do this:<\/div>\n
\n
# Another way to do it if exiting is not desired\n\ncd $some_directory && rm *\n<\/pre>\n<\/div>\n
\nI want to point out that even with the defense against errors we have introduced in our example for the use of cd, this code is still vulnerable to a common programming error, namely, what happens if the name of the variable containing the name of the directory is misspelled? In that case, the shell will interpret the variable as empty and the cd succeed, but it will change directories to the user’s home directory, so beware!<\/div>\n
\nImproving The Error Exit Function<\/h2>\n
\nThere are a number of improvements that we can make to the error_exit function. I like to include the name of the program in the error message to make clear where the error is coming from. This becomes more important as your programs get more complex and you start having scripts launching other scripts, etc. Also, note the inclusion of the LINENO environment variable which will help you identify the exact line within your script where the error occurred.<\/div>\n
\n
#!\/bin\/bash\n\n# A slicker error handling routine\n\n# I put a variable in my scripts named PROGNAME which\n# holds the name of the program being run.  You can get this\n# value from the first item on the command line ($0).\n\nPROGNAME=$(basename $0)\n\nerror_exit()\n{\n\n# ----------------------------------------------------------------\n# Function for exit due to fatal program error\n#  Accepts 1 argument:\n#   string containing descriptive error message\n# ----------------------------------------------------------------\n\n\n echo \"${PROGNAME}: ${1:-\"Unknown Error\"}\" 1>&2\n exit 1\n}\n\n# Example call of the error_exit function.  Note the inclusion\n# of the LINENO environment variable.  It contains the current\n# line number.\n\necho \"Example of error with line number and message\"\nerror_exit \"$LINENO: An error has occurred.\"\n<\/pre>\n<\/div>\n
\nThe use of the curly braces within the error_exit function is an example of parameter expansion<\/i>. You can surround a variable name with curly braces (as with ${PROGNAME}) if you need to be sure it is separated from surrounding text. Some people just put them around every variable out of habit. That usage is simply a style thing. The second use, ${1:-“Unknown Error”} means that if parameter 1 ($1) is undefined, substitute the string “Unknown Error” in its place. Using parameter expansion, it is possible to perform a number of useful string manipulations. You can read more about parameter expansion in the bash<\/a> man page under the topic “EXPANSIONS”.<\/div>\n
\n<\/div>\n
<\/span><\/div>\n","protected":false},"excerpt":{"rendered":"
The Linux Command Line by William Shotts In this l … \u9605\u8bfb\u66f4\u591a<\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[50,51,52,53],"class_list":["post-182","post","type-post","status-publish","format-standard","hentry","category-uncategorized","tag-error","tag-linux","tag-shell","tag-the-linux-command-line"],"_links":{"self":[{"href":"https:\/\/yeslq.com\/index.php?rest_route=\/wp\/v2\/posts\/182","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/yeslq.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/yeslq.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/yeslq.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/yeslq.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=182"}],"version-history":[{"count":1,"href":"https:\/\/yeslq.com\/index.php?rest_route=\/wp\/v2\/posts\/182\/revisions"}],"predecessor-version":[{"id":322,"href":"https:\/\/yeslq.com\/index.php?rest_route=\/wp\/v2\/posts\/182\/revisions\/322"}],"wp:attachment":[{"href":"https:\/\/yeslq.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=182"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/yeslq.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=182"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/yeslq.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=182"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}