[v2] Add pre-commit and CI static checks (#1025)

* Add pre-commit and CI static checks Signed-off-by: Tomek Urbaszek <[email protected]> * Check if scalers are sorted and check offensive language Signed-off-by: Tomek Urbaszek <[email protected]> * Add autogenreated tables of content Signed-off-by: Tomek Urbaszek <[email protected]> * Improve information about pre-commits in KEDA Signed-off-by: Tomek Urbaszek <[email protected]> * Align casing Signed-off-by: Tomek Urbaszek <[email protected]> * Fix merge conflict Signed-off-by: Tomek Urbaszek <[email protected]> * fixup! Fix merge conflict Signed-off-by: Tomek Urbaszek <[email protected]>
kedacore · Aug 26, 2020 · 02f6da7 · 02f6da7
1 parent a768340
commit 02f6da7
Show file tree

Hide file tree

Showing 52 changed files with 288 additions and 111 deletions.
diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json
@@ -13,16 +13,16 @@
 		"-v", "keda-gomodcache:/go/pkg",
 		// Cache vscode exentsions installs and homedir
 		"-v", "keda-vscodecache:/root/.vscode-server",
-		
+
 		// Mount docker socket for docker builds
 		"-v", "/var/run/docker.sock:/var/run/docker.sock",
 
 		"--cap-add=SYS_PTRACE", "--security-opt", "seccomp=unconfined"
 	],
 
-	// Use 'settings' to set *default* container specific settings.json values on container create. 
+	// Use 'settings' to set *default* container specific settings.json values on container create.
 	// You can edit these settings after create using File > Preferences > Settings > Remote.
-	"settings": { 
+	"settings": {
 		"terminal.integrated.shell.linux": "/bin/bash",
 		"go.gopath": "/go"
 	},
@@ -31,4 +31,4 @@
 	"extensions": [
 		"ms-vscode.go"
 	]
-}
+}
diff --git a/.github/CODEOWNERS b/.github/CODEOWNERS
@@ -1,3 +1,3 @@
 # These owners will be the default owners for everything in
 # the repo. Unless a later match takes precedence
-*       @ahmelsayed @zroubalik 
+*       @ahmelsayed @zroubalik
diff --git a/.github/ISSUE_TEMPLATE/Bug_report.md b/.github/ISSUE_TEMPLATE/Bug_report.md
@@ -23,4 +23,4 @@ A clear and concise description of what the bug is.
   - **KEDA Version:** *Please elaborate*
   - **Platform & Version:** *Please elaborate*
   - **Kubernetes Version:** *Please elaborate*
-  - **Scaler(s):** *Please elaborate*
+  - **Scaler(s):** *Please elaborate*
diff --git a/.github/ISSUE_TEMPLATE/Suggest_scaler.md b/.github/ISSUE_TEMPLATE/Suggest_scaler.md
@@ -8,4 +8,4 @@ A clear and concise description of what scaler you'd like to use and how you'd w
 
   - **Scaler Source:** *Please elaborate*
   - **How do you want to scale:** *Please elaborate*
-  - **Authentication:** *Please elaborate*
+  - **Authentication:** *Please elaborate*
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -2,4 +2,4 @@ blank_issues_enabled: false
 contact_links:
   - name: Ask a question or get support
     url: https://github.com/kedacore/keda/discussions/new
-    about: Ask a question or request support for using KEDA
+    about: Ask a question or request support for using KEDA
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,5 +1,5 @@
 <!-- Thank you for contributing!
-     
+
      Read more about how you can contribute in our contribution guide:
      https://github.com/kedacore/keda/blob/master/CONTRIBUTING.md
 -->

diff --git a/.github/workflows/code-quality.yaml b/.github/workflows/code-quality.yaml
@@ -0,0 +1,25 @@
+name: Code Quality
+on:
+  push:
+    branches:
+      - master
+      - v2
+  pull_request:
+    branches:
+      - master
+      - v2
+jobs:
+  statics:
+    name: Static checks
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v1
+      - uses: actions/setup-go@v2-beta
+        with:
+          go-version: 1.15
+      - name: install go-lint
+        run: |
+          go get -u golang.org/x/lint/golint
+          export PATH=$PATH:$(go list -f {{.Target}} golang.org/x/lint/golint)
+      - uses: pre-commit/[email protected]
diff --git a/.github/workflows/pr-validation.yml b/.github/workflows/pr-validation.yml
@@ -22,7 +22,7 @@ jobs:
 
       - name: Verify Generated clientset is up to date
         run: make clientset-verify
-      
+
       - name: Build
         run: make build
 

diff --git a/.gitignore b/.gitignore
@@ -346,4 +346,4 @@ vendor
 cover.out
 
 # GO debug binary
-cmd/manager/debug.test
+cmd/manager/debug.test
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -0,0 +1,77 @@
+default_stages: [commit, push]
+minimum_pre_commit_version: "1.20.0"
+repos:
+  - repo: git://github.com/dnephin/pre-commit-golang
+    rev: master
+    hooks:
+      - id: go-fmt
+      - id: go-lint
+        exclude: |
+          (?x)(
+            .*zz_generated.*|
+            ^api/v1alpha1/condition_types\.go$|
+            ^api/v1alpha1/groupversion_info\.go$|
+            ^api/v1alpha1/gvkr_types\.go$|
+            ^api/v1alpha1/scaledjob_types\.go$|
+            ^api/v1alpha1/scaledobject_types\.go$|
+            ^api/v1alpha1/triggerauthentication_types\.go$|
+            ^controllers/scaledjob_controller\.go$|
+            ^controllers/scaledobject_controller\.go$|
+            ^controllers/util/status\.go$|
+            ^controllers/util/string_lists\.go$|
+            ^hack/tools\.go$|
+            ^pkg/scalers/artemis_scaler\.go$|
+            ^pkg/scalers/azure/azure_aad_podidentity\.go$|
+            ^pkg/scalers/azure/azure_eventhub\.go$|
+            ^pkg/scalers/azure/azure_monitor\.go$|
+            ^pkg/scalers/azure/azure_queue\.go$|
+            ^pkg/scalers/azure/azure_storage\.go$|
+            ^pkg/scalers/azure_eventhub_scaler\.go$|
+            ^pkg/scalers/azure_queue_scaler\.go$|
+            ^pkg/scalers/azure_servicebus_scaler\.go$|
+            ^pkg/scalers/cron_scaler\.go$|
+            ^pkg/scalers/external_scaler\.go$|
+            ^pkg/scalers/kafka_scram_client\.go$|
+            ^pkg/scalers/liiklus_scaler\.go$|
+            ^pkg/scalers/postgresql_scaler\.go$|
+            ^pkg/scalers/rabbitmq_scaler\.go$|
+            ^pkg/scalers/rabbitmq_scaler_test\.go$|
+            ^pkg/scalers/scaler\.go$|
+            ^pkg/scaling/executor/scale_executor\.go$|
+            ^pkg/scaling/resolver/hashicorpvault_handler\.go$|
+            ^pkg/scaling/resolver/scale_resolvers\.go$|
+            ^pkg/util/gvkr\.go$|
+            ^pkg/util/k8sversion\.go$|
+            ^pkg/util/normalize_string\.go$|
+            ^version/version\.go$
+          )
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+      - id: trailing-whitespace
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: check-merge-conflict
+      - id: mixed-line-ending
+  - repo: https://github.com/thlorenz/doctoc.git
+    rev: v1.4.0
+    hooks:
+      - id: doctoc
+        name: Add TOC for md files
+        files: ^README\.md$|^CONTRIBUTING\.md$
+        args:
+          - "--maxlevel"
+          - "2"
+  - repo: local
+    hooks:
+    - id: language-matters
+      language: pygrep
+      name: Check for language that we do not accept as community
+      description: Please use "deny_list" or "allow_list"  instead.
+      entry: "(?i)(black|white)[_-]?(list|List)"
+      pass_filenames: true
+    - id: sort-scalers
+      name: Check if scalers are sorted in scaler_handler.go
+      language: system
+      entry: "bash tools/sort_scalers.sh"
+      files: .*scale_handler\.go$
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -4,6 +4,19 @@ Thanks for helping make KEDA better 😍.
 
 There are many areas we can use contributions - ranging from code, documentation, feature proposals, issue triage, samples, and content creation.
 
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of contents**
+
+- [Getting Help](#getting-help)
+- [Contributing Scalers](#contributing-scalers)
+- [Including Documentation Changes](#including-documentation-changes)
+- [Creating and building a local environment](#creating-and-building-a-local-environment)
+- [Developer Certificate of Origin: Signing your work](#developer-certificate-of-origin-signing-your-work)
+- [Code Quality](#code-quality)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
 ## Getting Help
 
 If you have a question about KEDA or how best to contribute, the [#KEDA](https://kubernetes.slack.com/archives/CKZJ36A5D) channel on the Kubernetes slack channel ([get an invite if you don't have one already](https://slack.k8s.io/)) is a good place to start.  We also have regular [community stand-ups](https://github.com/kedacore/keda#community-standup) to track ongoing work and discuss areas of contribution.  For any issues with the product you can [create an issue](https://github.com/kedacore/keda/issues/new) in this repo.
@@ -68,3 +81,29 @@ git add -A
 git commit -sm "one commit on <branch-name>"
 git push --force
 ```
+
+## Code Quality
+
+This project is using [pre-commits](https://pre-commit.com) to ensure the quality of the code.
+We encourage you to use pre-commits, but it's not a required to contribute. Every change is checked
+on CI and if it does not pass the tests it cannot be accepted. If you want to check locally then
+you should install Python3.6 or newer together and run:
+```bash
+pip install pre-commit
+# or
+brew install pre-commit
+```
+For more installation options visit the [pre-commits](https://pre-commit.com).
+
+To turn on pre-commit checks for commit operations in git, run:
+```bash
+pre-commit install
+```
+To run all checks on your staged files, run:
+```bash
+pre-commit run
+```
+To run all checks on all files, run:
+```bash
+pre-commit run --all-files
+```
diff --git a/Dockerfile.adapter b/Dockerfile.adapter
@@ -34,4 +34,4 @@ COPY --from=builder /workspace/bin/keda-adapter .
 USER nonroot:nonroot
 
 
-ENTRYPOINT ["/keda-adapter", "--secure-port=6443", "--logtostderr=true", "--v=0"]
+ENTRYPOINT ["/keda-adapter", "--secure-port=6443", "--logtostderr=true", "--v=0"]
diff --git a/GOVERNANCE.md b/GOVERNANCE.md
@@ -20,7 +20,7 @@ maintainers over the course of a one week voting period. At the end of the week,
 votes are counted and a pull request is made on the repo adding the new
 maintainer to the [MAINTAINERS](MAINTAINERS.md) file.
 
-Individuals interested in becoming maintainers may submit an [issue](https://github.com/kedacore/keda/issues/new) 
+Individuals interested in becoming maintainers may submit an [issue](https://github.com/kedacore/keda/issues/new)
 stating their interest.  Existing maintainers can choose if they would
 like to nominate these individuals to be a maintainer following the process
 above.

diff --git a/LICENSE b/LICENSE
@@ -201,4 +201,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
+   limitations under the License.
diff --git a/MAINTAINERS.md b/MAINTAINERS.md
@@ -16,4 +16,4 @@
 | -------------------- | --------------------------------------------- | ----------- |
 | Aarthi Saravanakumar | [Aarthisk](https://github.com/Aarthisk)       | Microsoft   |
 | Yaron Schneider      | [yaron2](https://github.com/yaron2)           | Microsoft   |
-| Ben Browning         | [bbrowning](https://github.com/bbrowning)     | Red Hat     |
+| Ben Browning         | [bbrowning](https://github.com/bbrowning)     | Red Hat     |
diff --git a/README.md b/README.md
@@ -17,16 +17,37 @@ Make sure to remove previous KEDA (including CRD) from the cluster. Switch to th
 <a href="https://bestpractices.coreinfrastructure.org/projects/3791"><img src="https://bestpractices.coreinfrastructure.org/projects/3791/badge"></a>
 <a href="https://twitter.com/kedaorg"><img src="https://img.shields.io/twitter/follow/kedaorg?style=social" alt="Twitter"></a></p>
 
-KEDA allows for fine-grained autoscaling (including to/from zero) for event driven Kubernetes workloads. KEDA serves 
-as a Kubernetes Metrics Server and allows users to define autoscaling rules using a dedicated Kubernetes custom 
+KEDA allows for fine-grained autoscaling (including to/from zero) for event driven Kubernetes workloads. KEDA serves
+as a Kubernetes Metrics Server and allows users to define autoscaling rules using a dedicated Kubernetes custom
 resource definition.
 
-KEDA can run on both the cloud and the edge, integrates natively with Kubernetes components such as the Horizontal 
+KEDA can run on both the cloud and the edge, integrates natively with Kubernetes components such as the Horizontal
 Pod Autoscaler, and has no external dependencies.
 
 We are a Cloud Native Computing Foundation (CNCF) sandbox project.
 <img src="https://raw.githubusercontent.com/kedacore/keda/master/images/logo-cncf.svg" height="75px">
-
+
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of contents**
+
+- [Getting started](#getting-started)
+- [Deploying KEDA](#deploying-keda)
+- [Documentation](#documentation)
+- [FAQ](#faq)
+- [Samples](#samples)
+- [Releases](#releases)
+- [Contributing](#contributing)
+- [Community](#community)
+- [Building: Quick start with Visual Studio Code Remote - Containers](#building-quick-start-with-visual-studio-code-remote---containers)
+- [Building: Locally directly](#building-locally-directly)
+- [Deploying: Custom KEDA locally outside cluster](#deploying-custom-keda-locally-outside-cluster)
+- [Deploying: Custom KEDA as an image](#deploying-custom-keda-as-an-image)
+- [Setting log levels](#setting-log-levels)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->
+
+
 ## Getting started
 
 * [QuickStart - RabbitMQ and Go](https://github.com/kedacore/sample-go-rabbitmq)
@@ -62,19 +83,19 @@ You can find Contributing guide [here](./CONTRIBUTING.md)
 
 If interested in contributing or participating in the direction of KEDA, you can join our community meetings.
 
-* **Meeting time:** Bi-weekly Thurs 16:00 UTC (does follow US daylight savings). 
+* **Meeting time:** Bi-weekly Thurs 16:00 UTC (does follow US daylight savings).
 ([Subscribe to Google Agenda](https://calendar.google.com/calendar?cid=bjE0bjJtNWM0MHVmam1ob2ExcTgwdXVkOThAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ) |
  [Convert to your timezone](https://www.thetimezoneconverter.com/?t=04%3A00%20pm&tz=UTC))
 * **Zoom link:** [https://zoom.us/j/150360492 ](https://zoom.us/j/150360492 )
 * **Meeting agenda:** [https://hackmd.io/s/r127ErYiN](https://hackmd.io/s/r127ErYiN)
 
-Just want to learn or chat about KEDA? Feel free to join the conversation in 
+Just want to learn or chat about KEDA? Feel free to join the conversation in
 **[#KEDA](https://kubernetes.slack.com/messages/CKZJ36A5D)** on the **[Kubernetes Slack](https://slack.k8s.io/)**!
 
 ## Building: Quick start with [Visual Studio Code Remote - Containers](https://code.visualstudio.com/docs/remote/containers)
 
-This helps you pull and build quickly - dev containers launch the project inside a container with all the tooling 
-required for a consistent and seamless developer experience. 
+This helps you pull and build quickly - dev containers launch the project inside a container with all the tooling
+required for a consistent and seamless developer experience.
 
 This means you don't have to install and configure your dev environment as the container handles this for you.
 
@@ -92,11 +113,11 @@ code .
 Once VSCode launches run `CTRL+SHIFT+P -> Remote-Containers: Reopen in container` and then use the integrated
 terminal to run:
 
-```bash 
+```bash
 make build
 ```
 
-> Note: The first time you run the container it will take some time to build and install the tooling. The image 
+> Note: The first time you run the container it will take some time to build and install the tooling. The image
 > will be cached so this is only required the first time.
 
 ## Building: Locally directly
@@ -127,9 +148,11 @@ go env -w GOPROXY=https://proxy.golang.org,direct GOSUMDB=sum.golang.org
 ```
 
 ## Deploying: Custom KEDA locally outside cluster
+
 The Operator SDK framework allows you to run the operator/controller locally outside the cluster without
- a need of building an image. This should help during development/debugging of KEDA Operator or Scalers. 
-> Note: This approach works only on Linux or macOS. 
+a need of building an image. This should help during development/debugging of KEDA Operator or Scalers.
+> Note: This approach works only on Linux or macOS.
+
 
 To have fully operational KEDA we need to deploy Metrics Server first.
 
@@ -145,11 +168,11 @@ To have fully operational KEDA we need to deploy Metrics Server first.
  and change the operator log level via `--zap-log-level=` if needed
    ```bash
    make run ARGS="--zap-log-level=debug"
-   ``` 
+   ```
 
 ## Deploying: Custom KEDA as an image
 
-If you want to change KEDA's behaviour, or if you have created a new scaler (more docs on this to come) and you want 
+If you want to change KEDA's behaviour, or if you have created a new scaler (more docs on this to come) and you want
 to deploy it as part of KEDA. Do the following:
 
 1. Make your change in the code.
@@ -162,7 +185,7 @@ to deploy it as part of KEDA. Do the following:
    ```bash
    IMAGE_REPO=johndoe make deploy
    ```
-4. Once the keda pods are up, check the logs to verify everything running ok, eg: 
+4. Once the keda pods are up, check the logs to verify everything running ok, eg:
     ```bash
     kubectl get pods --no-headers -n keda | awk '{print $1}' | grep keda-operator | xargs kubectl -n keda logs -f
Original file line number	Diff line number	Diff line change
Expand Up		@@ -34,4 +34,4 @@ COPY --from=builder /workspace/bin/keda-adapter .
		USER nonroot:nonroot


		ENTRYPOINT ["/keda-adapter", "--secure-port=6443", "--logtostderr=true", "--v=0"]
		ENTRYPOINT ["/keda-adapter", "--secure-port=6443", "--logtostderr=true", "--v=0"]