add basic plugin architecture
This commit is contained in:
parent
e0e0290dcf
commit
d484d44981
1
.gitignore
vendored
Normal file
1
.gitignore
vendored
Normal file
@ -0,0 +1 @@
|
|||||||
|
dist/
|
@ -15,20 +15,23 @@ func NewLsCommand() *cobra.Command {
|
|||||||
|
|
||||||
r, err := register.
|
r, err := register.
|
||||||
NewPluginRegisterBuilder().
|
NewPluginRegisterBuilder().
|
||||||
Add("gocli", "").
|
Add("gocli", "plugins/gocli/main.go").
|
||||||
|
Add("rust", "plugins/rust/main.go").
|
||||||
Build(ctx)
|
Build(ctx)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
defer r.Close()
|
||||||
|
|
||||||
about, err := r.About(ctx)
|
about, err := r.About(ctx)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
return err
|
return err
|
||||||
}
|
}
|
||||||
|
|
||||||
for plugin, aboutText := range about {
|
for _, a := range about {
|
||||||
fmt.Printf("plugin: %s\n", plugin)
|
fmt.Printf("plugin: %s\n", a.Name)
|
||||||
fmt.Printf("\tabout: %s\n", aboutText)
|
fmt.Printf("\tversion: %s\n", a.Version)
|
||||||
|
fmt.Printf("\tabout: %s\n", a.About)
|
||||||
fmt.Println()
|
fmt.Println()
|
||||||
}
|
}
|
||||||
|
|
||||||
|
1
examples/basic/.char/plugins/rust
Symbolic link
1
examples/basic/.char/plugins/rust
Symbolic link
@ -0,0 +1 @@
|
|||||||
|
../../../../
|
BIN
examples/basic/char
Executable file
BIN
examples/basic/char
Executable file
Binary file not shown.
4
examples/basic/char.yml
Normal file
4
examples/basic/char.yml
Normal file
@ -0,0 +1,4 @@
|
|||||||
|
registry: git.front.kjuulh.io
|
||||||
|
plugins:
|
||||||
|
"kjuulh/char#plugins/gocli": {}
|
||||||
|
"kjuulh/char#plugins/rust": {}
|
@ -1,3 +1,5 @@
|
|||||||
#!/bin/bash
|
#!/bin/bash
|
||||||
|
|
||||||
go run ../../main.go ls
|
go build -o char ../../main.go
|
||||||
|
|
||||||
|
CHAR_DEV_MODE=true ./char ls
|
||||||
|
@ -1 +0,0 @@
|
|||||||
package script
|
|
@ -1,5 +1,13 @@
|
|||||||
package register
|
package register
|
||||||
|
|
||||||
type Plugin interface {
|
import "context"
|
||||||
About() string
|
|
||||||
|
type About struct {
|
||||||
|
Name string `json:"name"`
|
||||||
|
Version string `json:"version"`
|
||||||
|
About string `json:"about"`
|
||||||
|
}
|
||||||
|
|
||||||
|
type Plugin interface {
|
||||||
|
About(ctx context.Context) (*About, error)
|
||||||
}
|
}
|
||||||
|
@ -7,6 +7,7 @@ import (
|
|||||||
)
|
)
|
||||||
|
|
||||||
type PluginAPI struct {
|
type PluginAPI struct {
|
||||||
|
path string
|
||||||
Impl Plugin
|
Impl Plugin
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@ -14,7 +14,7 @@ type PluginBuilder struct {
|
|||||||
|
|
||||||
func NewPluginBuilder(name string, p Plugin) *PluginBuilder {
|
func NewPluginBuilder(name string, p Plugin) *PluginBuilder {
|
||||||
logger := hclog.New(&hclog.LoggerOptions{
|
logger := hclog.New(&hclog.LoggerOptions{
|
||||||
Level: hclog.Trace,
|
Level: hclog.Error,
|
||||||
Output: os.Stderr,
|
Output: os.Stderr,
|
||||||
JSONFormat: false,
|
JSONFormat: false,
|
||||||
})
|
})
|
||||||
|
@ -1,7 +1,8 @@
|
|||||||
package register
|
package register
|
||||||
|
|
||||||
import (
|
import (
|
||||||
"log"
|
"context"
|
||||||
|
"encoding/json"
|
||||||
"net/rpc"
|
"net/rpc"
|
||||||
)
|
)
|
||||||
|
|
||||||
@ -11,12 +12,18 @@ type PluginClient struct {
|
|||||||
|
|
||||||
var _ Plugin = &PluginClient{}
|
var _ Plugin = &PluginClient{}
|
||||||
|
|
||||||
func (pc *PluginClient) About() string {
|
func (pc *PluginClient) About(ctx context.Context) (*About, error) {
|
||||||
var resp string
|
var resp string
|
||||||
err := pc.client.Call("Plugin.About", new(any), &resp)
|
err := pc.client.Call("Plugin.About", new(any), &resp)
|
||||||
if err != nil {
|
if err != nil {
|
||||||
log.Fatal(err)
|
return nil, err
|
||||||
}
|
}
|
||||||
|
|
||||||
return resp
|
var about About
|
||||||
|
err = json.Unmarshal([]byte(resp), &about)
|
||||||
|
if err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
|
return &about, nil
|
||||||
}
|
}
|
||||||
|
@ -4,6 +4,7 @@ import (
|
|||||||
"context"
|
"context"
|
||||||
"errors"
|
"errors"
|
||||||
"fmt"
|
"fmt"
|
||||||
|
"log"
|
||||||
"os"
|
"os"
|
||||||
"os/exec"
|
"os/exec"
|
||||||
|
|
||||||
@ -23,7 +24,9 @@ func NewPluginRegisterBuilder() *PluginRegisterBuilder {
|
|||||||
}
|
}
|
||||||
|
|
||||||
func (pr *PluginRegisterBuilder) Add(name, path string) *PluginRegisterBuilder {
|
func (pr *PluginRegisterBuilder) Add(name, path string) *PluginRegisterBuilder {
|
||||||
pr.plugins[name] = PluginAPI{}
|
pr.plugins[name] = PluginAPI{
|
||||||
|
path: path,
|
||||||
|
}
|
||||||
|
|
||||||
return pr
|
return pr
|
||||||
}
|
}
|
||||||
@ -32,10 +35,38 @@ func (pr *PluginRegisterBuilder) Build(ctx context.Context) (*PluginRegister, er
|
|||||||
clients := make(map[string]*pluginClientWrapper, 0)
|
clients := make(map[string]*pluginClientWrapper, 0)
|
||||||
errgroup, _ := errgroup.WithContext(ctx)
|
errgroup, _ := errgroup.WithContext(ctx)
|
||||||
|
|
||||||
|
if err := os.MkdirAll(".char/plugins/", 0755); err != nil {
|
||||||
|
return nil, err
|
||||||
|
}
|
||||||
|
|
||||||
for name, p := range pr.plugins {
|
for name, p := range pr.plugins {
|
||||||
name, p := name, p
|
name, p := name, p
|
||||||
|
|
||||||
errgroup.Go(func() error {
|
errgroup.Go(func() error {
|
||||||
|
pluginPath := fmt.Sprintf(".char/plugins/%s/dist/%s", name, name)
|
||||||
|
|
||||||
|
_, err := os.Stat(pluginPath)
|
||||||
|
if err != nil || os.Getenv("CHAR_DEV_MODE") == "true" {
|
||||||
|
log.Printf("building: %s", name)
|
||||||
|
cmd := exec.Command(
|
||||||
|
"sh",
|
||||||
|
"-c",
|
||||||
|
fmt.Sprintf(
|
||||||
|
"(cd .char/plugins/%s; go build -o dist/%s %s)",
|
||||||
|
name,
|
||||||
|
name,
|
||||||
|
p.path,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
output, err := cmd.CombinedOutput()
|
||||||
|
if len(output) > 0 {
|
||||||
|
log.Println(string(output))
|
||||||
|
}
|
||||||
|
if err != nil {
|
||||||
|
return fmt.Errorf("could not build plugin: %w", err)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
client := plugin.NewClient(&plugin.ClientConfig{
|
client := plugin.NewClient(&plugin.ClientConfig{
|
||||||
HandshakeConfig: plugin.HandshakeConfig{
|
HandshakeConfig: plugin.HandshakeConfig{
|
||||||
ProtocolVersion: 1,
|
ProtocolVersion: 1,
|
||||||
@ -45,13 +76,15 @@ func (pr *PluginRegisterBuilder) Build(ctx context.Context) (*PluginRegister, er
|
|||||||
Logger: hclog.New(&hclog.LoggerOptions{
|
Logger: hclog.New(&hclog.LoggerOptions{
|
||||||
Name: "char",
|
Name: "char",
|
||||||
Output: os.Stdout,
|
Output: os.Stdout,
|
||||||
Level: hclog.Debug,
|
Level: hclog.Error,
|
||||||
}),
|
}),
|
||||||
Cmd: exec.Command("sh", "-c", fmt.Sprintf(
|
Cmd: exec.Command(
|
||||||
"(cd ./.char/plugins/%s; go run plugins/%s/main.go)",
|
fmt.Sprintf(
|
||||||
name,
|
".char/plugins/%s/dist/%s",
|
||||||
name,
|
name,
|
||||||
)),
|
name,
|
||||||
|
),
|
||||||
|
),
|
||||||
Plugins: map[string]plugin.Plugin{
|
Plugins: map[string]plugin.Plugin{
|
||||||
name: &p,
|
name: &p,
|
||||||
},
|
},
|
||||||
@ -126,17 +159,30 @@ func (pr *PluginRegister) Close() error {
|
|||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
|
||||||
func (pr *PluginRegister) About(ctx context.Context) (map[string]string, error) {
|
type AboutItem struct {
|
||||||
list := make(map[string]string, len(pr.clients))
|
Name string
|
||||||
|
Version string
|
||||||
|
About string
|
||||||
|
}
|
||||||
|
|
||||||
|
func (pr *PluginRegister) About(ctx context.Context) ([]AboutItem, error) {
|
||||||
|
list := make([]AboutItem, 0)
|
||||||
|
|
||||||
errgroup, ctx := errgroup.WithContext(ctx)
|
errgroup, ctx := errgroup.WithContext(ctx)
|
||||||
|
|
||||||
for n, c := range pr.clients {
|
for n, c := range pr.clients {
|
||||||
n, c := n, c
|
n, c := n, c
|
||||||
errgroup.Go(func() error {
|
errgroup.Go(func() error {
|
||||||
about := c.plugin.About()
|
about, err := c.plugin.About(ctx)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
list[n] = about
|
list = append(list, AboutItem{
|
||||||
|
Name: n,
|
||||||
|
Version: about.Version,
|
||||||
|
About: about.About,
|
||||||
|
})
|
||||||
return nil
|
return nil
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
@ -1,10 +1,25 @@
|
|||||||
package register
|
package register
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"encoding/json"
|
||||||
|
)
|
||||||
|
|
||||||
type PluginServer struct {
|
type PluginServer struct {
|
||||||
Impl Plugin
|
Impl Plugin
|
||||||
}
|
}
|
||||||
|
|
||||||
func (ps *PluginServer) About(args any, resp *string) error {
|
func (ps *PluginServer) About(args any, resp *string) error {
|
||||||
*resp = ps.Impl.About()
|
r, err := ps.Impl.About(context.Background())
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
respB, err := json.Marshal(r)
|
||||||
|
if err != nil {
|
||||||
|
return err
|
||||||
|
}
|
||||||
|
|
||||||
|
*resp = string(respB)
|
||||||
return nil
|
return nil
|
||||||
}
|
}
|
||||||
|
@ -10,9 +10,12 @@ import (
|
|||||||
type GoCliPlugin struct {
|
type GoCliPlugin struct {
|
||||||
}
|
}
|
||||||
|
|
||||||
// About implements register.Plugin
|
func (*GoCliPlugin) About(ctx context.Context) (*register.About, error) {
|
||||||
func (*GoCliPlugin) About() string {
|
return ®ister.About{
|
||||||
return "gocli"
|
Name: "gocli",
|
||||||
|
Version: "v0.0.1",
|
||||||
|
About: "golang cli provides a set of actions and presets supporting golang development",
|
||||||
|
}, nil
|
||||||
}
|
}
|
||||||
|
|
||||||
var _ register.Plugin = &GoCliPlugin{}
|
var _ register.Plugin = &GoCliPlugin{}
|
||||||
|
32
plugins/rust/main.go
Normal file
32
plugins/rust/main.go
Normal file
@ -0,0 +1,32 @@
|
|||||||
|
package main
|
||||||
|
|
||||||
|
import (
|
||||||
|
"context"
|
||||||
|
"log"
|
||||||
|
|
||||||
|
"git.front.kjuulh.io/kjuulh/char/pkg/register"
|
||||||
|
)
|
||||||
|
|
||||||
|
type GoCliPlugin struct {
|
||||||
|
}
|
||||||
|
|
||||||
|
func (*GoCliPlugin) About(ctx context.Context) (*register.About, error) {
|
||||||
|
return ®ister.About{
|
||||||
|
Name: "rust",
|
||||||
|
Version: "v0.0.1",
|
||||||
|
About: "golang cli provides a set of actions and presets supporting golang development",
|
||||||
|
}, nil
|
||||||
|
}
|
||||||
|
|
||||||
|
var _ register.Plugin = &GoCliPlugin{}
|
||||||
|
|
||||||
|
func main() {
|
||||||
|
if err := register.
|
||||||
|
NewPluginBuilder(
|
||||||
|
"rust",
|
||||||
|
&GoCliPlugin{},
|
||||||
|
).
|
||||||
|
Serve(context.Background()); err != nil {
|
||||||
|
log.Fatal(err)
|
||||||
|
}
|
||||||
|
}
|
Loading…
Reference in New Issue
Block a user