.golangci.yml

version: "2"

run:
  timeout: 5m

formatters:
  settings:
     goimports:
      # Put VMware imports beginning with the following prefixes after any
      # third-party packages.
      local-prefixes:
      - github.com/vmware
      - github.com/vmware-tanzu
      - github.com/vmware-tanzu/vm-operator

linters:
  default: all
  disable:
  - asasalint         # 2
  - containedctx      # 3
  - contextcheck      # 50
  - cyclop            # 5
  - dupl              # 50
  - dupword           # 11
  - err113            # 50
  - errname           # 6
  - exhaustive        # 29
  - exhaustruct       # 50
  - exptostd          # 2
  - fatcontext        # 3
  - forbidigo         # 1
  - forcetypeassert   # 6
  - funcorder         # 50
  - funlen            # 50
  - ginkgolinter      # 38
  - gochecknoglobals  # 50
  - gochecknoinits    # 3
  - gocognit          # 43
  - godox             # 50
  - gomoddirectives   # 9
  - inamedparam       # 11
  - interfacebloat    # 2
  - intrange          # 4
  - ireturn           # 50
  - lll               # 50
  - loggercheck       # 2
  - maintidx          # 26
  - mirror            # 2
  - mnd               # 50
  - musttag           # 3
  - nestif            # 50
  - nilnil            # 3
  - nlreturn          # 9
  - noctx             # 4
  - nolintlint        # 5
  - nonamedreturns    # 23
  - nosprintfhostport # 3
  - paralleltest      # 50
  - perfsprint        # 7
  - recvcheck         # 5
  - tagalign          # 33
  - tagliatelle       # 8
  - testpackage       # 17
  - thelper           # 1
  - usestdlibvars     # 1
  - varnamelen        # 50
  - whitespace        # 6
  - wrapcheck         # 50
  - wsl               # 50

  settings:

    importas:
      alias:
        - alias: context
          pkg: context

        - alias: corev1
          pkg: k8s.io/api/core/v1
        - alias: metav1
          pkg: k8s.io/apimachinery/pkg/apis/meta/v1
        - alias: apiconversion
          pkg: k8s.io/apimachinery/pkg/conversion
        - alias: apierrors
          pkg: k8s.io/apimachinery/pkg/api/errors
        - alias: apierrorsutil
          pkg: k8s.io/apimachinery/pkg/util/errors

        - alias: ctrl
          pkg: sigs.k8s.io/controller-runtime
        - alias: ctrlcache
          pkg: sigs.k8s.io/controller-runtime/pkg/cache
        - alias: ctrlconversion
          pkg: sigs.k8s.io/controller-runtime/pkg/conversion
        - alias: ctrlclient
          pkg: sigs.k8s.io/controller-runtime/pkg/client
        - alias: ctrlmgr
          pkg: sigs.k8s.io/controller-runtime/pkg/manager

        - alias: vim25
          pkg: github.com/vmware/govmomi/vim25
        - alias: mo
          pkg: github.com/vmware/govmomi/vim25/mo
        - alias: pbmtypes
          pkg: github.com/vmware/govmomi/pbm/types
        - alias: vimtypes
          pkg: github.com/vmware/govmomi/vim25/types

        - alias: backupapi
          pkg: github.com/vmware-tanzu/vm-operator/pkg/backup/api

        - alias: vmopapi
          pkg: github.com/vmware-tanzu/vm-operator/api

        - alias: vmopv1a1
          pkg: github.com/vmware-tanzu/vm-operator/api/v1alpha1

        - alias: vmopv1a2
          pkg: github.com/vmware-tanzu/vm-operator/api/v1alpha2
        - alias: vmopv1a2cloudinit
          pkg: github.com/vmware-tanzu/vm-operator/api/v1alpha2/cloudinit
        - alias: vmopv1a2common
          pkg: github.com/vmware-tanzu/vm-operator/api/v1alpha2/common
        - alias: vmopv1a2sysprep
          pkg: github.com/vmware-tanzu/vm-operator/api/v1alpha2/sysprep

        - alias: vmopv1a3
          pkg: github.com/vmware-tanzu/vm-operator/api/v1alpha3
        - alias: vmopv1a3cloudinit
          pkg: github.com/vmware-tanzu/vm-operator/api/v1alpha3/cloudinit
        - alias: vmopv1a3common
          pkg: github.com/vmware-tanzu/vm-operator/api/v1alpha3/common
        - alias: vmopv1a3sysprep
          pkg: github.com/vmware-tanzu/vm-operator/api/v1alpha3/sysprep

        - alias: vmopv1a4
          pkg: github.com/vmware-tanzu/vm-operator/api/v1alpha4
        - alias: vmopv1a4cloudinit
          pkg: github.com/vmware-tanzu/vm-operator/api/v1alpha4/cloudinit
        - alias: vmopv1a4common
          pkg: github.com/vmware-tanzu/vm-operator/api/v1alpha4/common
        - alias: vmopv1a4sysprep
          pkg: github.com/vmware-tanzu/vm-operator/api/v1alpha4/sysprep

        - alias: vmopv1a5
          pkg: github.com/vmware-tanzu/vm-operator/api/v1alpha5
        - alias: vmopv1a5cloudinit
          pkg: github.com/vmware-tanzu/vm-operator/api/v1alpha5/cloudinit
        - alias: vmopv1a5common
          pkg: github.com/vmware-tanzu/vm-operator/api/v1alpha5/common
        - alias: vmopv1a5sysprep
          pkg: github.com/vmware-tanzu/vm-operator/api/v1alpha5/sysprep

        - alias: vmopv1
          pkg: github.com/vmware-tanzu/vm-operator/api/v1alpha6
        - alias: vmopv1cloudinit
          pkg: github.com/vmware-tanzu/vm-operator/api/v1alpha6/cloudinit
        - alias: vmopv1common
          pkg: github.com/vmware-tanzu/vm-operator/api/v1alpha6/common
        - alias: vmopv1sysprep
          pkg: github.com/vmware-tanzu/vm-operator/api/v1alpha6/sysprep

        - alias: vmopv1util
          pkg: github.com/vmware-tanzu/vm-operator/pkg/util/vmopv1

        - alias: byokv1
          pkg: github.com/vmware-tanzu/vm-operator/external/byok/api/v1alpha1
        - alias: capv1
          pkg: github.com/vmware-tanzu/vm-operator/external/capabilities/api/v1alpha1
        - alias: appv1a1
          pkg: github.com/vmware-tanzu/vm-operator/external/appplatform/api/v1alpha1
        - alias: vspherepolv1
          pkg: github.com/vmware-tanzu/vm-operator/external/vsphere-policy/api/v1alpha1
        - alias: infrav1
          pkg: github.com/vmware-tanzu/vm-operator/external/infra/api/v1alpha1
        - alias: vimv1
          pkg: github.com/vmware-tanzu/vm-operator/external/vim/api/v1alpha1

        - alias: proxyaddr
          pkg: github.com/vmware-tanzu/vm-operator/pkg/util/kube/proxyaddr
        - alias: pkgcrd
          pkg: github.com/vmware-tanzu/vm-operator/pkg/crd
        - alias: pkgcfg
          pkg: github.com/vmware-tanzu/vm-operator/pkg/config
        - alias: pkgcond
          pkg: github.com/vmware-tanzu/vm-operator/pkg/conditions
        - alias: pkgconst
          pkg: github.com/vmware-tanzu/vm-operator/pkg/constants
        - alias: pkgctx
          pkg: github.com/vmware-tanzu/vm-operator/pkg/context
        - alias: pkgerr
          pkg: github.com/vmware-tanzu/vm-operator/pkg/errors
        - alias: pkgexit
          pkg: github.com/vmware-tanzu/vm-operator/pkg/exit
        - alias: pkglog
          pkg: github.com/vmware-tanzu/vm-operator/pkg/log
        - alias: pkgnil
          pkg: github.com/vmware-tanzu/vm-operator/pkg/util/nil
        - alias: ctxop
          pkg: github.com/vmware-tanzu/vm-operator/pkg/context/operation
        - alias: pkgmgr
          pkg: github.com/vmware-tanzu/vm-operator/pkg/manager
        - alias: pkgutil
          pkg: github.com/vmware-tanzu/vm-operator/pkg/util
        - alias: proberctx
          pkg: github.com/vmware-tanzu/vm-operator/pkg/prober/context
        - alias: clsutil
          pkg: github.com/vmware-tanzu/vm-operator/pkg/util/vsphere/library
        - alias: kubeutil
          pkg: github.com/vmware-tanzu/vm-operator/pkg/util/kube

    depguard:
      rules:
        main:
          list-mode: lax # allow unless explicitly denied
          files:
          - $all
          - "!$test"
          - "!**/test/builder/*.go"
          - "!**/test/builder/log/*.go"
          - "!**/matcher.go"
          - "!**/pkg/util/kube/storage.go"
          allow:
          - $gostd
          - github.com/go-logr/logr
          - sigs.k8s.io/controller-runtime
          deny:
          - pkg: io/ioutil
            desc: "replaced by io and os packages since Go 1.16: https://tip.golang.org/doc/go1.16#ioutil"
          - pkg: github.com/pkg/errors
            desc: "replaced by stdlib errors package since Go.13: https://go.dev/blog/go1.13-errors"
          - pkg: k8s.io/utils
            desc: "replaced by internal packages like pkg/util/ptr"
          - pkg: testing
            desc: "do not import testing packages in non-test sources"
          - pkg: github.com/onsi/ginkgo$
            desc: "do not import testing packages in non-test sources"
          - pkg: github.com/onsi/ginkgo/v2
            desc: "do not import testing packages in non-test sources"
          - pkg: github.com/onsi/gomega
            desc: "do not import testing packages in non-test sources"

        #
        # This section is a duplicate of the main section, so please keep their
        # rules in lock-step. However, the one difference is files matched by
        # this section are allowed to import the "testing" package in order for
        # something in the file to determine if the code is being executed as
        # part of a test or not.
        #
        allow-testing-import:
          list-mode: lax # allow unless explicitly denied
          files:
          - "**/pkg/util/kube/storage.go"
          allow:
          - $gostd
          - github.com/go-logr/logr
          - sigs.k8s.io/controller-runtime
          deny:
          - pkg: io/ioutil
            desc: "replaced by io and os packages since Go 1.16: https://tip.golang.org/doc/go1.16#ioutil"
          - pkg: github.com/pkg/errors
            desc: "replaced by stdlib errors package since Go.13: https://go.dev/blog/go1.13-errors"
          - pkg: k8s.io/utils
            desc: "replaced by internal packages like pkg/util/ptr"
          - pkg: github.com/onsi/ginkgo$
            desc: "do not import testing packages in non-test sources"
          - pkg: github.com/onsi/ginkgo/v2
            desc: "do not import testing packages in non-test sources"
          - pkg: github.com/onsi/gomega
            desc: "do not import testing packages in non-test sources"

        test:
          list-mode: lax # allow unless explicitly denied
          files:
          - $test
          deny:
          - pkg: io/ioutil
            desc: "replaced by io and os packages since Go 1.16: https://tip.golang.org/doc/go1.16#ioutil"
          - pkg: github.com/pkg/errors
            desc: "replaced by stdlib errors package since Go.13: https://go.dev/blog/go1.13-errors"
          - pkg: k8s.io/utils
            desc: "replaced by internal packages like pkg/util/ptr"
          - pkg: github.com/onsi/ginkgo$
            desc: "replaced by github.com/onsi/ginkgo/v2"
        test-builder:
          list-mode: lax # allow unless explicitly denied
          files:
          - "**/test/builder/*.go"
          - "**/matcher.go"
          - "!$test"
          deny:
          - pkg: io/ioutil
            desc: "replaced by io and os packages since Go 1.16: https://tip.golang.org/doc/go1.16#ioutil"
          - pkg: github.com/pkg/errors
            desc: "replaced by stdlib errors package since Go.13: https://go.dev/blog/go1.13-errors"
          - pkg: k8s.io/utils
            desc: "replaced by internal packages like pkg/util/ptr"
          - pkg: github.com/onsi/ginkgo$
            desc: "replaced by github.com/onsi/ginkgo/v2"

  exclusions:
    generated: lax
    warn-unused: true

    paths:
    - external
    - pkg/util/cloudinit/schema
    - pkg/util/netplan/schema
    - ".*generated.*\\.go"

    rules:

    # TODO: Stop excluding ST1000 once the issue has been resolved.
    - linters:
      - golint
      text: "ST1000: at least one file in a package should have a package comment"

    - linters:
      - staticcheck
      text: "^SA1019: corev1.(Endpoints|EndpointSubset) is deprecated: This API is deprecated in v1.33+.*"
    - linters:
      - staticcheck
      text: "^SA1019: [^.]+.Wait is deprecated: Please use WaitEx instead."
    - linters:
      - staticcheck
      text: "^SA1019: [^.]+.WaitForResult is deprecated: Please use WaitForResultEx instead."
    - linters:
      - staticcheck
      text: "^SA1019: .*TCPSocket is deprecated"
    - linters:
      - staticcheck
      text: "^SA1019: c?vmiAfter.Status.ContentLibraryRef is deprecated"
    - linters:
      - staticcheck
      text: "QF1008: could remove embedded field"
    - linters:
      - staticcheck
      text: "QF1003: could use tagged switch"

    - linters:
      - revive
      text: ".*should have (a package )?comment.*"
    - linters:
      - revive
      text: "^exported: comment on exported const"

    - linters:
      - revive
      text: "unused-parameter: parameter"

    - linters:
      - govet
      text: "printf: non-constant format string in call"

    # Dot imports for gomega or ginkgo are allowed within test files.
    - path: test/builder/intg_test_context.go
      text: should not use dot imports
    - path: test/builder/test_suite.go
      text: should not use dot imports
    - path: test/builder/vcsim_test_context.go
      text: should not use dot imports
    - path: _test.go
      text: should not use dot imports

    # All of our webhooks follow the pattern of passing the webhook context
    # which contains fields like the Client. Ignore the linter warnings for now.
    - path: webhooks/
      text: ".* ctx is unused"
      linters:
      - unparam
    - path: _test.go
      linters:
      - depguard
      - gosec

    - path: pkg/config/env/env.go
      linters:
      - gocyclo
    - path: pkg/providers/vsphere/vmlifecycle/update_status.go
      linters:
      - gocyclo

    # Ignore underscores in conversion function names as required by K8s API.
    - path: "_conversion.go"
      text: ".*use underscores in Go names"

    # Ignore unsafe.Pointer() calls used in conversion functions.
    - path: "_conversion.go"
      text: "G103: Use of unsafe calls should be audited"

    # Ignore different receiver names in conversion functions (e.g. src vs dst).
    - path: "_conversion.go"
      text: ".*receiver name"

    - path: "test/e2e"
      linters:
        - revive
        - gosec
        - prealloc
        - wsl
        - wsl_v5
        - gocritic
        - gocyclo
        - noinlineerr
        - makezero
        - modernize
        - gocheckcompilerdirectives
        - embeddedstructcheck
        - importas
        - ineffassign
        - goconst
        - depguard
        - godoclint
        # E2E tests use . imports for gomega or ginkgo.
        - staticcheck