set -o pipefail in Bash Scripting - Cheat Sheet & Quick Revision

Recall & Review

beginner

What does set -o pipefail do in a bash script?

set -o pipefail makes the script return the exit status of the rightmost failed command in a pipeline instead of the last command.

beginner

Why is set -o pipefail useful in scripting?

It helps catch errors in any command within a pipeline, making scripts more reliable by not hiding failures.

beginner

What is the default behavior of bash pipelines without set -o pipefail?

By default, bash returns the exit status of the last command in the pipeline, ignoring failures in earlier commands.

beginner

How do you enable pipefail in a bash script?

Use the command set -o pipefail or set -e -o pipefail to enable it.

intermediate

Example: What will be the exit status of false | true with and without set -o pipefail?

Without set -o pipefail, exit status is 0 (success) because the last command true succeeds.
With set -o pipefail, exit status is 1 (failure) because false failed.

What does set -o pipefail change in bash pipelines?

A Returns the exit status of the rightmost failed command in the pipeline

B Ignores all errors in the pipeline

C Always returns 0 regardless of errors

D Returns the exit status of the last command only

set -o pipefail makes bash return the exit status of the rightmost command that fails in a pipeline, improving error detection.

Without set -o pipefail, what exit status does bash return for false | true?

A 2

B 1

C 0

D Depends on shell version

By default, bash returns the exit status of the last command in the pipeline, which is true (0).

How do you enable pipefail in a bash script?

A set -o pipefail

B enable pipefail

C pipefail on

D set pipefail true

The correct command is set -o pipefail to enable this option.

Which of these is a benefit of using set -o pipefail?

A It hides errors in pipelines

B It helps detect errors in any command of a pipeline

C It makes scripts run faster

D It disables all error checking

set -o pipefail helps detect errors anywhere in a pipeline, making scripts safer.

What is the default exit status behavior of bash pipelines without pipefail?

A Always 0

B Exit status of the first command

C Always 1

D Exit status of the last command

By default, bash returns the exit status of the last command in the pipeline.

Explain what set -o pipefail does and why it is important in bash scripting.

Think about how bash normally reports pipeline errors.

Describe a scenario where not using set -o pipefail could cause a script to miss an error.

Consider a pipeline like <code>false | true</code>.

Practice

1. What does the set -o pipefail command do in a bash script?

easy

A. It makes the pipeline return the exit status of the last failed command.

B. It disables all error checking in the script.

C. It forces the script to ignore errors in pipelines.

D. It restarts the pipeline if any command fails.

Solution

1. Step 1: Understand pipeline exit status behavior

   Normally, a pipeline returns the exit status of the last command only, ignoring failures in earlier commands.

2. Step 2: Effect of set -o pipefail

   This option changes the pipeline's exit status to that of the last failed command, making error detection more reliable.

3. Final Answer:

   It makes the pipeline return the exit status of the last failed command. -> Option A

4. Quick Check:

   Pipeline failure detection = It makes the pipeline return the exit status of the last failed command. [OK]

Hint: Remember: pipefail catches failures anywhere in a pipeline [OK]

Common Mistakes:

• Thinking it disables error checking
• Assuming it restarts pipelines on failure
• Believing it ignores errors in commands

2. Which of the following is the correct way to enable pipefail in a bash script?

easy

A. set pipefail on

B. set -o pipefail

C. enable pipefail

D. pipefail enable

Solution

1. Step 1: Recall bash syntax for options

   Bash uses set -o option_name to enable shell options.

2. Step 2: Identify correct syntax for pipefail

   The correct command to enable pipefail is set -o pipefail.

3. Final Answer:

   set -o pipefail -> Option B

4. Quick Check:

   Enable pipefail = set -o pipefail [OK]

Hint: Use 'set -o' before option name to enable it [OK]

Common Mistakes:

• Using 'set pipefail on' which is invalid syntax
• Trying 'enable pipefail' which is not a bash command
• Writing 'pipefail enable' which is incorrect order

3. Consider this script snippet with set -o pipefail enabled:

set -o pipefail
false | true | true
echo $? 

What will be the output?

medium

A. 1

B. 0

C. 2

D. 3

Solution

1. Step 1: Understand commands in pipeline

   The first command false returns exit status 1 (failure), the others return 0 (success).

2. Step 2: Effect of set -o pipefail

   With pipefail, the pipeline exit status is the exit status of the last failed command, which is 1.

3. Final Answer:

   1 -> Option A

4. Quick Check:

   Pipeline exit status = last failure = 1 [OK]

Hint: With pipefail, pipeline returns last error code [OK]

Common Mistakes:

• Assuming output is 0 because last command succeeds
• Thinking output is sum of exit codes
• Confusing exit codes with command count

4. You have this script:

set -o pipefail
cat file.txt | grep 'pattern' | sort
if [ $? -ne 0 ]; then
  echo 'Error detected'
fi

But it never prints 'Error detected' even if grep fails. What is the likely problem?

medium

A. The script needs set -e instead.

B. The if condition syntax is incorrect.

C. The pipeline commands are all succeeding.

D. set -o pipefail was not enabled before the pipeline.

Solution

1. Step 1: Check when pipefail is enabled

   If set -o pipefail is enabled after the pipeline runs, it won't affect that pipeline's exit status.

2. Step 2: Confirm error detection depends on pipefail

   Without pipefail enabled before the pipeline, the exit status is from the last command, so failures in earlier commands are missed.

3. Final Answer:

   set -o pipefail was not enabled before the pipeline. -> Option D

4. Quick Check:

   Enable pipefail before pipeline = set -o pipefail was not enabled before the pipeline. [OK]

Hint: Enable pipefail before running pipelines to catch errors [OK]

Common Mistakes:

• Assuming set -e alone catches pipeline errors
• Thinking if syntax is wrong
• Believing all commands always succeed

5. You want to write a script that stops immediately if any command in a pipeline fails. Which combination of bash options should you use?

hard

A. set -o pipefail only

B. set -e only

C. set -e and set -o pipefail

D. set -u and set -o pipefail

Solution

1. Step 1: Understand set -e behavior

   set -e makes the script exit immediately if any command returns a non-zero status.

2. Step 2: Understand set -o pipefail role

   Without pipefail, set -e ignores failures in earlier pipeline commands because the pipeline exit status is from the last command.

3. Step 3: Combine both for strict error detection

   Using both set -e and set -o pipefail ensures the script exits on any failure inside pipelines.

4. Final Answer:

   set -e and set -o pipefail -> Option C

5. Quick Check:

   Exit on any failure = set -e + pipefail = set -e and set -o pipefail [OK]

Hint: Use both set -e and pipefail to stop on any pipeline error [OK]

Common Mistakes:

• Using only pipefail without set -e
• Using only set -e without pipefail
• Confusing set -u (undefined vars) with error exit