towk/makeshift
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Packages Wiki Activity Actions

feat: updated implementations for cmds

Browse source
This commit is contained in:
David Allen 2025-08-24 20:39:39 -06:00
parent 7a96bfd6c7
commit 59a5225b28
Signed by: towk
GPG key ID: 0430CDBE22619155
7 changed files with 331 additions and 102 deletions
Download patch file Download diff file Expand all files Collapse all files

97
cmd/download.go
View file

@ -3,11 +3,13 @@ package cmd
import ( import (
"fmt" "fmt"
"net/http" "net/http"
"net/url"
"os" "os"
"path/filepath" "path/filepath"
"strings"
"time" "time"
"git.towk2.me/towk/configurator/pkg/client" "git.towk2.me/towk/makeshift/pkg/client"
"github.com/rs/zerolog/log" "github.com/rs/zerolog/log"
"github.com/spf13/cobra" "github.com/spf13/cobra"
) )
@ -15,30 +17,40 @@ import (
var downloadCmd = cobra.Command{ var downloadCmd = cobra.Command{
Use: "download", Use: "download",
Example: ` Example: `
# download a file or directory (as archive) # set up environment
configurator download export MAKESHIFT_HOST=http://localhost:5050
configurator download --host https://example.com --path test export MAKESHIFT_PATH=test
configurator download --plugins smd,jinja2 --profile compute
curl $CONFIGURATOR_HOST/download/test?plugins=smd,jinja2 # download a file or directory (as archive)
makeshift download
makeshift download --host http://localhost:5050.com --path test
# download a file or directory and run plugins with profile data
makeshift download --plugins smd,jinja2 --profile compute
curl $MAKESHIFT_HOST/download/test?plugins=smd,jinja2&profile=test
# download directory and extract it's contents automatically
makeshift download --extract
`, `,
Short: "Download and modify files with plugins", Short: "Download and modify files with plugins",
PreRun: func(cmd *cobra.Command, args []string) { PreRun: func(cmd *cobra.Command, args []string) {
setenv(&host, "CONFIGURATOR_HOST") setenv(cmd, "host", "MAKESHIFT_HOST")
setenv(&path, "CONFIGURATOR_PATH") setenv(cmd, "path", "MAKESHIFT_PATH")
}, },
Run: func(cmd *cobra.Command, args []string) { Run: func(cmd *cobra.Command, args []string) {
var ( var (
c = client.New(host) host, _ = cmd.Flags().GetString("host")
res *http.Response path, _ = cmd.Flags().GetString("path")
body []byte outputPath, _ = cmd.Flags().GetString("output")
err error pluginNames, _ = cmd.Flags().GetStringSlice("plugins")
) profileIDs, _ = cmd.Flags().GetStringSlice("profiles")
log.Debug(). c = client.New(host)
Str("host", host). res *http.Response
Str("path", path). query string
Str("output", outputPath). body []byte
Send() err error
)
// set output path to match path if empty // set output path to match path if empty
if outputPath == "" { if outputPath == "" {
@ -49,22 +61,42 @@ var downloadCmd = cobra.Command{
} }
} }
// make request to /download endpoint query = fmt.Sprintf("/download/%s?", path)
// _, err = c.Download(outputPath, client.HTTPEnvelope{ if len(pluginNames) > 0 {
// Path: fmt.Sprintf("/download/%s", path), query += "plugins=" + url.QueryEscape(strings.Join(pluginNames, ","))
// Method: http.MethodGet, }
// }) if len(profileIDs) > 0 {
query += "&profiles=" + url.QueryEscape(strings.Join(profileIDs, ","))
}
log.Debug().
Str("host", host).
Str("path", path).
Str("query", query).
Str("output", outputPath).
Strs("profiles", profileIDs).
Strs("plugins", pluginNames).
Send()
res, body, err = c.MakeRequest(client.HTTPEnvelope{ res, body, err = c.MakeRequest(client.HTTPEnvelope{
Path: fmt.Sprintf("/download/%s", path), Path: query,
Method: http.MethodGet, Method: http.MethodGet,
}) })
if err != nil { if err != nil {
log.Error().Err(err).Str("host", host).Msg("failed to make request") log.Error().Err(err).
Str("host", host).
Str("path", path).
Str("output", outputPath).
Msg("failed to make request")
os.Exit(1) os.Exit(1)
} }
if res.StatusCode != http.StatusOK { if res.StatusCode != http.StatusOK {
log.Error().Int("status", res.StatusCode).Str("host", host).Msg("response returned bad status") log.Error().
Int("status", res.StatusCode).
Str("host", host).
Str("path", path).
Str("output", outputPath).
Msg("response returned bad status")
os.Exit(1) os.Exit(1)
} }
if outputPath != "" { if outputPath != "" {
@ -80,12 +112,15 @@ var downloadCmd = cobra.Command{
}, },
} }
var downloadProfileCmd = &cobra.Command{}
var downloadPluginCmd = &cobra.Command{}
func init() { func init() {
downloadCmd.Flags().StringVar(&host, "host", "http://localhost:5050", "Set the configurator remote host (can be set with CONFIGURATOR_HOST)") downloadCmd.Flags().String("host", "http://localhost:5050", "Set the makeshift remote host (can be set with MAKESHIFT_HOST)")
downloadCmd.Flags().StringVarP(&path, "path", "p", ".", "Set the path to list files (can be set with CONFIGURATOR_PATH)") downloadCmd.Flags().StringP("path", "p", ".", "Set the path to list files (can be set with MAKESHIFT_PATH)")
downloadCmd.Flags().StringVarP(&outputPath, "output", "o", "", "Set the output path to write files") downloadCmd.Flags().StringP("output", "o", "", "Set the output path to write files")
downloadCmd.Flags().StringVar(&profile, "profile", "", "Set the profile to use to populate data store") downloadCmd.Flags().StringSlice("profiles", []string{}, "Set the profile to use to populate data store")
downloadCmd.Flags().StringSliceVar(&plugins, "plugins", []string{}, "Set the plugins to run before downloading files") downloadCmd.Flags().StringSlice("plugins", []string{}, "Set the plugins to run before downloading files")
rootCmd.AddCommand(&downloadCmd) rootCmd.AddCommand(&downloadCmd)
} }

28
cmd/list.go
View file

@ -6,7 +6,7 @@ import (
"net/http" "net/http"
"os" "os"
"git.towk2.me/towk/configurator/pkg/client" "git.towk2.me/towk/makeshift/pkg/client"
"github.com/rs/zerolog/log" "github.com/rs/zerolog/log"
"github.com/spf13/cobra" "github.com/spf13/cobra"
) )
@ -14,19 +14,24 @@ import (
var listCmd = &cobra.Command{ var listCmd = &cobra.Command{
Use: "list", Use: "list",
Example: ` Example: `
# list files in a remote data directory # list files in a remote data directory
configurator list --path test configurator list --path test
configurator list --host https://example.com --path test configurator list --host http://localhost:5050 --path test
curl https://example.com/list/test
# list files using 'curl'
curl http://localhost:5050/list/test
`, `,
Args: cobra.NoArgs, Args: cobra.NoArgs,
Short: "List all files in a remote data directory", Short: "List all files in a remote data directory",
PreRun: func(cmd *cobra.Command, args []string) { PreRun: func(cmd *cobra.Command, args []string) {
setenv(&host, "CONFIGURATOR_HOST") setenv(cmd, "host", "MAKESHIFT_HOST")
setenv(&path, "CONFIGURATOR_PATH") setenv(cmd, "path", "MAKESHIFT_PATH")
}, },
Run: func(cmd *cobra.Command, args []string) { Run: func(cmd *cobra.Command, args []string) {
var ( var (
host, _ = cmd.Flags().GetString("host")
path, _ = cmd.Flags().GetString("path")
c = client.New(host) c = client.New(host)
body []byte body []byte
output []string output []string
@ -44,7 +49,10 @@ var listCmd = &cobra.Command{
Method: http.MethodGet, Method: http.MethodGet,
}) })
if err != nil { if err != nil {
log.Error().Err(err).Str("url", host).Msg("failed to make request") log.Error().Err(err).
Str("host", host).
Str("path", path).
Msg("failed to make request")
os.Exit(1) os.Exit(1)
} }
@ -60,8 +68,8 @@ var listCmd = &cobra.Command{
} }
func init() { func init() {
listCmd.Flags().StringVar(&host, "host", "http://localhost:5050", "Set the configurator remote host (can be set with CONFIGURATOR_HOST)") listCmd.Flags().String("host", "http://localhost:5050", "Set the configurator remote host (can be set with MAKESHIFT_HOST)")
listCmd.Flags().StringVarP(&path, "path", "p", ".", "Set the path to list files (can be set with CONFIGURATOR_PATH)") listCmd.Flags().StringP("path", "p", ".", "Set the path to list files (can be set with MAKESHIFT_PATH)")
rootCmd.AddCommand(listCmd) rootCmd.AddCommand(listCmd)
} }

157
cmd/plugins.go Normal file
View file

@ -0,0 +1,157 @@
package cmd
import (
"fmt"
"io/fs"
"os"
"os/exec"
"path/filepath"
makeshift "git.towk2.me/towk/makeshift/pkg"
"git.towk2.me/towk/makeshift/pkg/service"
"github.com/rs/zerolog/log"
"github.com/spf13/cobra"
)
var pluginsCmd = &cobra.Command{
Use: "plugins",
Short: "Manage and compile plugins (requires Go build tools)",
}
var pluginsCompileCmd = &cobra.Command{
Use: "compile",
Example: `
# compile plugin using Go build tools
go build -buildmode=plugin -o lib/myplugin.so src/plugins/myplugin.go
# try to compile all plugins in current directory
cd src/plugins
makeshift plugin compile
# try to compile all plugins in specified directory
makeshift plugin compile src/plugins
# compile 'src/plugins/myplugin.go' and save to 'lib/myplugin.so'
makeshift plugin compile src/plugins/myplugin.go -o lib/myplugin.so
`,
Args: cobra.MaximumNArgs(1),
Run: func(cmd *cobra.Command, args []string) {
var (
outputPath, _ = cmd.Flags().GetString("output")
output []byte
fileInfo os.FileInfo
err error
)
// make the directory
err = os.MkdirAll(filepath.Dir(outputPath), 0o777)
if err != nil {
log.Fatal().Err(err).Msg("failed to make output directory")
}
// one arg passed, so determine if it is file or directory
if len(args) > 0 {
if fileInfo, err = os.Stat(args[0]); err == nil {
if fileInfo.IsDir() {
err = compilePluginsDir(args[0], outputPath)
if err != nil {
log.Fatal().Err(err).
Bytes("output", output).
Msg("failed to compile plugin")
}
} else {
// not a directory so check if Go file so try and compile it
if filepath.Ext(args[0]) == ".go" {
output, err = compilePlugin(outputPath, args[0])
if err != nil {
log.Fatal().Err(err).
Bytes("output", output).
Msg("failed to compile plugin")
}
} else {
log.Fatal().Msg("argument is not a valid plugin (must be Go file)")
}
}
} else if err != nil {
log.Fatal().Err(err).Msgf("failed to stat provided plugin path")
}
} else {
// no args passed, so use current directory
err = compilePluginsDir(".", outputPath)
if err != nil {
log.Fatal().Err(err).
Bytes("output", output).
Msg("failed to compile plugin")
}
}
},
}
var pluginInspectCmd = &cobra.Command{
Use: "inspect",
Args: cobra.MinimumNArgs(1),
Example: `
# inspect a plugin and print its information
makeshift plugin inspect lib/jinja2.so
`,
Run: func(cmd *cobra.Command, args []string) {
for _, path := range args {
var (
plugin makeshift.Plugin
err error
)
plugin, err = service.LoadPluginFromFile(path)
if err != nil {
log.Error().Err(err).
Str("path", path).
Msg("failed to load plugin from file")
continue
}
log.Info().Any("plugin", map[string]any{
"name": plugin.Name(),
"version": plugin.Version(),
"description": plugin.Description(),
"metadata": plugin.Metadata(),
}).Send()
}
},
}
func init() {
pluginsCompileCmd.Flags().StringP("output", "o", "", "Set the path to save compiled plugin")
pluginsCmd.AddCommand(pluginsCompileCmd, pluginInspectCmd)
rootCmd.AddCommand(pluginsCmd)
}
func compilePlugin(outputPath string, srcPath string) ([]byte, error) {
var (
commandArgs string
command *exec.Cmd
)
// execute command to build the plugin
commandArgs = fmt.Sprintf("go build -buildmode=plugin -o=%s %s", outputPath, srcPath)
command = exec.Command("bash", "-c", commandArgs)
return command.CombinedOutput()
}
func compilePluginsDir(dirpath string, outputPath string) error {
err := filepath.WalkDir(dirpath, func(path string, d fs.DirEntry, err error) error {
// not a directory and is Go file, so try and compile it
if !d.IsDir() && filepath.Ext(path) == ".go" {
var (
localOutputPath string = outputPath + "/" + path
)
output, err := compilePlugin(localOutputPath, path)
if err != nil {
log.Fatal().Err(err).
Bytes("output", output).
Str("path", localOutputPath).
Msg("failed to compile plugin")
return err
}
}
return nil
})
return err
}

90
cmd/root.go
View file

@ -3,36 +3,58 @@ package cmd
import ( import (
"fmt" "fmt"
"os" "os"
"slices"
"strings"
"github.com/rs/zerolog" logger "git.towk2.me/towk/makeshift/pkg/log"
"github.com/rs/zerolog/log" "github.com/rs/zerolog/log"
"github.com/spf13/cobra" "github.com/spf13/cobra"
) )
var ( var (
host string // host string
path string // path string
outputPath string // outputPath string
rootPath string // rootPath string
logLevel string // profile string
profile string // plugins []string
plugins []string // timeout int
timeout int // logFile string
logLevel logger.LogLevel = logger.INFO
) )
var rootCmd = cobra.Command{ var rootCmd = cobra.Command{
Use: "configurator", Use: "makeshift",
Short: "Extensible configuration builder to download files", Short: "Extensible file cobbler",
PersistentPreRun: func(cmd *cobra.Command, args []string) { PersistentPreRun: func(cmd *cobra.Command, args []string) {
// set the logging level var (
level, err := strToLogLevel(logLevel) logFile string
err error
)
// initialize the logger
logFile, _ = cmd.Flags().GetString("log-file")
err = logger.InitWithLogLevel(logLevel, logFile)
if err != nil { if err != nil {
log.Error().Err(err).Msg("failed to convert log level argument") log.Error().Err(err).Msg("failed to initialize logger")
os.Exit(1) os.Exit(1)
} }
zerolog.SetGlobalLevel(level) },
Run: func(cmd *cobra.Command, args []string) {
// try and set flags using env vars
setenv(cmd, "log-file", "MAKESHIFT_LOG_FILE")
if len(args) == 0 {
err := cmd.Help()
if err != nil {
log.Error().Err(err).Msg("failed to print help")
}
os.Exit(0)
}
},
PostRun: func(cmd *cobra.Command, args []string) {
log.Debug().Msg("closing log file")
err := logger.LogFile.Close()
if err != nil {
log.Error().Err(err).Msg("failed to close log file")
}
}, },
} }
@ -46,34 +68,16 @@ func Execute() {
func init() { func init() {
// initialize the config a single time // initialize the config a single time
rootCmd.PersistentFlags().StringVarP(&logLevel, "log-level", "l", "info", "Set the log level output") rootCmd.PersistentFlags().VarP(&logLevel, "log-level", "l", "Set the log level output")
rootCmd.PersistentFlags().String("log-file", "", "Set the log file path (can be set with MAKESHIFT_LOG_FILE)")
} }
func strToLogLevel(ll string) (zerolog.Level, error) { func setenv(cmd *cobra.Command, varname string, envvar string) {
levels := []string{"debug", "info", "warn", "disabled"} if cmd.Flags().Changed(varname) {
if index := slices.Index(levels, ll); index >= 0 { return
// handle special case to map index == 3 to zerolog.Disabled == 7
switch index {
case 3:
return zerolog.Disabled, nil
}
return zerolog.Level(index), nil
} }
return -100, fmt.Errorf( val := os.Getenv(envvar)
"invalid log level (options: %s)", strings.Join(levels, ", "), if val != "" {
) // use 'info' by default cmd.Flags().Set(varname, val)
}
func setenv(v *string, key string) {
t := os.Getenv(key)
if t != "" {
*v = t
} }
} }
// func setenv(cmd *cobra.Command, varname string, envvar string) {
// v := os.Getenv(envvar)
// if v != "" {
// cmd.Flags().Set(varname, v)
// }
// }

2
cmd/run.go
View file

@ -4,7 +4,7 @@ import "github.com/spf13/cobra"
var runCmd = &cobra.Command{ var runCmd = &cobra.Command{
Use: "run", Use: "run",
Short: "Run the configurator locally", Short: "Run 'makeshift' locally with plugins",
Run: func(cmd *cobra.Command, args []string) { Run: func(cmd *cobra.Command, args []string) {
}, },

49
cmd/serve.go
View file

@ -1,42 +1,57 @@
package cmd package cmd
import ( import (
"net/url"
"time" "time"
"git.towk2.me/towk/configurator/pkg/service" "git.towk2.me/towk/makeshift/pkg/service"
"github.com/rs/zerolog/log" "github.com/rs/zerolog/log"
"github.com/spf13/cobra" "github.com/spf13/cobra"
) )
var serveCmd = &cobra.Command{ var serveCmd = &cobra.Command{
Use: "serve", Use: "serve",
Example: `
# start the service in current directory
makeshift serve
# start the service with root path and initialize
makeshift serve --root ./test --init -l debug
`,
Args: cobra.NoArgs, Args: cobra.NoArgs,
PreRun: func(cmd *cobra.Command, args []string) { PreRun: func(cmd *cobra.Command, args []string) {
// try and set flags using env vars setenv(cmd, "host", "MAKESHIFT_HOST")
setenv(&host, "CONFIGURATOR_HOST") setenv(cmd, "root", "MAKESHIFT_SERVER_ROOT")
setenv(&rootPath, "CONFIGURATOR_ROOT") setenv(cmd, "timeout", "MAKESHIFT_TIMEOUT")
}, },
Run: func(cmd *cobra.Command, args []string) { Run: func(cmd *cobra.Command, args []string) {
var ( var (
host string host, _ = cmd.Flags().GetString("host")
rootPath string rootPath, _ = cmd.Flags().GetString("root")
server *service.Service timeout, _ = cmd.Flags().GetInt("timeout")
err error
parsed *url.URL
server *service.Service
err error
) )
// get vars but don't modify // parse the host to remove scheme if needed
host, _ = cmd.Flags().GetString("host") parsed, err = url.Parse(host)
rootPath, _ = cmd.Flags().GetString("root") if err != nil {
log.Warn().Err(err).
Str("host", host).
Msg("could not parse host")
}
// set the server values // set the server values
server = service.New() server = service.New()
server.Addr = host server.Addr = parsed.Host
server.RootPath = rootPath server.RootPath = rootPath
server.Timeout = time.Duration(timeout) * time.Second server.Timeout = time.Duration(timeout) * time.Second
// show some debugging information // show some debugging information
log.Debug(). log.Debug().
Str("host", host). Str("host", parsed.Host).
Any("paths", map[string]string{ Any("paths", map[string]string{
"root": rootPath, "root": rootPath,
"data": server.PathForData(), "data": server.PathForData(),
@ -59,9 +74,9 @@ var serveCmd = &cobra.Command{
func init() { func init() {
serveCmd.Flags().Bool("init", false, "Initializes default files at specified with the '--root' flag") serveCmd.Flags().Bool("init", false, "Initializes default files at specified with the '--root' flag")
serveCmd.Flags().StringVar(&host, "host", "localhost:5050", "Set the configurator server host (can be set with CONFIGURATOR_HOST)") serveCmd.Flags().String("host", "localhost:5050", "Set the configurator server host (can be set with MAKESHIFT_HOST)")
serveCmd.Flags().StringVar(&rootPath, "root", "./", "Set the root path to serve files (can be set with CONFIGURATOR_ROOT)") serveCmd.Flags().String("root", "./", "Set the root path to serve files (can be set with MAKESHIFT_ROOT)")
serveCmd.Flags().IntVarP(&timeout, "timeout", "t", 60, "Set the timeout in seconds for requests.") serveCmd.Flags().IntP("timeout", "t", 60, "Set the timeout in seconds for requests (can be set with MAKESHIFT_TIMEOUT)")
rootCmd.AddCommand(serveCmd) rootCmd.AddCommand(serveCmd)
} }

10
cmd/upload.go
View file

@ -9,6 +9,16 @@ var uploadCmd = &cobra.Command{
}, },
} }
var uploadProfileCmd = &cobra.Command{
Use: "profile",
}
var uploadPluginCmd = &cobra.Command{
Use: "plugin",
}
func init() { func init() {
uploadCmd.AddCommand(uploadProfileCmd, uploadPluginCmd)
rootCmd.AddCommand(uploadCmd) rootCmd.AddCommand(uploadCmd)
} }