-
Notifications
You must be signed in to change notification settings - Fork 95
/
lint.go
117 lines (94 loc) · 3.03 KB
/
lint.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
// Copyright 2023 Chainguard, 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 cli
import (
"context"
"fmt"
"slices"
"strings"
"github.com/chainguard-dev/clog"
"github.com/spf13/cobra"
"golang.org/x/sync/errgroup"
"chainguard.dev/melange/pkg/linter"
linter_defaults "chainguard.dev/melange/pkg/linter/defaults"
)
type LintOpts struct {
linters []string
}
func Lint() *cobra.Command {
o := LintOpts{}
var enabled, disabled []string
cmd := &cobra.Command{
Use: "lint",
Short: "EXPERIMENTAL COMMAND - Lints an APK, checking for problems and errors",
Long: `Lint is an EXPERIMENTAL COMMAND - Lints an APK file, checking for problems and errors.`,
Example: ` melange lint [--enable=foo[,bar]] [--disable=baz] foo.apk`,
Args: cobra.MinimumNArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
ctx := cmd.Context()
// Cheap and dirty way to handle duplicates
linterSet := map[string]struct{}{}
// Get all default linters, ignoring disabled ones
for _, e := range linter_defaults.GetDefaultLinters(linter_defaults.LinterClassApk) {
if !slices.Contains(disabled, e) {
linterSet[e] = struct{}{}
}
}
// Enable non-default lints
for _, e := range enabled {
if !slices.Contains(disabled, e) {
linterSet[e] = struct{}{}
}
}
// Collect
linters := []string{}
for e := range linterSet {
linters = append(linters, e)
}
badLints := linter.CheckValidLinters(linters)
if len(badLints) > 0 {
return fmt.Errorf("Unknwon linter(s): %s", strings.Join(badLints, ", "))
}
o.linters = linters
return o.RunAllE(ctx, args...)
},
}
cmd.Flags().StringSliceVar(&enabled, "enabled", []string{}, "enable additional, non-default lints, `--disabled` overrides this")
cmd.Flags().StringSliceVar(&disabled, "disabled", []string{}, "disable linters enabled by default or passed in `--enabled`")
return cmd
}
func (o LintOpts) RunAllE(ctx context.Context, pkgs ...string) error {
g, ctx := errgroup.WithContext(ctx)
for _, pkg := range pkgs {
p := pkg
g.Go(func() error {
return o.run(ctx, p)
})
}
return g.Wait()
}
func (o LintOpts) run(ctx context.Context, pkg string) error {
log := clog.FromContext(ctx)
log.Infof("Linting apk: %s\n", pkg)
var innerErr error
err := linter.LintApk(ctx, pkg, func(err error) {
innerErr = err
}, o.linters)
if err != nil {
return fmt.Errorf("package linter error in %s: %w\n", pkg, err)
} else if innerErr != nil {
log.Infof("package linter warning in %s: %v\n", pkg, innerErr)
}
return nil
}