fix: add unit tests and fix bugs

Author: lfbdev

docs/plugins/trello-github-integ_plugin.md

@@ -1,6 +1,6 @@
 ## 1 `trello-github-integ` Plugin
 
-This plugin creates a new GitHub Actions file(trello-github-integration) and upload to your GitHub repo.
+This plugin creates a new GitHub Actions workflow(trello-github-integration) and uploads it to your GitHub repo.
 
 ## 2 Usage:
 
@@ -17,18 +17,18 @@ tools:
     # checkout the version from the GitHub releases
     version: 0.2.0
   # optional; if specified, dtm will make sure the dependency is applied first before handling this tool.
-  dependsOn: [ "TOOL1_NAME.TOOL1_KIND", "TOOL2_NAME.TOOL2_KIND" ]
+  dependsOn: [ "TRELLO_INSTANCE_NAME.trello" ]
   # options for the plugin
   options:
     # the repo's owner. It should be case-sensitive here; strictly use your GitHub user name; please change the value below.
     owner: YOUR_GITHUB_USERNAME
     # the repo where you'd like to setup GitHub Actions; please change the value below.
     repo: YOUR_REPO_NAME
     # reference parameters come from dependency, their usage will be explained later
-    boardId: ${{ default.trello.outputs.boardId }}
-    todoListId: ${{ default.trello.outputs.todoListId }}
-    doingListId: ${{ default.trello.outputs.doingListId }}
-    doneListId: ${{ default.trello.outputs.doneListId }}
+    boardId: ${{ TRELLO_INSTANCE_NAME.trello.outputs.boardId }}
+    todoListId: ${{ TRELLO_INSTANCE_NAME.trello.outputs.todoListId }}
+    doingListId: ${{ TRELLO_INSTANCE_NAME.trello.outputs.doingListId }}
+    doneListId: ${{ TRELLO_INSTANCE_NAME.trello.outputs.doneListId }}
     # main branch of the repo (to which branch the plugin will submit the workflows)
     branch: main
 ```
@@ -67,8 +67,8 @@ tools:
 
 In the example above:
 
-- We put `default.trello` as dependency by using the `dependsOn` keyword.
-- We use `default.trello`'s output as input for the `default_trello_github` plugin.
+- We put `trello_init_demo.trello` as a dependency by using the `dependsOn` keyword.
+- We use `trello_init_demo.trello`'s output as input for the `trello_github_integ_demo` plugin.
 
 Pay attention to the `${{ xxx }}` part in the example. `${{ TOOL_NAME.TOOL_KIND.outputs.var}}` is the syntax for using an output.
 

docs/plugins/trello_plugin.md

@@ -69,7 +69,7 @@ tools:
 
 In the example above:
 
-- We put `default.trello` as dependency by using the `dependsOn` keyword.
+- We put `default.trello` as a dependency by using the `dependsOn` keyword.
 - We use `default.trello`'s output as input for the `default_trello_github` plugin.
 
 Pay attention to the `${{ xxx }}` part in the example. `${{ TOOL_NAME.TOOL_KIND.outputs.var}}` is the syntax for using an output.

internal/pkg/plugin/trello/helper.go

@@ -37,6 +37,13 @@ func buildReadState(options *Options) (map[string]interface{}, error) {
 		return nil, err
 	}
 
+	output := make(map[string]interface{})
+	output["boardId"] = fmt.Sprint(listIds["boardId"])
+	output["todoListId"] = fmt.Sprint(listIds["todoListId"])
+	output["doingListId"] = fmt.Sprint(listIds["doingListId"])
+	output["doneListId"] = fmt.Sprint(listIds["doneListId"])
+
+	listIds["outputs"] = output
 	return listIds, nil
 }
 

internal/pkg/plugin/trello/trello.go

@@ -28,6 +28,25 @@ func CreateTrelloBoard(options *Options) (*TrelloItemId, error) {
 		return nil, err
 	}
 
+	exist, err := c.CheckBoardExists(options.Owner, options.Repo, options.KanbanBoardName)
+	if err != nil {
+		return nil, err
+	}
+
+	if exist {
+		log.Infof("Board already exists, owner: %s, repo: %s, kanbanName: %s.", options.Owner, options.Repo, options.KanbanBoardName)
+		listIds, err := c.GetBoardIdAndListId(options.Owner, options.Repo, options.KanbanBoardName)
+		if err != nil {
+			return nil, err
+		}
+		return &TrelloItemId{
+			boardId:     fmt.Sprint(listIds["boardId"]),
+			todoListId:  fmt.Sprint(listIds["todoListId"]),
+			doingListId: fmt.Sprint(listIds["doingListId"]),
+			doneListId:  fmt.Sprint(listIds["doneListId"]),
+		}, nil
+	}
+
 	board, err := c.CreateBoard(options.KanbanBoardName, options.Owner, options.Repo)
 	if err != nil {
 		return nil, err

internal/pkg/plugin/trellogithub/create.go

@@ -17,18 +17,18 @@ func Create(options map[string]interface{}) (map[string]interface{}, error) {
 
 	log.Success("Adding workflow file succeeded.")
 
-	trelloIds := &TrelloItemId{
+	trelloItemId := &TrelloItemId{
 		boardId:     tg.options.BoardId,
 		todoListId:  tg.options.todoListId,
 		doingListId: tg.options.doingListId,
 		doneListId:  tg.options.doneListId,
 	}
 
-	if err := tg.AddTrelloIdSecret(trelloIds); err != nil {
+	if err := tg.AddTrelloIdSecret(trelloItemId); err != nil {
 		return nil, err
 	}
 
 	log.Success("Adding secret keys for trello succeeded.")
 
-	return buildState(tg, trelloIds), nil
+	return buildState(tg), nil
 }

internal/pkg/plugin/trellogithub/helper.go

@@ -4,7 +4,7 @@ import (
 	"fmt"
 )
 
-func buildState(tg *TrelloGithub, ti *TrelloItemId) map[string]interface{} {
+func buildState(tg *TrelloGithub) map[string]interface{} {
 	res := make(map[string]interface{})
 	res["workflowDir"] = fmt.Sprintf("/repos/%s/%s/contents/.github/workflows", tg.options.Owner, tg.options.Repo)
 	return res

internal/pkg/plugin/trellogithub/update.go

@@ -23,17 +23,17 @@ func Update(options map[string]interface{}) (map[string]interface{}, error) {
 
 	log.Success("Adding workflow file succeeded.")
 
-	trelloIds := &TrelloItemId{
+	trelloItemId := &TrelloItemId{
 		boardId:     tg.options.BoardId,
 		todoListId:  tg.options.todoListId,
 		doingListId: tg.options.doingListId,
 		doneListId:  tg.options.doneListId,
 	}
 
-	if err := tg.AddTrelloIdSecret(trelloIds); err != nil {
+	if err := tg.AddTrelloIdSecret(trelloItemId); err != nil {
 		return nil, err
 	}
 	log.Success("Adding secret keys for trello succeeded.")
 
-	return buildState(tg, trelloIds), nil
+	return buildState(tg), nil
 }

internal/pkg/pluginengine/change.go

@@ -14,6 +14,15 @@ import (
 const REF_PREFIX = "${{"
 const REF_SUFFIX = "}}"
 
+// eg. ${{name.kind.outputs.key}},name setgment number is 0
+const NAME_SEGMENT_NUM = 0
+
+// eg. ${{name.kind.outputs.key}},kind setgment number is 1
+const KIND_SEGMENT_NUM = 1
+
+// eg. ${{name.kind.outputs.key}},key setgment number is 3
+const REF_SEGMENT_NUM = 3
+
 // Change is a wrapper with a single Tool and its Action should be execute.
 type Change struct {
 	Tool        *configloader.Tool
@@ -101,13 +110,13 @@ func execute(smgr statemanager.Manager, changes []*Change) map[string]error {
 		var err error
 		var returnValue map[string]interface{}
 
-		log.Info("tool raw changes: ", c.Tool.Options)
+		log.Infof("Tool's raw changes are: %s.", c.Tool.Options)
 		// fill ref inputs
 		err = fillRefValueWithOutputs(smgr, c.Tool.Options)
 		if err != nil {
 			succeeded = false
 		}
-		log.Info("tool changes with filled inputs: ", c.Tool.Options)
+		log.Infof("Tool's changes with filled inputs are: %s.", c.Tool.Options)
 
 		switch c.ActionName {
 		case statemanager.ActionCreate:
@@ -183,34 +192,35 @@ func handleResult(smgr statemanager.Manager, change *Change) error {
 	return nil
 }
 
-// FillInputParams fill inputs from state
+// fillRefValueWithOutputs fill inputs from state
 func fillRefValueWithOutputs(smgr statemanager.Manager, options map[string]interface{}) error {
-	// traverse options
 	for key, value := range options {
 		log.Debugf("Key: %s,  Value: %s.", key, value)
 		// judge whether the value is a string
 		if inst, ok := value.(string); ok {
 			// judge whether the format is ${{xxx}}
-			if strings.HasPrefix(inst, REF_PREFIX) && strings.HasSuffix(inst, REF_SUFFIX) {
-				ref := strings.TrimSpace(strings.TrimSuffix(strings.TrimPrefix(inst, REF_PREFIX), REF_SUFFIX))
+			if isValidRefFormat(inst) {
+				ref := getRefFormatString(inst)
 				log.Debug("Ref inputs: ", ref)
 				refParam := strings.Split(ref, ".")
 				if len(refParam) <= 3 {
-					return errors.New("ref input format is not correct: " + ref)
+					return errors.New("incorrect output reference: " + ref)
 				}
 
-				outputs, err := smgr.GetOutputs(statemanager.GenStateKey(refParam))
+				outputs, err := smgr.GetOutputs(statemanager.GenStateKey(refParam[NAME_SEGMENT_NUM], refParam[KIND_SEGMENT_NUM]))
 				if err != nil {
 					return err
 				}
 				log.Debug("Ref outputs: ", outputs)
 
 				if outs, ok := outputs.(map[string]interface{}); ok {
 					log.Debug("Ref outs: ", outs)
-					log.Debug("Ref param: ", refParam[3])
-					options[key] = outs[refParam[3]]
+					log.Debug("Ref param: ", refParam[REF_SEGMENT_NUM])
 					if value == nil {
-						return errors.New("ref input value is null: " + refParam[3])
+						return errors.New("ref input value is null: " + refParam[REF_SEGMENT_NUM])
+					}
+					if options[key], ok = outs[refParam[REF_SEGMENT_NUM]]; !ok {
+						return fmt.Errorf("can not find %s in dependency outputs", refParam[REF_SEGMENT_NUM])
 					}
 				}
 			}
@@ -224,3 +234,13 @@ func fillRefValueWithOutputs(smgr statemanager.Manager, options map[string]inter
 	}
 	return nil
 }
+
+// isValidRefFormat if the format is ${{abc}}
+func isValidRefFormat(ref string) bool {
+	return strings.HasPrefix(ref, REF_PREFIX) && strings.HasSuffix(ref, REF_SUFFIX)
+}
+
+// getRefFormatString get abc from ${{abc}} or ${{ abc }}
+func getRefFormatString(rawFormatString string) string {
+	return strings.TrimSpace(strings.TrimSuffix(strings.TrimPrefix(rawFormatString, REF_PREFIX), REF_SUFFIX))
+}

internal/pkg/pluginengine/change_helper.go

@@ -82,6 +82,9 @@ func changesForApply(smgr statemanager.Manager, cfg *configloader.Config) ([]*Ch
 				description := fmt.Sprintf("Tool < %s > found in config but doesn't exist in the state, will be created.", tool.Name)
 				changes = append(changes, generateCreateAction(&tool, description))
 			} else {
+				if err := renderRefByDependency(&tool, cfg.Tools, smgr); err != nil {
+					return nil, err
+				}
 				// tool found in the state
 				if drifted(tool.Options, state.Options) {
 					// tool's config differs from State's, Update
@@ -166,3 +169,33 @@ func changesForForceDelete(smgr statemanager.Manager, cfg *configloader.Config)
 	}
 	return changes
 }
+
+// renderRefByDependency
+// 1. if dependency plugin changed, do not fill ${{***}} with ref value;
+// 2. if dependency plugin did not change, fill ${{***}} with ref value;
+func renderRefByDependency(tool *configloader.Tool, tools []configloader.Tool, smgr statemanager.Manager) error {
+	if len(tool.DependsOn) > 0 {
+		for _, dependency := range tool.DependsOn {
+			dependencyChange := false
+			for _, c := range tools {
+				log.Debugf("====== Name: %s kind: %s dependency: %s  =====", c.Name, c.Plugin.Kind, dependency)
+				if fmt.Sprintf("%s%s%s", c.Name, ".", c.Plugin.Kind) == dependency {
+					state := smgr.GetState(statemanager.StateKeyGenerateFunc(&c))
+					if drifted(c.Options, state.Options) {
+						dependencyChange = true
+					}
+				}
+			}
+			if !dependencyChange {
+				// fill ref inputs,
+				if err := fillRefValueWithOutputs(smgr, tool.Options); err != nil {
+					return err
+				}
+				log.Infof("Dependency plugin no changes, ref inputs will be filled: %s.", tool.Options)
+			} else {
+				log.Infof("Do not fill ref inputs now, they will be filled when dependency plugin complete: %s.", tool.Options)
+			}
+		}
+	}
+	return nil
+}