/
legacy_keys.go
93 lines (80 loc) · 2.9 KB
/
legacy_keys.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
// Copyright 2021 The Operator-SDK Authors
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package util
import (
"errors"
log "github.com/sirupsen/logrus"
gofunk "github.com/thoas/go-funk"
"sigs.k8s.io/kubebuilder/v3/pkg/config"
cfgv3 "sigs.k8s.io/kubebuilder/v3/pkg/config/v3"
)
const (
// The catch-all plugin key for the go/v2+manifests+scorecard plugins.
// Should still be accepted for backwards-compat.
legacyGoPluginKey = "go.sdk.operatorframework.io/v2-alpha"
legacyGoPluginAlphaKey = "go.sdk.operatorframework.io/v2-alpha"
// Hard-code the latest manifests and scorecard keys here to avoid a circular import.
manifestsKey = "manifests.sdk.operatorframework.io/v2"
scorecardKey = "scorecard.sdk.operatorframework.io/v2"
)
// Plugin keys that existed when manifests/scorecard keys did not.
var acceptedLayoutKeys = []string{
"ansible.sdk.operatorframework.io/v1",
"helm.sdk.operatorframework.io/v1",
}
// UpdateIfLegacyKey returns true if c's "plugins" map or "layout" value contains
// a legacy key that may require this plugin be executed, even if the "manifests" key
// isn't in "plugins".
func UpdateIfLegacyKey(c config.Config) bool {
if c.GetVersion().Compare(cfgv3.Version) < 0 {
return false
}
if IsGolangLegacyLayout(c) {
return true
}
chain := c.GetPluginChain()
for _, key := range acceptedLayoutKeys {
if gofunk.ContainsString(chain, key) {
// Encode missing plugin keys.
if !gofunk.ContainsString(chain, manifestsKey) {
if err := c.EncodePluginConfig(manifestsKey, struct{}{}); err != nil {
log.Error(err)
}
}
if !gofunk.ContainsString(chain, scorecardKey) {
if err := c.EncodePluginConfig(scorecardKey, struct{}{}); err != nil {
log.Error(err)
}
}
return true
}
}
return false
}
// IsGolangLegacyLayout returns true if c's does not have the plugins
// configuration.
func IsGolangLegacyLayout(c config.Config) bool {
err := c.DecodePluginConfig(legacyGoPluginKey, struct{}{})
if err == nil || !errors.As(err, &config.PluginKeyNotFoundError{}) {
// There is no way to remove keys from "plugins", so print a warning.
log.Warnf("Plugin key %q is deprecated. Replace this key with %q and %q on separate lines.",
legacyGoPluginKey, manifestsKey, scorecardKey)
return true
}
err = c.DecodePluginConfig(legacyGoPluginAlphaKey, struct{}{})
if err == nil || !errors.As(err, &config.PluginKeyNotFoundError{}) {
return true
}
return false
}