-
Notifications
You must be signed in to change notification settings - Fork 21
/
tool.go
291 lines (250 loc) · 6.79 KB
/
tool.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
/*
Copyright 2023 Red Hat 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 internal
import (
"context"
"errors"
"io"
"log/slog"
"runtime"
"runtime/debug"
"slices"
"github.com/openshift-kni/oran-o2ims/internal/logging"
"github.com/spf13/cobra"
)
// ToolBuilder contains the data and logic needed to create an instance of the command line
// tool. Don't create instances of this directly, use the NewTool function instead.
type ToolBuilder struct {
logger *slog.Logger
sub []func() *cobra.Command
args []string
in io.Reader
out io.Writer
err io.Writer
}
// Tool is an instance of the command line tool. Don't create instances of this directly, use the
// NewTool function instead.
type Tool struct {
logger *slog.Logger
loggerOwned bool
cmd *cobra.Command
sub []func() *cobra.Command
args []string
in io.Reader
out io.Writer
err io.Writer
}
// NewTool creates a builder that can then be used to configure and create an instance of the
// command line tool.
func NewTool() *ToolBuilder {
return &ToolBuilder{}
}
// SetLogger sets the logger that the tool will use to write messages to the log. This is optional,
// and if not specified a new one will be created that writes JSON messages to a file `o2ims.log`
// file inside the tool cache directory.
func (b *ToolBuilder) SetLogger(value *slog.Logger) *ToolBuilder {
b.logger = value
return b
}
// AddCommand adds a sub-command.
func (b *ToolBuilder) AddCommand(value func() *cobra.Command) *ToolBuilder {
b.sub = append(b.sub, value)
return b
}
// AddCommands adds a list of sub-commands.
func (b *ToolBuilder) AddCommands(values ...func() *cobra.Command) *ToolBuilder {
b.sub = append(b.sub, values...)
return b
}
// AddArg adds one command line argument.
func (b *ToolBuilder) AddArg(value string) *ToolBuilder {
b.args = append(b.args, value)
return b
}
// AddArgs adds a list of command line arguments.
func (b *ToolBuilder) AddArgs(values ...string) *ToolBuilder {
b.args = append(b.args, values...)
return b
}
// SetArgs sets the list of command line arguments.
func (b *ToolBuilder) SetArgs(values ...string) *ToolBuilder {
b.args = slices.Clone(values)
return b
}
// SetIn sets the standard input stream. This is mandatory.
func (b *ToolBuilder) SetIn(value io.Reader) *ToolBuilder {
b.in = value
return b
}
// SetOut sets the standard output stream. This is mandatory.
func (b *ToolBuilder) SetOut(value io.Writer) *ToolBuilder {
b.out = value
return b
}
// SetErr sets the standard error output stream. This is mandatory.
func (b *ToolBuilder) SetErr(value io.Writer) *ToolBuilder {
b.err = value
return b
}
// Build uses the data stored in the buider to create a new instance of the command line tool.
func (b *ToolBuilder) Build() (result *Tool, err error) {
// Check parameters:
if len(b.args) == 0 {
err = errors.New(
"at least one command line argument (usually the name of the binary) is " +
"required",
)
return
}
if b.in == nil {
err = errors.New("standard input stream is mandatory")
return
}
if b.out == nil {
err = errors.New("standard output stream is mandatory")
return
}
if b.err == nil {
err = errors.New("standard error output stream is mandatory")
return
}
// Create and populate the object:
result = &Tool{
logger: b.logger,
sub: slices.Clone(b.sub),
args: slices.Clone(b.args),
in: b.in,
out: b.out,
err: b.err,
}
return
}
// Run rus the tool.
func (t *Tool) Run(ctx context.Context) error {
// Create the main command:
err := t.createCommand()
if err != nil {
return err
}
// Create a default logger that we can use while we haven't yet parsed the command line
// flags that contain the logging configuration.
if t.logger == nil {
t.logger, err = t.createDefaultLogger()
if err != nil {
return err
}
t.loggerOwned = true
}
// Execute the main command:
t.logger.InfoContext(
ctx,
"Command",
"args", t.args,
)
t.cmd.SetArgs(t.args[1:])
err = t.cmd.ExecuteContext(ctx)
if err != nil {
t.logger.ErrorContext(
ctx,
"Failed to run command",
"args", t.args,
"error", err,
)
}
return err
}
func (t *Tool) run(cmd *cobra.Command, args []string) error {
var err error
// Replace the default logger with one configured according to the command line options:
if t.loggerOwned {
t.logger, err = t.createConfiguredLogger()
if err != nil {
return err
}
}
// Populate the context:
ctx := cmd.Context()
ctx = ToolIntoContext(ctx, t)
ctx = LoggerIntoContext(ctx, t.logger)
cmd.SetContext(ctx)
// Write build information:
t.writeBuildInfo(ctx)
return nil
}
func (t *Tool) createCommand() error {
// Create the main command:
t.cmd = &cobra.Command{
Use: "o2ims",
Long: "O2 IMS",
PersistentPreRunE: t.run,
SilenceErrors: true,
SilenceUsage: true,
}
// Add flags that apply to all the commands:
flags := t.cmd.PersistentFlags()
logging.AddFlags(flags)
// Add sub-commands:
for _, sub := range t.sub {
t.cmd.AddCommand(sub())
}
return nil
}
func (t *Tool) createDefaultLogger() (result *slog.Logger, err error) {
result, err = logging.NewLogger().
SetOut(t.out).
SetErr(t.err).
Build()
return
}
func (t *Tool) createConfiguredLogger() (result *slog.Logger, err error) {
result, err = logging.NewLogger().
SetFlags(t.cmd.Flags()).
SetOut(t.out).
SetErr(t.err).
Build()
return
}
func (t *Tool) writeBuildInfo(ctx context.Context) {
// Retrieve the information:
buildInfo, ok := debug.ReadBuildInfo()
if !ok {
t.logger.InfoContext(ctx, "Build information isn't available")
return
}
// Extract the information that we need:
logFields := []any{
"go", buildInfo.GoVersion,
"os", runtime.GOOS,
"arch", runtime.GOARCH,
}
for _, buildSetting := range buildInfo.Settings {
switch buildSetting.Key {
case "vcs.revision":
logFields = append(logFields, "revision", buildSetting.Value)
case "vcs.time":
logFields = append(logFields, "time", buildSetting.Value)
}
}
// Write the information:
t.logger.InfoContext(ctx, "Build", logFields...)
}
// In returns the input stream of the tool.
func (t *Tool) In() io.Reader {
return t.in
}
// Out returns the output stream of the tool.
func (t *Tool) Out() io.Writer {
return t.out
}
// Err returns the error output stream of the tool.
func (t *Tool) Err() io.Writer {
return t.err
}