Merge pull request #572 from aFlyBird0/fix-config-varFile

fix(configloader): varFile can be empty

Author: daniel-hutao

cmd/devstream/list/list.go

@@ -14,7 +14,7 @@ import (
 
 var PluginsName string
 
-// List all of plugins name
+// List all plugins name
 func List(pluginFilter string) {
 	listPluginsName := strings.Fields(PluginsName)
 	r, _ := regexp.Compile(pluginFilter)

docs/development/creating-a-plugin.md

@@ -53,4 +53,4 @@ DevStream uses [go plugin](https://pkg.go.dev/plugin) to implement custom DevOps
 
 When you execute a command which calls any of the interfaces(`Create`, `Read`, `Update`, `Delete`), devstream's pluginengine will call the [`plugin.Lookup("DevStreamPlugin")` function](https://github.com/devstream-io/devstream/blob/38307894bbc08f691b2c5015366d9e45cc87970c/internal/pkg/pluginengine/plugin_helper.go#L28) to load the plugin, get the variable `DevStreamPlugin` that implements the ` DevStreamPlugin` interface, and then you can call the corresponding plugin logic functions.  This is why it is not recommended to modify the `/cmd/plugin/YOUR-PLUGIN-NAME/main.go` file directly.
 
-Note: The `main()` in `/cmd/plugin/YOUR-PLUGIN-NAME/main.go` file will not executed, it is only used to avoid the goclangci-lint error.
+Note: The `main()` in `/cmd/plugin/YOUR-PLUGIN-NAME/main.go` file will not be executed, it is only used to avoid the goclangci-lint error.

internal/pkg/backend/backend.go

@@ -18,9 +18,9 @@ const (
 
 // Backend is used to persist data, it can be local file/etcd/s3/...
 type Backend interface {
-	// Read is used to reads data from persistent storage.
+	// Read is used to read data from persistent storage.
 	Read() ([]byte, error)
-	// Write is used to writes data to persistent storage.
+	// Write is used to write data to persistent storage.
 	Write(data []byte) error
 }
 

internal/pkg/backend/local/local.go

@@ -52,7 +52,7 @@ func (l *Local) Read() ([]byte, error) {
 	return data, nil
 }
 
-// Write is used to writes the data to local file.
+// Write is used to write the data to local file.
 func (l *Local) Write(data []byte) error {
 	l.mu.Lock()
 	defer l.mu.Unlock()

internal/pkg/configloader/validation.go

@@ -82,10 +82,6 @@ func validateDependency(tools []Tool) []error {
 func validateConfigFile(c *ConfigFile) []error {
 	errors := make([]error, 0)
 
-	if c.VarFile == "" {
-		errors = append(errors, fmt.Errorf("variables file is empty"))
-	}
-
 	if c.ToolFile == "" {
 		errors = append(errors, fmt.Errorf("tool file is empty"))
 	}

internal/pkg/configloader/variables.go

@@ -12,6 +12,9 @@ import (
 )
 
 func renderVariables(varFileName string, configFileBytes []byte) ([]byte, error) {
+	if varFileName == "" {
+		return configFileBytes, nil
+	}
 	// load variables file
 	variables, err := loadVariablesFilesIntoMap(varFileName)
 	if err != nil {

internal/pkg/plugin/githubactions/golang/jobs.go

@@ -9,20 +9,20 @@ const (
 	RegistryHarbor    RegistryType = "harbor"
 )
 
-// Build is the struct for githubacions job.
+// Build is the struct for githubactions job.
 type Build struct {
 	Enable  bool
 	Command string
 }
 
-// Test is the struct for githubacions job.
+// Test is the struct for githubactions job.
 type Test struct {
 	Enable   bool
 	Command  string
 	Coverage Coverage
 }
 
-// Docker is the struct for githubacions job.
+// Docker is the struct for githubactions job.
 type Docker struct {
 	Enable   bool
 	Registry Registry
@@ -35,18 +35,18 @@ type Registry struct {
 	Repository string
 }
 
-// Coverage is the struct for githubacions job.
+// Coverage is the struct for githubactions job.
 type Coverage struct {
 	Enable  bool
 	Profile string
 	Output  string
 }
 
-// Tag is the struct for githubacions job.
+// Tag is the struct for githubactions job.
 type Tag struct {
 }
 
-// Image is the struct for githubacions job.
+// Image is the struct for githubactions job.
 type Image struct {
 }
 

internal/pkg/pluginengine/change.go

@@ -38,13 +38,13 @@ const (
 )
 
 // GetChangesForApply takes "State Manager" & "Config" then do some calculate and return a Plan.
-// All actions should be execute is included in this Plan.changes.
+// All actions should be executed is included in this Plan.changes.
 func GetChangesForApply(smgr statemanager.Manager, cfg *configloader.Config) ([]*Change, error) {
 	return getChanges(smgr, cfg, CommandApply, false)
 }
 
 // GetChangesForDelete takes "State Manager" & "Config" then do some calculation and return a Plan to delete all plugins in the Config.
-// All actions should be execute is included in this Plan.changes.
+// All actions should be executed is included in this Plan.changes.
 func GetChangesForDelete(smgr statemanager.Manager, cfg *configloader.Config, isForceDelete bool) ([]*Change, error) {
 	return getChanges(smgr, cfg, CommandDelete, isForceDelete)
 }

internal/pkg/pluginengine/outputs.go

@@ -43,7 +43,7 @@ func HandleOutputsReferences(smgr statemanager.Manager, options map[string]inter
 }
 
 // getToolNamePluginKindAndOutputReferenceKey returns (false, "", "", "") if regex doesn't match
-// if match, returns (true, name, instanceID, key)
+// if matched, returns (true, name, instanceID, key)
 func getToolNamePluginOutputKey(s string) (bool, string, string, string) {
 	regex := `.*\${{\s*([^.]*)\.([^.]*)\.outputs\.([^.\s]*)\s*}}.*`
 	r := regexp.MustCompile(regex)