mirror of
https://github.com/project-zot/zot.git
synced 2026-06-16 04:17:55 +08:00
feat(cli): add referrers and search commands to cli (#1497)
* feat(cli): add referrers command to cli Signed-off-by: Laurentiu Niculae <niculae.laurentiu1@gmail.com> * feat(cli): add global search command Signed-off-by: Laurentiu Niculae <niculae.laurentiu1@gmail.com> * feat(cli): fix comments Signed-off-by: Laurentiu Niculae <niculae.laurentiu1@gmail.com> --------- Signed-off-by: Laurentiu Niculae <niculae.laurentiu1@gmail.com>
This commit is contained in:
LaurentiuNiculae
@@ -0,0 +1,433 @@
|
||||
//go:build search
|
||||
// +build search
|
||||
|
||||
package cli //nolint:testpackage
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"fmt"
|
||||
"io"
|
||||
"os"
|
||||
"regexp"
|
||||
"strings"
|
||||
"testing"
|
||||
|
||||
ispec "github.com/opencontainers/image-spec/specs-go/v1"
|
||||
. "github.com/smartystreets/goconvey/convey"
|
||||
|
||||
"zotregistry.io/zot/pkg/api"
|
||||
"zotregistry.io/zot/pkg/api/config"
|
||||
extconf "zotregistry.io/zot/pkg/extensions/config"
|
||||
"zotregistry.io/zot/pkg/test"
|
||||
)
|
||||
|
||||
func TestGlobalSearchers(t *testing.T) {
|
||||
globalSearcher := globalSearcherGQL{}
|
||||
|
||||
Convey("GQL Searcher", t, func() {
|
||||
Convey("Bad parameters", func() {
|
||||
ok, err := globalSearcher.search(searchConfig{params: map[string]*string{
|
||||
"badParam": ref("badParam"),
|
||||
}})
|
||||
|
||||
So(err, ShouldBeNil)
|
||||
So(ok, ShouldBeFalse)
|
||||
})
|
||||
|
||||
Convey("global searcher service fail", func() {
|
||||
conf := searchConfig{
|
||||
params: map[string]*string{
|
||||
"query": ref("repo"),
|
||||
},
|
||||
searchService: NewSearchService(),
|
||||
user: ref("test:pass"),
|
||||
servURL: ref("127.0.0.1:8080"),
|
||||
verifyTLS: ref(false),
|
||||
debug: ref(false),
|
||||
verbose: ref(false),
|
||||
fixedFlag: ref(false),
|
||||
}
|
||||
ok, err := globalSearcher.search(conf)
|
||||
|
||||
So(err, ShouldNotBeNil)
|
||||
So(ok, ShouldBeTrue)
|
||||
})
|
||||
|
||||
Convey("print images fail", func() {
|
||||
conf := searchConfig{
|
||||
params: map[string]*string{
|
||||
"query": ref("repo"),
|
||||
},
|
||||
user: ref("user:pass"),
|
||||
outputFormat: ref("bad-format"),
|
||||
searchService: mockService{},
|
||||
resultWriter: io.Discard,
|
||||
verbose: ref(false),
|
||||
}
|
||||
ok, err := globalSearcher.search(conf)
|
||||
|
||||
So(err, ShouldNotBeNil)
|
||||
So(ok, ShouldBeTrue)
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
func TestSearchCLI(t *testing.T) {
|
||||
Convey("Test GQL", t, func() {
|
||||
rootDir := t.TempDir()
|
||||
|
||||
port := test.GetFreePort()
|
||||
baseURL := test.GetBaseURL(port)
|
||||
conf := config.New()
|
||||
conf.HTTP.Port = port
|
||||
conf.Storage.GC = false
|
||||
defaultVal := true
|
||||
conf.Extensions = &extconf.ExtensionConfig{
|
||||
Search: &extconf.SearchConfig{BaseConfig: extconf.BaseConfig{Enable: &defaultVal}},
|
||||
}
|
||||
ctlr := api.NewController(conf)
|
||||
ctlr.Config.Storage.RootDirectory = rootDir
|
||||
cm := test.NewControllerManager(ctlr)
|
||||
cm.StartAndWait(conf.HTTP.Port)
|
||||
defer cm.StopServer()
|
||||
|
||||
const (
|
||||
repo1 = "repo"
|
||||
r1tag1 = "repo1tag1"
|
||||
r1tag2 = "repo1tag2"
|
||||
|
||||
repo2 = "repo/alpine"
|
||||
r2tag1 = "repo2tag1"
|
||||
r2tag2 = "repo2tag2"
|
||||
|
||||
repo3 = "repo/test/alpine"
|
||||
r3tag1 = "repo3tag1"
|
||||
r3tag2 = "repo3tag2"
|
||||
)
|
||||
|
||||
image1, err := test.GetImageWithConfig(ispec.Image{
|
||||
Platform: ispec.Platform{
|
||||
OS: "Os",
|
||||
Architecture: "Arch",
|
||||
},
|
||||
})
|
||||
So(err, ShouldBeNil)
|
||||
img1Digest, err := image1.Digest()
|
||||
formatterDigest1 := img1Digest.Encoded()[:8]
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
image2, err := test.GetRandomImage("")
|
||||
So(err, ShouldBeNil)
|
||||
img2Digest, err := image2.Digest()
|
||||
formatterDigest2 := img2Digest.Encoded()[:8]
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
// repo1
|
||||
image1.Reference = r1tag1
|
||||
err = test.UploadImage(image1, baseURL, repo1)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
image2.Reference = r1tag2
|
||||
err = test.UploadImage(image2, baseURL, repo1)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
// repo2
|
||||
image1.Reference = r2tag1
|
||||
err = test.UploadImage(image1, baseURL, repo2)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
image2.Reference = r2tag2
|
||||
err = test.UploadImage(image2, baseURL, repo2)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
// repo3
|
||||
image1.Reference = r3tag1
|
||||
err = test.UploadImage(image1, baseURL, repo3)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
image2.Reference = r3tag2
|
||||
err = test.UploadImage(image2, baseURL, repo3)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
// search by repos
|
||||
|
||||
args := []string{"searchtest", "--query", "test/alpin", "--verbose"}
|
||||
|
||||
configPath := makeConfigFile(fmt.Sprintf(`{"configs":[{"_name":"searchtest","url":"%s","showspinner":false}]}`,
|
||||
baseURL))
|
||||
defer os.Remove(configPath)
|
||||
|
||||
cmd := NewSearchCommand(new(searchService))
|
||||
|
||||
buff := &bytes.Buffer{}
|
||||
cmd.SetOut(buff)
|
||||
cmd.SetErr(buff)
|
||||
cmd.SetArgs(args)
|
||||
err = cmd.Execute()
|
||||
So(err, ShouldBeNil)
|
||||
space := regexp.MustCompile(`\s+`)
|
||||
str := strings.TrimSpace(space.ReplaceAllString(buff.String(), " "))
|
||||
So(str, ShouldContainSubstring, "NAME SIZE LAST UPDATED DOWNLOADS STARS PLATFORMS")
|
||||
So(str, ShouldContainSubstring, "repo/test/alpine 1.1kB 0001-01-01 00:00:00 +0000 UTC 0 0")
|
||||
So(str, ShouldContainSubstring, "Os/Arch")
|
||||
So(str, ShouldContainSubstring, "linux/amd64")
|
||||
|
||||
fmt.Println("\n", buff.String())
|
||||
|
||||
os.Remove(configPath)
|
||||
|
||||
cmd = NewSearchCommand(new(searchService))
|
||||
|
||||
args = []string{"searchtest", "--query", "repo/alpine:"}
|
||||
|
||||
configPath = makeConfigFile(fmt.Sprintf(`{"configs":[{"_name":"searchtest","url":"%s","showspinner":false}]}`,
|
||||
baseURL))
|
||||
|
||||
defer os.Remove(configPath)
|
||||
|
||||
buff = &bytes.Buffer{}
|
||||
cmd.SetOut(buff)
|
||||
cmd.SetErr(buff)
|
||||
cmd.SetArgs(args)
|
||||
err = cmd.Execute()
|
||||
So(err, ShouldBeNil)
|
||||
str = strings.TrimSpace(space.ReplaceAllString(buff.String(), " "))
|
||||
So(str, ShouldContainSubstring, "IMAGE NAME TAG OS/ARCH DIGEST SIGNED SIZE")
|
||||
So(str, ShouldContainSubstring, "repo/alpine repo2tag1 Os/Arch "+formatterDigest1+" false 577B")
|
||||
So(str, ShouldContainSubstring, "repo/alpine repo2tag2 linux/amd64 "+formatterDigest2+" false 524B")
|
||||
|
||||
fmt.Println("\n", buff.String())
|
||||
})
|
||||
}
|
||||
|
||||
func TestFormatsSearchCLI(t *testing.T) {
|
||||
Convey("", t, func() {
|
||||
rootDir := t.TempDir()
|
||||
|
||||
port := test.GetFreePort()
|
||||
baseURL := test.GetBaseURL(port)
|
||||
conf := config.New()
|
||||
conf.HTTP.Port = port
|
||||
conf.Storage.GC = false
|
||||
defaultVal := true
|
||||
conf.Extensions = &extconf.ExtensionConfig{
|
||||
Search: &extconf.SearchConfig{BaseConfig: extconf.BaseConfig{Enable: &defaultVal}},
|
||||
}
|
||||
ctlr := api.NewController(conf)
|
||||
ctlr.Config.Storage.RootDirectory = rootDir
|
||||
cm := test.NewControllerManager(ctlr)
|
||||
cm.StartAndWait(conf.HTTP.Port)
|
||||
defer cm.StopServer()
|
||||
|
||||
const (
|
||||
repo1 = "repo"
|
||||
r1tag1 = "repo1tag1"
|
||||
r1tag2 = "repo1tag2"
|
||||
|
||||
repo2 = "repo/alpine"
|
||||
r2tag1 = "repo2tag1"
|
||||
r2tag2 = "repo2tag2"
|
||||
|
||||
repo3 = "repo/test/alpine"
|
||||
r3tag1 = "repo3tag1"
|
||||
r3tag2 = "repo3tag2"
|
||||
)
|
||||
|
||||
image1, err := test.GetRandomImage("")
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
image2, err := test.GetRandomImage("")
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
// repo1
|
||||
image1.Reference = r1tag1
|
||||
err = test.UploadImage(image1, baseURL, repo1)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
image2.Reference = r1tag2
|
||||
err = test.UploadImage(image2, baseURL, repo1)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
// repo2
|
||||
image1.Reference = r2tag1
|
||||
err = test.UploadImage(image1, baseURL, repo2)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
image2.Reference = r2tag2
|
||||
err = test.UploadImage(image2, baseURL, repo2)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
// repo3
|
||||
image1.Reference = r3tag1
|
||||
err = test.UploadImage(image1, baseURL, repo3)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
image2.Reference = r3tag2
|
||||
err = test.UploadImage(image2, baseURL, repo3)
|
||||
So(err, ShouldBeNil)
|
||||
|
||||
cmd := NewSearchCommand(new(searchService))
|
||||
|
||||
Convey("JSON format", func() {
|
||||
args := []string{"searchtest", "--output", "json", "--query", "repo/alpine"}
|
||||
|
||||
configPath := makeConfigFile(fmt.Sprintf(`{"configs":[{"_name":"searchtest","url":"%s","showspinner":false}]}`,
|
||||
baseURL))
|
||||
|
||||
defer os.Remove(configPath)
|
||||
|
||||
buff := &bytes.Buffer{}
|
||||
cmd.SetOut(buff)
|
||||
cmd.SetErr(buff)
|
||||
cmd.SetArgs(args)
|
||||
err = cmd.Execute()
|
||||
So(err, ShouldBeNil)
|
||||
fmt.Println(buff.String())
|
||||
})
|
||||
|
||||
Convey("YAML format", func() {
|
||||
args := []string{"searchtest", "--output", "yaml", "--query", "repo/alpine"}
|
||||
|
||||
configPath := makeConfigFile(fmt.Sprintf(`{"configs":[{"_name":"searchtest","url":"%s","showspinner":false}]}`,
|
||||
baseURL))
|
||||
|
||||
defer os.Remove(configPath)
|
||||
|
||||
buff := &bytes.Buffer{}
|
||||
cmd.SetOut(buff)
|
||||
cmd.SetErr(buff)
|
||||
cmd.SetArgs(args)
|
||||
err = cmd.Execute()
|
||||
So(err, ShouldBeNil)
|
||||
fmt.Println(buff.String())
|
||||
})
|
||||
|
||||
Convey("Invalid format", func() {
|
||||
args := []string{"searchtest", "--output", "invalid", "--query", "repo/alpine"}
|
||||
|
||||
configPath := makeConfigFile(fmt.Sprintf(`{"configs":[{"_name":"searchtest","url":"%s","showspinner":false}]}`,
|
||||
baseURL))
|
||||
|
||||
defer os.Remove(configPath)
|
||||
|
||||
buff := &bytes.Buffer{}
|
||||
cmd.SetOut(buff)
|
||||
cmd.SetErr(buff)
|
||||
cmd.SetArgs(args)
|
||||
err = cmd.Execute()
|
||||
So(err, ShouldNotBeNil)
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
func TestSearchCLIErrors(t *testing.T) {
|
||||
Convey("Errors", t, func() {
|
||||
cmd := NewSearchCommand(new(searchService))
|
||||
|
||||
Convey("no url provided", func() {
|
||||
args := []string{"searchtest", "--output", "invalid", "--query", "repo/alpine"}
|
||||
|
||||
configPath := makeConfigFile(`{"configs":[{"_name":"searchtest","showspinner":false}]}`)
|
||||
|
||||
defer os.Remove(configPath)
|
||||
|
||||
buff := &bytes.Buffer{}
|
||||
cmd.SetOut(buff)
|
||||
cmd.SetErr(buff)
|
||||
cmd.SetArgs(args)
|
||||
err := cmd.Execute()
|
||||
So(err, ShouldNotBeNil)
|
||||
})
|
||||
|
||||
Convey("getConfigValue", func() {
|
||||
args := []string{"searchtest", "--output", "invalid", "--query", "repo/alpine"}
|
||||
|
||||
configPath := makeConfigFile(`bad-json`)
|
||||
|
||||
defer os.Remove(configPath)
|
||||
|
||||
buff := &bytes.Buffer{}
|
||||
cmd.SetOut(buff)
|
||||
cmd.SetErr(buff)
|
||||
cmd.SetArgs(args)
|
||||
err := cmd.Execute()
|
||||
So(err, ShouldNotBeNil)
|
||||
})
|
||||
|
||||
Convey("bad showspinnerConfig ", func() {
|
||||
args := []string{"searchtest"}
|
||||
|
||||
configPath := makeConfigFile(
|
||||
`{"configs":[{"_name":"searchtest", "url":"http://127.0.0.1:8080", "showspinner":"bad"}]}`)
|
||||
|
||||
defer os.Remove(configPath)
|
||||
|
||||
buff := &bytes.Buffer{}
|
||||
cmd.SetOut(buff)
|
||||
cmd.SetErr(buff)
|
||||
cmd.SetArgs(args)
|
||||
err := cmd.Execute()
|
||||
So(err, ShouldNotBeNil)
|
||||
})
|
||||
|
||||
Convey("bad verifyTLSConfig ", func() {
|
||||
args := []string{"searchtest"}
|
||||
|
||||
configPath := makeConfigFile(
|
||||
`{"configs":[{"_name":"searchtest", "url":"http://127.0.0.1:8080", "showspinner":false, "verify-tls": "bad"}]}`)
|
||||
|
||||
defer os.Remove(configPath)
|
||||
|
||||
buff := &bytes.Buffer{}
|
||||
cmd.SetOut(buff)
|
||||
cmd.SetErr(buff)
|
||||
cmd.SetArgs(args)
|
||||
err := cmd.Execute()
|
||||
So(err, ShouldNotBeNil)
|
||||
})
|
||||
|
||||
Convey("url from config is empty", func() {
|
||||
args := []string{"searchtest", "--output", "invalid", "--query", "repo/alpine"}
|
||||
|
||||
configPath := makeConfigFile(`{"configs":[{"_name":"searchtest", "url":"", "showspinner":false}]}`)
|
||||
|
||||
defer os.Remove(configPath)
|
||||
|
||||
buff := &bytes.Buffer{}
|
||||
cmd.SetOut(buff)
|
||||
cmd.SetErr(buff)
|
||||
cmd.SetArgs(args)
|
||||
err := cmd.Execute()
|
||||
So(err, ShouldNotBeNil)
|
||||
})
|
||||
|
||||
Convey("no url provided error", func() {
|
||||
args := []string{}
|
||||
|
||||
configPath := makeConfigFile(`bad-json`)
|
||||
|
||||
defer os.Remove(configPath)
|
||||
|
||||
buff := &bytes.Buffer{}
|
||||
cmd.SetOut(buff)
|
||||
cmd.SetErr(buff)
|
||||
cmd.SetArgs(args)
|
||||
err := cmd.Execute()
|
||||
So(err, ShouldNotBeNil)
|
||||
})
|
||||
|
||||
Convey("globalSearch without gql active", func() {
|
||||
err := globalSearch(searchConfig{
|
||||
user: ref("t"),
|
||||
servURL: ref("t"),
|
||||
verifyTLS: ref(false),
|
||||
debug: ref(false),
|
||||
params: map[string]*string{
|
||||
"query": ref("t"),
|
||||
},
|
||||
resultWriter: io.Discard,
|
||||
})
|
||||
So(err, ShouldNotBeNil)
|
||||
})
|
||||
})
|
||||
}
|
||||
Reference in New Issue
Block a user