mirror of
https://github.com/project-zot/zot.git
synced 2026-06-17 21:17:58 +08:00
Andrei Aaron
ddb6279a25
Make `zli config` and config subcommands show usage/help when invoked with missing required args, instead of Cobra’s generic “accepts N arg(s)” errors. Example: - before: `zli config add` -> `Error: accepts 2 arg(s), received 0` - after: `zli config add` prints `zli config add <config-name> <url>` usage/help1~fix(zli config): print help for missing args Signed-off-by: Andrei Aaron <andreifdaaron@gmail.com>
543 lines
15 KiB
Go
543 lines
15 KiB
Go
//go:build search
|
|
|
|
// Deprecated parent `config` invocation (--list, positional args, --reset). Prefer tests in config_cmd_test.go.
|
|
package client_test
|
|
|
|
import (
|
|
"bytes"
|
|
"errors"
|
|
"os"
|
|
"regexp"
|
|
"strings"
|
|
"testing"
|
|
|
|
. "github.com/smartystreets/goconvey/convey"
|
|
|
|
zerr "zotregistry.dev/zot/v2/errors"
|
|
"zotregistry.dev/zot/v2/pkg/cli/client"
|
|
)
|
|
|
|
func TestConfigCmdDeprecatedBasics(t *testing.T) {
|
|
Convey("Test config help", t, func() {
|
|
args := []string{"--help"}
|
|
|
|
_ = makeConfigFile(t, "showspinner = false")
|
|
|
|
cmd := client.NewConfigCommand()
|
|
buff := bytes.NewBufferString("")
|
|
cmd.SetOut(buff)
|
|
cmd.SetErr(buff)
|
|
cmd.SetArgs(args)
|
|
err := cmd.Execute()
|
|
|
|
So(err, ShouldBeNil)
|
|
So(buff.String(), ShouldContainSubstring, "Usage")
|
|
|
|
Convey("with the shorthand", func() {
|
|
args[0] = "-h"
|
|
|
|
_ = makeConfigFile(t, "showspinner = false")
|
|
|
|
cmd := client.NewConfigCommand()
|
|
buff := bytes.NewBufferString("")
|
|
cmd.SetOut(buff)
|
|
cmd.SetErr(buff)
|
|
cmd.SetArgs(args)
|
|
err := cmd.Execute()
|
|
|
|
So(buff.String(), ShouldContainSubstring, "Usage")
|
|
So(err, ShouldBeNil)
|
|
})
|
|
})
|
|
|
|
Convey("Test config no args", t, func() {
|
|
args := []string{}
|
|
|
|
_ = makeConfigFile(t, "showspinner = false")
|
|
|
|
cmd := client.NewConfigCommand()
|
|
buff := bytes.NewBufferString("")
|
|
cmd.SetOut(buff)
|
|
cmd.SetErr(buff)
|
|
cmd.SetArgs(args)
|
|
err := cmd.Execute()
|
|
|
|
So(buff.String(), ShouldContainSubstring, "Usage")
|
|
So(err, ShouldBeNil)
|
|
})
|
|
}
|
|
|
|
func TestConfigCmdDeprecatedMain(t *testing.T) {
|
|
Convey("Test add config", t, func() {
|
|
args := []string{"add", "configtest1", "https://test-url.com"}
|
|
|
|
configPath := makeConfigFile(t, "")
|
|
|
|
cmd := client.NewConfigCommand()
|
|
buff := bytes.NewBufferString("")
|
|
cmd.SetOut(buff)
|
|
cmd.SetErr(buff)
|
|
cmd.SetArgs(args)
|
|
_ = cmd.Execute()
|
|
|
|
actual, err := os.ReadFile(configPath)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
actualStr := string(actual)
|
|
So(actualStr, ShouldContainSubstring, "configtest1")
|
|
So(actualStr, ShouldContainSubstring, "https://test-url.com")
|
|
})
|
|
|
|
Convey("Test error on home directory", t, func() {
|
|
args := []string{"add", "configtest1", "https://test-url.com"}
|
|
|
|
_ = makeConfigFile(t, "")
|
|
|
|
t.Setenv("HOME", "nonExistentDirectory")
|
|
|
|
cmd := client.NewConfigCommand()
|
|
buff := bytes.NewBufferString("")
|
|
cmd.SetOut(buff)
|
|
cmd.SetErr(buff)
|
|
cmd.SetArgs(args)
|
|
err := cmd.Execute()
|
|
So(err, ShouldNotBeNil)
|
|
})
|
|
|
|
Convey("Test error on home directory at new add config", t, func() {
|
|
args := []string{"configtest1", "https://test-url.com"}
|
|
|
|
_ = makeConfigFile(t, "")
|
|
|
|
t.Setenv("HOME", "nonExistentDirectory")
|
|
|
|
cmd := client.NewConfigAddCommand()
|
|
buff := bytes.NewBufferString("")
|
|
cmd.SetOut(buff)
|
|
cmd.SetErr(buff)
|
|
cmd.SetArgs(args)
|
|
err := cmd.Execute()
|
|
So(err, ShouldNotBeNil)
|
|
})
|
|
|
|
Convey("Test list config with invalid format", t, func() {
|
|
args := []string{"--list"}
|
|
|
|
_ = makeConfigFile(t, `{"configs":{"_name":"configtest","url":"https://test-url.com","showspinner":false}}`)
|
|
|
|
cmd := client.NewConfigCommand()
|
|
buff := bytes.NewBufferString("")
|
|
cmd.SetOut(buff)
|
|
cmd.SetErr(buff)
|
|
cmd.SetArgs(args)
|
|
err := cmd.Execute()
|
|
So(errors.Is(err, zerr.ErrCliBadConfig), ShouldBeTrue)
|
|
})
|
|
|
|
Convey("Test add config with invalid URL", t, func() {
|
|
args := []string{"add", "configtest1", "test..com"}
|
|
|
|
_ = makeConfigFile(t, "")
|
|
|
|
cmd := client.NewConfigCommand()
|
|
buff := bytes.NewBufferString("")
|
|
cmd.SetOut(buff)
|
|
cmd.SetErr(buff)
|
|
cmd.SetArgs(args)
|
|
err := cmd.Execute()
|
|
So(err, ShouldNotBeNil)
|
|
So(strings.Contains(err.Error(), zerr.ErrInvalidURL.Error()), ShouldBeTrue)
|
|
})
|
|
|
|
Convey("Test remove config entry successfully", t, func() {
|
|
args := []string{"remove", "configtest"}
|
|
|
|
configPath := makeConfigFile(t,
|
|
`{"configs":[{"_name":"configtest","url":"https://test-url.com","showspinner":false}]}`)
|
|
|
|
cmd := client.NewConfigCommand()
|
|
buff := bytes.NewBufferString("")
|
|
cmd.SetOut(buff)
|
|
cmd.SetErr(buff)
|
|
cmd.SetArgs(args)
|
|
err := cmd.Execute()
|
|
So(err, ShouldBeNil)
|
|
actual, err := os.ReadFile(configPath)
|
|
So(err, ShouldBeNil)
|
|
space := regexp.MustCompile(`\s+`)
|
|
actualString := space.ReplaceAllString(string(actual), " ")
|
|
So(actualString, ShouldEqual, `{ "configs": [] }`)
|
|
})
|
|
|
|
Convey("Test remove missing config entry", t, func() {
|
|
args := []string{"remove", "configtest"}
|
|
|
|
_ = makeConfigFile(t, `{"configs":[]}`)
|
|
|
|
cmd := client.NewConfigCommand()
|
|
buff := bytes.NewBufferString("")
|
|
cmd.SetOut(buff)
|
|
cmd.SetErr(buff)
|
|
cmd.SetArgs(args)
|
|
err := cmd.Execute()
|
|
So(err, ShouldNotBeNil)
|
|
So(buff.String(), ShouldContainSubstring, "does not exist")
|
|
})
|
|
|
|
Convey("Test remove bad config file content", t, func() {
|
|
args := []string{"remove", "configtest"}
|
|
|
|
_ = makeConfigFile(t, `{"asdf":[]`)
|
|
|
|
cmd := client.NewConfigCommand()
|
|
buff := bytes.NewBufferString("")
|
|
cmd.SetOut(buff)
|
|
cmd.SetErr(buff)
|
|
cmd.SetArgs(args)
|
|
err := cmd.Execute()
|
|
So(err, ShouldNotBeNil)
|
|
So(errors.Is(err, zerr.ErrCliBadConfig), ShouldBeTrue)
|
|
})
|
|
|
|
Convey("Test remove bad config file entry", t, func() {
|
|
args := []string{"remove", "configtest"}
|
|
|
|
_ = makeConfigFile(t, `{"configs":[asdad]`)
|
|
|
|
cmd := client.NewConfigCommand()
|
|
buff := bytes.NewBufferString("")
|
|
cmd.SetOut(buff)
|
|
cmd.SetErr(buff)
|
|
cmd.SetArgs(args)
|
|
err := cmd.Execute()
|
|
So(err, ShouldNotBeNil)
|
|
So(buff.String(), ShouldContainSubstring, zerr.ErrCliBadConfig.Error())
|
|
})
|
|
|
|
Convey("Test remove config bad permissions", t, func() {
|
|
args := []string{"remove", "configtest"}
|
|
configPath := makeConfigFile(t,
|
|
`{"configs":[{"_name":"configtest","url":"https://test-url.com","showspinner":false}]}`)
|
|
|
|
defer func() {
|
|
_ = os.Chmod(configPath, 0o600)
|
|
}()
|
|
|
|
err := os.Chmod(configPath, 0o400) // Read-only, so we fail only on updating the file, not reading
|
|
So(err, ShouldBeNil)
|
|
|
|
cmd := client.NewConfigCommand()
|
|
buff := bytes.NewBufferString("")
|
|
cmd.SetOut(buff)
|
|
cmd.SetErr(buff)
|
|
cmd.SetArgs(args)
|
|
err = cmd.Execute()
|
|
So(err, ShouldNotBeNil)
|
|
So(buff.String(), ShouldContainSubstring, "permission denied")
|
|
})
|
|
|
|
Convey("Test fetch all config", t, func() {
|
|
args := []string{"--list"}
|
|
|
|
_ = makeConfigFile(t, `{"configs":[{"_name":"configtest","url":"https://test-url.com","showspinner":false}]}`)
|
|
|
|
cmd := client.NewConfigCommand()
|
|
outBuff := bytes.NewBufferString("")
|
|
errBuff := bytes.NewBufferString("")
|
|
cmd.SetOut(outBuff)
|
|
cmd.SetErr(errBuff)
|
|
cmd.SetArgs(args)
|
|
err := cmd.Execute()
|
|
|
|
So(outBuff.String(), ShouldContainSubstring, "https://test-url.com")
|
|
So(errBuff.String(), ShouldContainSubstring, "`zli config list`")
|
|
So(err, ShouldBeNil)
|
|
|
|
Convey("with the shorthand", func() {
|
|
args := []string{"-l"}
|
|
|
|
_ = makeConfigFile(t, `{"configs":[{"_name":"configtest","url":"https://test-url.com","showspinner":false}]}`)
|
|
|
|
cmd := client.NewConfigCommand()
|
|
outBuff := bytes.NewBufferString("")
|
|
errBuff := bytes.NewBufferString("")
|
|
cmd.SetOut(outBuff)
|
|
cmd.SetErr(errBuff)
|
|
cmd.SetArgs(args)
|
|
|
|
err := cmd.Execute()
|
|
So(err, ShouldBeNil)
|
|
|
|
So(outBuff.String(), ShouldContainSubstring, "https://test-url.com")
|
|
So(errBuff.String(), ShouldContainSubstring, "`zli config list`")
|
|
})
|
|
|
|
Convey("From empty file", func() {
|
|
args := []string{"-l"}
|
|
|
|
_ = makeConfigFile(t, ``)
|
|
|
|
cmd := client.NewConfigCommand()
|
|
outBuff := bytes.NewBufferString("")
|
|
errBuff := bytes.NewBufferString("")
|
|
cmd.SetOut(outBuff)
|
|
cmd.SetErr(errBuff)
|
|
cmd.SetArgs(args)
|
|
|
|
err := cmd.Execute()
|
|
So(err, ShouldBeNil)
|
|
|
|
So(strings.TrimSpace(outBuff.String()), ShouldEqual, "")
|
|
So(errBuff.String(), ShouldContainSubstring, "`zli config list`")
|
|
})
|
|
})
|
|
|
|
Convey("Test fetch a config", t, func() {
|
|
args := []string{"configtest", "--list"}
|
|
|
|
_ = makeConfigFile(t, `{"configs":[{"_name":"configtest","url":"https://test-url.com","showspinner":false}]}`)
|
|
|
|
cmd := client.NewConfigCommand()
|
|
outBuff := bytes.NewBufferString("")
|
|
errBuff := bytes.NewBufferString("")
|
|
cmd.SetOut(outBuff)
|
|
cmd.SetErr(errBuff)
|
|
cmd.SetArgs(args)
|
|
|
|
err := cmd.Execute()
|
|
So(err, ShouldBeNil)
|
|
|
|
So(outBuff.String(), ShouldContainSubstring, "url = https://test-url.com")
|
|
So(outBuff.String(), ShouldContainSubstring, "showspinner = false")
|
|
So(errBuff.String(), ShouldContainSubstring, "`zli config show <name>`")
|
|
|
|
Convey("with the shorthand", func() {
|
|
args := []string{"configtest", "-l"}
|
|
|
|
_ = makeConfigFile(t, `{"configs":[{"_name":"configtest","url":"https://test-url.com","showspinner":false}]}`)
|
|
|
|
cmd := client.NewConfigCommand()
|
|
outBuff := bytes.NewBufferString("")
|
|
errBuff := bytes.NewBufferString("")
|
|
cmd.SetOut(outBuff)
|
|
cmd.SetErr(errBuff)
|
|
cmd.SetArgs(args)
|
|
|
|
err := cmd.Execute()
|
|
So(err, ShouldBeNil)
|
|
|
|
So(outBuff.String(), ShouldContainSubstring, "url = https://test-url.com")
|
|
So(outBuff.String(), ShouldContainSubstring, "showspinner = false")
|
|
So(errBuff.String(), ShouldContainSubstring, "`zli config show <name>`")
|
|
})
|
|
|
|
Convey("From empty file", func() {
|
|
args := []string{"configtest", "-l"}
|
|
|
|
_ = makeConfigFile(t, ``)
|
|
|
|
cmd := client.NewConfigCommand()
|
|
outBuff := bytes.NewBufferString("")
|
|
errBuff := bytes.NewBufferString("")
|
|
cmd.SetOut(outBuff)
|
|
cmd.SetErr(errBuff)
|
|
cmd.SetArgs(args)
|
|
|
|
err := cmd.Execute()
|
|
So(err, ShouldBeNil)
|
|
|
|
So(strings.TrimSpace(outBuff.String()), ShouldEqual, "")
|
|
So(errBuff.String(), ShouldContainSubstring, "`zli config show <name>`")
|
|
})
|
|
})
|
|
|
|
Convey("Test fetch a config val", t, func() {
|
|
args := []string{"configtest", "url"}
|
|
|
|
_ = makeConfigFile(t, `{"configs":[{"_name":"configtest","url":"https://test-url.com","showspinner":false}]}`)
|
|
|
|
cmd := client.NewConfigCommand()
|
|
outBuff := bytes.NewBufferString("")
|
|
errBuff := bytes.NewBufferString("")
|
|
cmd.SetOut(outBuff)
|
|
cmd.SetErr(errBuff)
|
|
cmd.SetArgs(args)
|
|
|
|
err := cmd.Execute()
|
|
So(err, ShouldBeNil)
|
|
So(outBuff.String(), ShouldEqual, "https://test-url.com\n")
|
|
So(errBuff.String(), ShouldContainSubstring, "deprecated invocation")
|
|
|
|
Convey("From empty file", func() {
|
|
args := []string{"configtest", "url"}
|
|
|
|
_ = makeConfigFile(t, ``)
|
|
|
|
cmd := client.NewConfigCommand()
|
|
outBuff := bytes.NewBufferString("")
|
|
errBuff := bytes.NewBufferString("")
|
|
cmd.SetOut(outBuff)
|
|
cmd.SetErr(errBuff)
|
|
cmd.SetArgs(args)
|
|
|
|
err := cmd.Execute()
|
|
So(err, ShouldNotBeNil)
|
|
|
|
combined := errBuff.String() + outBuff.String()
|
|
So(combined, ShouldContainSubstring, "does not exist")
|
|
})
|
|
})
|
|
|
|
Convey("Test add a config val", t, func() {
|
|
args := []string{"configtest", "showspinner", "false"}
|
|
|
|
configPath := makeConfigFile(t, `{"configs":[{"_name":"configtest","url":"https://test-url.com"}]}`)
|
|
|
|
cmd := client.NewConfigCommand()
|
|
outBuff := bytes.NewBufferString("")
|
|
errBuff := bytes.NewBufferString("")
|
|
cmd.SetOut(outBuff)
|
|
cmd.SetErr(errBuff)
|
|
cmd.SetArgs(args)
|
|
err := cmd.Execute()
|
|
So(err, ShouldBeNil)
|
|
|
|
actual, err := os.ReadFile(configPath)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
actualStr := string(actual)
|
|
So(actualStr, ShouldContainSubstring, "https://test-url.com")
|
|
So(actualStr, ShouldContainSubstring, `"showspinner": false`)
|
|
So(outBuff.String(), ShouldEqual, "")
|
|
So(errBuff.String(), ShouldContainSubstring, "deprecated invocation")
|
|
|
|
Convey("To an empty file", func() {
|
|
args := []string{"configtest", "showspinner", "false"}
|
|
|
|
_ = makeConfigFile(t, ``)
|
|
|
|
cmd := client.NewConfigCommand()
|
|
outBuff := bytes.NewBufferString("")
|
|
errBuff := bytes.NewBufferString("")
|
|
cmd.SetOut(outBuff)
|
|
cmd.SetErr(errBuff)
|
|
cmd.SetArgs(args)
|
|
|
|
err := cmd.Execute()
|
|
So(err, ShouldNotBeNil)
|
|
|
|
combined := errBuff.String() + outBuff.String()
|
|
So(combined, ShouldContainSubstring, "does not exist")
|
|
})
|
|
})
|
|
|
|
Convey("Test overwrite a config", t, func() {
|
|
args := []string{"configtest", "url", "https://new-url.com"}
|
|
|
|
configPath := makeConfigFile(t,
|
|
`{"configs":[{"_name":"configtest","url":"https://test-url.com","showspinner":false}]}`)
|
|
|
|
cmd := client.NewConfigCommand()
|
|
outBuff := bytes.NewBufferString("")
|
|
errBuff := bytes.NewBufferString("")
|
|
cmd.SetOut(outBuff)
|
|
cmd.SetErr(errBuff)
|
|
cmd.SetArgs(args)
|
|
err := cmd.Execute()
|
|
So(err, ShouldBeNil)
|
|
|
|
actual, err := os.ReadFile(configPath)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
actualStr := string(actual)
|
|
So(actualStr, ShouldContainSubstring, `https://new-url.com`)
|
|
So(actualStr, ShouldContainSubstring, `"showspinner": false`)
|
|
So(actualStr, ShouldNotContainSubstring, `https://test-url.com`)
|
|
So(outBuff.String(), ShouldEqual, "")
|
|
So(errBuff.String(), ShouldContainSubstring, "deprecated invocation")
|
|
})
|
|
|
|
Convey("Test reset a config val", t, func() {
|
|
args := []string{"configtest", "showspinner", "--reset"}
|
|
|
|
configPath := makeConfigFile(t,
|
|
`{"configs":[{"_name":"configtest","url":"https://test-url.com","showspinner":false}]}`)
|
|
|
|
cmd := client.NewConfigCommand()
|
|
outBuff := bytes.NewBufferString("")
|
|
errBuff := bytes.NewBufferString("")
|
|
cmd.SetOut(outBuff)
|
|
cmd.SetErr(errBuff)
|
|
cmd.SetArgs(args)
|
|
err := cmd.Execute()
|
|
So(err, ShouldBeNil)
|
|
|
|
actual, err := os.ReadFile(configPath)
|
|
if err != nil {
|
|
panic(err)
|
|
}
|
|
actualStr := string(actual)
|
|
So(actualStr, ShouldNotContainSubstring, "showspinner")
|
|
So(actualStr, ShouldContainSubstring, `"url": "https://test-url.com"`)
|
|
So(outBuff.String(), ShouldEqual, "")
|
|
So(errBuff.String(), ShouldContainSubstring, "`zli config reset <name> <key>`")
|
|
})
|
|
|
|
Convey("Test reset a url", t, func() {
|
|
args := []string{"configtest", "url", "--reset"}
|
|
|
|
_ = makeConfigFile(t, `{"configs":[{"_name":"configtest","url":"https://test-url.com","showspinner":false}]}`)
|
|
|
|
cmd := client.NewConfigCommand()
|
|
outBuff := bytes.NewBufferString("")
|
|
errBuff := bytes.NewBufferString("")
|
|
cmd.SetOut(outBuff)
|
|
cmd.SetErr(errBuff)
|
|
cmd.SetArgs(args)
|
|
|
|
err := cmd.Execute()
|
|
So(err, ShouldNotBeNil)
|
|
|
|
combined := errBuff.String() + outBuff.String()
|
|
So(combined, ShouldContainSubstring, "cannot reset")
|
|
So(combined, ShouldContainSubstring, "`zli config reset <name> <key>`")
|
|
})
|
|
|
|
Convey("Test add a config with an existing saved name", t, func() {
|
|
args := []string{"add", "configtest", "https://test-url.com/new"}
|
|
|
|
_ = makeConfigFile(t, `{"configs":[{"_name":"configtest","url":"https://test-url.com","showspinner":false}]}`)
|
|
|
|
cmd := client.NewConfigCommand()
|
|
buff := bytes.NewBufferString("")
|
|
cmd.SetOut(buff)
|
|
cmd.SetErr(buff)
|
|
cmd.SetArgs(args)
|
|
|
|
err := cmd.Execute()
|
|
So(err, ShouldNotBeNil)
|
|
|
|
So(buff.String(), ShouldContainSubstring, "cli config name already added")
|
|
})
|
|
|
|
Convey("Test deprecated config invalid args (too many args)", t, func() {
|
|
args := []string{"configtest", "url", "x", "y"}
|
|
|
|
_ = makeConfigFile(t, `{"configs":[{"_name":"configtest","url":"https://test-url.com","showspinner":false}]}`)
|
|
|
|
cmd := client.NewConfigCommand()
|
|
outBuff := bytes.NewBufferString("")
|
|
errBuff := bytes.NewBufferString("")
|
|
cmd.SetOut(outBuff)
|
|
cmd.SetErr(errBuff)
|
|
cmd.SetArgs(args)
|
|
|
|
err := cmd.Execute()
|
|
So(err, ShouldNotBeNil)
|
|
So(errors.Is(err, zerr.ErrInvalidArgs), ShouldBeTrue)
|
|
})
|
|
}
|