Test Method Naming (ARCH5008)

Key go.naming.test-name-convention · Severity info · Category naming

Retired

This rule has been retired and is no longer checked: the collector does not run it and no new finding carries this code. The page is kept for reference and for findings recorded before it was retired.

Test functions should follow the framework’s discovery convention; in Go a test function must start with Test and the part after it must begin with an uppercase letter. Otherwise go test will not pick them up.

Incorrect

func testUserLogin(t *testing.T) { // lowercase 't', not discovered
  if !login("alice") {
    t.Fatal("login failed")
  }
}

Correct

func TestUserLogin(t *testing.T) {
  if !login("alice") {
    t.Fatal("login failed")
  }
}

Fix

Name test functions with the Test prefix and an uppercase continuation.