-
Notifications
You must be signed in to change notification settings - Fork 19
/
interface.go
145 lines (124 loc) · 3.98 KB
/
interface.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
/*
* Copyright 2022 Aspect Build Systems, Inc.
*
* 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 plugin
import (
"context"
"fmt"
"strings"
buildeventstream "aspect.build/cli/bazel/buildeventstream"
"aspect.build/cli/pkg/bazel"
"aspect.build/cli/pkg/ioutils"
"aspect.build/cli/pkg/plugin/sdk/v1alpha2/proto"
)
// Plugin determines how an aspect Plugin should be implemented.
type Plugin interface {
BEPEventCallback(event *buildeventstream.BuildEvent) error
CustomCommands() ([]*Command, error)
PostBuildHook(
isInteractiveMode bool,
promptRunner ioutils.PromptRunner,
) error
PostTestHook(
isInteractiveMode bool,
promptRunner ioutils.PromptRunner,
) error
PostRunHook(
isInteractiveMode bool,
promptRunner ioutils.PromptRunner,
) error
Setup(properties []byte) error
}
// Base satisfies the Plugin interface. For plugins that only implement a subset
// of the Plugin interface, using this as a base will give the advantage of not
// needing to implement the empty methods.
type Base struct{}
var _ Plugin = (*Base)(nil)
// Setup satisfies Plugin.Setup.
func (*Base) Setup([]byte) error {
return nil
}
// BEPEventCallback satisfies Plugin.BEPEventCallback.
func (*Base) BEPEventCallback(*buildeventstream.BuildEvent) error {
return nil
}
// CustomCommands satisfies Plugin.BEPEventCallback.
func (*Base) CustomCommands() ([]*Command, error) {
return nil, nil
}
// PostBuildHook satisfies Plugin.PostBuildHook.
func (*Base) PostBuildHook(bool, ioutils.PromptRunner) error {
return nil
}
// PostTestHook satisfies Plugin.PostTestHook.
func (*Base) PostTestHook(bool, ioutils.PromptRunner) error {
return nil
}
// PostRunHook satisfies Plugin.PostRunHook.
func (*Base) PostRunHook(bool, ioutils.PromptRunner) error {
return nil
}
// CustomCommandFn defines the parameters of that the Run functions will be called with.
type CustomCommandFn (func(ctx context.Context, args []string, bzl bazel.Bazel) error)
// Command defines the information needed to create a custom command that will be callable when
// running the CLI.
type Command struct {
*proto.Command
Run CustomCommandFn
}
// NewCommand is a wrapper around Command. Designed to be used as a cleaner way to make a Command
// given Command's nested proto
func NewCommand(
use string,
shortDesc string,
longDesc string,
run CustomCommandFn,
) *Command {
return &Command{
Command: &proto.Command{
Use: use,
ShortDesc: shortDesc,
LongDesc: longDesc,
},
Run: run,
}
}
// CommandManager is internal to the SDK and is used to manage custom commands that
// are provided by plugins.
type CommandManager interface {
Save(commands []*Command) error
Execute(command string, ctx context.Context, args []string) error
}
// PluginCommandManager is internal to the SDK and is used to manage custom commands that
// are provided by plugins.
type PluginCommandManager struct {
commands map[string]CustomCommandFn
}
// Save satisfies CommandManager.
func (cm *PluginCommandManager) Save(commands []*Command) error {
for _, cmd := range commands {
cmdName := strings.SplitN(cmd.Use, " ", 2)[0]
if _, exists := cm.commands[cmdName]; exists {
return fmt.Errorf("command %q is declared more than once by plugin", cmdName)
}
cm.commands[cmdName] = cmd.Run
}
return nil
}
// Execute satisfies CommandManager.
func (cm *PluginCommandManager) Execute(command string, ctx context.Context, args []string) error {
return cm.commands[command](ctx, args, bazel.WorkspaceFromWd)
}
var _ CommandManager = (*PluginCommandManager)(nil)