1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
package main
import (
"context"
"fmt"
"runtime"
"github.com/argoproj-labs/argocd-image-updater/pkg/image"
"github.com/argoproj-labs/argocd-image-updater/pkg/kube"
"github.com/argoproj-labs/argocd-image-updater/pkg/log"
"github.com/argoproj-labs/argocd-image-updater/pkg/options"
"github.com/argoproj-labs/argocd-image-updater/pkg/registry"
"github.com/spf13/cobra"
"github.com/spf13/pflag"
"go.uber.org/ratelimit"
)
func newTestCommand() *cobra.Command {
var (
semverConstraint string
strategy string
registriesConfPath string
logLevel string
allowTags string
credentials string
kubeConfig string
disableKubernetes bool
ignoreTags []string
disableKubeEvents bool
rateLimit int
platforms []string
)
var runCmd = &cobra.Command{
Use: "test IMAGE",
Short: "Test the behaviour of argocd-image-updater",
Long: `
The test command lets you test the behaviour of argocd-image-updater before
configuring annotations on your Argo CD Applications.
Its main use case is to tell you to which tag a given image would be updated
to using the given parametrization. Command line switches can be used as a
way to supply the required parameters.
`,
Example: `
# In the most simple form, check for the latest available (semver) version of
# an image in the registry
argocd-image-updater test nginx
# Check to which version the nginx image within the 1.17 branch would be
# updated to, using the default semver strategy
argocd-image-updater test nginx --semver-constraint v1.17.x
# Check for the latest built image for a tag that matches a pattern
argocd-image-updater test nginx --allow-tags '^1.19.\d+(\-.*)*$' --update-strategy latest
`,
Run: func(cmd *cobra.Command, args []string) {
if len(args) != 1 {
cmd.HelpFunc()(cmd, args)
log.Fatalf("image needs to be specified")
}
if err := log.SetLogLevel(logLevel); err != nil {
log.Fatalf("could not set log level to %s: %v", logLevel, err)
}
var kubeClient *kube.KubernetesClient
var err error
if !disableKubernetes {
ctx := context.Background()
kubeClient, err = getKubeConfig(ctx, "", kubeConfig)
if err != nil {
log.Fatalf("could not create K8s client: %v", err)
}
}
img := image.NewFromIdentifier(args[0])
vc := &image.VersionConstraint{
Constraint: semverConstraint,
Strategy: image.StrategySemVer,
}
vc.Strategy = img.ParseUpdateStrategy(strategy)
if allowTags != "" {
vc.MatchFunc, vc.MatchArgs = img.ParseMatchfunc(allowTags)
}
vc.IgnoreList = ignoreTags
logCtx := img.LogContext()
logCtx.Infof("retrieving information about image")
vc.Options = options.NewManifestOptions()
for _, platform := range platforms {
os, arch, variant, err := image.ParsePlatform(platform)
if err != nil {
logCtx.Fatalf("Could not parse platform %s: %v", platform, err)
}
if os != "linux" && os != "windows" {
log.Warnf("Target platform is '%s/%s', but that's not a supported container platform. Forgot --platforms?", os, arch)
}
vc.Options = vc.Options.WithPlatform(os, arch, variant)
}
vc.Options = vc.Options.WithMetadata(vc.Strategy.NeedsMetadata())
vc.Options.WithLogger(logCtx.AddField("application", "test"))
if registriesConfPath != "" {
if err := registry.LoadRegistryConfiguration(registriesConfPath, false); err != nil {
logCtx.Fatalf("could not load registries configuration: %v", err)
}
}
ep, err := registry.GetRegistryEndpoint(img.RegistryURL)
if err != nil {
logCtx.Fatalf("could not get registry endpoint: %v", err)
}
if err := ep.SetEndpointCredentials(kubeClient); err != nil {
logCtx.Fatalf("could not set registry credentials: %v", err)
}
checkFlag := func(f *pflag.Flag) {
if f.Name == "rate-limit" {
logCtx.Infof("Overriding registry rate-limit to %d requests per second", rateLimit)
ep.Limiter = ratelimit.New(rateLimit)
}
}
cmd.Flags().Visit(checkFlag)
var creds *image.Credential
var username, password string
if credentials != "" {
credSrc, err := image.ParseCredentialSource(credentials, false)
if err != nil {
logCtx.Fatalf("could not parse credential definition '%s': %v", credentials, err)
}
creds, err = credSrc.FetchCredentials(ep.RegistryAPI, kubeClient)
if err != nil {
logCtx.Fatalf("could not fetch credentials: %v", err)
}
username = creds.Username
password = creds.Password
}
regClient, err := registry.NewClient(ep, username, password)
if err != nil {
logCtx.Fatalf("could not create registry client: %v", err)
}
logCtx.Infof("Fetching available tags and metadata from registry")
tags, err := ep.GetTags(img, regClient, vc)
if err != nil {
logCtx.Fatalf("could not get tags: %v", err)
}
logCtx.Infof("Found %d tags in registry", len(tags.Tags()))
upImg, err := img.GetNewestVersionFromTags(vc, tags)
if err != nil {
logCtx.Fatalf("could not get updateable image from tags: %v", err)
}
if upImg == nil {
logCtx.Infof("no newer version of image found")
return
}
logCtx.Infof("latest image according to constraint is %s", img.WithTag(upImg))
},
}
runCmd.Flags().StringVar(&semverConstraint, "semver-constraint", "", "only consider tags matching semantic version constraint")
runCmd.Flags().StringVar(&allowTags, "allow-tags", "", "only consider tags in registry that satisfy the match function")
runCmd.Flags().StringArrayVar(&ignoreTags, "ignore-tags", nil, "ignore tags in registry that match given glob pattern")
runCmd.Flags().StringVar(&strategy, "update-strategy", "semver", "update strategy to use, one of: semver, latest)")
runCmd.Flags().StringVar(®istriesConfPath, "registries-conf-path", "", "path to registries configuration")
runCmd.Flags().StringVar(&logLevel, "loglevel", "debug", "log level to use (one of trace, debug, info, warn, error)")
runCmd.Flags().BoolVar(&disableKubernetes, "disable-kubernetes", false, "whether to disable the Kubernetes client")
runCmd.Flags().StringVar(&kubeConfig, "kubeconfig", "", "path to your Kubernetes client configuration")
runCmd.Flags().StringVar(&credentials, "credentials", "", "the credentials definition for the test (overrides registry config)")
runCmd.Flags().StringSliceVar(&platforms, "platforms", []string{fmt.Sprintf("%s/%s", runtime.GOOS, runtime.GOARCH)}, "limit images to given platforms")
runCmd.Flags().BoolVar(&disableKubeEvents, "disable-kubernetes-events", false, "Disable kubernetes events")
runCmd.Flags().IntVar(&rateLimit, "rate-limit", 20, "specificy registry rate limit (overrides registry.conf)")
return runCmd
}
|
