Running tests in Go

Introduction

Running tests helps you check if your code works correctly. It finds mistakes early so you can fix them quickly.

You want to make sure a new feature works before sharing your program.

You changed some code and want to confirm nothing else broke.

You want to automatically check your program every time you save changes.

You want to share your code with others and prove it works.

You want to catch bugs before users find them.

Syntax

Go

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

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

Use go test command to run all tests in a package.

Examples

This test checks if the Add function returns 5 when adding 2 and 3.

Go

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

This test checks if the IsEven function correctly identifies 4 as even.

Go

func TestIsEven(t *testing.T) {
    if !IsEven(4) {
        t.Error("4 should be even")
    }
}

Sample Program

This program defines a simple Add function and a test TestAdd that checks if adding 2 and 3 equals 5.

Run go test in the terminal to see the test result.

Go

package main

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

// To run tests, place the following test function in a separate file named add_test.go
// and run 'go test' in the terminal.

import "testing"

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

Important Notes

Test files must be named with _test.go suffix to be recognized by go test.

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

Tests help keep your code reliable and easier to maintain.

Summary

Tests check if your code works as expected.

Write test functions starting with Test and use go test to run them.

Fix problems early by running tests often.

Practice

1. What is the correct way to name a test function in Go so that go test can run it?

easy

A. Start the function name with Test

B. Start the function name with test (lowercase t)

C. Name the function RunTest

D. Name the function CheckTest

Solution

1. Step 1: Understand Go test naming rules

   Go requires test functions to start with an uppercase Test to be recognized by go test.

2. Step 2: Check the options

   Only Start the function name with Test starts with Test exactly, others do not follow the naming convention.

3. Final Answer:

   Start the function name with Test -> Option A

4. Quick Check:

   Test functions start with 'Test' [OK]

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

Common Mistakes:

• Using lowercase 'test' at start
• Naming test functions without 'Test' prefix
• Using unrelated prefixes like 'Run' or 'Check'

2. Which of the following is the correct syntax to run tests in a Go module from the command line?

easy

A. go execute test

B. go run test

C. go build test

D. go test

Solution

1. Step 1: Recall Go test command

   The command to run tests in Go is go test.

2. Step 2: Compare options

   Only go test matches the correct command. Others are invalid commands.

3. Final Answer:

   go test -> Option D

4. Quick Check:

   Run tests with 'go test' [OK]

Hint: Use 'go test' to run tests, not 'go run' [OK]

Common Mistakes:

• Using 'go run test' instead of 'go test'
• Trying 'go build test' which builds but doesn't test
• Using non-existent commands like 'go execute test'

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

package main

import "testing"

func TestSum(t *testing.T) {
  if 2+2 != 4 {
    t.Error("Sum failed")
  }
}

medium

A. Syntax error: missing main function

B. FAIL
--- FAIL: TestSum

C. PASS
ok main 0.001s

D. No tests to run

Solution

1. Step 1: Analyze the test logic

   The test checks if 2+2 equals 4, which is true, so no error is called.

2. Step 2: Understand test output

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

3. Final Answer:

   PASS ok main 0.001s -> Option C

4. Quick Check:

   Test passes, so output shows PASS [OK]

Hint: If test condition is true, output shows PASS [OK]

Common Mistakes:

• Assuming syntax error due to missing main
• Expecting FAIL when condition is true
• Thinking tests won't run without main function

4. Identify the error in this test function that prevents go test from running it:

package main

import "testing"

func testAdd(t *testing.T) {
  if 1+1 != 2 {
    t.Error("Add failed")
  }
}

medium

A. Missing import of 'fmt' package

B. Function name must start with uppercase 'Test'

C. Test function must return a value

D. Test functions cannot have parameters

Solution

1. Step 1: Check test function naming

   The function is named testAdd with lowercase 't', so go test ignores it.

2. Step 2: Verify other requirements

   Test functions must start with uppercase 'Test' and accept *testing.T parameter, which is correct except the name.

3. Final Answer:

   Function name must start with uppercase 'Test' -> Option B

4. Quick Check:

   Test functions need 'Test' prefix [OK]

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

Common Mistakes:

• Thinking test functions need to return a value
• Assuming missing 'fmt' import causes test failure
• Believing test functions cannot have parameters

5. You want to run only tests in the file math_test.go inside your module. Which command should you use?

hard

A. go test math_test.go

B. go test -file math_test.go

C. go test -v

D. go test -run math_test.go

Solution

1. Step 1: Understand how to run tests in a specific file

   Go allows specifying test files directly as arguments to go test.

2. Step 2: Check options for correct usage

   Only go test math_test.go runs tests in the specified file. B uses invalid -file flag, C's go test -v runs all tests verbosely, D's -run matches test names.

3. Final Answer:

   go test math_test.go -> Option A

4. Quick Check:

   Specify test file directly to run its tests [OK]

Hint: Run tests in a file by naming it after 'go test' [OK]

Common Mistakes:

• Using invalid flags like -run or -file with filenames
• Confusing verbose flag -v with file selection
• Not specifying the file and running all tests