feat: generate command from YAML file (#244)

Author: b00f

.gitignore

@@ -7,10 +7,7 @@ todo
 .env
 *.log
 /local
-config/config.yml
-config/config.*.yml
-config/wallets
-config/templates
+config/config.local.yml
 __debug_*
 *.sqlite*
 deployment/.env

.golangci.yml

@@ -211,6 +211,7 @@ linters-settings:
 
 issues:
   exclude-use-default: false
+  exclude-generated: lax
   exclude-rules:
     - path: _test.go
       linters:

Makefile

@@ -48,5 +48,10 @@ build-telegram:
 build-http:
 	go build -o build/pagu-http     ./cmd/http
 
+### Generating commands
+gen:
+	go run ./internal/generator/main.go \
+		"./internal/engine/command/crowdfund/crowdfund.yml"
+
 ###
-.PHONY: devtools mock proto fmt check test build build-cli build-discord build-grpc build-telegram build-http
+.PHONY: devtools mock proto fmt check test build build-cli build-discord build-grpc build-telegram build-http gen

go.mod

@@ -13,6 +13,7 @@ require (
 	github.com/spf13/cobra v1.8.1
 	github.com/stretchr/testify v1.10.0
 	go.uber.org/mock v0.5.0
+	golang.org/x/exp v0.0.0-20241217172543-b2144cdd0a67
 	golang.org/x/text v0.21.0
 	google.golang.org/grpc v1.69.2
 	google.golang.org/protobuf v1.36.1
@@ -56,7 +57,6 @@ require (
 	github.com/valyala/fasttemplate v1.2.2 // indirect
 	github.com/x448/float16 v0.8.4 // indirect
 	golang.org/x/crypto v0.31.0 // indirect
-	golang.org/x/exp v0.0.0-20241217172543-b2144cdd0a67 // indirect
 	golang.org/x/net v0.33.0 // indirect
 	golang.org/x/sys v0.28.0 // indirect
 	google.golang.org/genproto/googleapis/api v0.0.0-20241223144023-3abc09e42ca8 // indirect

internal/engine/command/command.go

@@ -7,7 +7,7 @@ import (
 	"strings"
 
 	"github.com/pagu-project/pagu/internal/entity"
-	"github.com/pagu-project/pagu/pkg/color"
+	"github.com/pagu-project/pagu/pkg/utils"
 )
 
 const failedTemplate = `
@@ -31,45 +31,81 @@ var (
 type InputBox int
 
 const (
-	InputBoxText InputBox = iota
-	InputBoxMultilineText
-	InputBoxInteger
-	InputBoxFloat
-	InputBoxFile
-	InputBoxToggle
-	InputBoxChoice
+	InputBoxText          InputBox = 1
+	InputBoxMultilineText InputBox = 2
+	InputBoxInteger       InputBox = 3
+	InputBoxFloat         InputBox = 4
+	InputBoxFile          InputBox = 5
+	InputBoxToggle        InputBox = 6
+	InputBoxChoice        InputBox = 7
 )
 
+var inputBoxToString = map[InputBox]string{
+	InputBoxText:          "Text",
+	InputBoxMultilineText: "MultilineText",
+	InputBoxInteger:       "Integer",
+	InputBoxFloat:         "Float",
+	InputBoxFile:          "File",
+	InputBoxToggle:        "Toggle",
+	InputBoxChoice:        "Choice",
+}
+
+func (ib InputBox) String() string {
+	str, ok := inputBoxToString[ib]
+	if ok {
+		return str
+	}
+
+	return fmt.Sprintf("%d", ib)
+}
+
+func (ib InputBox) MarshalYAML() (any, error) {
+	return utils.MarshalEnum(ib, inputBoxToString)
+}
+
+func (ib *InputBox) UnmarshalYAML(unmarshal func(any) error) error {
+	var str string
+	if err := unmarshal(&str); err != nil {
+		return err
+	}
+	val, err := utils.UnmarshalEnum(str, inputBoxToString)
+	if err != nil {
+		return err
+	}
+	*ib = val
+
+	return nil
+}
+
 type Choice struct {
-	Name  string
-	Value int
+	Name  string `yaml:"name"`
+	Value int    `yaml:"value"`
 }
 
 type Args struct {
-	Name     string
-	Desc     string
-	InputBox InputBox
-	Optional bool
-	Choices  []Choice
+	Name     string   `yaml:"name"`
+	Desc     string   `yaml:"desc"`
+	InputBox InputBox `yaml:"input_box"`
+	Optional bool     `yaml:"optional"`
+	Choices  []Choice `yaml:"choices"`
 }
 
 type HandlerFunc func(caller *entity.User, cmd *Command, args map[string]string) CommandResult
 
 type Command struct {
-	Emoji       string
-	Color       color.ColorCode
-	Name        string
-	Help        string
-	Args        []Args
-	AppIDs      []entity.PlatformID
-	SubCommands []*Command
-	Middlewares []MiddlewareFunc
-	Handler     HandlerFunc
-	TargetFlag  int
+	Emoji          string              `yaml:"emoji"`
+	Name           string              `yaml:"name"`
+	Help           string              `yaml:"help"`
+	Args           []Args              `yaml:"args"`
+	SubCommands    []*Command          `yaml:"sub_commands"`
+	ResultTemplate string              `yaml:"result_template"`
+	Middlewares    []MiddlewareFunc    `yaml:"-"`
+	Handler        HandlerFunc         `yaml:"-"`
+	AppIDs         []entity.PlatformID `yaml:"-"`
+	TargetFlag     int                 `yaml:"-"`
 }
 
 type CommandResult struct {
-	Color      color.ColorCode
 	Title      string
 	Message    string
 	Successful bool
@@ -79,7 +115,6 @@ func (cmd *Command) RenderFailedTemplate(reason string) CommandResult {
 	msg, _ := cmd.executeTemplate(failedTemplate, map[string]any{"reason": reason})
 
 	return CommandResult{
-		Color:      cmd.Color,
 		Title:      fmt.Sprintf("%v %v", cmd.Name, cmd.Emoji),
 		Message:    msg,
 		Successful: false,
@@ -90,14 +125,13 @@ func (cmd *Command) RenderErrorTemplate(err error) CommandResult {
 	msg, _ := cmd.executeTemplate(errorTemplate, map[string]any{"err": err})
 
 	return CommandResult{
-		Color:      cmd.Color,
 		Title:      fmt.Sprintf("%v %v", cmd.Name, cmd.Emoji),
 		Message:    msg,
 		Successful: false,
 	}
 }
 
-func (cmd *Command) RenderResultTemplate(templateContent string, keyvals ...any) CommandResult {
+func (cmd *Command) RenderResultTemplate(keyvals ...any) CommandResult {
 	if len(keyvals)%2 != 0 {
 		keyvals = append(keyvals, "!MISSING-VALUE!")
 	}
@@ -110,13 +144,12 @@ func (cmd *Command) RenderResultTemplate(templateContent string, keyvals ...any)
 		data[key] = val
 	}
 
-	msg, err := cmd.executeTemplate(templateContent, data)
+	msg, err := cmd.executeTemplate(cmd.ResultTemplate, data)
 	if err != nil {
 		return cmd.RenderErrorTemplate(err)
 	}
 
 	return CommandResult{
-		Color:      cmd.Color,
 		Title:      fmt.Sprintf("%v %v", cmd.Name, cmd.Emoji),
 		Message:    msg,
 		Successful: true,
@@ -143,7 +176,6 @@ func (cmd *Command) SuccessfulResult(msg string) CommandResult {
 // Deprecated: Use RenderResultTemplate.
 func (cmd *Command) SuccessfulResultF(msg string, a ...any) CommandResult {
 	return CommandResult{
-		Color:      cmd.Color,
 		Title:      fmt.Sprintf("%v %v", cmd.Name, cmd.Emoji),
 		Message:    fmt.Sprintf(msg, a...),
 		Successful: true,
@@ -158,7 +190,6 @@ func (cmd *Command) FailedResult(msg string) CommandResult {
 // Deprecated: Use RenderFailedTemplate.
 func (cmd *Command) FailedResultF(msg string, a ...any) CommandResult {
 	return CommandResult{
-		Color:      cmd.Color,
 		Title:      fmt.Sprintf("%v %v", cmd.Name, cmd.Emoji),
 		Message:    fmt.Sprintf(msg, a...),
 		Successful: false,
@@ -172,7 +203,6 @@ func (cmd *Command) ErrorResult(err error) CommandResult {
 
 func (cmd *Command) HelpResult() CommandResult {
 	return CommandResult{
-		Color:      cmd.Color,
 		Title:      fmt.Sprintf("%v %v", cmd.Help, cmd.Emoji),
 		Message:    cmd.HelpMessage(),
 		Successful: false,
@@ -198,6 +228,10 @@ func (cmd *Command) HelpMessage() string {
 }
 
 func (cmd *Command) AddSubCommand(subCmd *Command) {
+	if subCmd == nil {
+		return
+	}
+
 	if subCmd.HasSubCommand() {
 		subCmd.AddHelpSubCommand()
 	}

internal/engine/command/command_test.go

@@ -0,0 +1,70 @@
+package command
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+	"gopkg.in/yaml.v3"
+)
+
+func TestInputBox_MarshalYAML(t *testing.T) {
+	tests := []struct {
+		name     string
+		input    InputBox
+		expected string
+		wantErr  bool
+	}{
+		{"Marshal Text", InputBoxText, `"Text"`, false},
+		{"Marshal MultilineText", InputBoxMultilineText, `"MultilineText"`, false},
+		{"Marshal Integer", InputBoxInteger, `"Integer"`, false},
+		{"Marshal Float", InputBoxFloat, `"Float"`, false},
+		{"Marshal File", InputBoxFile, `"File"`, false},
+		{"Marshal Toggle", InputBoxToggle, `"Toggle"`, false},
+		{"Marshal Choice", InputBoxChoice, `"Choice"`, false},
+		{"Marshal Unknown", InputBox(999), ``, true},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			data, err := yaml.Marshal(tt.input)
+			if tt.wantErr {
+				assert.Error(t, err)
+			} else {
+				assert.NoError(t, err)
+				assert.YAMLEq(t, tt.expected, string(data))
+			}
+		})
+	}
+}
+
+func TestInputBox_UnmarshalYAML(t *testing.T) {
+	tests := []struct {
+		name     string
+		input    string
+		expected InputBox
+		wantErr  bool
+	}{
+		{"Unmarshal Text", `"Text"`, InputBoxText, false},
+		{"Unmarshal MultilineText", `"MultilineText"`, InputBoxMultilineText, false},
+		{"Unmarshal Integer", `"Integer"`, InputBoxInteger, false},
+		{"Unmarshal Float", `"Float"`, InputBoxFloat, false},
+		{"Unmarshal File", `"File"`, InputBoxFile, false},
+		{"Unmarshal Toggle", `"Toggle"`, InputBoxToggle, false},
+		{"Unmarshal Choice", `"Choice"`, InputBoxChoice, false},
+		{"Unmarshal Unknown", `"Unknown"`, InputBox(0), true},
+		{"Unmarshal Invalid YAML", `123`, InputBox(0), true},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			var box InputBox
+			err := yaml.Unmarshal([]byte(tt.input), &box)
+			if tt.wantErr {
+				assert.Error(t, err)
+			} else {
+				assert.NoError(t, err)
+				assert.Equal(t, tt.expected, box)
+			}
+		})
+	}
+}

internal/engine/command/crowdfund/create.go

@@ -19,15 +19,15 @@ func (c *CrowdfundCmd) createHandler(
 	packages := []entity.Package{}
 	err := json.Unmarshal([]byte(packagesJSON), &packages)
 	if err != nil {
-		return cmd.FailedResult(err.Error())
+		return cmd.RenderErrorTemplate(err)
 	}
 
 	if title == "" {
-		return cmd.FailedResult("The title of the crowdfunding campaign cannot be empty")
+		return cmd.RenderFailedTemplate("The title of the crowdfunding campaign cannot be empty")
 	}
 
 	if len(packages) < 2 {
-		return cmd.FailedResult("At least 3 packages are required for the crowdfunding campaign")
+		return cmd.RenderFailedTemplate("At least 3 packages are required for the crowdfunding campaign")
 	}
 
 	campaign := &entity.CrowdfundCampaign{
@@ -38,10 +38,8 @@ func (c *CrowdfundCmd) createHandler(
 	}
 	err = c.db.AddCrowdfundCampaign(campaign)
 	if err != nil {
-		return cmd.FailedResult(err.Error())
+		return cmd.RenderErrorTemplate(err)
 	}
 
-	return cmd.SuccessfulResultF(
-		"Crowdfund campaign '%s' created successfully with %d packages",
-		title, len(packages))
+	return cmd.RenderResultTemplate("campaign", campaign)
 }