-
Notifications
You must be signed in to change notification settings - Fork 1.4k
/
registry.go
254 lines (209 loc) · 6.9 KB
/
registry.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
/*
Copyright 2018 the Velero contributors.
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 clientmgmt
import (
"fmt"
"os"
"path/filepath"
"github.com/pkg/errors"
"github.com/sirupsen/logrus"
"github.com/vmware-tanzu/velero/pkg/plugin/framework"
"github.com/vmware-tanzu/velero/pkg/util/filesystem"
)
// Registry manages information about available plugins.
type Registry interface {
// DiscoverPlugins discovers all available plugins.
DiscoverPlugins() error
// List returns all PluginIdentifiers for kind.
List(kind framework.PluginKind) []framework.PluginIdentifier
// Get returns the PluginIdentifier for kind and name.
Get(kind framework.PluginKind, name string) (framework.PluginIdentifier, error)
}
// kindAndName is a convenience struct that combines a PluginKind and a name.
type kindAndName struct {
kind framework.PluginKind
name string
}
// registry implements Registry.
type registry struct {
// dir is the directory to search for plugins.
dir string
logger logrus.FieldLogger
logLevel logrus.Level
processFactory ProcessFactory
fs filesystem.Interface
pluginsByID map[kindAndName]framework.PluginIdentifier
pluginsByKind map[framework.PluginKind][]framework.PluginIdentifier
}
// NewRegistry returns a new registry.
func NewRegistry(dir string, logger logrus.FieldLogger, logLevel logrus.Level) Registry {
return ®istry{
dir: dir,
logger: logger,
logLevel: logLevel,
processFactory: newProcessFactory(),
fs: filesystem.NewFileSystem(),
pluginsByID: make(map[kindAndName]framework.PluginIdentifier),
pluginsByKind: make(map[framework.PluginKind][]framework.PluginIdentifier),
}
}
func (r *registry) DiscoverPlugins() error {
plugins, err := r.readPluginsDir(r.dir)
if err != nil {
return err
}
// Start by adding velero's internal plugins
commands := []string{os.Args[0]}
// Then add the discovered plugin executables
commands = append(commands, plugins...)
return r.discoverPlugins(commands)
}
func (r *registry) discoverPlugins(commands []string) error {
for _, command := range commands {
plugins, err := r.listPlugins(command)
if err != nil {
return err
}
for _, plugin := range plugins {
r.logger.WithFields(logrus.Fields{
"kind": plugin.Kind,
"name": plugin.Name,
"command": command,
}).Info("registering plugin")
if err := r.register(plugin); err != nil {
return err
}
}
}
return nil
}
// List returns info about all plugin binaries that implement the given
// PluginKind.
func (r *registry) List(kind framework.PluginKind) []framework.PluginIdentifier {
return r.pluginsByKind[kind]
}
// Get returns info about a plugin with the given name and kind, or an
// error if one cannot be found.
func (r *registry) Get(kind framework.PluginKind, name string) (framework.PluginIdentifier, error) {
p, found := r.pluginsByID[kindAndName{kind: kind, name: name}]
if !found {
return framework.PluginIdentifier{}, newPluginNotFoundError(kind, name)
}
return p, nil
}
// readPluginsDir recursively reads dir looking for plugins.
func (r *registry) readPluginsDir(dir string) ([]string, error) {
if _, err := r.fs.Stat(dir); err != nil {
if os.IsNotExist(err) {
return []string{}, nil
}
return nil, errors.WithStack(err)
}
files, err := r.fs.ReadDir(dir)
if err != nil {
return nil, errors.WithStack(err)
}
fullPaths := make([]string, 0, len(files))
for _, file := range files {
fullPath := filepath.Join(dir, file.Name())
if file.IsDir() {
subDirPaths, err := r.readPluginsDir(fullPath)
if err != nil {
return nil, err
}
fullPaths = append(fullPaths, subDirPaths...)
continue
}
if !executable(file) {
continue
}
fullPaths = append(fullPaths, fullPath)
}
return fullPaths, nil
}
// executable determines if a file is executable.
func executable(info os.FileInfo) bool {
/*
When we AND the mode with 0111:
- 0100 (user executable)
- 0010 (group executable)
- 0001 (other executable)
the result will be 0 if and only if none of the executable bits is set.
*/
return (info.Mode() & 0111) != 0
}
// listPlugins executes command, queries it for registered plugins, and returns the list of PluginIdentifiers.
func (r *registry) listPlugins(command string) ([]framework.PluginIdentifier, error) {
process, err := r.processFactory.newProcess(command, r.logger, r.logLevel)
if err != nil {
return nil, err
}
defer process.kill()
plugin, err := process.dispense(kindAndName{kind: framework.PluginKindPluginLister})
if err != nil {
return nil, err
}
lister, ok := plugin.(framework.PluginLister)
if !ok {
return nil, errors.Errorf("%T is not a PluginLister", plugin)
}
return lister.ListPlugins()
}
// register registers a PluginIdentifier with the registry.
func (r *registry) register(id framework.PluginIdentifier) error {
key := kindAndName{kind: id.Kind, name: id.Name}
if existing, found := r.pluginsByID[key]; found {
return newDuplicatePluginRegistrationError(existing, id)
}
// no need to pass list of existing plugins since the check if this exists was done above
if err := framework.ValidatePluginName(id.Name, nil); err != nil {
return errors.Errorf("invalid plugin name %q: %s", id.Name, err)
}
r.pluginsByID[key] = id
r.pluginsByKind[id.Kind] = append(r.pluginsByKind[id.Kind], id)
return nil
}
// pluginNotFoundError indicates a plugin could not be located for kind and name.
type pluginNotFoundError struct {
kind framework.PluginKind
name string
}
// newPluginNotFoundError returns a new pluginNotFoundError for kind and name.
func newPluginNotFoundError(kind framework.PluginKind, name string) *pluginNotFoundError {
return &pluginNotFoundError{
kind: kind,
name: name,
}
}
func (e *pluginNotFoundError) Error() string {
return fmt.Sprintf("unable to locate %v plugin named %s", e.kind, e.name)
}
type duplicatePluginRegistrationError struct {
existing framework.PluginIdentifier
duplicate framework.PluginIdentifier
}
func newDuplicatePluginRegistrationError(existing, duplicate framework.PluginIdentifier) *duplicatePluginRegistrationError {
return &duplicatePluginRegistrationError{
existing: existing,
duplicate: duplicate,
}
}
func (e *duplicatePluginRegistrationError) Error() string {
return fmt.Sprintf(
"unable to register plugin (kind=%s, name=%s, command=%s) because another plugin is already registered for this kind and name (command=%s)",
string(e.duplicate.Kind),
e.duplicate.Name,
e.duplicate.Command,
e.existing.Command,
)
}