Debugging and Testing

Debugging and testing are critical phases of the software development lifecycle. Debugging is the process of locating and correcting errors, while testing is the process of executing a program to find those errors.

1. The Role of Compiler Warnings

The first line of defense against bugs is enabling and heeding compiler warnings. Warnings indicate code that is technically legal but highly suspicious or prone to runtime errors.

• Enabling Warnings (GCC): You should always compile your C code with flags that maximize warnings and treat them as errors:
  • -Wall: Enables almost all common warnings.
  • -Wextra: Enables additional, useful warnings not covered by -Wall.
  • -Werror: Treats all warnings as errors, forcing you to fix them before compilation succeeds.

# Example compilation command using high warning flags
gcc -Wall -Wextra -Werror my_program.c -o my_app

2. The GNU Debugger (GDB)

GDB is the most widely used command-line debugger for C/C++ programs. It allows you to execute your program step-by-step, inspect variables, and pinpoint the exact line where a crash or unexpected behavior occurs.

• Preparation: To use GDB, you must compile your code with the debugging symbols flag (-g). This embeds extra information into the executable that GDB uses to map machine code back to your source lines.

# Compile with debugging symbols
gcc -g my_program.c -o my_app 

Essential GDB Commands

3. Testing and Assertion

Good programming practice involves testing code modules to ensure they behave as expected.

• Unit Testing: Testing small, isolated units of code (like a single function).
• Assertion: The <assert.h> library provides the assert() macro, which is a simple way to test assumptions at runtime.

The assert() Macro

assert(expression) evaluates the expression. If the expression is false (0), the program prints an error message to stderr and terminates (crashes). If the expression is true (non-zero), nothing happens.

#include <assert.h>

int safe_division(int numerator, int denominator) {
    // Assert that the denominator is not zero before proceeding
    assert(denominator != 0); 
    
    return numerator / denominator;
}

Note: Asserts are often disabled in final production builds by compiling with the -D NDEBUG flag.