Fix godoc in suite_test template of testing plugin (#257)

tchssk · web-flow · commit 55c37e9ae042 · 2026-05-27T14:30:44.000-07:00
* Fix godoc in suite_test template of testing plugin

* make
diff --git a/testing/codegen/templates/suite_test.go.tpl b/testing/codegen/templates/suite_test.go.tpl
@@ -1,4 +1,4 @@
-{{ printf "Run%sHarness exercises the generated harness against your service implementation." .Service.Name | comment }}
+{{ printf "Run%sHarness exercises the generated harness against your service implementation." .Service.StructName | comment }}
 {{ printf "Call this helper from your test, passing your service implementation." | comment }}
 func Run{{ .Service.StructName }}Harness(t *testing.T, svc {{ .Service.PkgName }}.Service) {
 	t.Helper()
diff --git a/testing/examples/calculator/calculator_suite_test.go b/testing/examples/calculator/calculator_suite_test.go
@@ -10,7 +10,7 @@ import (
 	calculatortest "goa.design/plugins/v3/testing/examples/calculator/gen/calculator/calculatortest"
 )
 
-// RuncalculatorHarness exercises the generated harness against your service
+// RunCalculatorHarness exercises the generated harness against your service
 // implementation.
 // Call this helper from your test, passing your service implementation.
 func RunCalculatorHarness(t *testing.T, svc calculator.Service) {
diff --git a/testing/examples/httpgrpc/test_http_grpc_suite_test.go b/testing/examples/httpgrpc/test_http_grpc_suite_test.go
@@ -10,8 +10,8 @@ import (
 	testHTTPGrpctest "goa.design/plugins/v3/testing/examples/httpgrpc/gen/test_http_grpc/test_http_grpctest"
 )
 
-// Runtest-http-grpcHarness exercises the generated harness against your
-// service implementation.
+// RunTestHTTPGrpcHarness exercises the generated harness against your service
+// implementation.
 // Call this helper from your test, passing your service implementation.
 func RunTestHTTPGrpcHarness(t *testing.T, svc testhttpgrpc.Service) {
 	t.Helper()
diff --git a/testing/examples/jsonrpc/test_jsonrpc_suite_test.go b/testing/examples/jsonrpc/test_jsonrpc_suite_test.go
@@ -9,7 +9,7 @@ import (
 	testJsonrpctest "goa.design/plugins/v3/testing/examples/jsonrpc/gen/test_jsonrpc/test_jsonrpctest"
 )
 
-// Runtest-jsonrpcHarness exercises the generated harness against your service
+// RunTestJsonrpcHarness exercises the generated harness against your service
 // implementation.
 // Call this helper from your test, passing your service implementation.
 func RunTestJsonrpcHarness(t *testing.T, svc testjsonrpc.Service) {

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-{{ printf "Run%sHarness exercises the generated harness against your service implementation." .Service.Name \| comment }}`
	`1`	`+{{ printf "Run%sHarness exercises the generated harness against your service implementation." .Service.StructName \| comment }}`
`2`	`2`	`{{ printf "Call this helper from your test, passing your service implementation." \| comment }}`
`3`	`3`	`func Run{{ .Service.StructName }}Harness(t *testing.T, svc {{ .Service.PkgName }}.Service) {`
`4`	`4`	`t.Helper()`
Original file line number	Diff line number	Diff line change
`@@ -10,7 +10,7 @@ import (`
`10`	`10`	`calculatortest "goa.design/plugins/v3/testing/examples/calculator/gen/calculator/calculatortest"`
`11`	`11`	`)`
`12`	`12`
`13`		`-// RuncalculatorHarness exercises the generated harness against your service`
	`13`	`+// RunCalculatorHarness exercises the generated harness against your service`
`14`	`14`	`// implementation.`
`15`	`15`	`// Call this helper from your test, passing your service implementation.`
`16`	`16`	`func RunCalculatorHarness(t *testing.T, svc calculator.Service) {`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ import (`
`9`	`9`	`testJsonrpctest "goa.design/plugins/v3/testing/examples/jsonrpc/gen/test_jsonrpc/test_jsonrpctest"`
`10`	`10`	`)`
`11`	`11`
`12`		`-// Runtest-jsonrpcHarness exercises the generated harness against your service`
	`12`	`+// RunTestJsonrpcHarness exercises the generated harness against your service`
`13`	`13`	`// implementation.`
`14`	`14`	`// Call this helper from your test, passing your service implementation.`
`15`	`15`	`func RunTestJsonrpcHarness(t *testing.T, svc testjsonrpc.Service) {`