mirror of
https://github.com/1Password/onepassword-operator.git
synced 2025-10-22 15:38:06 +00:00

* Move controller package inside internal directory Based on the go/v4 project structure, the following changed: - Pakcage `controllers` is now named `controller` - Package `controller` now lives inside new `internal` directory * Move main.go in cmd directory Based on the new go/v4 project structure, `main.go` now lives in the `cmd` directory. * Change package import in main.go * Update go mod dependencies Update the dependencies based on the versions obtained by creating a new operator project using `kubebuilder init --domain onepassword.com --plugins=go/v4`. This is based on the migration steps provided to go from go/v3 to go/v4 (https://book.kubebuilder.io/migration/migration_guide_gov3_to_gov4) * Update vendor * Adjust code for breaking changes from pkg update sigs.k8s.io/controller-runtime package had breaking changes from v0.14.5 to v0.16.3. This commit brings the changes needed to achieve the same things using the new functionality avaialble. * Adjust paths to connect yaml files Since `main.go` is now in `cmd` directory, the paths to the files for deploying Connect have to be adjusted based on the new location `main.go` is executed from. * Update files based on new structure and scaffolding These changes are made based on the new project structure and scaffolding obtained when using the new go/v4 project structure. These were done based on the migration steps mentioned when migrating to go/v4 (https://book.kubebuilder.io/migration/migration_guide_gov3_to_gov4). * Update config files These updates are made based on the Kustomize v4 syntax. This is part of the upgrate to go/v4 (https://book.kubebuilder.io/migration/migration_guide_gov3_to_gov4) * Update dependencies and GO version * Update vendor * Update Kubernetes tools versions * Update operator version in Makefile Now the version in the Makefile matches the version of the operator * Update Operator SDK version in version.go * Adjust generated deepcopy It seems that the +build tag is no longer needed based on the latest generated scaffolding, therefore it's removed. * Update copyright year * Bring back missing changes from migration Some customization in Makefile was lost during the migration process. Specifically, the namespace customization for `make deploy` command. Also, we push changes to kustomization.yaml for making the deploy process smoother. * Add RBAC perms for coordination.k8s.io It seems that with the latest changes to Kubernetes and Kustomize, we need to add additional RBAC to the service account used so that it can properly access the `leases` resource. * Optimize Dockerfile Dockerfile had a step for caching dependencies (go mod download). However, this is already done by the vendor directory, which we include. Therefore, this step can be removed to make the image build time faster.
171 lines
5.2 KiB
YAML
171 lines
5.2 KiB
YAML
linters:
|
|
disable-all: true
|
|
enable:
|
|
- asasalint
|
|
- asciicheck
|
|
- bidichk
|
|
- bodyclose
|
|
- dogsled
|
|
- dupl
|
|
- errcheck
|
|
- errchkjson
|
|
- errorlint
|
|
- exhaustive
|
|
- exportloopref
|
|
- ginkgolinter
|
|
- goconst
|
|
- gocritic
|
|
- gocyclo
|
|
- gofmt
|
|
- goimports
|
|
- goprintffuncname
|
|
- gosec
|
|
- gosimple
|
|
- govet
|
|
- importas
|
|
- ineffassign
|
|
- makezero
|
|
- misspell
|
|
- nakedret
|
|
- nilerr
|
|
- nolintlint
|
|
- prealloc
|
|
- revive
|
|
- staticcheck
|
|
- stylecheck
|
|
- tagliatelle
|
|
- typecheck
|
|
- unconvert
|
|
- unparam
|
|
- unused
|
|
- whitespace
|
|
|
|
linters-settings:
|
|
importas:
|
|
no-unaliased: true
|
|
alias:
|
|
# Kubernetes
|
|
- pkg: k8s.io/api/core/v1
|
|
alias: corev1
|
|
- pkg: k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1
|
|
alias: apiextensionsv1
|
|
- pkg: k8s.io/apimachinery/pkg/apis/meta/v1
|
|
alias: metav1
|
|
- pkg: k8s.io/apimachinery/pkg/api/errors
|
|
alias: apierrors
|
|
- pkg: k8s.io/apimachinery/pkg/util/errors
|
|
alias: kerrors
|
|
# Controller Runtime
|
|
- pkg: sigs.k8s.io/controller-runtime
|
|
alias: ctrl
|
|
staticcheck:
|
|
go: "1.20"
|
|
stylecheck:
|
|
go: "1.20"
|
|
revive:
|
|
rules:
|
|
# The following rules are recommended https://github.com/mgechev/revive#recommended-configuration
|
|
- name: blank-imports
|
|
- name: context-as-argument
|
|
- name: context-keys-type
|
|
- name: dot-imports
|
|
- name: error-return
|
|
- name: error-strings
|
|
- name: error-naming
|
|
- name: exported
|
|
- name: if-return
|
|
- name: increment-decrement
|
|
- name: var-naming
|
|
- name: var-declaration
|
|
- name: range
|
|
- name: receiver-naming
|
|
- name: time-naming
|
|
- name: unexported-return
|
|
- name: indent-error-flow
|
|
- name: errorf
|
|
- name: superfluous-else
|
|
- name: unreachable-code
|
|
- name: redefines-builtin-id
|
|
#
|
|
# Rules in addition to the recommended configuration above.
|
|
#
|
|
- name: bool-literal-in-expr
|
|
- name: constant-logical-expr
|
|
|
|
issues:
|
|
max-same-issues: 0
|
|
max-issues-per-linter: 0
|
|
# We are disabling default golangci exclusions because we want to help reviewers to focus on reviewing the most relevant
|
|
# changes in PRs and avoid nitpicking.
|
|
exclude-use-default: false
|
|
# List of regexps of issue texts to exclude, empty list by default.
|
|
exclude:
|
|
# The following are being worked on to remove their exclusion. This list should be reduced or go away all together over time.
|
|
# If it is decided they will not be addressed they should be moved above this comment.
|
|
- Subprocess launch(ed with variable|ing should be audited)
|
|
- (G204|G104|G307)
|
|
- "ST1000: at least one file in a package should have a package comment"
|
|
exclude-rules:
|
|
- linters:
|
|
- gosec
|
|
text: "G108: Profiling endpoint is automatically exposed on /debug/pprof"
|
|
- linters:
|
|
- revive
|
|
text: "exported: exported method .*\\.(Reconcile|SetupWithManager|SetupWebhookWithManager) should have comment or be unexported"
|
|
- linters:
|
|
- errcheck
|
|
text: Error return value of .((os\.)?std(out|err)\..*|.*Close|.*Flush|os\.Remove(All)?|.*print(f|ln)?|os\.(Un)?Setenv). is not checked
|
|
- linters:
|
|
- staticcheck
|
|
text: "SA1019: .*The component config package has been deprecated and will be removed in a future release."
|
|
# With Go 1.16, the new embed directive can be used with an un-named import,
|
|
# revive (previously, golint) only allows these to be imported in a main.go, which wouldn't work for us.
|
|
# This directive allows the embed package to be imported with an underscore everywhere.
|
|
- linters:
|
|
- revive
|
|
source: _ "embed"
|
|
# Exclude some packages or code to require comments, for example test code, or fake clients.
|
|
- linters:
|
|
- revive
|
|
text: exported (method|function|type|const) (.+) should have comment or be unexported
|
|
source: (func|type).*Fake.*
|
|
- linters:
|
|
- revive
|
|
text: exported (method|function|type|const) (.+) should have comment or be unexported
|
|
path: fake_\.go
|
|
# Disable unparam "always receives" which might not be really
|
|
# useful when building libraries.
|
|
- linters:
|
|
- unparam
|
|
text: always receives
|
|
# Dot imports for gomega and ginkgo are allowed
|
|
# within test files.
|
|
- path: _test\.go
|
|
text: should not use dot imports
|
|
- path: _test\.go
|
|
text: cyclomatic complexity
|
|
- path: _test\.go
|
|
text: "G107: Potential HTTP request made with variable url"
|
|
# Append should be able to assign to a different var/slice.
|
|
- linters:
|
|
- gocritic
|
|
text: "appendAssign: append result not assigned to the same slice"
|
|
- linters:
|
|
- gocritic
|
|
text: "singleCaseSwitch: should rewrite switch statement to if statement"
|
|
# It considers all file access to a filename that comes from a variable problematic,
|
|
# which is naiv at best.
|
|
- linters:
|
|
- gosec
|
|
text: "G304: Potential file inclusion via variable"
|
|
- linters:
|
|
- dupl
|
|
path: _test\.go
|
|
|
|
run:
|
|
timeout: 10m
|
|
skip-files:
|
|
- "zz_generated.*\\.go$"
|
|
- ".*conversion.*\\.go$"
|
|
allow-parallel-runners: true
|