update .golangci.yml (#344)

* update .golangci.yml Signed-off-by: adisos <[email protected]> * update headers Signed-off-by: adisos <[email protected]> * lint fix: the type name connlistAnalyzerWarning should conform to the xxxError format Signed-off-by: adisos <[email protected]> --------- Signed-off-by: adisos <[email protected]>
np-guard · May 6, 2024 · 1e64c08 · 1e64c08
1 parent 15fa943
commit 1e64c08
Show file tree

Hide file tree

Showing 56 changed files with 351 additions and 194 deletions.
diff --git a/.golangci.yml b/.golangci.yml
@@ -5,7 +5,7 @@ linters-settings:
     lines: 100
     statements: 50
   gci:
-    local-prefixes: github.com/np-guard
+    prefix: github.com/np-guard
   goconst:
     min-len: 2
     min-occurrences: 2
@@ -18,18 +18,24 @@ linters-settings:
       - style
   gocyclo:
     min-complexity: 15
+  goheader:
+    values:
+      const:
+        COMPANY: IBM Inc.
+    template: |-
+      Copyright 2023- {{ COMPANY }} All Rights Reserved.
+
+      SPDX-License-Identifier: Apache-2.0
   goimports:
     local-prefixes: github.com/np-guard
   mnd:
-    settings:
-      mnd:
-        # don't include the "operation" and "assign"
-        checks: argument,case,condition,return
-        ignored-numbers: 0,1,2,3
-        ignored-functions: strings.SplitN
+      # don't include the "operation" and "assign"
+      checks: argument,case,condition,return
+      ignored-numbers: 0,1,2,3
+      ignored-functions: strings.SplitN
 
   govet:
-    check-shadowing: true
+    shadow: true
   lll:
     line-length: 140
   misspell:
@@ -70,6 +76,7 @@ linters:
     - dupl
     - durationcheck
     - errcheck
+    - errname
     - errorlint
     - exportloopref
     - funlen
@@ -79,6 +86,7 @@ linters:
     - gocritic
     - gocyclo
     - gofmt
+    - goheader
     - goimports
     - mnd
     - gomoddirectives
@@ -108,7 +116,6 @@ linters:
     - tagliatelle
     - tenv
     - testableexamples
-    - tparallel
     - typecheck
     - unconvert
     - unparam
@@ -124,7 +131,9 @@ issues:
        - revive
        - goconst
        - funlen
-       - errcheck
-
+
 run:
   timeout: 5m
+
+output:
+  print-issued-lines: false
diff --git a/cmd/netpolicy/main.go b/cmd/netpolicy/main.go
@@ -1,16 +1,9 @@
-// Copyright 2022
-//
-// 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.
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
 package main
 
 import (

diff --git a/pkg/cli/command_test.go b/pkg/cli/command_test.go
@@ -1,3 +1,9 @@
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
 package cli
 
 import (

diff --git a/pkg/cli/diff.go b/pkg/cli/diff.go
@@ -1,16 +1,9 @@
-// Copyright 2022
-//
-// 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.
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
 package cli
 
 import (

diff --git a/pkg/cli/evaluate.go b/pkg/cli/evaluate.go
@@ -1,16 +1,9 @@
-// Copyright 2022
-//
-// 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.
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
 package cli
 
 import (

diff --git a/pkg/cli/list.go b/pkg/cli/list.go
@@ -1,16 +1,9 @@
-// Copyright 2022
-//
-// 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.
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
 package cli
 
 import (

diff --git a/pkg/cli/root.go b/pkg/cli/root.go
@@ -1,16 +1,9 @@
-// Copyright 2022
-//
-// 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.
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
 package cli
 
 import (

diff --git a/pkg/internal/netpolerrors/netpol_errors.go b/pkg/internal/netpolerrors/netpol_errors.go
@@ -1,3 +1,9 @@
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
 package netpolerrors
 
 import "fmt"

diff --git a/pkg/internal/output/output.go b/pkg/internal/output/output.go
@@ -1,3 +1,9 @@
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
 package output
 
 import "os"

diff --git a/pkg/internal/projectpath/projectpath.go b/pkg/internal/projectpath/projectpath.go
@@ -1,3 +1,9 @@
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
 package projectpath
 
 import (

diff --git a/pkg/internal/testutils/testutils.go b/pkg/internal/testutils/testutils.go
@@ -1,3 +1,9 @@
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
 package testutils
 
 import (

diff --git a/pkg/logger/logger.go b/pkg/logger/logger.go
@@ -1,3 +1,9 @@
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
 package logger
 
 import (

diff --git a/pkg/manifests/fsscanner/manifests.go b/pkg/manifests/fsscanner/manifests.go
@@ -1,3 +1,9 @@
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
 package fsscanner
 
 import (

diff --git a/pkg/manifests/fsscanner/manifests_test.go b/pkg/manifests/fsscanner/manifests_test.go
@@ -1,3 +1,9 @@
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
 package fsscanner
 
 import (

diff --git a/pkg/manifests/parser/error_types.go b/pkg/manifests/parser/error_types.go
@@ -1,3 +1,9 @@
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
 package parser
 
 import (

diff --git a/pkg/manifests/parser/k8sobj.go b/pkg/manifests/parser/k8sobj.go
@@ -1,3 +1,9 @@
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
 package parser
 
 import (

diff --git a/pkg/manifests/parser/parser.go b/pkg/manifests/parser/parser.go
@@ -1,3 +1,9 @@
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
 package parser
 
 import (

diff --git a/pkg/netpol/connlist/connlist.go b/pkg/netpol/connlist/connlist.go
@@ -1,3 +1,9 @@
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
 // The connlist package of netpol-analyzer allows producing a k8s connectivity report based on several resources:
 // k8s NetworkPolicy, k8s Ingress, openshift Route
 // It lists the set of allowed connections between each pair of different peers (k8s workloads or ip-blocks).

diff --git a/pkg/netpol/connlist/connlist_errors.go b/pkg/netpol/connlist/connlist_errors.go
@@ -1,3 +1,9 @@
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
 package connlist
 
 import (
@@ -23,7 +29,7 @@ type resourceEvaluationError struct {
 	origErr error
 }
 
-type connlistAnalyzerWarning struct {
+type connlistAnalyzerWarnError struct {
 	origErr error
 }
 
@@ -35,7 +41,7 @@ func (e *resourceEvaluationError) Error() string {
 	return e.origErr.Error()
 }
 
-func (e *connlistAnalyzerWarning) Error() string {
+func (e *connlistAnalyzerWarnError) Error() string {
 	return e.origErr.Error()
 }
 
@@ -70,5 +76,5 @@ func newResourceEvaluationError(err error) *connlistGeneratingError {
 }
 
 func newConnlistAnalyzerWarning(err error) *connlistGeneratingError {
-	return &connlistGeneratingError{err: &connlistAnalyzerWarning{err}, fatal: false, severe: false}
+	return &connlistGeneratingError{err: &connlistAnalyzerWarnError{err}, fatal: false, severe: false}
 }
diff --git a/pkg/netpol/connlist/connlist_test.go b/pkg/netpol/connlist/connlist_test.go
@@ -1,3 +1,9 @@
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
 package connlist
 
 import (

diff --git a/pkg/netpol/connlist/conns_formatter.go b/pkg/netpol/connlist/conns_formatter.go
@@ -1,3 +1,9 @@
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
 package connlist
 
 import (

diff --git a/pkg/netpol/connlist/conns_formatter_csv.go b/pkg/netpol/connlist/conns_formatter_csv.go
@@ -1,3 +1,9 @@
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
 package connlist
 
 import (

diff --git a/pkg/netpol/connlist/conns_formatter_dot.go b/pkg/netpol/connlist/conns_formatter_dot.go
@@ -1,3 +1,9 @@
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
 package connlist
 
 import (

diff --git a/pkg/netpol/connlist/conns_formatter_json.go b/pkg/netpol/connlist/conns_formatter_json.go
@@ -1,3 +1,9 @@
+/*
+Copyright 2023- IBM Inc. All Rights Reserved.
+
+SPDX-License-Identifier: Apache-2.0
+*/
+
 package connlist
 
 import "encoding/json"