-
-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathtranslator.go
More file actions
302 lines (257 loc) · 7.16 KB
/
translator.go
File metadata and controls
302 lines (257 loc) · 7.16 KB
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
package managers
import (
"fmt"
"sort"
"github.com/git-pkgs/managers/definitions"
)
type Translator struct {
definitions map[string]*definitions.Definition
validators map[string]*definitions.Validator
}
func NewTranslator() *Translator {
return &Translator{
definitions: make(map[string]*definitions.Definition),
validators: make(map[string]*definitions.Validator),
}
}
func (t *Translator) Register(def *definitions.Definition) {
t.definitions[def.Name] = def
}
func (t *Translator) RegisterValidator(name string, v *definitions.Validator) {
t.validators[name] = v
}
func (t *Translator) Definition(name string) (*definitions.Definition, bool) {
def, ok := t.definitions[name]
return def, ok
}
type CommandInput struct {
Args map[string]string
Flags map[string]any
Extra []string // Raw arguments appended to the command (escape hatch)
}
func (t *Translator) BuildCommand(managerName, operation string, input CommandInput) ([]string, error) {
def, ok := t.definitions[managerName]
if !ok {
return nil, fmt.Errorf("unknown manager: %s", managerName)
}
cmd, ok := def.Commands[operation]
if !ok {
return nil, ErrUnsupportedOperation
}
return t.buildSingleCommand(def.Binary, cmd, input)
}
// BuildCommands returns all commands for an operation (including "then" chains)
func (t *Translator) BuildCommands(managerName, operation string, input CommandInput) ([][]string, error) {
def, ok := t.definitions[managerName]
if !ok {
return nil, fmt.Errorf("unknown manager: %s", managerName)
}
cmd, ok := def.Commands[operation]
if !ok {
return nil, ErrUnsupportedOperation
}
return t.buildCommandChain(def.Binary, cmd, input)
}
func (t *Translator) buildCommandChain(binary string, cmd definitions.Command, input CommandInput) ([][]string, error) {
first, err := t.buildSingleCommand(binary, cmd, input)
if err != nil {
return nil, err
}
result := [][]string{first}
for _, next := range cmd.Then {
nextCmd, err := t.buildSingleCommand(binary, next, input)
if err != nil {
return nil, err
}
result = append(result, nextCmd)
}
return result, nil
}
func (t *Translator) buildSingleCommand(binary string, cmd definitions.Command, input CommandInput) ([]string, error) {
args := []string{binary}
baseOverrideUsed := t.applyBaseOverrides(&args, cmd, input)
packageVal := input.Args["package"]
sortedArgs := t.sortArgs(cmd)
for _, entry := range sortedArgs {
val, err := t.processArg(entry.name, entry.argDef, input, &args)
if err != nil {
return nil, err
}
if val == "" {
continue
}
}
t.applyVersionSuffix(&args, cmd, input, packageVal)
args = append(args, cmd.DefaultFlags...)
t.applyUserFlags(&args, cmd, input, baseOverrideUsed)
args = append(args, input.Extra...)
return args, nil
}
type argEntry struct {
name string
argDef definitions.Arg
}
func (t *Translator) applyBaseOverrides(args *[]string, cmd definitions.Command, input CommandInput) string {
base := cmd.Base
baseOverrideUsed := ""
for flagName, override := range cmd.BaseOverrides {
if val, ok := input.Flags[flagName]; ok && isTruthy(val) {
base = override
baseOverrideUsed = flagName
break
}
}
*args = append(*args, base...)
return baseOverrideUsed
}
func (t *Translator) sortArgs(cmd definitions.Command) []argEntry {
var sorted []argEntry
for name, argDef := range cmd.Args {
sorted = append(sorted, argEntry{name, argDef})
}
sort.Slice(sorted, func(i, j int) bool {
iIsFlag := sorted[i].argDef.Flag != ""
jIsFlag := sorted[j].argDef.Flag != ""
if iIsFlag != jIsFlag {
return !iIsFlag
}
return sorted[i].argDef.Position < sorted[j].argDef.Position
})
return sorted
}
func (t *Translator) processArg(name string, argDef definitions.Arg, input CommandInput, args *[]string) (string, error) {
val, provided := input.Args[name]
if !provided {
if argDef.Required && !argDef.ExtractionOnly {
return "", ErrMissingArgument{Argument: name}
}
return "", nil
}
if argDef.ExtractionOnly {
return "", nil
}
if argDef.Validate != "" {
if err := t.validate(argDef.Validate, val); err != nil {
return "", err
}
}
switch {
case argDef.Flag != "":
*args = append(*args, argDef.Flag, val)
case argDef.FixedSuffix != "":
*args = append(*args, val+argDef.FixedSuffix)
case argDef.Suffix != "" && name == "version":
// Handled in applyVersionSuffix
default:
*args = append(*args, val)
}
return val, nil
}
func (t *Translator) applyVersionSuffix(args *[]string, cmd definitions.Command, input CommandInput, packageVal string) {
versionDef, hasVersion := cmd.Args["version"]
if !hasVersion || versionDef.Suffix == "" {
return
}
version, hasVersionVal := input.Args["version"]
if !hasVersionVal {
return
}
for i, a := range *args {
if a == packageVal {
(*args)[i] = a + versionDef.Suffix + version
break
}
}
}
func (t *Translator) applyUserFlags(args *[]string, cmd definitions.Command, input CommandInput, baseOverrideUsed string) {
for name, val := range input.Flags {
if val == false || val == "" || val == nil {
continue
}
if name == baseOverrideUsed {
continue
}
flagDef, ok := cmd.Flags[name]
if !ok {
continue
}
expanded := t.expandFlag(flagDef, input.Flags)
*args = append(*args, expanded...)
}
}
func (t *Translator) expandFlag(flag definitions.Flag, flags map[string]any) []string {
var result []string
for _, v := range flag.Values {
switch {
case v.Literal != "" && v.Field != "" && v.Join != "":
if val, ok := flags[v.Field]; ok {
if s, ok := val.(string); ok && s != "" {
result = append(result, v.Literal+v.Join+s)
}
}
case v.Literal != "":
result = append(result, v.Literal)
case v.Field != "":
if val, ok := flags[v.Field]; ok {
if s, ok := val.(string); ok && s != "" {
result = append(result, s)
}
}
}
}
return result
}
func (t *Translator) validate(validatorName, value string) error {
v, ok := t.validators[validatorName]
if !ok {
return nil
}
if v.MaxLength > 0 && len(value) > v.MaxLength {
return ErrInvalidPackageName{
Name: value,
Reason: fmt.Sprintf("exceeds maximum length of %d", v.MaxLength),
}
}
return nil
}
// ExitCodeMeaning returns the semantic meaning of an exit code for a
// manager/operation pair, as defined in the YAML. Returns "" if the
// manager, operation, or exit code is not defined.
func (t *Translator) ExitCodeMeaning(managerName, operation string, exitCode int) string {
def, ok := t.definitions[managerName]
if !ok {
return ""
}
cmd, ok := def.Commands[operation]
if !ok {
return ""
}
return cmd.ExitCodes[exitCode]
}
// IsFatalExitCode reports whether exitCode represents a fatal error for
// the given manager/operation. Exit code 0 is never fatal. For non-zero
// codes, the result is fatal unless the YAML definition assigns a
// non-"error" meaning.
func (t *Translator) IsFatalExitCode(managerName, operation string, exitCode int) bool {
if exitCode == 0 {
return false
}
meaning := t.ExitCodeMeaning(managerName, operation, exitCode)
if meaning == "" || meaning == "error" {
return true
}
return false
}
func isTruthy(val any) bool {
if val == nil {
return false
}
switch v := val.(type) {
case bool:
return v
case string:
return v != ""
default:
return true
}
}