Testing package overview in Go

Introduction

Testing helps you check if your Go code works correctly. The testing package makes it easy to write and run tests.

When you want to check if a function returns the right result.

When you fix a bug and want to make sure it stays fixed.

When you add new features and want to confirm they work well.

When you want to run tests automatically before sharing your code.

Syntax

Go

func TestXxx(t *testing.T) {
    // test code here
}

Test functions start with 'Test' and take *testing.T as a parameter.

Use t.Error or t.Fatal to report test failures.

Examples

This test checks if Add(2, 3) returns 5.

Go

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

This test checks if dividing by zero returns an error.

Go

func TestDivide(t *testing.T) {
    _, err := Divide(4, 0)
    if err == nil {
        t.Fatal("Expected error for division by zero")
    }
}

Sample Program

This program defines a simple Add function and a test to check it returns the correct sum.

Go

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("Add(2, 3) should be 5")
    }
}

Important Notes

Run tests using go test in the terminal.

Test files must end with _test.go to be recognized.

Use t.Error to report errors but continue, t.Fatal to stop the test immediately.

Summary

The testing package helps you write tests as functions starting with Test.

Tests check if your code works as expected and report problems.

Run tests easily with go test command.

Practice

1. What is the main purpose of the testing package in Go?

easy

A. To compile Go programs faster

B. To create graphical user interfaces

C. To manage database connections

D. To write functions that check if your code works correctly

Solution

1. Step 1: Understand the role of the testing package

   The testing package is designed to help write tests that verify code correctness.

2. Step 2: Identify the correct purpose

   It does not handle GUIs, databases, or compilation speed but focuses on testing functions.

3. Final Answer:

   To write functions that check if your code works correctly -> Option D

4. Quick Check:

   testing package = write test functions [OK]

Hint: Testing package is for checking code correctness [OK]

Common Mistakes:

• Confusing testing with UI or database packages
• Thinking it speeds up compilation
• Assuming it manages runtime behavior

2. Which of the following is the correct way to name a test function in Go using the testing package?

easy

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

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

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

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

Solution

1. Step 1: Recall test function naming rules

   Test functions must start with uppercase 'Test' followed by the function name.

2. Step 2: Match the correct naming pattern

   Only func TestMyFunction(t *testing.T) {} uses 'Test' prefix correctly and has the right signature.

3. Final Answer:

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

4. Quick Check:

   Test functions start with 'Test' [OK]

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

Common Mistakes:

• Starting function name with lowercase 'test'
• Placing 'Test' at the end of the function name
• Using incorrect function signature

3. What will be the output when running go test on this test file?

package main

import "testing"

func TestSum(t *testing.T) {
  total := 2 + 3
  if total != 5 {
    t.Error("Sum was incorrect")
  }
}

medium

A. Syntax error: missing return type

B. FAIL
Sum was incorrect

C. PASS
ok main 0.001s

D. No tests to run

Solution

1. Step 1: Analyze the test logic

   The test calculates 2 + 3 and checks if it equals 5, which is true, so no error is called.

2. Step 2: Understand test output

   Since the test passes, go test reports PASS with timing info.

3. Final Answer:

   PASS ok main 0.001s -> Option C

4. Quick Check:

   Correct test = PASS output [OK]

Hint: If no t.Error called, test passes [OK]

Common Mistakes:

• Assuming test fails without error call
• Confusing syntax errors with test failures
• Expecting output when no tests exist

4. Identify the error in this test function:

package main

import "testing"

func TestMultiply(t *testing.T) {
  result := 3 * 4
  if result = 12 {
    t.Log("Multiplication correct")
  }
}

medium

A. t.Log cannot be used inside tests

B. Using assignment '=' instead of comparison '==' in if condition

C. Test function name should be lowercase

D. Missing import of fmt package

Solution

1. Step 1: Check the if condition syntax

   The condition uses '=' which assigns value instead of '==' which compares values.

2. Step 2: Understand Go syntax rules

   Using '=' in if condition causes a compile error; '==' is needed for comparison.

3. Final Answer:

   Using assignment '=' instead of comparison '==' in if condition -> Option B

4. Quick Check:

   Use '==' for comparison in if [OK]

Hint: Use '==' for comparisons, not '=' [OK]

Common Mistakes:

• Confusing assignment '=' with equality '=='
• Thinking t.Log is disallowed
• Ignoring function naming conventions

5. You want to write a test that fails if a function returns an empty string. Which of these test snippets correctly uses the testing package to do this?

func TestNonEmpty(t *testing.T) {
  result := getName()
  // Which check is correct?
}

hard

A. if result == "" { t.Error("Result should not be empty") }

B. if result != "" { t.Error("Result should not be empty") }

C. if result == nil { t.Error("Result should not be empty") }

D. if result == 0 { t.Error("Result should not be empty") }

Solution

1. Step 1: Understand the test goal

   The test must fail if the returned string is empty, so check if result equals empty string.

2. Step 2: Choose the correct condition

   if result == "" { t.Error("Result should not be empty") } checks if result == "" and calls t.Error, which correctly fails the test on empty string.

3. Final Answer:

   if result == "" { t.Error("Result should not be empty") } -> Option A

4. Quick Check:

   Fail test when string is empty [OK]

Hint: Check empty string with == "" to fail test [OK]

Common Mistakes:

• Using != instead of == for empty check
• Comparing string to nil or 0
• Not calling t.Error on failure condition