Why testing is required in Go - See It in Action

Why Testing is Required

📖 Scenario: Imagine you are building a small calculator program in Go. You want to make sure it adds numbers correctly every time. Testing helps you check that your program works as expected before you share it with others.

🎯 Goal: You will create a simple function to add two numbers, then write a test to check if the function returns the correct result. This will show why testing is important to catch mistakes early.

📋 What You'll Learn

Create a function called Add that takes two integers and returns their sum.

Create a test function called TestAdd to check if Add returns the correct sum.

Use the Go testing package to write the test.

Run the test and see the output.

💡 Why This Matters

🌍 Real World

Testing is used in real software projects to make sure programs behave correctly before users see them.

💼 Career

Knowing how to write and run tests is a key skill for software developers to deliver reliable and bug-free applications.

1

Create the Add function

Write a function called Add that takes two integers named a and b and returns their sum as an integer.

Go

// Your code here

Hint

Define a function with two integer parameters and return their sum using return a + b.

2

Set up the test function

Import the testing package and write a test function called TestAdd that takes a parameter t of type *testing.T.

Go

package main

func Add(a int, b int) int {
    return a + b
}

// Your code here

Hint

Use import "testing" and define func TestAdd(t *testing.T) to start your test.

3

Write the test logic

Inside TestAdd, call Add(2, 3) and check if the result equals 5. If not, use t.Errorf to report an error with the message "Add(2, 3) = %d; want 5".

Go

package main

import "testing"

func Add(a int, b int) int {
    return a + b
}

func TestAdd(t *testing.T) {
    // Your code here
}

Hint

Call Add(2, 3), compare with 5, and use t.Errorf to show an error if it is wrong.

4

Run the test and see the output

Run the test using go test in your terminal. Write a main function that prints Add(2, 3) to show the function works outside the test.

Go

package main

import "fmt"
import "testing"

func Add(a int, b int) int {
    return a + b
}

func TestAdd(t *testing.T) {
    result := Add(2, 3)
    if result != 5 {
        t.Errorf("Add(2, 3) = %d; want 5", result)
    }
}

func main() {
    // Your code here
}

Hint

Use fmt.Println(Add(2, 3)) inside main to print the sum.

Practice

1. Why is testing important in Go programming?

easy

A. It allows the program to use more memory.

B. It makes the program run faster automatically.

C. It removes the need to write comments in code.

D. It helps find bugs early and ensures the program works correctly.

Solution

1. Step 1: Understand the purpose of testing

   Testing is done to find errors or bugs early in the program so they can be fixed before causing problems.

2. Step 2: Recognize the benefit of testing

   By testing, we keep the program working correctly and avoid unexpected failures.

3. Final Answer:

   It helps find bugs early and ensures the program works correctly. -> Option D

4. Quick Check:

   Testing = Find bugs early [OK]

Hint: Testing finds bugs early to keep code safe [OK]

Common Mistakes:

• Thinking testing makes code faster
• Believing testing removes need for comments
• Assuming testing increases memory use

2. Which of these is the correct way to start a test function in Go?

easy

A. func TestExample(t *testing.T) {}

B. func testExample(t *testing.T) {}

C. func ExampleTest(t *testing.T) {}

D. func TestingExample(t *testing.T) {}

Solution

1. Step 1: Recall Go test function naming rules

   Go test functions must start with capitalized 'Test' followed by the test name.

2. Step 2: Match the correct function signature

   The function must accept a pointer to testing.T as parameter.

3. Final Answer:

   func TestExample(t *testing.T) {} -> Option A

4. Quick Check:

   Test functions start with 'Test' [OK]

Hint: Test functions start with capital 'Test' [OK]

Common Mistakes:

• Starting function name with lowercase 'test'
• Swapping 'Test' and 'Example' in name
• Using wrong parameter type

3. What will be the output when running this Go test code?

package main

import (
	"testing"
)

func Add(a, b int) int {
	return a + b
}

func TestAdd(t *testing.T) {
	result := Add(2, 3)
	if result != 5 {
		t.Error("Expected 5")
	}
}

medium

A. Compilation error due to missing main function

B. Test fails with error 'Expected 5'

C. Test passes with no output

D. Test fails with runtime panic

Solution

1. Step 1: Analyze the Add function

   Add returns the sum of two integers. Add(2, 3) returns 5.

2. Step 2: Check the test condition

   The test checks if result != 5. Since result is 5, condition is false, so no error is called.

3. Final Answer:

   Test passes with no output -> Option C

4. Quick Check:

   Correct sum means test passes [OK]

Hint: If condition false, test passes silently [OK]

Common Mistakes:

• Assuming test fails when condition is false
• Thinking missing main causes compile error in tests
• Confusing test output with program output

4. Identify the error in this Go test code:

package main

import "testing"

func TestMultiply(t *testing.T) {
	result := Multiply(2, 3)
	if result != 6 {
		t.Error("Expected 6")
	}
}

medium

A. Missing import for Multiply function

B. Multiply function is not defined anywhere

C. Test function name should be lowercase

D. t.Error should be t.Fail

Solution

1. Step 1: Check if Multiply function exists

   The code calls Multiply but no definition or import is shown for it.

2. Step 2: Understand Go requires defined functions

   Calling an undefined function causes a compile error.

3. Final Answer:

   Multiply function is not defined anywhere -> Option B

4. Quick Check:

   Undefined function causes compile error [OK]

Hint: Undefined functions cause compile errors [OK]

Common Mistakes:

• Thinking import is needed for local functions
• Believing test function names can be lowercase
• Confusing t.Error and t.Fail usage

5. You want to add a test for a new feature that returns the length of a string. Which is the best reason to write this test?

hard

A. To check the feature works correctly and prevent future bugs.

B. To make the program run faster when counting string length.

C. To avoid writing documentation for the feature.

D. To reduce the size of the compiled program.

Solution

1. Step 1: Understand the purpose of feature testing

   Tests confirm that new features behave as expected and help catch bugs early.

2. Step 2: Recognize what tests do not do

   Tests do not improve speed, replace documentation, or reduce program size.

3. Final Answer:

   To check the feature works correctly and prevent future bugs. -> Option A

4. Quick Check:

   Tests ensure correctness and catch bugs [OK]

Hint: Tests prove features work and catch bugs [OK]

Common Mistakes:

• Thinking tests improve performance
• Believing tests replace documentation
• Assuming tests reduce program size