Skip to content

Commit

Permalink
go: merge some tests of the test goal to impove CI times (pantsbuild#…
Browse files Browse the repository at this point in the history 
…18104)

The tests in `src/python/pants/backend/go/goals/test_test.py` are timing out on occasion in CI.  For example in [this CI build](https://github.com/pantsbuild/pants/actions/runs/4027057409/jobs/6922371712#step:11:638).

Merge some of the success tests together to reduce runtime by reducing the number of tests.
  • Loading branch information
@tdyas
tdyas authored Jan 27, 2023
1 parent 557c47d commit 162111d
Showing 1 changed file with 65 additions and 179 deletions.
244 changes: 65 additions & 179 deletions src/python/pants/backend/go/goals/test_test.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ def test_transform_test_args() -> None:
)


def test_internal_test_success(rule_runner: RuleRunner) -> None:
def test_all_the_tests_are_successful(rule_runner: RuleRunner) -> None:
rule_runner.write_files(
{
"foo/BUILD": "go_mod(name='mod')\ngo_package()",
Expand All @@ -107,58 +107,11 @@ def test_internal_test_success(rule_runner: RuleRunner) -> None:
func add(x, y int) int {
return x + y
}
"""
),
"foo/add_test.go": textwrap.dedent(
"""
package foo
import "testing"
func TestAdd(t *testing.T) {
if add(2, 3) != 5 {
t.Fail()
}
}
"""
),
}
)
tgt = rule_runner.get_target(Address("foo"))
result = rule_runner.request(
TestResult, [GoTestRequest.Batch("", (GoTestFieldSet.create(tgt),), None)]
)
assert result.exit_code == 0
assert "PASS: TestAdd" in result.stdout


def test_internal_test_fails(rule_runner: RuleRunner) -> None:
rule_runner.write_files(
{
"foo/BUILD": "go_mod(name='mod')\ngo_package()",
"foo/go.mod": "module foo",
"foo/bar_test.go": textwrap.dedent(
"""
package foo
import "testing"
func TestAdd(t *testing.T) {
t.Fail()
func Add(x, y int) int {
return add(x, y)
}
"""
),
}
)
tgt = rule_runner.get_target(Address("foo"))
result = rule_runner.request(
TestResult, [GoTestRequest.Batch("", (GoTestFieldSet.create(tgt),), None)]
)
assert result.exit_code == 1
assert "FAIL: TestAdd" in result.stdout


def test_internal_benchmark_passes(rule_runner: RuleRunner) -> None:
rule_runner.write_files(
{
"foo/BUILD": "go_mod(name='mod')\ngo_package()",
"foo/go.mod": "module foo",
"foo/fib.go": textwrap.dedent(
"""
package foo
Expand All @@ -170,15 +123,60 @@ def test_internal_benchmark_passes(rule_runner: RuleRunner) -> None:
}
"""
),
"foo/fib_test.go": textwrap.dedent(
"foo/internal_test.go": textwrap.dedent(
"""
package foo
import "testing"
func BenchmarkAdd(b *testing.B) {
import (
"fmt"
"testing"
)
func TestAddInternal(t *testing.T) {
if add(2, 3) != 5 {
t.Fail()
}
}
func BenchmarkAddInternal(b *testing.B) {
for n := 0; n < b.N; n++ {
Fib(10)
}
}
func ExamplePrintInternal() {
fmt.Println("foo")
// Output: foo
}
"""
),
"foo/external_test.go": textwrap.dedent(
"""
package foo_test
import (
"foo"
"fmt"
"testing"
)
func TestAddExternal(t *testing.T) {
if foo.Add(2, 3) != 5 {
t.Fail()
}
}
func BenchmarkAddExternal(b *testing.B) {
for n := 0; n < b.N; n++ {
foo.Fib(10)
}
}
func ExamplePrintExternal() {
fmt.Println("foo")
// Output: foo
}
"""
),
}
Expand All @@ -188,24 +186,26 @@ def test_internal_benchmark_passes(rule_runner: RuleRunner) -> None:
TestResult, [GoTestRequest.Batch("", (GoTestFieldSet.create(tgt),), None)]
)
assert result.exit_code == 0
assert "BenchmarkAdd" in result.stdout
assert "PASS" in result.stdout
print(f"stdout:\n{result.stdout}\nstderr:\n{result.stderr}")
assert "PASS: TestAddInternal" in result.stdout
assert "PASS: ExamplePrintInternal" in result.stdout
assert "BenchmarkAddInternal" in result.stdout
assert "PASS: TestAddExternal" in result.stdout
assert "PASS: ExamplePrintExternal" in result.stdout
assert "BenchmarkAddExternal" in result.stdout


def test_internal_example_passes(rule_runner: RuleRunner) -> None:
def test_internal_test_fails(rule_runner: RuleRunner) -> None:
rule_runner.write_files(
{
"foo/BUILD": "go_mod(name='mod')\ngo_package()",
"foo/go.mod": "module foo",
"foo/print_test.go": textwrap.dedent(
"foo/bar_test.go": textwrap.dedent(
"""
package foo
import (
"fmt"
)
func ExamplePrint() {
fmt.Println("foo")
// Output: foo
import "testing"
func TestAdd(t *testing.T) {
t.Fail()
}
"""
),
Expand All @@ -215,8 +215,8 @@ def test_internal_example_passes(rule_runner: RuleRunner) -> None:
result = rule_runner.request(
TestResult, [GoTestRequest.Batch("", (GoTestFieldSet.create(tgt),), None)]
)
assert result.exit_code == 0
assert "PASS: ExamplePrint" in result.stdout
assert result.exit_code == 1
assert "FAIL: TestAdd" in result.stdout


def test_internal_test_with_test_main(rule_runner: RuleRunner) -> None:
Expand Down Expand Up @@ -296,43 +296,6 @@ def test_internal_test_fails_to_compile(rule_runner: RuleRunner) -> None:
assert "dep/f.go:1:1: expected 'package', found invalid\n" in result.stderr


def test_external_test_success(rule_runner: RuleRunner) -> None:
rule_runner.write_files(
{
"foo/BUILD": "go_mod(name='mod')\ngo_package()",
"foo/go.mod": "module foo",
"foo/add.go": textwrap.dedent(
"""
package foo
func Add(x, y int) int {
return x + y
}
"""
),
"foo/add_test.go": textwrap.dedent(
"""
package foo_test
import (
"foo"
"testing"
)
func TestAdd(t *testing.T) {
if foo.Add(2, 3) != 5 {
t.Fail()
}
}
"""
),
}
)
tgt = rule_runner.get_target(Address("foo"))
result = rule_runner.request(
TestResult, [GoTestRequest.Batch("", (GoTestFieldSet.create(tgt),), None)]
)
assert result.exit_code == 0
assert "PASS: TestAdd" in result.stdout


def test_external_test_fails(rule_runner: RuleRunner) -> None:
rule_runner.write_files(
{
Expand Down Expand Up @@ -368,83 +331,6 @@ def test_external_test_fails(rule_runner: RuleRunner) -> None:
assert "FAIL: TestAdd" in result.stdout


def test_external_benchmark_passes(rule_runner: RuleRunner) -> None:
rule_runner.write_files(
{
"foo/BUILD": "go_mod(name='mod')\ngo_package()",
"foo/go.mod": "module foo",
"foo/fib.go": textwrap.dedent(
"""
package foo
func Fib(n int) int {
if n < 2 {
return n
}
return Fib(n-1) + Fib(n-2)
}
"""
),
"foo/fib_test.go": textwrap.dedent(
"""
package foo_test
import (
"foo"
"testing"
)
func BenchmarkAdd(b *testing.B) {
for n := 0; n < b.N; n++ {
foo.Fib(10)
}
}
"""
),
}
)
tgt = rule_runner.get_target(Address("foo"))
result = rule_runner.request(
TestResult, [GoTestRequest.Batch("", (GoTestFieldSet.create(tgt),), None)]
)
assert result.exit_code == 0
assert "BenchmarkAdd" in result.stdout
assert "PASS" in result.stdout


def test_external_example_passes(rule_runner: RuleRunner) -> None:
rule_runner.write_files(
{
"foo/BUILD": "go_mod(name='mod')\ngo_package()",
"foo/go.mod": "module foo",
"foo/print.go": textwrap.dedent(
"""
package foo
import "fmt"
func MyPrint(msg string) {
fmt.Println(msg)
}
"""
),
"foo/print_test.go": textwrap.dedent(
"""
package foo_test
import (
"foo"
)
func ExamplePrint() {
foo.MyPrint("foo")
// Output: foo
}
"""
),
}
)
tgt = rule_runner.get_target(Address("foo"))
result = rule_runner.request(
TestResult, [GoTestRequest.Batch("", (GoTestFieldSet.create(tgt),), None)]
)
assert result.exit_code == 0
assert "PASS: ExamplePrint" in result.stdout


def test_external_test_with_test_main(rule_runner: RuleRunner) -> None:
rule_runner.write_files(
{
Expand Down

0 comments on commit 162111d

Please sign in to comment.