feat: try gRPC approach

Author: saitho

README.md

@@ -1,43 +1,9 @@
 # StackHead Plugin API
 
-## Expected structure
+## Requirements
 
-```go
-package main
+...
 
-import "github.com/getstackhead/pluginlib"
+## Example
 
-type MyPlugin struct {
-}
-
-var PluginConfig = pluginlib.PluginConfig{
-	Name:        "Test",
-	Description: "This is an example StackHead Proxy plugin",
-	Version:     "0.0.0-dev",
-	Authors:     []string{"Your Name"},
-	PluginType:  pluginlib.PluginType.PROXY,
-}
-
-func (p MyPlugin) Setup() {
-	// implement software setup action
-}
-
-func (p MyPlugin) Deploy(project pluginlib.Project) {
-	// implement project deploy action
-}
-
-func (p MyPlugin) Destroy(project pluginlib.Project) {
-	// implement project destroy action
-}
-
-func (p MyPlugin) TriggerHook(hookName string, project pluginlib.Project) {
-	// triggered by hooks
-}
-
-// Export plugin to StackHead. Must be named "Plugin"!
-var Plugin MyPlugin
-```
-
-```shell
-go build -buildmode=plugin -o plugin.so main.go
-```
+See [./example](./example)

events.go

@@ -1,35 +1,47 @@
 package main
 
 import (
-	"fmt"
+	"log"
+	"net"
 
-	"github.com/getstackhead/pluginlib"
-)
-
-var Plugin MyPlugin
-var PluginConfig = pluginlib.PluginConfig{
-	Name:        "Test",
-	Description: "This is an example StackHead Proxy plugin",
-	Version:     "0.0.0-dev",
-	Authors:     []string{"Mario Lubenka"},
-	PluginType:  pluginlib.PluginType.PROXY,
-}
+	"github.com/phayes/freeport"
+	"google.golang.org/grpc"
 
-type MyPlugin struct {
-}
+	pb "github.com/getstackhead/pluginlib/gen"
+)
 
-func (p MyPlugin) Deploy(project pluginlib.Project) {
-	fmt.Println("Hello " + project.Name)
-}
+var Plugin MyPluginWrapper
 
-func (p MyPlugin) Destroy(project pluginlib.Project) {
-	fmt.Println("Bye " + project.Name)
+type MyPluginWrapper struct {
 }
 
-func (p MyPlugin) Setup() {
-	fmt.Println("Setup...")
+type plugin struct {
+	pb.UnimplementedStackHeadPlugin
 }
 
-func (p MyPlugin) TriggerHook(hookName string, project pluginlib.Project) {
-	fmt.Println("Hook " + hookName + " triggered for project " + project.Name + ".")
+func (p MyPluginWrapper) LaunchServer(callback func(int)) {
+	// Set up connection with local StackHead server
+	conn, err := grpc.Dial("localhost:1412", grpc.WithInsecure(), grpc.WithBlock())
+	if err != nil {
+		log.Fatalf("did not connect: %v", err)
+	}
+	defer conn.Close()
+	StackHeadClient := pb.NewStackHeadServiceClient(conn)
+
+	port, err := freeport.GetFreePort()
+	if err != nil {
+		log.Fatal(err)
+		return
+	}
+	lis, err := net.Listen("tcp", ":"+port)
+	if err != nil {
+		log.Fatalf("failed to listen: %v", err)
+	}
+	s := grpc.NewServer()
+	pb.RegisterStackHeadPluginServer(s, &plugin{})
+	log.Printf("server listening at %v", lis.Addr())
+	if err := s.Serve(lis); err != nil {
+		log.Fatalf("failed to serve: %v", err)
+	}
+	callback(port)
 }

example/main.go

@@ -1,8 +1,3 @@
 module github.com/getstackhead/pluginlib
 
 go 1.17
-
-require (
-	github.com/asaskevich/EventBus v0.0.0-20200907212545-49d423059eef
-	github.com/valyala/gorpc v0.0.0-20160519171614-908281bef774
-)

go.mod

@@ -1,4 +0,0 @@
-github.com/asaskevich/EventBus v0.0.0-20200907212545-49d423059eef h1:2JGTg6JapxP9/R33ZaagQtAM4EkkSYnIAlOG5EI8gkM=
-github.com/asaskevich/EventBus v0.0.0-20200907212545-49d423059eef/go.mod h1:JS7hed4L1fj0hXcyEejnW57/7LCetXggd+vwrRnYeII=
-github.com/valyala/gorpc v0.0.0-20160519171614-908281bef774 h1:SUHFQHAaySqF0YHCmmm0EIFooFZpDPpi5KTom7YJ07c=
-github.com/valyala/gorpc v0.0.0-20160519171614-908281bef774/go.mod h1:8uNqM1i7pr0jO7gdvbNCgsSa8Ki2vMh7JCQxO9BlF90=

go.sum

@@ -1,46 +1,5 @@
 package pluginlib
 
-import (
-	"plugin"
-)
-
 type Plugin interface {
-	Setup() <-chan error
-	Deploy(project Project) <-chan error
-	Destroy(project Project) <-chan error
-	TriggerHook(hookName string, project Project)
-}
-
-func LoadPlugin(path string) (Plugin, *PluginConfig, error) {
-	// load module
-	plug, err := plugin.Open(path)
-	if err != nil {
-		return nil, nil, err
-	}
-
-	// 2. look up a symbol (an exported function or variable)
-	symPlugin, err := plug.Lookup("Plugin")
-	if err != nil {
-		return nil, nil, err
-	}
-	var ok bool
-	var pluginObj Plugin
-	pluginObj, ok = symPlugin.(Plugin)
-	if !ok {
-		return nil, nil, err
-	}
-
-	// 3. look up a symbol (an exported function or variable)
-	symPluginConfig, err := plug.Lookup("PluginConfig")
-	if err != nil {
-		return nil, nil, err
-	}
-	var pluginConfig *PluginConfig
-	pluginConfig, ok = symPluginConfig.(*PluginConfig)
-	if !ok {
-		return nil, nil, err
-	}
-
-	// 4. Assert that loaded symbol is of a desired type
-	return pluginObj, pluginConfig, nil
+	LaunchServer(callback func(int))
 }

install.go

@@ -0,0 +1,83 @@
+syntax = "proto3";
+
+option go_package = "github.com/getstackhead/pluginlib/gen";
+option java_multiple_files = true;
+option java_package = "io.stackhead.pluginlib.gen";
+option java_outer_classname = "pluginlib";
+
+package pluginlib;
+
+// StackHeadService is implemented by StackHead and allows
+// plugins to interact with Terraform or the package managers
+service StackHeadService {
+  rpc Execute(StackHeadServiceRequest) returns (StackHeadServiceReply) {}
+  rpc InstallPackage(StackHeadPackageInformation) returns (StackHeadServiceReply) {}
+  rpc UninstallPackage(StackHeadPackageInformation) returns (StackHeadServiceReply) {}
+}
+
+service StackHeadPlugin {
+  rpc GetConfig(NullRequest) returns (StackHeadPluginConfig) {}
+  rpc Setup(SetupRequest) returns (StackHeadPluginReply) {}
+  rpc Deploy(DeployRequest) returns (StackHeadPluginReply) {}
+  rpc Destroy(DestroyRequest) returns (StackHeadPluginReply) {}
+  rpc TriggerHook(HookRequest) returns (StackHeadPluginReply) {}
+}
+
+message NullRequest{}
+
+message StackHeadPluginConfig {
+  string AdditionalJsonData = 1;
+  string Name = 2;
+  string Description = 3;
+  optional string Version = 4;
+  repeated string Authors = 5;
+  string PluginType = 6;
+  optional StackHeadPluginTerraformConfig Terraform = 7;
+}
+
+message StackHeadPluginTerraformConfig {
+  string Name = 1;
+  string vendor = 2;
+  string version = 3;
+  string resourceName = 4;
+  string init = 5;
+  bool providerPerProject = 6;
+}
+
+message SetupRequest {
+}
+
+message HookRequest {
+  string hookName = 1;
+  StackHeadProject project = 2;
+}
+message DeployRequest {
+    StackHeadProject project = 1;
+}
+message DestroyRequest {
+    StackHeadProject project = 1;
+}
+
+message StackHeadProject {
+  string AdditionalJsonData = 1;
+  string Name = 2;
+}
+
+message StackHeadPackageInformation {
+  string ApkPackageName = 1;
+}
+
+message StackHeadServiceRequest {
+  string Command = 1;
+  string Data = 2;
+}
+
+message StackHeadServiceReply {
+  bool success = 1;
+  string errorMessage = 2;
+}
+
+message StackHeadPluginReply {
+  bool success = 1;
+  string errorMessage = 2;
+}