feat: plugin scaffold for apache-devlake

Signed-off-by: Daniel Hu <tao.hu@merico.dev>

Author: daniel-hutao

cmd/plugin/apache-devlake/main.go

@@ -0,0 +1,39 @@
+package main
+
+import (
+	"github.com/devstream-io/devstream/internal/pkg/plugin/apachedevlake"
+	"github.com/devstream-io/devstream/pkg/util/log"
+)
+
+// NAME is the name of this DevStream plugin.
+const NAME = "apache-devlake"
+
+// Plugin is the type used by DevStream core. It's a string.
+type Plugin string
+
+// Create implements the create of apache-devlake.
+func (p Plugin) Create(options map[string]interface{}) (map[string]interface{}, error) {
+	return apachedevlake.Create(options)
+}
+
+// Update implements the update of apache-devlake.
+func (p Plugin) Update(options map[string]interface{}) (map[string]interface{}, error) {
+	return apachedevlake.Update(options)
+}
+
+// Delete implements the delete of apache-devlake.
+func (p Plugin) Delete(options map[string]interface{}) (bool, error) {
+	return apachedevlake.Delete(options)
+}
+
+// Read implements the read of apache-devlake.
+func (p Plugin) Read(options map[string]interface{}) (map[string]interface{}, error) {
+	return apachedevlake.Read(options)
+}
+
+// DevStreamPlugin is the exported variable used by the DevStream core.
+var DevStreamPlugin Plugin
+
+func main() {
+	log.Infof("%T: %s is a plugin for DevStream. Use it with DevStream.\n", DevStreamPlugin, NAME)
+}

docs/plugins/apache-devlake.md

@@ -0,0 +1,9 @@
+# apache-devlake plugin
+
+TODO(dtm): Add your document here.
+
+## Usage
+
+``` yaml
+--8<-- "apache-devlake.yaml"
+```

docs/plugins/apache-devlake.zh.md

@@ -0,0 +1,9 @@
+# apache-devlake 插件
+
+TODO(dtm): 在这里添加文档.
+
+## 用例
+
+``` yaml
+--8<-- "apache-devlake.yaml"
+```

internal/pkg/plugin/apachedevlake/apachedevlake.go

@@ -0,0 +1,3 @@
+package apachedevlake
+
+// TODO(dtm): Add your logic here.

internal/pkg/plugin/apachedevlake/create.go

@@ -0,0 +1,34 @@
+package apachedevlake
+
+import (
+	"github.com/devstream-io/devstream/internal/pkg/plugininstaller"
+	"github.com/devstream-io/devstream/internal/pkg/statemanager"
+	"github.com/devstream-io/devstream/pkg/util/log"
+)
+
+func Create(options map[string]interface{}) (map[string]interface{}, error) {
+	// Initialize Operator with Operations
+	operator := &plugininstaller.Operator{
+		PreExecuteOperations: plugininstaller.PreExecuteOperations{
+			// TODO(dtm): Add your PreExecuteOperations here.
+		},
+		ExecuteOperations: plugininstaller.ExecuteOperations{
+			// TODO(dtm): Add your ExecuteOperations here.
+		},
+		TerminateOperations: plugininstaller.TerminateOperations{
+			// TODO(dtm): Add your TerminateOperations here.
+		},
+		GetStateOperation: func(options plugininstaller.RawOptions) (statemanager.ResourceState, error) {
+			// TODO(dtm): Add your GetStateOperation here.
+			return nil, nil
+		},
+	}
+
+	// Execute all Operations in Operator
+	status, err := operator.Execute(plugininstaller.RawOptions(options))
+	if err != nil {
+		return nil, err
+	}
+	log.Debugf("Return map: %v", status)
+	return status, nil
+}

internal/pkg/plugin/apachedevlake/delete.go

@@ -0,0 +1,24 @@
+package apachedevlake
+
+import (
+	"github.com/devstream-io/devstream/internal/pkg/plugininstaller"
+)
+
+func Delete(options map[string]interface{}) (bool, error) {
+	// Initialize Operator with Operations
+	operator := &plugininstaller.Operator{
+		PreExecuteOperations: plugininstaller.PreExecuteOperations{
+			// TODO(dtm): Add your PreExecuteOperations here.
+		},
+		ExecuteOperations: plugininstaller.ExecuteOperations{
+			// TODO(dtm): Add your ExecuteOperations here.
+		},
+	}
+	_, err := operator.Execute(plugininstaller.RawOptions(options))
+	if err != nil {
+		return false, err
+	}
+
+	// 2. return ture if all process success
+	return true, nil
+}

internal/pkg/plugin/apachedevlake/options.go

@@ -0,0 +1,22 @@
+package apachedevlake
+
+import (
+	"github.com/mitchellh/mapstructure"
+
+	"github.com/devstream-io/devstream/internal/pkg/plugininstaller"
+)
+
+// Options is the struct for configurations of the apache-devlake plugin.
+type Options struct {
+	// TODO(dtm): Add your params here.
+	Foo string
+}
+
+// NewOptions create options by raw options
+func NewOptions(options plugininstaller.RawOptions) (Options, error) {
+	var opts Options
+	if err := mapstructure.Decode(options, &opts); err != nil {
+		return opts, err
+	}
+	return opts, nil
+}

internal/pkg/plugin/apachedevlake/read.go

@@ -0,0 +1,28 @@
+package apachedevlake
+
+import (
+	"github.com/devstream-io/devstream/internal/pkg/plugininstaller"
+	"github.com/devstream-io/devstream/internal/pkg/statemanager"
+	"github.com/devstream-io/devstream/pkg/util/log"
+)
+
+func Read(options map[string]interface{}) (map[string]interface{}, error) {
+	// Initialize Operator with Operations
+	operator := &plugininstaller.Operator{
+		PreExecuteOperations: plugininstaller.PreExecuteOperations{
+			// TODO(dtm): Add your PreExecuteOperations here.
+		},
+		GetStateOperation: func(options plugininstaller.RawOptions) (statemanager.ResourceState, error) {
+			// TODO(dtm): Add your GetStateOperation here.
+			return nil, nil
+		},
+	}
+
+	// Execute all Operations in Operator
+	status, err := operator.Execute(plugininstaller.RawOptions(options))
+	if err != nil {
+		return nil, err
+	}
+	log.Debugf("Return map: %v", status)
+	return status, nil
+}

internal/pkg/plugin/apachedevlake/update.go

@@ -0,0 +1,34 @@
+package apachedevlake
+
+import (
+	"github.com/devstream-io/devstream/internal/pkg/plugininstaller"
+	"github.com/devstream-io/devstream/internal/pkg/statemanager"
+	"github.com/devstream-io/devstream/pkg/util/log"
+)
+
+func Update(options map[string]interface{}) (map[string]interface{}, error) {
+	// Initialize Operator with Operations
+	operator := &plugininstaller.Operator{
+		PreExecuteOperations: plugininstaller.PreExecuteOperations{
+			// TODO(dtm): Add your PreExecuteOperations here.
+		},
+		ExecuteOperations: plugininstaller.ExecuteOperations{
+			// TODO(dtm): Add your ExecuteOperations here.
+		},
+		TerminateOperations: plugininstaller.TerminateOperations{
+			// TODO(dtm): Add your TerminateOperations here.
+		},
+		GetStateOperation: func(options plugininstaller.RawOptions) (statemanager.ResourceState, error) {
+			// TODO(dtm): Add your GetStateOperation here.
+			return nil, nil
+		},
+	}
+
+	// Execute all Operations in Operator
+	status, err := operator.Execute(plugininstaller.RawOptions(options))
+	if err != nil {
+		return nil, err
+	}
+	log.Debugf("Return map: %v", status)
+	return status, nil
+}

internal/pkg/plugin/apachedevlake/validate.go

@@ -0,0 +1,25 @@
+package apachedevlake
+
+import (
+	"fmt"
+
+	"github.com/devstream-io/devstream/internal/pkg/plugininstaller"
+	"github.com/devstream-io/devstream/pkg/util/log"
+	"github.com/devstream-io/devstream/pkg/util/validator"
+)
+
+// validate validates the options provided by the core.
+func validate(options plugininstaller.RawOptions) (plugininstaller.RawOptions, error) {
+	opts, err := NewOptions(options)
+	if err != nil {
+		return nil, err
+	}
+	errs := validator.Struct(opts)
+	if len(errs) > 0 {
+		for _, e := range errs {
+			log.Errorf("Options error: %s.", e)
+		}
+		return nil, fmt.Errorf("opts are illegal")
+	}
+	return options, nil
+}