chore(dependencies): improve logging (#58)

Author: blackhatcrazy

.buildvars.yml

@@ -1,5 +1,5 @@
-go_version: "1.21"
-golangci_version: v1.55.2
-goreleaser_version: v1.16.2
+go_version: "1.24"
+golangci_version: v2.1.6
+goreleaser_version: v1.26.2
 
 coverage_min: 80

.github/workflows/ci.yaml

@@ -70,7 +70,7 @@ jobs:
         cache: false
     - name: Run golangci-lint
       # https://github.com/marketplace/actions/run-golangci-lint
-      uses: golangci/golangci-lint-action@v3
+      uses: golangci/golangci-lint-action@v8
       with:
         version: ${{ needs.variables.outputs.golangci_version }}
         args: --timeout 10m

.github/workflows/coverage-badge.yaml

@@ -40,7 +40,7 @@ jobs:
         with:
           go-version: ${{ needs.variables.outputs.go_version }}
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v4
         with:
           path: ~/go/pkg/mod
           key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}

.golangci.yaml

@@ -0,0 +1,120 @@
+version: "2"
+run:
+  tests: true
+output:
+  formats:
+    text:
+      path: stdout
+      print-linter-name: true
+      print-issued-lines: true
+    json:
+      path: stderr
+    checkstyle:
+      path: go-report.xml
+linters:
+  default: none
+  enable:
+    - depguard
+    - dupl
+    - errcheck
+    - gochecknoinits
+    # - gochecknoglobals
+    - goconst
+    - gocritic
+    - gocyclo
+    - govet
+    - ineffassign
+    - misspell
+    - nolintlint
+    - revive
+    - staticcheck
+  # disable:
+  #   - wsl
+  #   - nlreturn
+  #   - err113
+  #   - exhaustruct
+  #   - gochecknoglobals
+  #   - ireturn
+  #   - nonamedreturns
+  #   - varnamelen
+  #   - wrapcheck
+  settings:
+    depguard:
+      rules:
+        main:
+          deny:
+            - pkg: github.com/sirupsen/logrus
+              desc: logging is allowed only by the local log package
+            - pkg: logutils.Log
+              desc: logging is allowed only by the local log package
+    dupl:
+      threshold: 100
+    funlen:
+      lines: 100
+      statements: 50
+    goconst:
+      min-len: 2
+      min-occurrences: 3
+    gocritic:
+      disabled-checks:
+        - dupImport
+        - ifElseChain
+        - octalLiteral
+        - whyNoLint
+      enabled-tags:
+        - diagnostic
+        - experimental
+        - opinionated
+        - performance
+        - style
+    gocyclo:
+      min-complexity: 15
+    govet:
+      settings:
+        printf:
+          funcs:
+            - (github.com/golangci/golangci-lint/pkg/logutils.Log).Infof
+            - (github.com/golangci/golangci-lint/pkg/logutils.Log).Warnf
+            - (github.com/golangci/golangci-lint/pkg/logutils.Log).Errorf
+            - (github.com/golangci/golangci-lint/pkg/logutils.Log).Fatalf
+    lll:
+      line-length: 120
+    misspell:
+      locale: US
+    nolintlint:
+      require-explanation: true
+      require-specific: true
+      allow-unused: false
+    revive:
+      rules:
+        - name: unused-parameter
+          disabled: true
+  exclusions:
+    generated: lax
+    presets:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
+formatters:
+  enable:
+    - gci
+    - gofmt
+    - gofumpt
+    - goimports
+  settings:
+    gofumpt:
+      module-path: github.tools.sap/AI/forest-workload-operator/components/workload-operator
+    goimports:
+      local-prefixes:
+        - github.com/golangci/golangci-lint
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$

.golangci.yml

@@ -18,7 +18,15 @@ GOCACHE         ?=$(HOME)/.cache/go-build
 
 .PHONY: test
 test: ## Run unit tests in the code base outside of the tmp/ folder
-	test_dir="$(shell go list ./... | grep -v -e tmp/)"; go test -v -race $$test_dir -coverprofile -covermode=count -coverprofile=coverage.out fmt
+	test_dir="$(shell go list ./... | grep -v \
+		-e tmp \
+		-e pkg/log \
+		-e pkg/testfuncs \
+		-e pkg/version \
+		-e pkg/terminal \
+		-e pkg/github \
+		-r commands \
+	)"; go test -v -race $$test_dir -coverprofile -covermode=count -coverprofile=coverage.out fmt
 	go tool cover -func=coverage.out -o=coverage.out
 	cat coverage.out
 

.reuse/dep5

@@ -1,6 +1,6 @@
 # Configuration tools for GitOps
 
-![Coverage](https://img.shields.io/badge/Coverage-84.8%25-brightgreen)
+![Coverage](https://img.shields.io/badge/Coverage-63.4%25-yellow)
 [![REUSE status](https://api.reuse.software/badge/github.com/SAP/configuration-tools-for-gitops)](https://api.reuse.software/info/github.com/SAP/configuration-tools-for-gitops)
 
 ## About this project

Makefile

@@ -0,0 +1,11 @@
+version = 1
+SPDX-PackageName = "configuration-tools-for-gitops"
+SPDX-PackageSupplier = "jan.fokken@sap.com"
+SPDX-PackageDownloadLocation = "https://github.com/SAP/configuration-tools-for-gitops"
+SPDX-PackageComment = "The code in this project may include calls to APIs (\"API Calls\") of\n SAP or third-party products or services developed outside of this project\n (\"External Products\").\n \"APIs\" means application programming interfaces, as well as their respective\n specifications and implementing code that allows software to communicate with\n other software.\n API Calls to External Products are not licensed under the open source license\n that governs this project. The use of such API Calls and related External\n Products are subject to applicable additional agreements with the relevant\n provider of the External Products. In no event shall the open source license\n that governs this project grant any rights in or to any External Products,or\n alter, expand or supersede any terms of the applicable additional agreements.\n If you have a valid license agreement with SAP for the use of a particular SAP\n External Product, then you may make use of any API Calls included in this\n project's code for that SAP External Product, subject to the terms of such\n license agreement. If you do not have a valid license agreement for the use of\n a particular SAP External Product, then you may only make use of any API Calls\n in this project for that SAP External Product for your internal, non-productive\n and non-commercial test and evaluation of such API Calls. Nothing herein grants\n you any rights to use or access any SAP External Product, or provide any third\n parties the right to use of access any SAP External Product, through API Calls."
+
+[[annotations]]
+path = "**"
+precedence = "aggregate"
+SPDX-FileCopyrightText = "2023 SAP SE or an SAP affiliate company and configuration-tools-for-gitops contributors"
+SPDX-License-Identifier = "Apache-2.0"

README.md

@@ -13,7 +13,7 @@ import (
 )
 
 const (
-	allAllowed = 0777
+	allAllowed = 0o777
 )
 
 var (
@@ -24,7 +24,7 @@ var (
 )
 
 func newDependencies() *cobra.Command {
-	var c = &cobra.Command{
+	c := &cobra.Command{
 		Use:     "dependencies",
 		Aliases: []string{"deps"},
 		Short:   "Returns structured information which components and dependencies are affected by a change in git",