Add devbox to the project (#172)

Author: thunderboltsid

.envrc

@@ -0,0 +1,7 @@
+# Automatically sets up your devbox environment whenever you cd into this
+# directory via our direnv integration:
+
+eval "$(devbox generate direnv --print-envrc)"
+
+# check out https://www.jetpack.io/devbox/docs/ide_configuration/direnv/
+# for more details

.github/workflows/build-lint-test.yml

@@ -3,9 +3,9 @@ env:
   EXPORT_RESULT: true
 on:
   push:
-    branches: [ "main" ]
+    branches: ["main"]
   pull_request:
-    branches: [ "main" ]
+    branches: ["main"]
 
 jobs:
   build:
@@ -15,30 +15,40 @@ jobs:
     steps:
     - uses: actions/checkout@v4
 
-    - name: Setup Go
-      uses: actions/setup-go@v5
+    - uses: actions/cache@v4
       with:
-        go-version: '^1.21'
-
-    - name: Check build
-      run: make build
+        path: |
+          ~/.cache/golangci-lint
+          ~/.cache/go-build
+          ~/go/pkg/mod
+        key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }}
+        restore-keys: |
+          ${{ runner.os }}-go-
+
+    - name: Install devbox
+      uses: jetify-com/devbox-install-action@v0.11.0
+      with:
+        enable-cache: "true"
 
     - name: Run golangci-lint
-      uses: golangci/golangci-lint-action@v3.7.0
-      with:
-        args: --enable gofmt --enable gofumpt --timeout 5m
+      run: devbox run -- make lint-go
 
     - name: Check YAML linting
-      run: make lint-yaml
+      run: devbox run -- make lint-yaml
 
     - name: Check Kubebuilder Annotation linting
-      run: make lint-kubebuilder
+      run: devbox run -- make lint-kubebuilder
 
     - name: Run tests
-      run: make test
+      run: devbox run -- make test
 
     - name: Prepare coverage report
-      run: make coverage
+      run: devbox run -- make coverage
 
     - name: Codecov
       uses: codecov/codecov-action@v3.1.4
+      env:
+        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+      with:
+        file: ./coverage.out  # Replace with the path to your coverage report
+        fail_ci_if_error: true

.github/workflows/synopsys.yaml

@@ -20,10 +20,7 @@ jobs:
       - name: Setup Go
         uses: actions/setup-go@v5
         with:
-          go-version: '^1.17'
-
-      - name: Build Project
-        run: make build
+          go-version: '^1.21'
 
       - name: Run Synopsys Detect
         uses: synopsys-sig/detect-action@v0.3.4

.golangci.yaml

@@ -0,0 +1,18 @@
+linters:
+  enable:
+    - errcheck
+    - gofmt
+    - gofumpt
+    - gosimple
+    - govet
+    - ineffassign
+    - nolintlint
+    - staticcheck
+    - unused
+linters-settings:
+  nolintlint:
+    require-explanation: true
+    require-specific: true
+run:
+  concurrency: 4
+  timeout: 5m

.yamllint

@@ -0,0 +1,7 @@
+extends: default
+
+rules:
+  indentation: disable
+  document-start: disable
+  comments: disable
+  line-length: disable

Makefile

@@ -1,7 +1,4 @@
 SHELL := /bin/bash
-GOCMD=go
-GOTEST=$(GOCMD) test
-GOVET=$(GOCMD) vet
 BINARY_NAME=nutanixclient
 EXPORT_RESULT?=false # for CI please set EXPORT_RESULT to true
 
@@ -20,94 +17,54 @@ build: ## Build your project and put the output binary in bin/
 	mkdir -p bin
 	$(GOCMD) build -o bin/$(BINARY_NAME) .
 
-# go-get-tool will 'go install' any package $2 and install it to $1.
-# originally copied from kubebuilder
-define go-get-tool
-@[ -f $(1) ] || { \
-set -e ;\
-BIN_PATH=$$(realpath $$(dirname $(1))) ;\
-PKG_BIN_NAME=$$(echo "$(2)" | sed 's,^.*/\(.*\)@v.*$$,\1,') ;\
-BIN_NAME=$$(basename $(1)) ;\
-echo "Install dir $$BIN_PATH" ;\
-echo "Downloading $(2)" ;\
-GOBIN=$$BIN_PATH go install $(2) ;\
-[[ $$PKG_BIN_NAME == $$BIN_NAME ]] || mv -f $$BIN_PATH/$$PKG_BIN_NAME $$BIN_PATH/$$BIN_NAME ;\
-}
-endef
-
 TOOLS_BIN_DIR := hack/tools/bin
 
 $(TOOLS_BIN_DIR):
 	mkdir -p $(TOOLS_BIN_DIR)
 
-CONTROLLER_GEN_BIN := controller-gen
-CONTROLLER_GEN := $(TOOLS_BIN_DIR)/$(CONTROLLER_GEN_BIN)
 # CRD_OPTIONS define options to add to the CONTROLLER_GEN
 CRD_OPTIONS ?= "crd:crdVersions=v1"
 
-$(CONTROLLER_GEN): $(TOOLS_BIN_DIR)
-	$(call go-get-tool,$(CONTROLLER_GEN),sigs.k8s.io/controller-tools/cmd/controller-gen@v0.14.0)
-
-KEPLOY_VER := v0.7.12
-KEPLOY_BIN := server-$(KEPLOY_VER)
-KEPLOY := $(TOOLS_BIN_DIR)/$(KEPLOY_BIN)
-KEPLOY_PKG := go.keploy.io/server/cmd/server
-
-.PHONY: $(KEPLOY)
-$(KEPLOY): $(TOOLS_BIN_DIR)
-	$(call go-get-tool,$(KEPLOY),$(KEPLOY_PKG)@$(KEPLOY_VER))
-
 .PHONY: run-keploy
-run-keploy: $(KEPLOY)
-	$(KEPLOY) run &
+run-keploy:
+	server run &
 
 .PHONY: stop-keploy
 stop-keploy:
-	@-pkill "$(KEPLOY_BIN)"
+	@-pkill "server"
 
 generate: $(CONTROLLER_GEN)  ## Generate zz_generated.deepcopy.go
 	$(CONTROLLER_GEN) paths="./..." object:headerFile="hack/boilerplate.go.txt"
 
 clean: ## Remove build related file
 	rm -fr ./bin vendor hack/tools/bin
-	rm -f ./junit-report.xml checkstyle-report.xml ./coverage.xml ./profile.cov yamllint-checkstyle.xml
+	rm -f checkstyle-report.xml ./coverage.out ./profile.cov yamllint-checkstyle.xml
 
 ## Test:
 test: run-keploy ## Run the tests of the project
-ifeq ($(EXPORT_RESULT), true)
-	go install github.com/jstemmer/go-junit-report
-	$(eval OUTPUT_OPTIONS = | tee /dev/tty | go-junit-report -set-exit-code > junit-report.xml)
-endif
-	$(GOTEST) -v -race ./... $(OUTPUT_OPTIONS)
+	go test -race -v ./...
 	@$(MAKE) stop-keploy
 
 coverage: run-keploy ## Run the tests of the project and export the coverage
-	$(GOTEST) -cover -covermode=count -coverprofile=profile.cov ./...
-	$(GOCMD) tool cover -func profile.cov
-ifeq ($(EXPORT_RESULT), true)
-	go install github.com/AlekSi/gocov-xml
-	go install github.com/axw/gocov/gocov
-	gocov convert profile.cov | gocov-xml > coverage.xml
-endif
+	go test -race -coverprofile=coverage.out -covermode=atomic ./...
 	@$(MAKE) stop-keploy
 
 ## Lint:
 lint: lint-go lint-yaml lint-kubebuilder ## Run all available linters
 
 lint-go: ## Use golintci-lint on your project
 	$(eval OUTPUT_OPTIONS = $(shell [ "${EXPORT_RESULT}" == "true" ] && echo "--out-format checkstyle ./... | tee /dev/tty > checkstyle-report.xml" || echo "" ))
-	docker run --rm -v $(shell pwd):/app -w /app golangci/golangci-lint:latest-alpine golangci-lint run --enable gofmt --fix --enable gofumpt $(OUTPUT_OPTIONS)
+	golangci-lint run -v
 
 lint-yaml: ## Use yamllint on the yaml file of your projects
 ifeq ($(EXPORT_RESULT), true)
-	go install github.com/thomaspoignant/yamllint-checkstyle
 	$(eval OUTPUT_OPTIONS = | tee /dev/tty | yamllint-checkstyle > yamllint-checkstyle.xml)
 endif
-	docker run --rm -it -v $(shell pwd):/data cytopia/yamllint -c yamllint-config.yaml -f parsable $(shell git ls-files '*.yml' '*.yaml') $(OUTPUT_OPTIONS)
+	yamllint -c .yamllint --no-warnings -f parsable $(shell git ls-files '*.yml' '*.yaml') $(OUTPUT_OPTIONS)
 
 .PHONY: lint-kubebuilder
-lint-kubebuilder: $(CONTROLLER_GEN) ## Lint Kubebuilder annotations by generating objects and checking if it is successful
-	$(CONTROLLER_GEN) $(CRD_OPTIONS) rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=.
+lint-kubebuilder: ## Lint Kubebuilder annotations by generating objects and checking if it is successful
+	controller-gen $(CRD_OPTIONS) rbac:roleName=manager-role webhook paths="./..." output:crd:artifacts:config=.
 
 ## Help:
 help: ## Show this help.

devbox.json

@@ -0,0 +1,16 @@
+{
+  "$schema": "https://raw.githubusercontent.com/jetpack-io/devbox/0.10.1/.schema/devbox.schema.json",
+  "packages": [
+    "bash@latest",
+    "coreutils@latest",
+    "gnumake@4.4.1",
+    "go@1.22.1",
+    "ginkgo@2.17.0",
+    "kubernetes-code-generator@0.25.4",
+    "kubernetes-controller-tools@0.13.0",
+    "yamllint@1.35.1",
+    "path:./hack/flakes#golangci-lint",
+    "path:./hack/flakes#yamllint-checkstyle",
+    "path:./hack/flakes#keploy"
+  ]
+}