Lock files for single instance in Bash Scripting - Mini Project: Build & Apply

Lock files for single instance

📖 Scenario: You want to run a script that should only have one copy running at a time. To do this, you will use a lock file. This lock file will tell the script if another copy is already running, so it won't start twice.

🎯 Goal: Build a bash script that creates a lock file when it starts. If the lock file exists, the script will stop and tell the user another instance is running. If not, it will create the lock file, run the main task, then remove the lock file at the end.

📋 What You'll Learn

Create a variable for the lock file path

Check if the lock file exists

Create the lock file if it does not exist

Remove the lock file after the main task

Print a message if another instance is running

💡 Why This Matters

🌍 Real World

Lock files are used in scripts that should not run multiple times at once, like backups or updates, to avoid conflicts.

💼 Career

Many system administrators and automation engineers use lock files to ensure safe script execution without overlap.

1

Create a lock file variable

Create a variable called lockfile and set it to /tmp/myscript.lock.

Bash Scripting

# Your code here

Hint

Use = to assign the string /tmp/myscript.lock to the variable lockfile.

2

Check if the lock file exists

Add an if statement to check if the file at $lockfile exists using test -e. If it exists, print "Another instance is running." and exit the script with status 1.

Bash Scripting

lockfile="/tmp/myscript.lock"
# Your code here

Hint

Use if test -e "$lockfile"; then to check if the file exists.

3

Create the lock file and simulate main task

Create the lock file by using touch on $lockfile. Then simulate the main task by printing "Script is running..." and sleeping for 2 seconds.

Bash Scripting

lockfile="/tmp/myscript.lock"
if test -e "$lockfile"; then
    echo "Another instance is running."
    exit 1
fi
# Your code here

Hint

Use touch "$lockfile" to create the lock file.

4

Remove the lock file and print completion

Remove the lock file using rm on $lockfile. Then print "Script finished and lock released.".

Bash Scripting

lockfile="/tmp/myscript.lock"
if test -e "$lockfile"; then
    echo "Another instance is running."
    exit 1
fi
touch "$lockfile"
echo "Script is running..."
sleep 2
# Your code here

Hint

Use rm "$lockfile" to remove the lock file.

Practice

1. What is the main purpose of using a lock file in a bash script?

easy

A. To prevent multiple instances of the script from running at the same time

B. To speed up the script execution

C. To store user input temporarily

D. To log errors during script execution

Solution

1. Step 1: Understand the role of a lock file

   A lock file is used to signal that a script is already running, preventing duplicates.

2. Step 2: Identify the main purpose

   This prevents multiple script instances from running simultaneously, avoiding conflicts.

3. Final Answer:

   To prevent multiple instances of the script from running at the same time -> Option A

4. Quick Check:

   Lock file purpose = prevent duplicates [OK]

Hint: Lock files stop duplicate script runs quickly [OK]

Common Mistakes:

• Thinking lock files speed up scripts
• Confusing lock files with log files
• Using lock files to store data

2. Which of the following bash commands correctly creates a lock file only if it does not already exist?

easy

A. touch /tmp/myscript.lock

B. echo $$ > /tmp/myscript.lock

C. mkdir /tmp/myscript.lock

D. if [ ! -e /tmp/myscript.lock ]; then touch /tmp/myscript.lock; fi

Solution

1. Step 1: Check for existence before creating

   The command must create the lock file only if it does not exist, so a test with [ ! -e ] is needed.

2. Step 2: Identify the correct syntax

   if [ ! -e /tmp/myscript.lock ]; then touch /tmp/myscript.lock; fi uses an if statement to check and then create the file, which is correct.

3. Final Answer:

   if [ ! -e /tmp/myscript.lock ]; then touch /tmp/myscript.lock; fi -> Option D

4. Quick Check:

   Check existence before touch = if [ ! -e /tmp/myscript.lock ]; then touch /tmp/myscript.lock; fi [OK]

Hint: Use if with [ ! -e ] to create lock file safely [OK]

Common Mistakes:

• Using touch without checking file existence
• Using mkdir which creates a directory, not a file
• Overwriting lock file without check

3. Given this script snippet:

if [ -e /tmp/myscript.lock ]; then
  echo "Script already running"
  exit 1
else
  touch /tmp/myscript.lock
  echo "Running script"
  rm /tmp/myscript.lock
fi

What will be the output if the lock file exists?

medium

A. Running script

B. Script already running

C. No output

D. Error: lock file missing

Solution

1. Step 1: Check the condition when lock file exists

   If /tmp/myscript.lock exists, the if condition is true and the script echoes "Script already running" and exits.

2. Step 2: Understand the output

   Since the script exits early, it does not run or remove the lock file.

3. Final Answer:

   Script already running -> Option B

4. Quick Check:

   Lock file exists = "Script already running" [OK]

Hint: If lock file exists, script exits with message [OK]

Common Mistakes:

• Assuming script runs even if lock file exists
• Expecting no output when lock file exists
• Confusing lock file presence with absence

4. This script is intended to prevent multiple runs using a lock file:

if [ -e /tmp/myscript.lock ]; then
  echo "Already running"
  exit 1
fi

touch /tmp/myscript.lock
# script work here
rm /tmp/myscript.lock

But sometimes multiple instances run simultaneously. What is the likely problem?

medium

A. The lock file is not checked before creation

B. The script does not remove the lock file

C. The lock file is created after the check, causing a race condition

D. The script uses rm instead of rmdir

Solution

1. Step 1: Analyze the timing of lock file creation

   The script checks for the lock file, then creates it. Between these steps, another instance can start and pass the check.

2. Step 2: Identify the race condition

   This gap causes multiple instances to run simultaneously because the lock file is not created atomically with the check.

3. Final Answer:

   The lock file is created after the check, causing a race condition -> Option C

4. Quick Check:

   Race condition from delayed lock creation = The lock file is created after the check, causing a race condition [OK]

Hint: Create lock file atomically to avoid race conditions [OK]

Common Mistakes:

• Ignoring race conditions in lock file creation
• Forgetting to remove lock file after script ends
• Confusing file removal commands

5. You want to write a bash script that runs only one instance at a time using a lock file. Which approach is best to avoid race conditions?

hard

A. Use 'mkdir /tmp/myscript.lock' and check if it succeeds before running

B. Check if lock file exists, then create it with 'touch' if not

C. Create lock file with 'echo $$ > /tmp/myscript.lock' without checking

D. Remove lock file at script start, then create it

Solution

1. Step 1: Understand atomic operations for locking

   Using 'mkdir' to create a directory as a lock is atomic; it either succeeds or fails immediately.

2. Step 2: Compare with other methods

   Other methods like checking then touching can cause race conditions; removing lock at start is unsafe.

3. Final Answer:

   Use 'mkdir /tmp/myscript.lock' and check if it succeeds before running -> Option A

4. Quick Check:

   Atomic mkdir lock = safest method [OK]

Hint: Use mkdir for atomic lock creation to avoid race [OK]

Common Mistakes:

• Using touch without atomic check
• Removing lock file before checking
• Ignoring race conditions