set -u for undefined variable errors in Bash Scripting - Mini Project: Build & Apply

Using set -u to Catch Undefined Variables in Bash Scripts

📖 Scenario: You are writing a small bash script to greet users by their name. Sometimes, the name might not be set, and you want to catch this mistake early to avoid confusing output.

🎯 Goal: Learn how to use set -u in bash scripts to catch errors caused by using variables that have not been defined.

📋 What You'll Learn

Create a variable with a user name

Enable set -u to catch undefined variables

Write a greeting message using the variable

Observe the error when using an undefined variable

💡 Why This Matters

🌍 Real World

In real bash scripts, using undefined variables can cause unexpected bugs. Using <code>set -u</code> helps catch these mistakes early, making scripts more reliable.

💼 Career

Many jobs that involve system administration, DevOps, or automation require writing bash scripts. Knowing how to use <code>set -u</code> is a basic skill to write safer scripts.

1

Create a variable called username with the value "Alice"

Create a variable called username and set it to the exact value "Alice".

Bash Scripting

# Create a variable called username and set it to "Alice"
# Your code here

Hint

Use username="Alice" to create the variable.

2

Add set -u at the top of the script to catch undefined variables

Add the line set -u at the very top of the script, before any other commands.

Bash Scripting

# Add set -u at the top of the script
username="Alice"
# Your code here

Hint

Place set -u as the first line to enable error checking for undefined variables.

3

Write a line to print a greeting using the username variable

Write a line that prints Hello, $username! using echo.

Bash Scripting

set -u
username="Alice"
# Print a greeting using the username variable
# Your code here

Hint

Use echo "Hello, $username!" to print the greeting.

4

Try to print an undefined variable $userage and observe the error

Add a line to print $userage using echo. Run the script and observe the error caused by set -u.

Bash Scripting

set -u
username="Alice"
echo "Hello, $username!"
# Print the undefined variable userage
# Your code here

Hint

When you run the script, you should see an error like bash: line 4: userage: unbound variable because userage is not defined.

Practice

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

easy

A. Prints all variables and their values

B. Allows the script to continue even if variables are undefined

C. Stops the script if an undefined variable is used

D. Disables all error messages in the script

Solution

1. Step 1: Understand the purpose of set -u

   The set -u option makes the script stop if it tries to use a variable that has not been set.

2. Step 2: Compare with other options

   Other options like continuing or printing variables do not match what set -u does.

3. Final Answer:

   Stops the script if an undefined variable is used -> Option C

4. Quick Check:

   set -u stops on unset variables [OK]

Hint: Remember: set -u = stop on unset variable [OK]

Common Mistakes:

• Thinking set -u ignores unset variables
• Confusing set -u with error message control
• Assuming it prints variables automatically

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

easy

A. set -x

B. set -e

C. set +u

D. set -u

Solution

1. Step 1: Identify the correct option to enable set -u

   The command to enable the undefined variable error checking is exactly set -u.

2. Step 2: Understand other options

   set -x enables debugging, set +u disables set -u, and set -e stops on any error, not specifically unset variables.

3. Final Answer:

   set -u -> Option D

4. Quick Check:

   Enable set -u with set -u [OK]

Hint: Use set -u exactly to enable undefined variable errors [OK]

Common Mistakes:

• Confusing set -u with set -x or set -e
• Using set +u which disables the feature
• Forgetting the dash before 'u'

3. What will happen when running this script with set -u enabled?

#!/bin/bash
set -u

echo "Hello $NAME"

medium

A. Stops with an error without printing anything if NAME is not set

B. Prints 'Hello $NAME' literally without substitution

C. Prints 'Hello' followed by the value of NAME if set, else empty

D. Ignores the unset NAME and prints 'Hello '

Solution

1. Step 1: Understand set -u effect on unset variables

   With set -u, using an unset variable like NAME causes the script to stop with an error.

2. Step 2: Analyze the script behavior

   The script tries to print $NAME which is not set, so it will stop and show an error instead of printing anything.

3. Final Answer:

   Stops with an error without printing anything if NAME is not set -> Option A

4. Quick Check:

   Unset variable with set -u causes error [OK]

Hint: Unset variable with set -u stops script immediately [OK]

Common Mistakes:

• Assuming unset variables print empty strings
• Thinking script ignores unset variables
• Confusing literal printing with variable substitution

4. Given this script snippet with set -u enabled, what is the error and how to fix it?

#!/bin/bash
set -u

if [ "$USER_NAME" = "admin" ]; then
  echo "Welcome admin"
fi

medium

A. Error: Syntax error in if statement; fix by adding spaces

B. Error: USER_NAME undefined; fix by setting USER_NAME or using ${USER_NAME:-default}

C. No error; script runs fine

D. Error: Missing quotes around USER_NAME; fix by adding quotes

Solution

1. Step 1: Identify the cause of error with set -u

   The variable USER_NAME is used but not set, causing the script to stop with an error.

2. Step 2: Fix the error by providing a default value

   Use ${USER_NAME:-default} to avoid error if USER_NAME is unset, or ensure it is set before use.

3. Final Answer:

   Error: USER_NAME undefined; fix by setting USER_NAME or using ${USER_NAME:-default} -> Option B

4. Quick Check:

   Unset variable error fixed by default value [OK]

Hint: Use ${VAR:-default} to avoid unset variable errors [OK]

Common Mistakes:

• Ignoring that variable might be unset
• Trying to fix syntax instead of variable usage
• Forgetting to quote variables properly

5. How can you safely use a variable CONFIG_PATH in a script with set -u enabled, providing a default path if it is not set?

hard

A. Use echo "${CONFIG_PATH:-/etc/default/config}"

B. Use if [ -z "$CONFIG_PATH" ]; then echo "/etc/default/config"; fi

C. Disable set -u before using the variable

D. Use echo "$CONFIG_PATH" directly

Solution

1. Step 1: Understand default value syntax

   Using ${CONFIG_PATH:-/etc/default/config} provides a default if CONFIG_PATH is unset, avoiding errors with set -u.

2. Step 2: Compare other options

   Direct use causes error if unset, disabling set -u is not recommended, and the if statement does not print the variable if set.

3. Final Answer:

   Use echo "${CONFIG_PATH:-/etc/default/config}" -> Option A

4. Quick Check:

   Default value syntax avoids unset errors [OK]

Hint: Use ${VAR:-default} to safely handle unset variables [OK]

Common Mistakes:

• Using variable directly without default
• Disabling set -u instead of fixing code
• Incorrect if condition that skips printing variable