Skip to content

feat: Add --service option to plural cd services lua #714

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
maciaszczykm merged 14 commits into from
Mar 19, 2026
Merged

feat: Add --service option to plural cd services lua #714

Show file tree
Hide file tree
Changes from 11 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
4fbb305
add service identifier parsing and retrieval functions
maciaszczykm Mar 18, 2026
8a189f4
replace service identifier functions with a unified parsing approach
maciaszczykm Mar 18, 2026
02f490d
update service context handling to populate configuration map
maciaszczykm Mar 18, 2026
672046d
rfactor Lua template handling and add bindings for service context
maciaszczykm Mar 18, 2026
55624b2
update Go modules to latest versions
maciaszczykm Mar 19, 2026
5fdb92f
refactor Lua template execution and enhance binding handling
maciaszczykm Mar 19, 2026
0fef302
add unit tests for Lua template execution and binding handling
maciaszczykm Mar 19, 2026
4b04378
refactor Lua template tests to use 'any' type for value maps
maciaszczykm Mar 19, 2026
d838c72
add unit tests for Lua bindings with service identifier and context path
maciaszczykm Mar 19, 2026
0b028d1
add service flag values for Lua service configuration
maciaszczykm Mar 19, 2026
aacba8f
Merge remote-tracking branch 'origin/main' into marcin/prod-4549-plur…
maciaszczykm Mar 19, 2026
dca4f51
update golangci-lint to version 9.2.0 and set latest version for linting
maciaszczykm Mar 19, 2026
b829f50
optimize slice initialization for better performance
maciaszczykm Mar 19, 2026
dff8274
update Go version from 1.25.8 to 1.26.1 in Dockerfile
maciaszczykm Mar 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
195 changes: 50 additions & 145 deletions cmd/command/cd/cd_services.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,15 @@ package cd

import (
"fmt"
iofs "io/fs"
"os"
"path/filepath"
"sort"
"strings"

"github.com/pluralsh/console/go/client"
"github.com/pluralsh/console/go/polly/fs"
"github.com/pluralsh/plural-cli/pkg/common"
lua "github.com/yuin/gopher-lua"

gqlclient "github.com/pluralsh/console/go/client"
"github.com/pluralsh/console/go/polly/containers"
"github.com/pluralsh/console/go/polly/luautils"
"github.com/pluralsh/plural-cli/pkg/cd/template"
"github.com/pluralsh/plural-cli/pkg/console"
"github.com/pluralsh/plural-cli/pkg/utils"
Expand Down Expand Up @@ -139,6 +135,10 @@ func (p *Plural) cdServiceCommands() []cli.Command {
Name: "context",
Usage: "A yaml context file to imitate the internal service template context",
},
cli.StringFlag{
Name: "service",
Usage: "The service which context to use. Use @{cluster-handle}/{service-name} format.",
},
cli.StringFlag{
Name: "dir",
Usage: "The directory to run the lua script from, defaults to the current working directory",
Expand Down Expand Up @@ -287,7 +287,7 @@ func (p *Plural) handleTemplateService(c *cli.Context) error {
}

if identifier := c.String("service"); identifier != "" {
serviceId, clusterName, serviceName, err := getServiceIdClusterNameServiceName(identifier)
serviceId, clusterName, serviceName, err := parseServiceIdentifier(identifier)
if err != nil {
return err
}
Expand Down Expand Up @@ -319,126 +319,6 @@ func (p *Plural) handleTemplateService(c *cli.Context) error {
return printResult(res)
}

func (p *Plural) handleLuaTemplate(c *cli.Context) error {
if err := p.InitConsoleClient(consoleToken, consoleURL); err != nil {
return err
}

luaFile := c.String("lua-file")
luaDir := c.String("lua-dir")
context := c.String("context")
dir := c.String("dir")
if dir == "" {
dir = "."
}

if luaFile == "" {
return fmt.Errorf("expected --lua-file flag")
}

luaStr, err := utils.ReadFile(luaFile)
if err != nil {
return err
}

if luaDir != "" {
luaFiles, err := luaFolder(luaDir)
if err != nil {
return err
}

luaStr = luaFiles + "\n\n" + luaStr
}

ctx := map[string]interface{}{}
if context != "" {
if err := utils.YamlFile(context, &ctx); err != nil {
return err
}
}

values := map[interface{}]interface{}{}
valuesFiles := []string{}

dir, err = filepath.Abs(dir)
if err != nil {
return err
}
L := luautils.NewLuaState(dir)
defer L.Close()

// Register global values and valuesFiles in Lua
valuesTable := L.NewTable()
L.SetGlobal("values", valuesTable)

valuesFilesTable := L.NewTable()
L.SetGlobal("valuesFiles", valuesFilesTable)
L.SetGlobal("cluster", luautils.GoValueToLuaValue(L, ctx["cluster"]))
L.SetGlobal("configuration", luautils.GoValueToLuaValue(L, ctx["configuration"]))
L.SetGlobal("contexts", luautils.GoValueToLuaValue(L, ctx["contexts"]))
L.SetGlobal("imports", luautils.GoValueToLuaValue(L, ctx["imports"]))

if err := L.DoString(luaStr); err != nil {
return err
}

if err := luautils.MapLua(L.GetGlobal("values").(*lua.LTable), &values); err != nil {
return err
}

if err := luautils.MapLua(L.GetGlobal("valuesFiles").(*lua.LTable), &valuesFiles); err != nil {
return err
}

result := map[string]interface{}{
"values": luautils.SanitizeValue(values),
"valuesFiles": valuesFiles,
}

utils.Highlight("Final lua output:\n\n")
utils.NewYAMLPrinter(result).PrettyPrint()
return nil
}

func luaFolder(folder string) (string, error) {
luaFiles := make([]string, 0)
if err := filepath.WalkDir(folder, func(path string, info iofs.DirEntry, err error) error {
if err != nil {
return err
}
if info.IsDir() {
return nil
}

if strings.HasSuffix(info.Name(), ".lua") {
luaPath, err := filepath.Rel(folder, path)
if err != nil {
return err
}
luaFiles = append(luaFiles, luaPath)
}

return nil
}); err != nil {
return "", fmt.Errorf("failed to walk lua folder %s: %w", folder, err)
}

sort.Slice(luaFiles, func(i, j int) bool {
return luaFiles[i] < luaFiles[j]
})

luaFileContents := make([]string, 0)
for _, file := range luaFiles {
luaContents, err := os.ReadFile(file)
if err != nil {
return "", fmt.Errorf("failed to read lua file %s: %w", file, err)
}
luaFileContents = append(luaFileContents, string(luaContents))
}

return strings.Join(luaFileContents, "\n\n"), nil
}

func (p *Plural) handleCloneClusterService(c *cli.Context) error {
if err := p.InitConsoleClient(consoleToken, consoleURL); err != nil {
return err
Expand All @@ -452,7 +332,7 @@ func (p *Plural) handleCloneClusterService(c *cli.Context) error {
return fmt.Errorf("could not find cluster %s", c.Args().Get(0))
}

serviceId, clusterName, serviceName, err := getServiceIdClusterNameServiceName(c.Args().Get(1))
serviceId, clusterName, serviceName, err := parseServiceIdentifier(c.Args().Get(1))
if err != nil {
return err
}
Expand Down Expand Up @@ -498,7 +378,7 @@ func (p *Plural) handleUpdateClusterService(c *cli.Context) error {
return err
}
contextBindings := containers.NewSet[string]()
serviceId, clusterName, serviceName, err := getServiceIdClusterNameServiceName(c.Args().Get(0))
serviceId, clusterName, serviceName, err := parseServiceIdentifier(c.Args().Get(0))
if err != nil {
return err
}
Expand Down Expand Up @@ -615,7 +495,7 @@ func (p *Plural) handleDescribeClusterService(c *cli.Context) error {
return err
}

serviceId, clusterName, serviceName, err := getServiceIdClusterNameServiceName(c.Args().Get(0))
serviceId, clusterName, serviceName, err := parseServiceIdentifier(c.Args().Get(0))
if err != nil {
return err
}
Expand Down Expand Up @@ -651,7 +531,7 @@ func (p *Plural) handleDeleteClusterService(c *cli.Context) error {
if err := p.InitConsoleClient(consoleToken, consoleURL); err != nil {
return err
}
serviceId, clusterName, serviceName, err := getServiceIdClusterNameServiceName(c.Args().Get(0))
serviceId, clusterName, serviceName, err := parseServiceIdentifier(c.Args().Get(0))
if err != nil {
return err
}
Expand All @@ -677,7 +557,7 @@ func (p *Plural) handleKickClusterService(c *cli.Context) error {
if err := p.InitConsoleClient(consoleToken, consoleURL); err != nil {
return err
}
serviceId, clusterName, serviceName, err := getServiceIdClusterNameServiceName(c.Args().Get(0))
serviceId, clusterName, serviceName, err := parseServiceIdentifier(c.Args().Get(0))
if err != nil {
return err
}
Expand All @@ -697,7 +577,7 @@ func (p *Plural) handleKickClusterService(c *cli.Context) error {
}

func (p *Plural) handleTarballClusterService(c *cli.Context) error {
serviceId, clusterName, serviceName, err := getServiceIdClusterNameServiceName(c.Args().Get(0))
serviceId, clusterName, serviceName, err := parseServiceIdentifier(c.Args().Get(0))
if err != nil {
return fmt.Errorf("could not parse args: %w", err)
}
Expand Down Expand Up @@ -744,30 +624,55 @@ type ServiceDeploymentAttributesConfiguration struct {
Configuration []*gqlclient.ConfigAttributes
}

func getServiceIdClusterNameServiceName(input string) (serviceId, clusterName, serviceName *string, err error) {
if strings.HasPrefix(input, "@") {
i := strings.Trim(input, "@")
func validateFlag(ctx *cli.Context, name string, defaultVal string) (string, error) {
res := ctx.String(name)
if res == "" {
if defaultVal == "" {
return "", fmt.Errorf("expected --%s flag", name)
}
res = defaultVal
}

return res, nil
}

// parseServiceIdentifier parses the given identifier and returns the service id, cluster name, and service name.
// If the identifier is in the format @{cluster-handle}/{service-name}, the cluster name and service name are returned.
// Otherwise, the service id is returned.
func parseServiceIdentifier(id string) (serviceId, clusterName, serviceName *string, err error) {
if strings.HasPrefix(id, "@") {
i := strings.Trim(id, "@")
split := strings.Split(i, "/")
if len(split) != 2 {
err = fmt.Errorf("expected format @{cluster-handle}/{serviceName}")
err = fmt.Errorf("expected format @{cluster-handle}/{service-name} or {service-id}, got %s", id)
return
}
clusterName = &split[0]
serviceName = &split[1]
} else {
serviceId = &input
serviceId = &id
}

return
}

func validateFlag(ctx *cli.Context, name string, defaultVal string) (string, error) {
res := ctx.String(name)
if res == "" {
if defaultVal == "" {
return "", fmt.Errorf("expected --%s flag", name)
}
res = defaultVal
// getService returns the service deployment for the given identifier.
// Identifier should be in the format of @{cluster-handle}/{service-name} or {service-id}.
// If the identifier is empty, it will return nil.
func getService(c console.ConsoleClient, id string) (*client.ServiceDeploymentExtended, error) {
if id == "" {
return nil, nil
}

return res, nil
serviceId, clusterName, serviceName, err := parseServiceIdentifier(id)
if err != nil {
return nil, fmt.Errorf("could not parse identifier: %w", err)
}

service, err := c.GetClusterService(serviceId, serviceName, clusterName)
if err != nil {
return nil, fmt.Errorf("could not get service deployment: %w", err)
}

return service, lo.Ternary(service == nil, fmt.Errorf("could not find service deployment for %s", id), nil)
}
Loading
Loading