[go_test_parser] Wrap go tests in their own parser.

This splits out the logic from testparser to specifically use the go
parsing logic for known go tests.

Bug: 435723394
Change-Id: I5c1beb8cb1936afe63121fd2230e07184c938d28
Reviewed-on: https://fuchsia-review.googlesource.com/c/fuchsia/+/1335566
Reviewed-by: Erick Tryzelaar <[email protected]>
Reviewed-by: Oliver Newman <[email protected]>
Fuchsia-Auto-Submit: Ina Huh <[email protected]>
Reviewed-by: Clayton Wilkinson <[email protected]>
Commit-Queue: Ina Huh <[email protected]>

Author: ihuh0

build/go/go_test.gni

@@ -66,14 +66,21 @@ template("go_test") {
 
   if (is_host) {
     _go_build_target_name = "${target_name}_go_build"
+    _test_data_target = "${target_name}_go_test_data"
+    host_test_data(_test_data_target) {
+      sources = [ "$root_out_dir/$_output_name" ]
+      deps = [ ":${_go_build_target_name}" ]
+    }
     host_test(target_name) {
-      binary_path = "$root_out_dir/$_output_name"
+      binary_path = get_label_info("//tools/go_test_parser", "root_out_dir") +
+                    "/go_test_parser"
 
       timeout = "5m"
       if (defined(invoker.timeout)) {
         timeout = invoker.timeout
       }
       args = [
+        rebase_path("$root_out_dir/$_output_name", root_build_dir),
         "-test.timeout",
         timeout,
         "-test.v",  # Emit detailed test case information.
@@ -82,7 +89,11 @@ template("go_test") {
         args += invoker.args
       }
 
-      deps = [ ":${_go_build_target_name}" ]
+      deps = [
+        ":${_go_build_target_name}",
+        ":${_test_data_target}",
+        "//tools/go_test_parser",
+      ]
 
       if (defined(invoker.deps)) {
         deps += invoker.deps

src/sys/pkg/tests/system-tests/system-tests.gni

@@ -2,7 +2,7 @@
 # Use of this source code is governed by a BSD-style license that can be
 # found in the LICENSE file.
 
-import("//build/testing/host_test.gni")
+import("//build/go/go_test.gni")
 
 if (is_host) {
   # Add this to go_test()'s environments to disable a test in infra
@@ -232,12 +232,11 @@ template("system_test_upgrade_suite") {
 
   foreach(test, _tests) {
     _test_name = get_label_info(test, "name")
-    _test_binary = "$root_out_dir/$_test_name"
 
     _host_test_target_name = "${target_name}_${_test_name}"
     _deps += [ ":${_host_test_target_name}" ]
 
-    _args = [ "-test.v" ]  # Print test detailed case status
+    _args = []
 
     foreach(build, _builds) {
       if (defined(build.release_build_id)) {
@@ -272,10 +271,6 @@ template("system_test_upgrade_suite") {
     if (defined(invoker.timeout)) {
       assert(invoker.timeout != "",
              "'${_host_test_target_name}' cannot have an empty timeout")
-      _args += [
-        "-test.timeout",
-        invoker.timeout,
-      ]
     }
 
     if (defined(invoker.pave_timeout)) {
@@ -400,10 +395,10 @@ template("system_test_upgrade_suite") {
       _args += [ "--resolver-mode=constant" ]
     }
 
-    host_test(_host_test_target_name) {
-      binary_path = _test_binary
+    go_test(_host_test_target_name) {
+      library = "//src/sys/pkg/tests/system-tests/upgrade_test:gopkg"
       args = _args
-      deps = [ test ]
+      forward_variables_from(invoker, [ "timeout" ])
 
       environments = []
       foreach(env, invoker.environments) {
@@ -490,12 +485,11 @@ template("system_test_reboot_suite") {
 
   foreach(test, _tests) {
     _test_name = get_label_info(test, "name")
-    _test_binary = "$root_out_dir/$_test_name"
 
     _host_test_target_name = "${target_name}_${_test_name}"
     _deps += [ ":${_host_test_target_name}" ]
 
-    _args = [ "-test.v" ]  # Print test detailed case status
+    _args = []
 
     if (defined(invoker.release_builder)) {
       _args += [
@@ -521,10 +515,6 @@ template("system_test_reboot_suite") {
     if (defined(invoker.timeout)) {
       assert(invoker.timeout != "",
              "'${_host_test_target_name}' cannot have an empty timeout")
-      _args += [
-        "-test.timeout",
-        invoker.timeout,
-      ]
     }
 
     if (defined(invoker.cycle_timeout)) {
@@ -570,10 +560,10 @@ template("system_test_reboot_suite") {
       _args += [ "--check-abr=false" ]
     }
 
-    host_test(_host_test_target_name) {
-      binary_path = _test_binary
+    go_test(_host_test_target_name) {
+      library = "//src/sys/pkg/tests/system-tests/reboot_test:gopkg"
       args = _args
-      deps = [ test ]
+      forward_variables_from(invoker, [ "timeout" ])
 
       environments = []
       foreach(env, invoker.environments) {
@@ -655,12 +645,11 @@ template("system_test_recovery_suite") {
 
   foreach(test, _tests) {
     _test_name = get_label_info(test, "name")
-    _test_binary = "$root_out_dir/$_test_name"
 
     _host_test_target_name = "${target_name}_${_test_name}"
     _deps += [ ":${_host_test_target_name}" ]
 
-    _args = [ "-test.v" ]  # Print test detailed case status
+    _args = []
 
     if (defined(invoker.release_builder)) {
       _args += [
@@ -686,10 +675,6 @@ template("system_test_recovery_suite") {
     if (defined(invoker.timeout)) {
       assert(invoker.timeout != "",
              "'${_host_test_target_name}' cannot have an empty timeout")
-      _args += [
-        "-test.timeout",
-        invoker.timeout,
-      ]
     }
 
     if (defined(invoker.cycle_timeout)) {
@@ -726,10 +711,10 @@ template("system_test_recovery_suite") {
       _args += [ "--check-abr=false" ]
     }
 
-    host_test(_host_test_target_name) {
-      binary_path = _test_binary
+    go_test(_host_test_target_name) {
+      library = "//src/sys/pkg/tests/system-tests/recovery_test:gopkg"
       args = _args
-      deps = [ test ]
+      forward_variables_from(invoker, [ "timeout" ])
 
       environments = []
       foreach(env, invoker.environments) {

tools/BUILD.gn

@@ -117,6 +117,7 @@ group("tests_no_e2e") {
     "//tools/fidlcat/tests",
     "//tools/fuzz:tests",
     "//tools/gn_desc:host_tests($host_toolchain)",
+    "//tools/go_test_parser:tests($host_toolchain)",
     "//tools/host_test_component:tests($host_toolchain)",
     "//tools/integration:tests($host_toolchain)",
     "//tools/jq5:tests($host_toolchain)",

tools/go_test_parser/BUILD.gn

@@ -0,0 +1,50 @@
+# Copyright 2025 The Fuchsia Authors. All rights reserved.
+# Use of this source code is governed by a BSD-style license that can be
+# found in the LICENSE file.
+
+import("//build/go/go_binary.gni")
+import("//build/go/go_library.gni")
+import("//build/go/go_test.gni")
+
+go_library("go_test_parser_lib") {
+  sources = [
+    "gotest.go",
+    "gotest_test.go",
+  ]
+
+  deps = [ "//tools/testing/runtests" ]
+}
+
+group("tests") {
+  testonly = true
+  deps = [
+    ":go_test_parser_cmd_tests",
+    ":go_test_parser_lib_tests",
+  ]
+}
+
+go_test("go_test_parser_lib_tests") {
+  library = ":go_test_parser_lib"
+  deps = [ "//third_party/golibs:github.com/google/go-cmp" ]
+}
+
+go_library("main") {
+  source_dir = "cmd"
+  sources = [
+    "main.go",
+    "main_test.go",
+  ]
+  deps = [
+    ":go_test_parser_lib",
+    "//tools/testing/testrunner:constants",
+  ]
+}
+
+go_binary("go_test_parser") {
+  library = ":main"
+}
+
+go_test("go_test_parser_cmd_tests") {
+  library = ":main"
+  deps = [ "//third_party/golibs:github.com/google/go-cmp" ]
+}

tools/go_test_parser/OWNERS

@@ -0,0 +1,3 @@
+[email protected]
+[email protected]
+[email protected]

tools/go_test_parser/cmd/main.go

@@ -0,0 +1,78 @@
+// Copyright 2025 The Fuchsia Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package main
+
+import (
+	"bytes"
+	"context"
+	"encoding/json"
+	"flag"
+	"fmt"
+	"io"
+	"os"
+
+	"go.fuchsia.dev/fuchsia/tools/go_test_parser"
+	"go.fuchsia.dev/fuchsia/tools/lib/subprocess"
+	"go.fuchsia.dev/fuchsia/tools/testing/testrunner/constants"
+)
+
+func usage() {
+	fmt.Printf(`go_test_parser [go test command]
+
+Reads stdout from the go test command, and writes a JSON formatted summary to stdout
+of any error messages parsed from the logs.
+`)
+}
+
+func indentJSON(jsonBytes []byte) ([]byte, error) {
+	buffer := bytes.NewBuffer([]byte{})
+	err := json.Indent(buffer, jsonBytes, "", "\t")
+	return buffer.Bytes(), err
+}
+
+func mainImpl() error {
+	flag.Usage = usage
+
+	// Parse any global flags (e.g. those for glog)
+	flag.Parse()
+
+	args := flag.Args()
+
+	var testErr error
+	stdoutForParsing := new(bytes.Buffer)
+	testStdout := io.MultiWriter(os.Stdout, stdoutForParsing)
+	r := &subprocess.Runner{Env: os.Environ()}
+	fmt.Fprintf(os.Stdout, "Running %s\n", args[0])
+	if err := r.Run(context.Background(), args, subprocess.RunOptions{Stdout: testStdout}); err != nil {
+		testErr = fmt.Errorf("Error running test: %w", err)
+	}
+
+	if outputSummaryPath := os.Getenv(constants.TestOutputSummaryPathEnvKey); outputSummaryPath != "" {
+		result := go_test_parser.Parse(stdoutForParsing.Bytes())
+		jsonData, err := json.Marshal(result)
+		if err != nil {
+			return fmt.Errorf("Error marshaling JSON: %w", err)
+		}
+		indentedData, err := indentJSON(jsonData)
+		if err != nil {
+			return fmt.Errorf("Error indenting JSON: %w", err)
+		}
+		output, err := os.Create(outputSummaryPath)
+		if err != nil {
+			return fmt.Errorf("Error creating output path %s: %w", outputSummaryPath, err)
+		}
+		if _, err := output.Write(indentedData); err != nil {
+			return fmt.Errorf("Error writing output: %w", err)
+		}
+	}
+	return testErr
+}
+
+func main() {
+	if err := mainImpl(); err != nil {
+		fmt.Fprintf(os.Stderr, "%s\n", err)
+		os.Exit(1)
+	}
+}

tools/go_test_parser/cmd/main_test.go

@@ -0,0 +1,55 @@
+// Copyright 2025 The Fuchsia Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+
+package main
+
+import (
+	"bytes"
+	"encoding/json"
+	"testing"
+
+	"github.com/google/go-cmp/cmp"
+)
+
+func compactJson(jsonBytes []byte) []byte {
+	buffer := bytes.NewBuffer([]byte{})
+	json.Compact(buffer, jsonBytes)
+	return buffer.Bytes()
+}
+
+func TestIndentJSON(t *testing.T) {
+	want := `[
+	{
+		"display_name": "tests::ignored_test",
+		"suite_name": "tests",
+		"case_name": "ignored_test",
+		"status": "Skip",
+		"duration_nanos": 0,
+		"format": "Rust"
+	},
+	{
+		"display_name": "tests::test_add_hundred",
+		"suite_name": "tests",
+		"case_name": "test_add_hundred",
+		"status": "Pass",
+		"duration_nanos": 0,
+		"format": "Rust"
+	},
+	{
+		"display_name": "tests::test_add",
+		"suite_name": "tests",
+		"case_name": "test_add",
+		"status": "Fail",
+		"duration_nanos": 0,
+		"format": "Rust"
+	}
+]`
+	result, err := indentJSON(compactJson([]byte(want)))
+	if err != nil {
+		t.Errorf("TestIndentJSON failed: %v", err)
+	}
+	if diff := cmp.Diff(string(result), want); diff != "" {
+		t.Errorf("indentJSON returned wrong output(diff): %s\n", diff)
+	}
+}

tools/testing/testparser/gotest.go renamed to tools/go_test_parser/gotest.go

@@ -1,10 +1,11 @@
-// Copyright 2020 The Fuchsia Authors. All rights reserved.
+// Copyright 2025 The Fuchsia Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
-package testparser
+package go_test_parser
 
 import (
+	"bytes"
 	"fmt"
 	"regexp"
 	"time"
@@ -18,6 +19,20 @@ var (
 	goTestPanicPattern    = regexp.MustCompile(`^panic: test timed out after (\S+)$`)
 )
 
+// Parse takes stdout from a go test program and returns structured results.
+// If no structured results were identified, an empty slice is returned.
+func Parse(stdout []byte) []runtests.TestCaseResult {
+	lines := bytes.Split(stdout, []byte{'\n'})
+	cases := parseGoTest(lines)
+
+	// Ensure that an empty set of cases is serialized to JSON as an empty
+	// array, not as null.
+	if cases == nil {
+		cases = []runtests.TestCaseResult{}
+	}
+	return cases
+}
+
 func parseGoTest(lines [][]byte) []runtests.TestCaseResult {
 	var res []runtests.TestCaseResult
 	var preambleName string