Go Testing

External

• https://go.dev/doc/code#Testing

Internal

• Go Engineering
• go test command

Overview

Go comes with a lightweight test framework that includes the go test command and the testing package. The tests live in *_test.go files.

Write a Unit Test

Write a module as shown here:

Declaring a Module

For each file containing behavior to test (a.go)

package a

func Reverse(s string) string {
 rs := []rune(s)
 var result []rune
 for i := len(rs) - 1; i >= 0; i-- {
  result = append(result, rs[i])
 }
 return string(result)
}

add a <file-name>_test.go test file. In this case a_test.go.

The test file should be part of the same package.

The test file should import testing:

package a

import "testing"

func TestReverseEmptyString(t *testing.T) {
 expected := ""
 result := Reverse("")
 if result != expected {
  t.Errorf("expected %q, got %q", expected, result)
 }
}

func TestReverseOneCharString(t *testing.T) {
 expected := "a"
 result := Reverse("a")
 if result != expected {
  t.Errorf("expected %q, got %q", expected, result)
 }
}

func TestReverseTwoCharString(t *testing.T) {
 expected := "ba"
 result := Reverse("ab")
 if result != expected {
  t.Errorf("expected %q, got %q", expected, result)
 }
}

From the module directory, run the tests:

go test

PASS ok example.com/a 0.116s

TO DEPLETE

Writing a Unit Test

• Write a _test.go test file. They should belong to the same package as the tested code. These files are ignored by the compiler and only compiled and executed when go test is run.

• Import "testing"

• Tests are identified as functions starting with Test_... and taking an argument (t *testing.T).

package blue

import "testing"

func TestBlue(t *testing.T) {
    ...
    t.Error("expected this, got ", ...)
}

Then

go test

The command will look for any tests in any of the files in the current folder and run them.

Also see external test packages.

TODO testing idiom "Introducing Go" page 96.