feat: add golangci-lint configuration with pre-commit hooks to lint code

.github/workflows/lint_pr_title.yml

@@ -21,4 +21,4 @@ jobs:
     steps:
       - uses: amannn/action-semantic-pull-request@e9fabac35e210fea40ca5b14c0da95a099eff26f # v5
         env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/pr_ci.yml

@@ -12,6 +12,18 @@ on:
       - ready_for_review
 
 jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: stable
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v6
+        with:
+          version: v1.59
   ci:
     name: Continuous integration
     runs-on: ubuntu-latest
@@ -21,15 +33,15 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@v5
         with:
-          go-version: '1.21'
+          go-version: "1.22"
 
       - name: Download Go dependencies
         run: go get  ./... && go mod tidy
 
       - name: Check if all dependencies were commited
         shell: bash
         run: |
-          if [ "$(git status --porcelain)" ]; then 
+          if [ "$(git status --porcelain)" ]; then
            git status
            exit 1
           else
@@ -51,7 +63,7 @@ jobs:
       - name: Set up Go
         uses: actions/setup-go@cdcb36043654635271a94b9a6d1392de5bb323a7 # v5
         with:
-          go-version: '1.21'
+          go-version: "1.22"
 
       - name: Download Go dependencies
         run: go get  ./... && go mod tidy

.gitignore

@@ -18,4 +18,4 @@
 *.swp
 
 # IDE
-.idea/
+.idea/

.golangci.yaml

@@ -0,0 +1,43 @@
+linters:
+  enable:
+    - asasalint
+    - copyloopvar
+    - decorder
+    - dogsled
+    - errname
+    - exhaustive
+    - exportloopref
+    - fatcontext
+    - forcetypeassert
+    - gci
+    - ginkgolinter
+    - gofmt
+    - grouper
+    - importas
+    - makezero
+    - nakedret
+    - nilerr
+    - nilnil
+    - predeclared
+    - sloglint
+    #- wrapcheck  # this one will be useful, but we have to fix a multitude of errors
+    #- unparam  # when fixed, probably already covered by revive/gocritic
+    #- revive  # too many errors, but useful, similar to gocritic, so probably choose one
+    #- prealloc  # enable when can
+    #- nestif  # enable once we clean up the code
+    #- gofumpt  # fix all files before we switch to gofumpt
+    #- gocritic  # too many failures for now
+    #- goconst  # once we rewrite string literals to consts
+    #- gochecknoglobals  # once we rewrite terraform codegen and drop global functions
+    #- funlen  # couple of functions over 60 lines
+    #- err113  # disabled because of too many dynamic errors that don't wrap anything
+
+linters-settings:
+  gci:
+    sections:
+      - standard
+      - default
+      - prefix(github.com/paloaltonetworks/pan-os-codegen)
+issues:
+  exclude-dirs:
+    - generated/

.pre-commit-config.yaml

@@ -0,0 +1,10 @@
+repos:
+  - repo: https://github.com/golangci/golangci-lint/
+    rev: v1.59.1
+    hooks:
+      - id: golangci-lint
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v2.3.0
+    hooks:
+      - id: end-of-file-fixer
+      - id: trailing-whitespace

README.md

@@ -33,7 +33,7 @@ The code have run login in `cmd/codegen` directory, to run it with default optio
 go run cmd/codegen/main.go
 ```
 This command can be parametrizes using options:
-- `-t/-type` - operation type, default is to create both Terraform  
+- `-t/-type` - operation type, default is to create both Terraform
   - `mktp` - create only Terraform provider
   - `mksdk` - create only PAN-OS SDK
 - `config` - specify path for the config file, default is `cmd/codegen/config.yaml`
@@ -47,4 +47,4 @@ example code:
 go run cmd/codegen/main.go -t mksdk
 cd ../generated/pango
 PANOS_HOSTNAME='***' PANOS_USERNAME='***' PANOS_PASSWORD='***' go run example/main.go
-```
+```

SUPPORT.md

@@ -4,4 +4,4 @@ This template/script/solution is released “as-is”, with no warranty and no s
 supported and Palo Alto Networks may contribute its expertise at its discretion. Palo Alto Networks, including through
 its Authorized Support Centers (ASC) partners and backline support options, will not provide technical support or help
 in using or troubleshooting this template/script/solution. The underlying product used by this template/script/solution
-will still be supported in accordance with the product’s applicable support policy and the customer’s entitlements.
+will still be supported in accordance with the product’s applicable support policy and the customer’s entitlements.

assets/pango/go.mod

@@ -1,6 +1,6 @@
 module github.com/PaloAltoNetworks/pango
 
-go 1.21.4
+go 1.22
 
 require (
 	github.com/onsi/ginkgo/v2 v2.19.0

assets/terraform/go.mod

@@ -1,6 +1,6 @@
 module github.com/PaloAltoNetworks/terraform-provider-panos
 
-go 1.21.4
+go 1.22
 
 require (
 	github.com/PaloAltoNetworks/pango v0.10.3-0.20240408115758-216d8509e7cf

go.mod

@@ -10,4 +10,4 @@ require (
 	github.com/pmezard/go-difflib v1.0.0 // indirect
 )
 
-go 1.21.4
+go 1.22.5

pkg/commands/codegen/codegen.go

@@ -3,17 +3,17 @@ package codegen
 import (
 	"context"
 	"fmt"
+	"log"
+
 	"github.com/paloaltonetworks/pan-os-codegen/pkg/generate"
 	"github.com/paloaltonetworks/pan-os-codegen/pkg/load"
 	"github.com/paloaltonetworks/pan-os-codegen/pkg/properties"
-	"log"
 )
 
 type Command struct {
 	ctx          context.Context
 	args         []string
 	specs        []string
-	config       string
 	commandType  properties.CommandType
 	templatePath string
 }
@@ -42,7 +42,7 @@ func (c *Command) Setup() error {
 	if c.specs == nil {
 		c.specs, err = properties.GetNormalizations()
 		if err != nil {
-			return fmt.Errorf("error getting normalizations: %s", err)
+			return fmt.Errorf("error getting normalizations: %w", err)
 		}
 	}
 	return nil
@@ -58,12 +58,12 @@ func (c *Command) Execute() error {
 
 	content, err := load.File(configPath)
 	if err != nil {
-		return fmt.Errorf("error loading %s - %s", configPath, err)
+		return fmt.Errorf("error loading %s: %w", configPath, err)
 	}
 
 	config, err := properties.ParseConfig(content)
 	if err != nil {
-		return fmt.Errorf("error parsing %s - %s", configPath, err)
+		return fmt.Errorf("error parsing %s: %w", configPath, err)
 	}
 	var resourceList []string
 	var dataSourceList []string
@@ -72,16 +72,16 @@ func (c *Command) Execute() error {
 		log.Printf("Parsing %s...\n", specPath)
 		content, err := load.File(specPath)
 		if err != nil {
-			return fmt.Errorf("error loading %s - %s", specPath, err)
+			return fmt.Errorf("error loading %s: %w", specPath, err)
 		}
 
 		spec, err := properties.ParseSpec(content)
 		if err != nil {
-			return fmt.Errorf("error parsing %s - %s", specPath, err)
+			return fmt.Errorf("error parsing %s: %w", specPath, err)
 		}
 
 		if err = spec.Sanity(); err != nil {
-			return fmt.Errorf("%s sanity failed: %s", specPath, err)
+			return fmt.Errorf("%s sanity failed: %w", specPath, err)
 		}
 
 		if c.commandType == properties.CommandTypeTerraform {
@@ -90,7 +90,7 @@ func (c *Command) Execute() error {
 			terraformGenerator := generate.NewCreator(config.Output.TerraformProvider, c.templatePath, spec)
 			err = terraformGenerator.RenderTerraformProviderFile(newProviderObject, spec)
 			if err != nil {
-				return fmt.Errorf("error generating Terraform provider - %s", err)
+				return fmt.Errorf("error generating Terraform provider: %w", err)
 			}
 
 			resourceList = append(resourceList, newProviderObject.Resources...)
@@ -99,7 +99,7 @@ func (c *Command) Execute() error {
 		} else if c.commandType == properties.CommandTypeSDK {
 			generator := generate.NewCreator(config.Output.GoSdk, c.templatePath, spec)
 			if err = generator.RenderTemplate(); err != nil {
-				return fmt.Errorf("error rendering %s - %s", specPath, err)
+				return fmt.Errorf("error rendering %s: %w", specPath, err)
 			}
 		}
 
@@ -115,10 +115,13 @@ func (c *Command) Execute() error {
 
 		terraformGenerator := generate.NewCreator(config.Output.TerraformProvider, c.templatePath, providerSpec)
 		err = terraformGenerator.RenderTerraformProvider(newProviderObject, providerSpec, config.TerraformProviderConfig)
+		if err != nil {
+			return err
+		}
 	}
 
 	if err = generate.CopyAssets(config, c.commandType); err != nil {
-		return fmt.Errorf("error copying assets %s", err)
+		return fmt.Errorf("error copying assets %w", err)
 	}
 
 	log.Println("Generation complete.")

pkg/content/unmarshal.go

@@ -3,8 +3,9 @@ package content
 import (
 	"encoding/json"
 	"fmt"
-	"gopkg.in/yaml.v3"
 	"strings"
+
+	"gopkg.in/yaml.v3"
 )
 
 func Unmarshal(v []byte, o interface{}) error {

pkg/generate/generator_test.go

@@ -7,9 +7,10 @@ import (
 	"strings"
 	"testing"
 
-	"github.com/paloaltonetworks/pan-os-codegen/pkg/properties"
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
+
+	"github.com/paloaltonetworks/pan-os-codegen/pkg/properties"
 )
 
 func TestCreateFullFilePath(t *testing.T) {

pkg/naming/names_test.go

@@ -1,8 +1,9 @@
 package naming
 
 import (
-	"github.com/stretchr/testify/assert"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
 func TestCamelCase(t *testing.T) {

pkg/properties/config_test.go

@@ -1,8 +1,9 @@
 package properties
 
 import (
-	"github.com/stretchr/testify/assert"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
 func TestConfig(t *testing.T) {

pkg/translate/assignments_test.go

@@ -1,9 +1,11 @@
 package translate
 
 import (
-	"github.com/paloaltonetworks/pan-os-codegen/pkg/properties"
-	"github.com/stretchr/testify/assert"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
+
+	"github.com/paloaltonetworks/pan-os-codegen/pkg/properties"
 )
 
 func TestSpecifyEntryAssignmentForFlatStructure(t *testing.T) {

pkg/translate/funcs_test.go

@@ -1,9 +1,11 @@
 package translate
 
 import (
-	"github.com/paloaltonetworks/pan-os-codegen/pkg/properties"
-	"github.com/stretchr/testify/assert"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
+
+	"github.com/paloaltonetworks/pan-os-codegen/pkg/properties"
 )
 
 func TestGenerateEntryXpath(t *testing.T) {

pkg/translate/imports_test.go

@@ -1,8 +1,9 @@
 package translate
 
 import (
-	"github.com/stretchr/testify/assert"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
 func TestRenderImports(t *testing.T) {

pkg/translate/names_test.go

@@ -1,8 +1,9 @@
 package translate
 
 import (
-	"github.com/stretchr/testify/assert"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
 )
 
 func TestPackageName(t *testing.T) {

pkg/translate/structs_test.go

@@ -1,9 +1,11 @@
 package translate
 
 import (
-	"github.com/paloaltonetworks/pan-os-codegen/pkg/properties"
-	"github.com/stretchr/testify/assert"
 	"testing"
+
+	"github.com/stretchr/testify/assert"
+
+	"github.com/paloaltonetworks/pan-os-codegen/pkg/properties"
 )
 
 const sampleSpec = `name: 'Address'

pkg/translate/terraform_provider/struct.go

@@ -2,11 +2,12 @@ package terraform_provider
 
 import (
 	"fmt"
-	"github.com/paloaltonetworks/pan-os-codegen/pkg/naming"
-	"github.com/paloaltonetworks/pan-os-codegen/pkg/properties"
 	"log"
 	"strings"
 	"text/template"
+
+	"github.com/paloaltonetworks/pan-os-codegen/pkg/naming"
+	"github.com/paloaltonetworks/pan-os-codegen/pkg/properties"
 )
 
 // Package-level function map to avoid repetition in each function

pkg/translate/terraform_provider/struct_test.go

@@ -1,12 +1,14 @@
 package terraform_provider_test
 
 import (
+	"strings"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+
 	"github.com/paloaltonetworks/pan-os-codegen/pkg/naming"
 	"github.com/paloaltonetworks/pan-os-codegen/pkg/properties"
 	"github.com/paloaltonetworks/pan-os-codegen/pkg/translate/terraform_provider"
-	"github.com/stretchr/testify/assert"
-	"strings"
-	"testing"
 )
 
 func TestParamToModel(t *testing.T) {