Why Running tests in Go? - Purpose & Use Cases

The Big Idea

What if you could catch bugs before they cause big problems, with just one command?

The Scenario

Imagine you wrote a program and want to make sure it works correctly. You try running it and checking the results yourself every time you make a change.

It's like baking a cake and tasting it after every ingredient you add to see if it's good.

The Problem

This manual checking is slow and tiring. You might forget some cases or make mistakes when testing by hand.

Also, if you change something, you have to repeat all the checks again, which wastes time and causes frustration.

The Solution

Running tests automatically means writing small programs that check your code for you.

In Go, you can write test functions and run them with a simple command. This saves time and catches errors early.

Before vs After

✗ Before

func main() {
    result := Add(2, 3)
    fmt.Println("Expected 5, got", result)
}

✓ After

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

What It Enables

It lets you quickly check your code's correctness anytime, making your programs more reliable and your work easier.

Real Life Example

Think of a calculator app: every time you add a new feature, running tests ensures all calculations still work perfectly without you checking each one manually.

Key Takeaways

Manual testing is slow and error-prone.

Automated tests run your checks quickly and reliably.

Go's testing tools make it easy to write and run tests.

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