rpc generation fix (zeromicro#184)

* reactor alert * optimize * add test case * update the target directory in case proto contains option * fix missing comments and format code
genewoo · Nov 5, 2020 · 856b5aa · 856b5aa
1 parent f7d778e
commit 856b5aa
Show file tree

Hide file tree

Showing 19 changed files with 97 additions and 36 deletions.
diff --git a/tools/goctl/rpc/cli/cli.go b/tools/goctl/rpc/cli/cli.go
@@ -18,10 +18,10 @@ func Rpc(c *cli.Context) error {
 	out := c.String("dir")
 	protoImportPath := c.StringSlice("proto_path")
 	if len(src) == 0 {
-		return errors.New("the proto source can not be nil")
+		return errors.New("missing -src")
 	}
 	if len(out) == 0 {
-		return errors.New("the target directory can not be nil")
+		return errors.New("missing -dir")
 	}
 	g := generator.NewDefaultRpcGenerator()
 	return g.Generate(src, out, protoImportPath)

diff --git a/tools/goctl/rpc/generator/gen_test.go b/tools/goctl/rpc/generator/gen_test.go
@@ -11,6 +11,7 @@ import (
 )
 
 func TestRpcGenerateCaseNilImport(t *testing.T) {
+	_ = Clean()
 	dispatcher := NewDefaultGenerator()
 	if err := dispatcher.Prepare(); err == nil {
 		g := NewRpcGenerator(dispatcher)
@@ -29,6 +30,7 @@ func TestRpcGenerateCaseNilImport(t *testing.T) {
 }
 
 func TestRpcGenerateCaseOption(t *testing.T) {
+	_ = Clean()
 	dispatcher := NewDefaultGenerator()
 	if err := dispatcher.Prepare(); err == nil {
 		g := NewRpcGenerator(dispatcher)
@@ -47,6 +49,7 @@ func TestRpcGenerateCaseOption(t *testing.T) {
 }
 
 func TestRpcGenerateCaseWordOption(t *testing.T) {
+	_ = Clean()
 	dispatcher := NewDefaultGenerator()
 	if err := dispatcher.Prepare(); err == nil {
 		g := NewRpcGenerator(dispatcher)
@@ -66,6 +69,7 @@ func TestRpcGenerateCaseWordOption(t *testing.T) {
 
 // test keyword go
 func TestRpcGenerateCaseGoOption(t *testing.T) {
+	_ = Clean()
 	dispatcher := NewDefaultGenerator()
 	if err := dispatcher.Prepare(); err == nil {
 		g := NewRpcGenerator(dispatcher)
@@ -84,6 +88,7 @@ func TestRpcGenerateCaseGoOption(t *testing.T) {
 }
 
 func TestRpcGenerateCaseImport(t *testing.T) {
+	_ = Clean()
 	dispatcher := NewDefaultGenerator()
 	if err := dispatcher.Prepare(); err == nil {
 		g := NewRpcGenerator(dispatcher)
@@ -102,3 +107,22 @@ func TestRpcGenerateCaseImport(t *testing.T) {
 		}())
 	}
 }
+
+func TestRpcGenerateCaseServiceRpcNamingSnake(t *testing.T) {
+	_ = Clean()
+	dispatcher := NewDefaultGenerator()
+	if err := dispatcher.Prepare(); err == nil {
+		g := NewRpcGenerator(dispatcher)
+		abs, err := filepath.Abs("./test")
+		assert.Nil(t, err)
+
+		err = g.Generate("./test_service_rpc_naming_snake.proto", abs, nil)
+		defer func() {
+			_ = os.RemoveAll(abs)
+		}()
+		assert.Nil(t, err)
+
+		_, err = execx.Run("go test "+abs, abs)
+		assert.Nil(t, err)
+	}
+}
diff --git a/tools/goctl/rpc/generator/gencall.go b/tools/goctl/rpc/generator/gencall.go
@@ -52,7 +52,7 @@ func New{{.serviceName}}(cli zrpc.Client) {{.serviceName}} {
 
 	callFunctionTemplate = `
 {{if .hasComment}}{{.comment}}{{end}}
-func (m *default{{.rpcServiceName}}) {{.method}}(ctx context.Context,in *{{.pbRequest}}) (*{{.pbResponse}}, error) {
+func (m *default{{.serviceName}}) {{.method}}(ctx context.Context,in *{{.pbRequest}}) (*{{.pbResponse}}, error) {
 	client := {{.package}}.New{{.rpcServiceName}}Client(m.cli.Conn())
 	return client.{{.method}}(ctx, in)
 }
@@ -90,9 +90,9 @@ func (g *defaultGenerator) GenCall(ctx DirContext, proto parser.Proto) error {
 		"name":        formatFilename(service.Name),
 		"alias":       strings.Join(alias.KeysStr(), util.NL),
 		"head":        head,
-		"filePackage": formatFilename(service.Name),
+		"filePackage": dir.Base,
 		"package":     fmt.Sprintf(`"%s"`, ctx.GetPb().Package),
-		"serviceName": parser.CamelCase(service.Name),
+		"serviceName": stringx.From(service.Name).ToCamel(),
 		"functions":   strings.Join(functions, util.NL),
 		"interface":   strings.Join(iFunctions, util.NL),
 	}, filename, true)
@@ -109,8 +109,9 @@ func (g *defaultGenerator) genFunction(goPackage string, service parser.Service)
 
 		comment := parser.GetComment(rpc.Doc())
 		buffer, err := util.With("sharedFn").Parse(text).Execute(map[string]interface{}{
-			"rpcServiceName": stringx.From(service.Name).Title(),
-			"method":         stringx.From(rpc.Name).Title(),
+			"serviceName":    stringx.From(service.Name).ToCamel(),
+			"rpcServiceName": parser.CamelCase(service.Name),
+			"method":         parser.CamelCase(rpc.Name),
 			"package":        goPackage,
 			"pbRequest":      parser.CamelCase(rpc.RequestType),
 			"pbResponse":     parser.CamelCase(rpc.ReturnsType),
@@ -140,7 +141,7 @@ func (g *defaultGenerator) getInterfaceFuncs(service parser.Service) ([]string,
 			map[string]interface{}{
 				"hasComment": len(comment) > 0,
 				"comment":    comment,
-				"method":     stringx.From(rpc.Name).Title(),
+				"method":     parser.CamelCase(rpc.Name),
 				"pbRequest":  parser.CamelCase(rpc.RequestType),
 				"pbResponse": parser.CamelCase(rpc.ReturnsType),
 			})

diff --git a/tools/goctl/rpc/generator/genlogic.go b/tools/goctl/rpc/generator/genlogic.go
@@ -63,7 +63,7 @@ func (g *defaultGenerator) GenLogic(ctx DirContext, proto parser.Proto) error {
 			return err
 		}
 		err = util.With("logic").GoFmt(true).Parse(text).SaveTo(map[string]interface{}{
-			"logicName": fmt.Sprintf("%sLogic", stringx.From(rpc.Name).Title()),
+			"logicName": fmt.Sprintf("%sLogic", stringx.From(rpc.Name).ToCamel()),
 			"functions": functions,
 			"imports":   strings.Join(imports.KeysStr(), util.NL),
 		}, filename, false)

diff --git a/tools/goctl/rpc/generator/genmain.go b/tools/goctl/rpc/generator/genmain.go
@@ -7,6 +7,7 @@ import (
 
 	"github.com/tal-tech/go-zero/tools/goctl/rpc/parser"
 	"github.com/tal-tech/go-zero/tools/goctl/util"
+	"github.com/tal-tech/go-zero/tools/goctl/util/stringx"
 )
 
 const mainTemplate = `{{.head}}
@@ -32,7 +33,7 @@ func main() {
 	var c config.Config
 	conf.MustLoad(*configFile, &c)
 	ctx := svc.NewServiceContext(c)
-	srv := server.New{{.service}}Server(ctx)
+	srv := server.New{{.serviceNew}}Server(ctx)
 
 	s := zrpc.MustNewServer(c.RpcServerConf, func(grpcServer *grpc.Server) {
 		{{.pkg}}.Register{{.service}}Server(grpcServer, srv)
@@ -65,6 +66,7 @@ func (g *defaultGenerator) GenMain(ctx DirContext, proto parser.Proto) error {
 		"serviceName": serviceNameLower,
 		"imports":     strings.Join(imports, util.NL),
 		"pkg":         proto.PbPackage,
+		"serviceNew":  stringx.From(proto.Service.Name).ToCamel(),
 		"service":     parser.CamelCase(proto.Service.Name),
 	}, fileName, false)
 }
diff --git a/tools/goctl/rpc/generator/genpb.go b/tools/goctl/rpc/generator/genpb.go
@@ -20,7 +20,7 @@ func (g *defaultGenerator) GenPb(ctx DirContext, protoImportPath []string, proto
 	cw.WriteString(" -I=" + base)
 	cw.WriteString(" " + proto.Name)
 	if strings.Contains(proto.GoPackage, "/") {
-		cw.WriteString(" --go_out=plugins=grpc:" + ctx.GetInternal().Filename)
+		cw.WriteString(" --go_out=plugins=grpc:" + ctx.GetMain().Filename)
 	} else {
 		cw.WriteString(" --go_out=plugins=grpc:" + dir.Filename)
 	}

diff --git a/tools/goctl/rpc/generator/genserver.go b/tools/goctl/rpc/generator/genserver.go
@@ -67,7 +67,7 @@ func (g *defaultGenerator) GenServer(ctx DirContext, proto parser.Proto) error {
 
 	err = util.With("server").GoFmt(true).Parse(text).SaveTo(map[string]interface{}{
 		"head":    head,
-		"server":  stringx.From(service.Name).Title(),
+		"server":  stringx.From(service.Name).ToCamel(),
 		"imports": strings.Join(imports.KeysStr(), util.NL),
 		"funcs":   strings.Join(funcList, util.NL),
 	}, serverFile, true)
@@ -84,8 +84,8 @@ func (g *defaultGenerator) genFunctions(goPackage string, service parser.Service
 
 		comment := parser.GetComment(rpc.Doc())
 		buffer, err := util.With("func").Parse(text).Execute(map[string]interface{}{
-			"server":     stringx.From(service.Name).Title(),
-			"logicName":  fmt.Sprintf("%sLogic", stringx.From(rpc.Name).Title()),
+			"server":     stringx.From(service.Name).ToCamel(),
+			"logicName":  fmt.Sprintf("%sLogic", stringx.From(rpc.Name).ToCamel()),
 			"method":     parser.CamelCase(rpc.Name),
 			"request":    fmt.Sprintf("*%s.%s", goPackage, parser.CamelCase(rpc.RequestType)),
 			"response":   fmt.Sprintf("*%s.%s", goPackage, parser.CamelCase(rpc.ReturnsType)),

diff --git a/tools/goctl/rpc/generator/mkdir.go b/tools/goctl/rpc/generator/mkdir.go
@@ -53,8 +53,12 @@ func mkdir(ctx *ctx.ProjectContext, proto parser.Proto) (DirContext, error) {
 	logicDir := filepath.Join(internalDir, "logic")
 	serverDir := filepath.Join(internalDir, "server")
 	svcDir := filepath.Join(internalDir, "svc")
-	pbDir := filepath.Join(internalDir, proto.GoPackage)
+	pbDir := filepath.Join(ctx.WorkDir, proto.GoPackage)
 	callDir := filepath.Join(ctx.WorkDir, strings.ToLower(stringx.From(proto.Service.Name).ToCamel()))
+	if strings.ToLower(proto.Service.Name) == strings.ToLower(proto.GoPackage) {
+		callDir = filepath.Join(ctx.WorkDir, strings.ToLower(stringx.From(proto.Service.Name+"_client").ToCamel()))
+	}
+
 	inner[wd] = Dir{
 		Filename: ctx.WorkDir,
 		Package:  filepath.ToSlash(filepath.Join(ctx.Path, strings.TrimPrefix(ctx.WorkDir, ctx.Dir))),

diff --git a/tools/goctl/rpc/generator/test.proto b/tools/goctl/rpc/generator/test.proto
@@ -6,11 +6,11 @@ option go_package = "go";
 
 import "test_base.proto";
 
-message TestMessage{
+message TestMessage {
   base.CommonReq req = 1;
 }
-message TestReq{}
-message TestReply{
+message TestReq {}
+message TestReply {
   base.CommonReply reply = 2;
 }
 
@@ -20,6 +20,6 @@ enum TestEnum {
   female = 2;
 }
 
-service TestService{
-  rpc TestRpc (TestReq)returns(TestReply);
+service TestService {
+  rpc TestRpc (TestReq) returns (TestReply);
 }
diff --git a/tools/goctl/rpc/generator/test_go_option.proto b/tools/goctl/rpc/generator/test_go_option.proto
@@ -14,5 +14,5 @@ message StreamResp {
 }
 
 service StreamGreeter {
-  rpc greet(StreamReq) returns (StreamResp);
+  rpc greet (StreamReq) returns (StreamResp);
 }
diff --git a/tools/goctl/rpc/generator/test_import.proto b/tools/goctl/rpc/generator/test_import.proto
@@ -14,5 +14,5 @@ message Out {
 }
 
 service StreamGreeter {
-  rpc greet(In) returns (Out);
+  rpc greet (In) returns (Out);
 }
diff --git a/tools/goctl/rpc/generator/test_option.proto b/tools/goctl/rpc/generator/test_option.proto
@@ -14,5 +14,5 @@ message StreamResp {
 }
 
 service StreamGreeter {
-  rpc greet(StreamReq) returns (StreamResp);
+  rpc greet (StreamReq) returns (StreamResp);
 }
diff --git a/tools/goctl/rpc/generator/test_service_rpc_naming_snake.proto b/tools/goctl/rpc/generator/test_service_rpc_naming_snake.proto
@@ -0,0 +1,27 @@
+// test proto
+syntax = "proto3";
+
+package snake_package;
+
+message StreamReq {
+  string name = 1;
+}
+
+message Stream_Resp {
+  string greet = 1;
+}
+
+message lowercase {
+  string in = 1;
+  string lower = 2;
+}
+
+message CamelCase {
+  string Camel = 1;
+}
+
+service Stream_Greeter {
+  rpc snake_service(StreamReq) returns (Stream_Resp);
+  rpc ServiceCamelCase(CamelCase) returns (CamelCase);
+  rpc servicelowercase(lowercase) returns (lowercase);
+}
diff --git a/tools/goctl/rpc/generator/test_stream.proto b/tools/goctl/rpc/generator/test_stream.proto
@@ -12,5 +12,6 @@ message StreamResp {
 }
 
 service StreamGreeter {
-  rpc greet(StreamReq) returns (StreamResp);
+  // greet service
+  rpc greet (StreamReq) returns (StreamResp);
 }
diff --git a/tools/goctl/rpc/parser/comment.go b/tools/goctl/rpc/parser/comment.go
@@ -6,5 +6,5 @@ func GetComment(comment *proto.Comment) string {
 	if comment == nil {
 		return ""
 	}
-	return comment.Message()
+	return "// " + comment.Message()
 }
diff --git a/tools/goctl/rpc/parser/test_invalid_request.proto b/tools/goctl/rpc/parser/test_invalid_request.proto
@@ -8,6 +8,6 @@ import "base.proto";
 message Reply{}
 
 
-service TestService{
-  rpc TestRpcTwo (base.Req)returns(Reply);
+service TestService {
+  rpc TestRpcTwo (base.Req) returns (Reply);
 }
diff --git a/tools/goctl/rpc/parser/test_invalid_response.proto b/tools/goctl/rpc/parser/test_invalid_response.proto
@@ -8,6 +8,6 @@ import "base.proto";
 message Req{}
 
 
-service TestService{
-  rpc TestRpcTwo (Req)returns(base.Reply);
+service TestService {
+  rpc TestRpcTwo (Req) returns (base.Reply);
 }
diff --git a/tools/goctl/rpc/parser/test_option.proto b/tools/goctl/rpc/parser/test_option.proto
@@ -2,9 +2,10 @@ syntax = "proto3";
 
 package stream;
 
-option go_package="github.com/tal-tech/go-zero";
+option go_package = "github.com/tal-tech/go-zero";
 
-message placeholder{}
-service greet{
-  rpc hello(placeholder)returns(placeholder);
+message placeholder {}
+
+service greet {
+  rpc hello (placeholder) returns (placeholder);
 }
diff --git a/tools/goctl/rpc/parser/test_option2.proto b/tools/goctl/rpc/parser/test_option2.proto
@@ -3,7 +3,8 @@ syntax = "proto3";
 package stream;
 
 
-message placeholder{}
-service greet{
-  rpc hello(placeholder)returns(placeholder);
+message placeholder {}
+
+service greet {
+  rpc hello (placeholder) returns (placeholder);
 }