-
Notifications
You must be signed in to change notification settings - Fork 786
/
upgrade_extensions.go
386 lines (350 loc) · 12.3 KB
/
upgrade_extensions.go
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
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
package cmd
import (
"bytes"
"fmt"
"io"
"io/ioutil"
"net/http"
"os"
"os/user"
"path/filepath"
"strings"
"time"
"github.com/jenkins-x/jx/pkg/extensions"
"github.com/pkg/errors"
"github.com/blang/semver"
"github.com/jenkins-x/jx/pkg/kube"
"github.com/jenkins-x/jx/pkg/util"
"github.com/jenkins-x/jx/pkg/log"
typev1 "github.com/jenkins-x/jx/pkg/client/clientset/versioned/typed/jenkins.io/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
jenkinsv1 "github.com/jenkins-x/jx/pkg/apis/jenkins.io/v1"
"github.com/ghodss/yaml"
"github.com/jenkins-x/jx/pkg/jx/cmd/templates"
"github.com/spf13/cobra"
"gopkg.in/AlecAivazis/survey.v1/terminal"
)
//const upstreamExtensionsRepositoryGitHub = "https://raw.githubusercontent.com/jenkins-x/jenkins-x-extensions/master/jenkins-x-extensions-repository.lock.yaml"
const upstreamExtensionsRepositoryGitHub = "github.com/jenkins-x/jenkins-x-extensions"
var (
upgradeExtensionsLong = templates.LongDesc(`
Upgrades the Jenkins X extensions available to this Jenkins X install if there are new versions available
`)
upgradeExtensionsExample = templates.Examples(`
# upgrade extensions
jx upgrade extensions
`)
)
type UpgradeExtensionsOptions struct {
CreateOptions
Filter string
ExtensionsRepositoryFile string
}
func NewCmdUpgradeExtensions(f Factory, in terminal.FileReader, out terminal.FileWriter, errOut io.Writer) *cobra.Command {
options := &UpgradeExtensionsOptions{
CreateOptions: CreateOptions{
CommonOptions: CommonOptions{
Factory: f,
In: in,
Out: out,
Err: errOut,
},
},
}
cmd := &cobra.Command{
Use: "extensions",
Short: "Upgrades the Jenkins X extensions available to this Jenkins X install if there are new versions available",
Long: upgradeExtensionsLong,
Example: upgradeBInariesExample,
Run: func(cmd *cobra.Command, args []string) {
options.Cmd = cmd
options.Args = args
err := options.Run()
CheckErr(err)
},
}
cmd.AddCommand(NewCmdUpgradeExtensionsRepository(f, in, out, errOut))
cmd.Flags().BoolVarP(&options.Verbose, "verbose", "", false, "Enable verbose logging")
cmd.Flags().StringVarP(&options.ExtensionsRepositoryFile, "extensions-repository-file", "", "", "Specify the extensions repository yaml file to read from")
return cmd
}
func (o *UpgradeExtensionsOptions) Run() error {
apisClient, err := o.ApiExtensionsClient()
if err != nil {
return err
}
err = kube.RegisterExtensionCRD(apisClient)
if err != nil {
return err
}
// Let's register the release CRD as charts built using Jenkins X use it, and it's very likely that people installing
// apps are using Helm
err = kube.RegisterReleaseCRD(apisClient)
if err != nil {
return err
}
kubeClient, curNs, err := o.KubeClientAndNamespace()
if err != nil {
return err
}
extensionsList, err := (&jenkinsv1.ExtensionConfigList{}).LoadFromConfigMap(extensions.ExtensionsConfigDefaultConfigMap, kubeClient, curNs)
if err != nil {
return err
}
if len(extensionsList.Extensions) > 0 {
if o.Verbose {
log.Infof("These extensions are configured for the team:\n")
for _, e := range extensionsList.Extensions {
log.Infof(" %s\n", util.ColorInfo(e.FullyQualifiedName()))
}
}
} else {
log.Warnf("No extensions are configured for the team\n")
}
extensionsRepository := jenkinsv1.ExtensionRepositoryLockList{}
var bs []byte
if o.ExtensionsRepositoryFile != "" {
path := o.ExtensionsRepositoryFile
// if it starts with a ~ it's the users homedir
if strings.HasPrefix(path, "~") {
usr, err := user.Current()
if err == nil {
path = filepath.Join(usr.HomeDir, strings.TrimPrefix(path, "~"))
}
}
// Perhaps it's an absolute file path
bs, err = ioutil.ReadFile(path)
if err != nil {
// Perhaps it's a relative path
cwd, err := os.Getwd()
if err != nil {
return err
}
log.Infof("Updating extensions from %s\n", path)
bs, err = ioutil.ReadFile(filepath.Join(cwd, path))
if err != nil {
return errors.New(fmt.Sprintf("Unable to open Extensions Repository at %s", path))
}
}
} else {
extensionsConfig, err := extensions.GetOrCreateExtensionsConfig(kubeClient, curNs)
if err != nil {
return err
}
current := jenkinsv1.ExtensionRepositoryReference{}
err = yaml.Unmarshal([]byte(extensionsConfig.Data[jenkinsv1.ExtensionsConfigRepository]), ¤t)
if err != nil {
return err
}
if current.Chart.Name != "" {
unpackDir, err := ioutil.TempDir("", "jenkins-x-extensions-chart")
if err != nil {
return err
}
if o.Verbose {
log.Infof("Using %s to unpack Helm Charts\n", util.ColorInfo(unpackDir))
}
chart := fmt.Sprintf("%s/%s", current.Chart.RepoName, current.Chart.Name)
log.Infof("Updating extensions from Helm Chart %s repo %s \n", util.ColorInfo(chart), util.ColorInfo(current.Chart.Repo))
err = o.Helm().FetchChart(chart, "", true, unpackDir, "", "", "")
if err != nil {
return err
}
path := filepath.Join(unpackDir, current.Chart.Name, "repository", "jenkins-x-extensions-repository.lock.yaml")
bs, err = ioutil.ReadFile(path)
if o.Verbose {
log.Infof("Extensions Repository Lock located at %s\n", util.ColorInfo(path))
}
if err != nil {
return fmt.Errorf("Unable to fetch Extensions Repository Helm Chart %s/%s because %v", current.Chart.RepoName, current.Chart.Name, err)
}
} else {
extensionsRepositoryUrl := current.Url
if extensionsRepositoryUrl == "" {
extensionsRepositoryUrl = upstreamExtensionsRepositoryGitHub
}
if current.GitHub != "" {
_, repoInfo, err := o.createGitProviderForURLWithoutKind(current.GitHub)
if err != nil {
return err
}
resolvedTag, err := util.GetLatestReleaseFromGitHub(repoInfo.Organisation, repoInfo.Name)
if err != nil {
return err
}
extensionsRepositoryUrl = fmt.Sprintf("https://raw.githubusercontent.com/%s/%s/%s/jenkins-x-extensions-repository.lock.yaml", repoInfo.Organisation, repoInfo.Name, resolvedTag)
}
log.Infof("Updating extensions from %s\n", extensionsRepositoryUrl)
httpClient := &http.Client{Timeout: 10 * time.Second}
resp, err := httpClient.Get(fmt.Sprintf("%s?version=%d", extensionsRepositoryUrl, time.Now().UnixNano()/int64(time.Millisecond)))
if err != nil {
return err
}
defer resp.Body.Close()
bs, err = ioutil.ReadAll(resp.Body)
if err != nil {
return err
}
}
}
err = yaml.Unmarshal(bs, &extensionsRepository)
if err != nil {
return err
}
log.Infof("Upgrading to Extension Repository version %s\n", util.ColorInfo(extensionsRepository.Version))
client, ns, err := o.JXClientAndDevNamespace()
if err != nil {
return err
}
extensionsClient := client.JenkinsV1().Extensions(ns)
availableExtensionsUUIDLookup := make(map[string]jenkinsv1.ExtensionSpec, 0)
for _, e := range extensionsRepository.Extensions {
availableExtensionsUUIDLookup[e.UUID] = e
}
installedExtensions, err := o.GetInstalledExtensions(extensionsClient)
if err != nil {
return err
}
// This will cause o.devNamespace to be populated
_, _, err = o.JXClientAndDevNamespace()
if err != nil {
return err
}
needsUpstalling := make([]jenkinsv1.ExtensionExecution, 0)
for _, e := range extensionsRepository.Extensions {
// TODO this is not very efficient probably
for _, c := range extensionsList.Extensions {
if c.Name == e.Name && c.Namespace == e.Namespace {
n, err := o.UpsertExtension(&e, extensionsClient, installedExtensions, c, availableExtensionsUUIDLookup, 0, 0)
if err != nil {
return err
}
needsUpstalling = append(needsUpstalling, n...)
break
}
}
}
// Before we start upstalling let's do a helm update, as extensions are likely to want it
err = o.Helm().UpdateRepo()
if err != nil {
return err
}
for _, n := range needsUpstalling {
envVars := ""
if len(n.EnvironmentVariables) > 0 {
envVarsFormatted := new(bytes.Buffer)
for _, envVar := range n.EnvironmentVariables {
fmt.Fprintf(envVarsFormatted, "%s=%s, ", envVar.Name, envVar.Value)
}
envVars = fmt.Sprintf("with environment variables [ %s ]", util.ColorInfo(strings.TrimSuffix(envVarsFormatted.String(), ", ")))
}
log.Infof("Preparing %s %s\n", util.ColorInfo(n.FullyQualifiedName()), envVars)
n.Execute(o.Verbose)
}
return nil
}
func (o *UpgradeExtensionsOptions) UpsertExtension(extension *jenkinsv1.ExtensionSpec, exts typev1.ExtensionInterface, installedExtensions map[string]jenkinsv1.Extension, extensionConfig jenkinsv1.ExtensionConfig, lookup map[string]jenkinsv1.ExtensionSpec, depth int, initialIndent int) (needsUpstalling []jenkinsv1.ExtensionExecution, err error) {
result := make([]jenkinsv1.ExtensionExecution, 0)
indent := ((depth - 1) * 2) + initialIndent
// TODO Validate extension
newVersion, err := semver.Parse(extension.Version)
if err != nil {
return result, err
}
existing, ok := installedExtensions[extension.UUID]
if !ok {
// Check for a name conflict
res, err := exts.Get(extension.FullyQualifiedKebabName(), metav1.GetOptions{})
if err == nil {
return result, errors.New(fmt.Sprintf("Extension %s has changed UUID. It used to have UUID %s and now has UUID %s. If this is correct, then you should manually remove the extension using\n"+
"\n"+
" kubectl delete ext %s\n"+
"\n"+
"If this is not correct, then contact the extension maintainer and inform them of this change.", util.ColorWarning(extension.FullyQualifiedName()), util.ColorWarning(res.Spec.UUID), util.ColorWarning(extension.UUID), extension.FullyQualifiedKebabName()))
}
// Doesn't exist
res, err = exts.Create(&jenkinsv1.Extension{
ObjectMeta: metav1.ObjectMeta{
Name: fmt.Sprintf(extension.FullyQualifiedKebabName()),
},
Spec: *extension,
})
if depth == 0 {
initialIndent = 7
log.Infof("Adding %s version %s\n", util.ColorInfo(extension.FullyQualifiedName()), util.ColorInfo(newVersion))
} else {
log.Infof("%s└ %s version %s\n", strings.Repeat(" ", indent), util.ColorInfo(extension.FullyQualifiedName()), util.ColorInfo(extension.Version))
}
if err != nil {
return result, err
}
if o.Contains(extension.When, jenkinsv1.ExtensionWhenInstall) {
e, _, err := extensions.ToExecutable(extension, extensionConfig.Parameters, o.devNamespace, exts)
if err != nil {
return result, err
}
result = append(result, e)
}
}
// TODO Handle uninstalling existing extension if name has changed but UUID hasn't
if existing.Spec.Version != "" {
existingVersion, err := semver.Parse(existing.Spec.Version)
if err != nil {
return result, err
}
if existingVersion.LT(newVersion) {
existing.Spec = *extension
_, err := exts.Update(&existing)
if err != nil {
return result, err
}
if o.Contains(extension.When, jenkinsv1.ExtensionWhenUpgrade) {
e, _, err := extensions.ToExecutable(extension, extensionConfig.Parameters, o.devNamespace, exts)
if err != nil {
return result, err
}
result = append(result, e)
}
if depth == 0 {
initialIndent = 10
log.Infof("Upgrading %s from %s to %s\n", util.ColorInfo(extension.FullyQualifiedName()), util.ColorInfo(existingVersion), util.ColorInfo(newVersion))
} else {
log.Infof("%s└ %s version %s\n", strings.Repeat(" ", indent), util.ColorInfo(extension.FullyQualifiedName()), util.ColorInfo(extension.Version))
}
}
}
for _, childRef := range extension.Children {
if child, ok := lookup[childRef]; ok {
e, err := o.UpsertExtension(&child, exts, installedExtensions, extensionConfig, lookup, depth+1, initialIndent)
if err != nil {
return result, err
}
result = append(result, e...)
} else {
errors.New(fmt.Sprintf("Unable to locate extension %s", childRef))
}
}
return result, nil
}
func (o *UpgradeExtensionsOptions) Contains(whens []jenkinsv1.ExtensionWhen, when jenkinsv1.ExtensionWhen) bool {
for _, w := range whens {
if when == w {
return true
}
}
return false
}
func (o *UpgradeExtensionsOptions) GetInstalledExtensions(extensions typev1.ExtensionInterface) (installedExtensions map[string]jenkinsv1.Extension, err error) {
exts, err := extensions.List(metav1.ListOptions{})
if err != nil {
return nil, err
}
installedExtensions = make(map[string]jenkinsv1.Extension)
for _, ext := range exts.Items {
if ext.Spec.UUID == "" {
return nil, errors.New(fmt.Sprintf("Extension %s does not have a UUID", util.ColorInfo(fmt.Sprintf("%s:%s", ext.Namespace, ext.Name))))
}
installedExtensions[ext.Spec.UUID] = ext
}
return installedExtensions, nil
}