mirror of
https://github.com/project-zot/zot.git
synced 2026-06-17 21:17:58 +08:00
Vishwas Rajashekar
9c7e77e12a
feat(zb): list tests and test regex filter + misc This change introduces the following changes to zb. Test Filtering =============== Allows users to selectively run tests by specifying a standard regex that matches on the name of the test. Test Listing =============== Allows users to list out the available tests as well as the matched tests when using the regex filter. The documentation README has also been updated with examples and the command help. The documentation for skip cleanup has been updated. Signed-off-by: Vishwas Rajashekar <dev@vrajashkr.com>
108 lines
3.2 KiB
Go
108 lines
3.2 KiB
Go
package main
|
|
|
|
import (
|
|
"os"
|
|
"regexp"
|
|
|
|
distspec "github.com/opencontainers/distribution-spec/specs-go"
|
|
"github.com/spf13/cobra"
|
|
|
|
"zotregistry.dev/zot/v2/pkg/api/config"
|
|
"zotregistry.dev/zot/v2/pkg/log"
|
|
)
|
|
|
|
// NewPerfRootCmd creates the root command for "zb" - performance benchmark and stress.
|
|
func NewPerfRootCmd() *cobra.Command {
|
|
showVersion := false
|
|
|
|
var auth, workdir, repo, outFmt, srcIPs, srcCIDR, testRegexStr string
|
|
|
|
var concurrency, requests int
|
|
|
|
var skipCleanup, listTests bool
|
|
|
|
rootCmd := &cobra.Command{
|
|
Use: "zb <url>",
|
|
Short: "`zb`",
|
|
Long: "`zb`",
|
|
Run: func(cmd *cobra.Command, args []string) {
|
|
if showVersion {
|
|
logger := log.NewLogger("info", "")
|
|
logger.Info().Str("distribution-spec", distspec.Version).Str("commit", config.Commit).
|
|
Str("binary-type", config.BinaryType).Str("go version", config.GoVersion).Msg("version")
|
|
}
|
|
|
|
if len(args) == 0 {
|
|
_ = cmd.Usage()
|
|
cmd.SilenceErrors = false
|
|
|
|
return
|
|
}
|
|
|
|
url := ""
|
|
if len(args) > 0 {
|
|
url = args[0]
|
|
}
|
|
|
|
var err error
|
|
|
|
if requests < concurrency {
|
|
panic("requests cannot be less than concurrency")
|
|
}
|
|
|
|
var testRegex *regexp.Regexp
|
|
|
|
if testRegexStr != "" {
|
|
testRegex, err = regexp.Compile(testRegexStr)
|
|
if err != nil {
|
|
panic("Test filter regex was invalid: " + err.Error())
|
|
}
|
|
}
|
|
|
|
if listTests {
|
|
ListTests(testRegex)
|
|
|
|
return
|
|
}
|
|
|
|
requests = concurrency * (requests / concurrency)
|
|
|
|
Perf(workdir, url, auth, repo, concurrency, requests, outFmt, srcIPs, srcCIDR, skipCleanup, testRegex)
|
|
},
|
|
}
|
|
|
|
rootCmd.Flags().StringVarP(&auth, "auth-creds", "A", "",
|
|
"Use colon-separated BASIC auth creds")
|
|
rootCmd.Flags().StringVarP(&srcIPs, "src-ips", "i", "",
|
|
"Use colon-separated ips to make requests from, src-ips and src-cidr are mutually exclusive")
|
|
rootCmd.Flags().StringVarP(&srcCIDR, "src-cidr", "s", "",
|
|
"Use specified cidr to obtain ips to make requests from, src-ips and src-cidr are mutually exclusive")
|
|
rootCmd.Flags().StringVarP(&workdir, "working-dir", "d", "",
|
|
"Use specified directory to store test data")
|
|
rootCmd.Flags().StringVarP(&repo, "repo", "r", "",
|
|
"Use specified repo on remote registry for test data")
|
|
rootCmd.Flags().IntVarP(&concurrency, "concurrency", "c", 1,
|
|
"Number of multiple requests to make at a time")
|
|
rootCmd.Flags().IntVarP(&requests, "requests", "n", 1,
|
|
"Number of requests to perform")
|
|
rootCmd.Flags().StringVarP(&outFmt, "output-format", "o", "",
|
|
"Output format of test results: stdout (default), json, ci-cd")
|
|
rootCmd.Flags().BoolVar(&skipCleanup, "skip-cleanup", false,
|
|
"Skip clean up of pushed repos from remote registry after running benchmark (default false)")
|
|
rootCmd.Flags().StringVarP(&testRegexStr, "test-regex", "t", "",
|
|
"Optional regex for selectively running tests. If blank, all tests are run by default.")
|
|
rootCmd.Flags().BoolVarP(&listTests, "list-tests", "l", false,
|
|
"Print a list of all available tests. When used together with test regex, lists the tests that match the regex.")
|
|
|
|
// "version"
|
|
rootCmd.Flags().BoolVarP(&showVersion, "version", "v", false, "Show the version and exit")
|
|
|
|
return rootCmd
|
|
}
|
|
|
|
func main() {
|
|
if err := NewPerfRootCmd().Execute(); err != nil {
|
|
os.Exit(1)
|
|
}
|
|
}
|