use megalinter

.cspell.json

@@ -0,0 +1,50 @@
+// cSpell Settings
+{
+  // Version of the setting file.  Always 0.2
+  "version": "0.2",
+  // language - current active spelling language
+  "language": "en",
+  // words - list of words to be always considered correct
+  "words": [
+      "apiextensions",
+      "bucketaccess",
+      "bucketaccessclass",
+      "bucketaccessclasses",
+      "bucketaccesses",
+      "bucketclaim",
+      "bucketclaims",
+      "bucketclass",
+      "bucketclasses",
+      "buildroot",
+      "buildx",
+      "CDPATH",
+      "cloudbuild",
+      "codegen",
+      "cosi",
+      "crds",
+      "devel",
+      "distroless",
+      "ghash",
+      "GOARCH",
+      "golangci",
+      "hadolint",
+      "healthz",
+      "HIGHCPU",
+      "klog",
+      "kubebuilder",
+      "kustomization",
+      "nonroot",
+      "objectstorage",
+      "readyz",
+      "rolebinding",
+      "serviceaccount",
+      "serviceaccounts",
+      "shellcheck",
+  ],
+  // flagWords - list of words to be always considered incorrect
+  // This is useful for offensive words and common spelling errors.
+  // For example "hte" should be "the"
+  "flagWords": [
+      "hte"
+  ]
+}

.github/workflows/mega-linter-action.yaml

@@ -0,0 +1,46 @@
+name: MegaLinter
+
+on:
+  pull_request:
+    branches:
+      - main
+      - master
+      - monorepo
+      - release-*
+
+concurrency:
+  group: ${{ github.ref }}-${{ github.workflow }}
+  cancel-in-progress: true
+
+permissions:
+  contents: read
+
+jobs:
+  megalinter:
+    name: MegaLinter
+    runs-on: ubuntu-latest
+    steps:
+
+      - name: Checkout Code
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Run MegaLinter
+        uses: oxsecurity/megalinter@v8 # More info at https://megalinter.io/flavors/
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          SECURED_ENV_VARIABLES: GITHUB_TOKEN # env vars hidden from sub-linters
+          VALIDATE_ALL_CODEBASE: true
+          FAIL_IF_MISSING_LINTER_IN_FLAVOR: true # if action can't run a desired linter, return err
+          SHOW_ELAPSED_TIME: true # for debugging any megalinter issues
+          PRINT_ALL_FILES: true # for debugging any megalinter issues
+
+      - name: Upload MegaLinter artifacts
+        uses: actions/upload-artifact@v4
+        if: success() || failure()
+        with:
+          name: MegaLinter reports
+          path: |
+            megalinter-reports
+            mega-linter.log

.gitignore

@@ -1,8 +1,11 @@
 *.tmp
 .DS_Store
 .build
+.cache
 *.swp
 release-tools
 .idea
 travis.yml
-
+megalinter-reports/
+mega-linter.log
+*megalinter*.txt

.mega-linter.yml

@@ -0,0 +1,18 @@
+# Configuration file for MegaLinter
+# See all available variables at https://megalinter.io/configuration/ and in linters documentation
+
+ENABLE_LINTERS: # all other linters will be disabled by default
+  - BASH_SHELLCHECK
+  - YAML_YAMLLINT
+  - DOCKERFILE_HADOLINT
+  - SPELL_CSPELL
+
+DISABLE_LINTERS:
+  # golangci-lint can't lint the whole project and needs called one-by-one for each submodule
+  - GO_GOLANGCI_LINT
+
+FILTER_REGEX_INCLUDE: '(\.*\.go)'
+
+FILTER_REGEX_EXCLUDE: '(\.github/workflows|.*/vendor|pkg/imported-.*)'
+
+# MARKDOWN_FILTER_REGEX_EXCLUDE: '(license\.md|docs/licenses)'

.yamllint.yml

@@ -0,0 +1,7 @@
+extends: default
+rules:
+  document-start: disable # don't care if doc doesn't start with ---
+  line-length:
+    level: warning
+  indentation: # kubebuilder generator uses non-recommended indentation, but it's consistent
+    indent-sequences: consistent

client/apis/objectstorage/v1alpha1/types.go

@@ -162,7 +162,7 @@ type BucketClaimSpec struct {
 }
 
 type BucketClaimStatus struct {
-	// BucketReady indicates that the bucket is ready for consumpotion
+	// BucketReady indicates that the bucket is ready for consumption
 	// by workloads
 	BucketReady bool `json:"bucketReady"`
 
@@ -287,7 +287,7 @@ type BucketAccessSpec struct {
 	// CredentialsSecretName is the name of the secret that COSI should populate
 	// with the credentials. If a secret by this name already exists, then it is
 	// assumed that credentials have already been generated. It is not overridden.
-	// This secret is deleted when the BucketAccess is delted.
+	// This secret is deleted when the BucketAccess is deleted.
 	CredentialsSecretName string `json:"credentialsSecretName"`
 
 	// ServiceAccountName is the name of the serviceAccount that COSI will map

client/config/crd/objectstorage.k8s.io_bucketaccesses.yaml

@@ -48,7 +48,7 @@ spec:
                   CredentialsSecretName is the name of the secret that COSI should populate
                   with the credentials. If a secret by this name already exists, then it is
                   assumed that credentials have already been generated. It is not overridden.
-                  This secret is deleted when the BucketAccess is delted.
+                  This secret is deleted when the BucketAccess is deleted.
                 type: string
               protocol:
                 description: |-

client/config/crd/objectstorage.k8s.io_bucketclaims.yaml

@@ -69,7 +69,7 @@ spec:
                 type: string
               bucketReady:
                 description: |-
-                  BucketReady indicates that the bucket is ready for consumpotion
+                  BucketReady indicates that the bucket is ready for consumption
                   by workloads
                 type: boolean
             required:

client/hack/update-codegen.sh

@@ -18,8 +18,10 @@ set -o errexit
 set -o nounset
 set -o pipefail
 
+# shellcheck disable=SC1091 # Not following: (with below) this is working to load the right path
 CLIENT_ROOT=$(unset CDPATH && cd "$(dirname "${BASH_SOURCE[0]}")"/.. && pwd)
 
+# shellcheck disable=SC1091 # Not following: (with above) this is working to load the right path
 source "${CLIENT_ROOT}/vendor/k8s.io/code-generator/kube_codegen.sh"
 
 kube::codegen::gen_helpers \

controller/Dockerfile

@@ -16,7 +16,10 @@ COPY internal/ internal/
 COPY controller/go.mod controller/go.mod
 COPY controller/go.sum controller/go.sum
 
-RUN cd controller && go mod download
+WORKDIR /buildroot/controller
+RUN go mod download
+
+WORKDIR /buildroot
 
 COPY controller/cmd/ controller/cmd/
 COPY controller/pkg/ controller/pkg/

controller/resources/deployment.yaml

@@ -34,4 +34,4 @@ spec:
           image: gcr.io/k8s-staging-sig-storage/objectstorage-controller:v20221027-v0.1.1-8-g300019f
           imagePullPolicy: Always
           args:
-          - "--v=5"
+            - "--v=5"

controller/resources/rbac.yaml

@@ -10,22 +10,21 @@ metadata:
     app.kubernetes.io/version: main
     app.kubernetes.io/name: container-object-storage-interface-controller
 rules:
-- apiGroups: ["objectstorage.k8s.io"]
-  resources: ["bucketclaims", "bucketaccesses", "bucketclaims/status", "bucketaccesses/status"]
-  verbs: ["get", "list", "watch", "update"]
-- apiGroups: ["objectstorage.k8s.io"]
-  resources: ["buckets"]
-  verbs: ["get", "list", "watch", "update", "create", "delete"]
-- apiGroups: ["objectstorage.k8s.io"]
-  resources: ["bucketclasses","bucketaccessclasses"]
-  verbs: ["get", "list"]
-- apiGroups: [""]
-  resources: ["events"]
-  verbs: ["list", "watch", "create", "update", "patch"]
-- apiGroups: [""]
-  resources: ["configmaps", "serviceaccounts"]
-  verbs: ["list", "get"]
-
+  - apiGroups: ["objectstorage.k8s.io"]
+    resources: ["bucketclaims", "bucketaccesses", "bucketclaims/status", "bucketaccesses/status"]
+    verbs: ["get", "list", "watch", "update"]
+  - apiGroups: ["objectstorage.k8s.io"]
+    resources: ["buckets"]
+    verbs: ["get", "list", "watch", "update", "create", "delete"]
+  - apiGroups: ["objectstorage.k8s.io"]
+    resources: ["bucketclasses", "bucketaccessclasses"]
+    verbs: ["get", "list"]
+  - apiGroups: [""]
+    resources: ["events"]
+    verbs: ["list", "watch", "create", "update", "patch"]
+  - apiGroups: [""]
+    resources: ["configmaps", "serviceaccounts"]
+    verbs: ["list", "get"]
 ---
 kind: ClusterRoleBinding
 apiVersion: rbac.authorization.k8s.io/v1
@@ -57,9 +56,9 @@ metadata:
     app.kubernetes.io/version: main
     app.kubernetes.io/name: container-object-storage-interface-controller
 rules:
-- apiGroups: ["coordination.k8s.io"]
-  resources: ["leases"]
-  verbs: ["get", "watch", "list", "delete", "update", "create"]
+  - apiGroups: ["coordination.k8s.io"]
+    resources: ["leases"]
+    verbs: ["get", "watch", "list", "delete", "update", "create"]
 ---
 kind: RoleBinding
 apiVersion: rbac.authorization.k8s.io/v1

hack/Dockerfile.in

@@ -14,7 +14,10 @@ COPY internal/ internal/
 COPY {{COMPONENT}}/go.mod {{COMPONENT}}/go.mod
 COPY {{COMPONENT}}/go.sum {{COMPONENT}}/go.sum
 
-RUN cd {{COMPONENT}} && go mod download
+WORKDIR /buildroot/{{COMPONENT}}
+RUN go mod download
+
+WORKDIR /buildroot
 
 COPY {{COMPONENT}}/cmd/ {{COMPONENT}}/cmd/
 COPY {{COMPONENT}}/pkg/ {{COMPONENT}}/pkg/

sidecar/Dockerfile

@@ -16,7 +16,10 @@ COPY internal/ internal/
 COPY sidecar/go.mod sidecar/go.mod
 COPY sidecar/go.sum sidecar/go.sum
 
-RUN cd sidecar && go mod download
+WORKDIR /buildroot/sidecar
+RUN go mod download
+
+WORKDIR /buildroot
 
 COPY sidecar/cmd/ sidecar/cmd/
 COPY sidecar/pkg/ sidecar/pkg/