refactor: merge shared to fungo

Author: debugtalk

fungo/grpc.go

@@ -8,7 +8,6 @@ import (
 	"google.golang.org/grpc"
 
 	"github.com/httprunner/funplugin/fungo/protoGen"
-	"github.com/httprunner/funplugin/shared"
 	jsoniter "github.com/json-iterator/go"
 )
 
@@ -65,7 +64,7 @@ func (m *functionGRPCClient) Call(funcName string, funcArgs ...interface{}) (int
 // Here is the gRPC server that functionGRPCClient talks to.
 type functionGRPCServer struct {
 	protoGen.UnimplementedDebugTalkServer
-	Impl shared.IFuncCaller
+	Impl IFuncCaller
 }
 
 func (m *functionGRPCServer) GetNames(ctx context.Context, req *protoGen.Empty) (*protoGen.GetNamesResponse, error) {
@@ -104,7 +103,7 @@ func (m *functionGRPCServer) Call(ctx context.Context, req *protoGen.CallRequest
 // GRPCPlugin implements hashicorp's plugin.GRPCPlugin.
 type GRPCPlugin struct {
 	plugin.Plugin
-	Impl shared.IFuncCaller
+	Impl IFuncCaller
 }
 
 func (p *GRPCPlugin) GRPCServer(broker *plugin.GRPCBroker, s *grpc.Server) error {

shared/config.go fungo/init.goshared/config.go renamed to fungo/init.go

@@ -1,10 +1,22 @@
-package shared
+package fungo
 
 import (
+	hclog "github.com/hashicorp/go-hclog"
 	"github.com/hashicorp/go-plugin"
 )
 
-const Version = "v0.5.0"
+const Version = "v0.5.2"
+
+var (
+	logger = Logger
+)
+
+var Logger = hclog.New(&hclog.LoggerOptions{
+	Name:   "fungo",
+	Output: hclog.DefaultOutput,
+	Level:  hclog.Debug,
+	Color:  hclog.AutoColor,
+})
 
 // PluginTypeEnvName is used to specify hashicorp go plugin type, rpc/grpc
 const PluginTypeEnvName = "HRP_PLUGIN_TYPE"
@@ -18,3 +30,9 @@ var HandshakeConfig = plugin.HandshakeConfig{
 	MagicCookieKey:   "HttpRunnerPlus",
 	MagicCookieValue: "debugtalk",
 }
+
+// IFuncCaller is the interface that we're exposing as a plugin.
+type IFuncCaller interface {
+	GetNames() ([]string, error)                                    // get all plugin function names list
+	Call(funcName string, args ...interface{}) (interface{}, error) // call plugin function
+}

fungo/plugin.go

@@ -7,13 +7,6 @@ import (
 
 	hclog "github.com/hashicorp/go-hclog"
 	"github.com/hashicorp/go-plugin"
-
-	"github.com/httprunner/funplugin/shared"
-)
-
-var (
-	Version = shared.Version
-	logger  = shared.Logger.Named("fungo")
 )
 
 // functionsMap stores plugin functions
@@ -43,7 +36,7 @@ func (p *functionPlugin) Call(funcName string, args ...interface{}) (interface{}
 		return nil, fmt.Errorf("function %s not found", funcName)
 	}
 
-	return shared.CallFunc(fn, args...)
+	return CallFunc(fn, args...)
 }
 
 var functions = make(functionsMap)
@@ -57,7 +50,7 @@ func Register(funcName string, fn interface{}) {
 	logger.Info("register plugin function", "funcName", funcName)
 	functions[funcName] = reflect.ValueOf(fn)
 	// automatic registration with common name
-	functions[shared.ConvertCommonName(funcName)] = functions[funcName]
+	functions[ConvertCommonName(funcName)] = functions[funcName]
 }
 
 // serveRPC starts a plugin server process in RPC mode.
@@ -74,7 +67,7 @@ func serveRPC() {
 	}
 	// start RPC server
 	plugin.Serve(&plugin.ServeConfig{
-		HandshakeConfig: shared.HandshakeConfig,
+		HandshakeConfig: HandshakeConfig,
 		Plugins:         pluginMap,
 	})
 }
@@ -93,15 +86,15 @@ func serveGRPC() {
 	}
 	// start gRPC server
 	plugin.Serve(&plugin.ServeConfig{
-		HandshakeConfig: shared.HandshakeConfig,
+		HandshakeConfig: HandshakeConfig,
 		Plugins:         pluginMap,
 		GRPCServer:      plugin.DefaultGRPCServer,
 	})
 }
 
 // default to run plugin in gRPC mode
 func Serve() {
-	if os.Getenv(shared.PluginTypeEnvName) == "rpc" {
+	if os.Getenv(PluginTypeEnvName) == "rpc" {
 		serveRPC()
 	} else {
 		// default

fungo/rpc.go

@@ -5,8 +5,6 @@ import (
 	"net/rpc"
 
 	"github.com/hashicorp/go-plugin"
-
-	"github.com/httprunner/funplugin/shared"
 )
 
 func init() {
@@ -61,7 +59,7 @@ func (g *functionRPCClient) Call(funcName string, funcArgs ...interface{}) (inte
 
 // functionRPCServer runs on the plugin side, executing the user custom function.
 type functionRPCServer struct {
-	Impl shared.IFuncCaller
+	Impl IFuncCaller
 }
 
 // plugin execution
@@ -93,7 +91,7 @@ func (s *functionRPCServer) Call(args interface{}, resp *interface{}) error {
 
 // RPCPlugin implements hashicorp's plugin.Plugin.
 type RPCPlugin struct {
-	Impl shared.IFuncCaller
+	Impl IFuncCaller
 }
 
 func (p *RPCPlugin) Server(*plugin.MuxBroker) (interface{}, error) {

shared/utils.go fungo/utils.goshared/utils.go renamed to fungo/utils.go

@@ -1,4 +1,4 @@
-package shared
+package fungo
 
 import (
 	"fmt"
@@ -10,7 +10,7 @@ import (
 func CallFunc(fn reflect.Value, args ...interface{}) (interface{}, error) {
 	argumentsValue, err := convertArgs(fn, args...)
 	if err != nil {
-		Logger.Error("convert arguments failed", "error", err)
+		logger.Error("convert arguments failed", "error", err)
 		return nil, err
 	}
 	return call(fn, argumentsValue)

shared/utils_test.go fungo/utils_test.goshared/utils_test.go renamed to fungo/utils_test.go

@@ -1,4 +1,4 @@
-package shared
+package fungo
 
 import (
 	"errors"

go_plugin.go

@@ -6,7 +6,7 @@ import (
 	"reflect"
 	"runtime"
 
-	"github.com/httprunner/funplugin/shared"
+	"github.com/httprunner/funplugin/fungo"
 )
 
 // goPlugin implements golang official plugin
@@ -74,7 +74,7 @@ func (p *goPlugin) Call(funcName string, args ...interface{}) (interface{}, erro
 		return nil, fmt.Errorf("function %s not found", funcName)
 	}
 	fn := p.cachedFunctions[funcName]
-	return shared.CallFunc(fn, args...)
+	return fungo.CallFunc(fn, args...)
 }
 
 func (p *goPlugin) Quit() error {

hashicorp_plugin.go

@@ -11,7 +11,6 @@ import (
 	"github.com/pkg/errors"
 
 	"github.com/httprunner/funplugin/fungo"
-	"github.com/httprunner/funplugin/shared"
 )
 
 type rpcType string
@@ -29,7 +28,7 @@ func (t rpcType) String() string {
 type hashicorpPlugin struct {
 	client          *plugin.Client
 	rpcType         rpcType
-	funcCaller      shared.IFuncCaller
+	funcCaller      fungo.IFuncCaller
 	cachedFunctions sync.Map // cache loaded functions to improve performance, key is function name, value is bool
 	path            string   // plugin file path
 	option          *pluginOption
@@ -42,7 +41,7 @@ func newHashicorpPlugin(path string, option *pluginOption) (*hashicorpPlugin, er
 	}
 
 	// plugin type, grpc or rpc
-	p.rpcType = rpcType(os.Getenv(shared.PluginTypeEnvName))
+	p.rpcType = rpcType(os.Getenv(fungo.PluginTypeEnvName))
 	if p.rpcType != rpcTypeRPC {
 		p.rpcType = rpcTypeGRPC // default
 	}
@@ -66,12 +65,12 @@ func newHashicorpPlugin(path string, option *pluginOption) (*hashicorpPlugin, er
 		// hashicorp go plugin
 		cmd = exec.Command(path)
 	}
-	cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%s", shared.PluginTypeEnvName, p.rpcType))
+	cmd.Env = append(os.Environ(), fmt.Sprintf("%s=%s", fungo.PluginTypeEnvName, p.rpcType))
 
 	// launch the plugin process
 	logger.Info("launch the plugin process")
 	p.client = plugin.NewClient(&plugin.ClientConfig{
-		HandshakeConfig: shared.HandshakeConfig,
+		HandshakeConfig: fungo.HandshakeConfig,
 		Plugins: map[string]plugin.Plugin{
 			rpcTypeRPC.String():  &fungo.RPCPlugin{},
 			rpcTypeGRPC.String(): &fungo.GRPCPlugin{},
@@ -98,7 +97,7 @@ func newHashicorpPlugin(path string, option *pluginOption) (*hashicorpPlugin, er
 
 	// We should have a Function now! This feels like a normal interface
 	// implementation but is in fact over an RPC connection.
-	p.funcCaller = raw.(shared.IFuncCaller)
+	p.funcCaller = raw.(fungo.IFuncCaller)
 
 	p.cachedFunctions = sync.Map{}
 	logger.Info("load hashicorp go plugin success", "path", path)

init.go

@@ -5,11 +5,11 @@ import (
 	"fmt"
 	"path/filepath"
 
-	"github.com/httprunner/funplugin/shared"
+	"github.com/httprunner/funplugin/fungo"
 )
 
 var (
-	logger = shared.Logger
+	logger = fungo.Logger
 )
 
 type IPlugin interface {