Skip to content

Commit e1a99f6

Browse files
mkcpAustinAbro321
andauthored
feat: add linter (2949) (#3053)
Signed-off-by: Kit Patella <[email protected]> Co-authored-by: Austin Abro <[email protected]>
1 parent 3f2ed2c commit e1a99f6

File tree

6 files changed

+28
-18
lines changed

6 files changed

+28
-18
lines changed

.golangci.yaml

+6-2
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@ linters-settings:
5959
testifylint:
6060
enable-all: true
6161
errcheck:
62+
check-blank: true
6263
check-type-assertions: true
6364
exclude-functions:
6465
- (*github.com/spf13/cobra.Command).Help
@@ -68,10 +69,13 @@ linters-settings:
6869
issues:
6970
# Revive rules that are disabled by default.
7071
include:
72+
- EXC0001
7173
- EXC0012
7274
- EXC0013
7375
- EXC0014
7476
- EXC0015
75-
# Exclude linting code copied from Helm.
7677
exclude-dirs:
77-
- "src/cmd/tools/helm"
78+
- "src/cmd/tools/helm" # Exclude linting code copied from Helm.
79+
- "src/internal/packager"
80+
- "src/pkg/packager" # TODO(mkcp): Delete packager rules once refactor is complete
81+
- "src/internal/packager2" # TODO(mkcp): Delete packager rules once refactor is complete

src/cmd/package.go

+12-6
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ var packageMirrorCmd = &cobra.Command{
128128
pkgConfig.PkgOpts.SkipSignatureValidation = true
129129
}
130130
},
131-
RunE: func(cmd *cobra.Command, args []string) error {
131+
RunE: func(cmd *cobra.Command, args []string) (err error) {
132132
var c *cluster.Cluster
133133
if dns.IsServiceURL(pkgConfig.InitOpts.RegistryInfo.Address) || dns.IsServiceURL(pkgConfig.InitOpts.GitServer.Address) {
134134
var err error
@@ -157,8 +157,11 @@ var packageMirrorCmd = &cobra.Command{
157157
if err != nil {
158158
return err
159159
}
160-
//nolint: errcheck // ignore
161-
defer pkgLayout.Cleanup()
160+
defer func() {
161+
// Cleanup package files
162+
err = errors.Join(err, pkgLayout.Cleanup())
163+
}()
164+
162165
mirrorOpt := packager2.MirrorOptions{
163166
Cluster: c,
164167
PkgLayout: pkgLayout,
@@ -194,7 +197,7 @@ var packageInspectCmd = &cobra.Command{
194197
return err
195198
}
196199

197-
cluster, _ := cluster.NewCluster()
200+
cluster, _ := cluster.NewCluster() //nolint:errcheck
198201
inspectOpt := packager2.ZarfInspectOptions{
199202
Source: src,
200203
SkipSignatureValidation: pkgConfig.PkgOpts.SkipSignatureValidation,
@@ -211,7 +214,10 @@ var packageInspectCmd = &cobra.Command{
211214
return fmt.Errorf("failed to inspect package: %w", err)
212215
}
213216
for _, image := range output {
214-
fmt.Fprintln(os.Stdout, "-", image)
217+
_, err := fmt.Fprintln(os.Stdout, "-", image)
218+
if err != nil {
219+
return err
220+
}
215221
}
216222
}
217223

@@ -291,7 +297,7 @@ var packageRemoveCmd = &cobra.Command{
291297
filters.ByLocalOS(runtime.GOOS),
292298
filters.BySelectState(pkgConfig.PkgOpts.OptionalComponents),
293299
)
294-
cluster, _ := cluster.NewCluster()
300+
cluster, _ := cluster.NewCluster() //nolint:errcheck
295301
removeOpt := packager2.RemoveOptions{
296302
Source: packageSource,
297303
Cluster: cluster,

src/pkg/utils/cosign.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -233,14 +233,14 @@ func GetCosignArtifacts(image string) ([]string, error) {
233233

234234
// Return empty if we don't have a signature on the image
235235
var remoteOpts []ociremote.Option
236-
simg, _ := ociremote.SignedEntity(ref, remoteOpts...) // TODO(mkcp): //nolint:errcheck
236+
simg, _ := ociremote.SignedEntity(ref, remoteOpts...) //nolint:errcheck
237237
if simg == nil {
238238
return nil, nil
239239
}
240240

241241
// Errors are dogsled because these functions always return a name.Tag which we can check for layers
242-
sigRef, _ := ociremote.SignatureTag(ref, remoteOpts...) // TODO(mkcp): //nolint:errcheck
243-
attRef, _ := ociremote.AttestationTag(ref, remoteOpts...) // TODO(mkcp): //nolint:errcheck
242+
sigRef, _ := ociremote.SignatureTag(ref, remoteOpts...) //nolint:errcheck
243+
attRef, _ := ociremote.AttestationTag(ref, remoteOpts...) //nolint:errcheck
244244

245245
ss, err := simg.Signatures()
246246
if err != nil {

src/test/e2e/20_zarf_init_test.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -104,8 +104,8 @@ func TestZarfInit(t *testing.T) {
104104
verifyZarfServiceLabels(t)
105105

106106
// Special sizing-hacking for reducing resources where Kind + CI eats a lot of free cycles (ignore errors)
107-
_, _, _ = e2e.Kubectl(t, "scale", "deploy", "-n", "kube-system", "coredns", "--replicas=1") // TODO(mkcp): intentionally ignored, mark nolint
108-
_, _, _ = e2e.Kubectl(t, "scale", "deploy", "-n", "zarf", "agent-hook", "--replicas=1") // TODO(mkcp): intentionally ignored, mark nolint
107+
_, _, _ = e2e.Kubectl(t, "scale", "deploy", "-n", "kube-system", "coredns", "--replicas=1") //nolint:errcheck
108+
_, _, _ = e2e.Kubectl(t, "scale", "deploy", "-n", "zarf", "agent-hook", "--replicas=1") //nolint:errcheck
109109
}
110110

111111
func checkLogForSensitiveState(t *testing.T, logText string, zarfState types.ZarfState) {

src/test/e2e/28_wait_test.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ func TestNoWait(t *testing.T) {
5151
case <-time.After(30 * time.Second):
5252
t.Error("Timeout waiting for zarf deploy (it tried to wait)")
5353
t.Log("Removing hanging namespace...")
54-
_, _, _ = e2e.Kubectl(t, "delete", "namespace", "no-wait", "--force=true", "--wait=false", "--grace-period=0") // TODO(mkcp): intentionally ignored, mark nolint
54+
_, _, _ = e2e.Kubectl(t, "delete", "namespace", "no-wait", "--force=true", "--wait=false", "--grace-period=0") //nolint:errcheck
5555
}
5656
require.NoError(t, err, stdOut, stdErr)
5757

src/test/external/ext_out_cluster_test.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -57,10 +57,10 @@ func (suite *ExtOutClusterTestSuite) SetupSuite() {
5757
// Teardown any leftovers from previous tests
5858
// NOTE(mkcp): We dogsled these errors because some of these commands will error if they don't cleanup a resource,
5959
// which is ok. A better solution would be checking for none or unexpected kinds of errors.
60-
_ = exec.CmdWithPrint("k3d", "cluster", "delete", clusterName) // TODO(mkcp): intentionally ignored, mark nolint
61-
_ = exec.CmdWithPrint("k3d", "registry", "delete", registryHost) // TODO(mkcp): intentionally ignored, mark nolint
62-
_ = exec.CmdWithPrint("docker", "compose", "down") // TODO(mkcp): intentionally ignored, mark nolint
63-
_ = exec.CmdWithPrint("docker", "network", "remove", network) // TODO(mkcp): intentionally ignored, mark nolint
60+
_ = exec.CmdWithPrint("k3d", "cluster", "delete", clusterName) //nolint:errcheck
61+
_ = exec.CmdWithPrint("k3d", "registry", "delete", registryHost) //nolint:errcheck
62+
_ = exec.CmdWithPrint("docker", "compose", "down") //nolint:errcheck
63+
_ = exec.CmdWithPrint("docker", "network", "remove", network) //nolint:errcheck
6464

6565
// Setup a network for everything to live inside
6666
err := exec.CmdWithPrint("docker", "network", "create", "--driver=bridge", "--subnet="+subnet, "--gateway="+gateway, network)

0 commit comments

Comments
 (0)