-
Notifications
You must be signed in to change notification settings - Fork 1.4k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.
Already on GitHub? Sign in to your account
馃尡 fix and improve samples as add further coverage #3616
Merged
k8s-ci-robot
merged 1 commit into
kubernetes-sigs:master
from
camilamacedo86:add-lint-check-sample
Sep 19, 2023
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,54 @@ | ||
| # Copyright 2023 The Caramello-io Authors. | ||
|
|
||
| name: Sample Testdata Tests | ||
|
|
||
| on: | ||
| push: | ||
| pull_request: | ||
|
|
||
| jobs: | ||
| test: | ||
| name: "Testdata - make test" | ||
| runs-on: ubuntu-latest | ||
| if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository) | ||
| steps: | ||
| - name: Clone the code | ||
| uses: actions/checkout@v3 | ||
| - name: Setup Go | ||
| uses: actions/setup-go@v4 | ||
| with: | ||
| go-version: '~1.20' | ||
| - name: Remove pre-installed kustomize | ||
| run: sudo rm -f /usr/local/bin/kustomize | ||
| - name: Run make test for project-v4-with-deploy-image | ||
| run: cd testdata/project-v4-with-deploy-image && go mod tidy && make all && make test | ||
| - name: Run make test for project-v4-multigroup-with-deploy-image | ||
| run: cd testdata/project-v4-multigroup-with-deploy-image && go mod tidy && make all && make test | ||
|
|
||
| lint: | ||
| name: "Testdata - Lint" | ||
| runs-on: ubuntu-latest | ||
| # Pull requests from the same repository won't trigger this checks as they were already triggered by the push | ||
| if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository) | ||
| steps: | ||
| - name: Setup Go | ||
| uses: actions/setup-go@v4 | ||
| with: | ||
| go-version: '~1.20' | ||
| - name: Clone the code | ||
| uses: actions/checkout@v4 | ||
| - name: Run linter | ||
| uses: golangci/golangci-lint-action@v3 | ||
| with: | ||
| version: v1.54 | ||
| working-directory: testdata/project-v4-with-deploy-image | ||
| args: --config .golangci.yml ./... | ||
| skip-cache: true # first lint action will handle | ||
| - name: Run linter | ||
| uses: golangci/golangci-lint-action@v3 | ||
| with: | ||
| version: v1.54 | ||
| working-directory: testdata/project-v4-multigroup-with-deploy-image | ||
| args: --config .golangci.yml ./... | ||
| skip-cache: true # first lint action will handle | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 3 additions & 0 deletions
3
testdata/project-v4-multigroup-with-deploy-image/.dockerignore
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| # More info: https://docs.docker.com/engine/reference/builder/#dockerignore-file | ||
| # Ignore build and test binaries. | ||
| bin/ |
26 changes: 26 additions & 0 deletions
26
testdata/project-v4-multigroup-with-deploy-image/.gitignore
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,26 @@ | ||
|
|
||
| # Binaries for programs and plugins | ||
| *.exe | ||
| *.exe~ | ||
| *.dll | ||
| *.so | ||
| *.dylib | ||
| bin/* | ||
| Dockerfile.cross | ||
|
|
||
| # Test binary, build with `go test -c` | ||
| *.test | ||
|
|
||
| # Output of the go coverage tool, specifically when used with LiteIDE | ||
| *.out | ||
|
|
||
| # Kubernetes Generated files - skip generated files, except for vendored files | ||
|
|
||
| !vendor/**/zz_generated.* | ||
|
|
||
| # editor and IDE paraphernalia | ||
| .idea | ||
| .vscode | ||
| *.swp | ||
| *.swo | ||
| *~ |
40 changes: 40 additions & 0 deletions
40
testdata/project-v4-multigroup-with-deploy-image/.golangci.yml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| run: | ||
| deadline: 5m | ||
| allow-parallel-runners: true | ||
|
|
||
| issues: | ||
| # don't skip warning about doc comments | ||
| # don't exclude the default set of lint | ||
| exclude-use-default: false | ||
| # restore some of the defaults | ||
| # (fill in the rest as needed) | ||
| exclude-rules: | ||
| - path: "api/*" | ||
| linters: | ||
| - lll | ||
| - path: "internal/*" | ||
| linters: | ||
| - dupl | ||
| - lll | ||
| linters: | ||
| disable-all: true | ||
| enable: | ||
| - dupl | ||
| - errcheck | ||
| - exportloopref | ||
| - goconst | ||
| - gocyclo | ||
| - gofmt | ||
| - goimports | ||
| - gosimple | ||
| - govet | ||
| - ineffassign | ||
| - lll | ||
| - misspell | ||
| - nakedret | ||
| - prealloc | ||
| - staticcheck | ||
| - typecheck | ||
| - unconvert | ||
| - unparam | ||
| - unused |
33 changes: 33 additions & 0 deletions
33
testdata/project-v4-multigroup-with-deploy-image/Dockerfile
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # Build the manager binary | ||
| FROM golang:1.20 as builder | ||
| ARG TARGETOS | ||
| ARG TARGETARCH | ||
|
|
||
| WORKDIR /workspace | ||
| # Copy the Go Modules manifests | ||
| COPY go.mod go.mod | ||
| COPY go.sum go.sum | ||
| # cache deps before building and copying source so that we don't need to re-download as much | ||
| # and so that source changes don't invalidate our downloaded layer | ||
| RUN go mod download | ||
|
|
||
| # Copy the go source | ||
| COPY cmd/main.go cmd/main.go | ||
| COPY api/ api/ | ||
| COPY internal/controller/ internal/controller/ | ||
|
|
||
| # Build | ||
| # the GOARCH has not a default value to allow the binary be built according to the host where the command | ||
| # was called. For example, if we call make docker-build in a local env which has the Apple Silicon M1 SO | ||
| # the docker BUILDPLATFORM arg will be linux/arm64 when for Apple x86 it will be linux/amd64. Therefore, | ||
| # by leaving it empty we can ensure that the container and binary shipped on it will have the same platform. | ||
| RUN CGO_ENABLED=0 GOOS=${TARGETOS:-linux} GOARCH=${TARGETARCH} go build -a -o manager cmd/main.go | ||
|
|
||
| # Use distroless as minimal base image to package the manager binary | ||
| # Refer to https://github.com/GoogleContainerTools/distroless for more details | ||
| FROM gcr.io/distroless/static:nonroot | ||
| WORKDIR / | ||
| COPY --from=builder /workspace/manager . | ||
| USER 65532:65532 | ||
|
|
||
| ENTRYPOINT ["/manager"] |
178 changes: 178 additions & 0 deletions
178
testdata/project-v4-multigroup-with-deploy-image/Makefile
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,178 @@ | ||
|
|
||
| # Image URL to use all building/pushing image targets | ||
| IMG ?= controller:latest | ||
| # ENVTEST_K8S_VERSION refers to the version of kubebuilder assets to be downloaded by envtest binary. | ||
| ENVTEST_K8S_VERSION = 1.28.0 | ||
|
|
||
| # Get the currently used golang install path (in GOPATH/bin, unless GOBIN is set) | ||
| ifeq (,$(shell go env GOBIN)) | ||
| GOBIN=$(shell go env GOPATH)/bin | ||
| else | ||
| GOBIN=$(shell go env GOBIN) | ||
| endif | ||
|
|
||
| # CONTAINER_TOOL defines the container tool to be used for building images. | ||
| # Be aware that the target commands are only tested with Docker which is | ||
| # scaffolded by default. However, you might want to replace it to use other | ||
| # tools. (i.e. podman) | ||
| CONTAINER_TOOL ?= docker | ||
|
|
||
| # Setting SHELL to bash allows bash commands to be executed by recipes. | ||
| # Options are set to exit when a recipe line exits non-zero or a piped command fails. | ||
| SHELL = /usr/bin/env bash -o pipefail | ||
| .SHELLFLAGS = -ec | ||
|
|
||
| .PHONY: all | ||
| all: build | ||
|
|
||
| ##@ General | ||
|
|
||
| # The help target prints out all targets with their descriptions organized | ||
| # beneath their categories. The categories are represented by '##@' and the | ||
| # target descriptions by '##'. The awk command is responsible for reading the | ||
| # entire set of makefiles included in this invocation, looking for lines of the | ||
| # file as xyz: ## something, and then pretty-format the target and help. Then, | ||
| # if there's a line with ##@ something, that gets pretty-printed as a category. | ||
| # More info on the usage of ANSI control characters for terminal formatting: | ||
| # https://en.wikipedia.org/wiki/ANSI_escape_code#SGR_parameters | ||
| # More info on the awk command: | ||
| # http://linuxcommand.org/lc3_adv_awk.php | ||
|
|
||
| .PHONY: help | ||
| help: ## Display this help. | ||
| @awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z_0-9-]+:.*?##/ { printf " \033[36m%-15s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST) | ||
|
|
||
| ##@ Development | ||
|
|
||
| .PHONY: manifests | ||
| manifests: controller-gen ## Generate WebhookConfiguration, ClusterRole and CustomResourceDefinition objects. | ||
| $(CONTROLLER_GEN) rbac:roleName=manager-role crd webhook paths="./..." output:crd:artifacts:config=config/crd/bases | ||
|
|
||
| .PHONY: generate | ||
| generate: controller-gen ## Generate code containing DeepCopy, DeepCopyInto, and DeepCopyObject method implementations. | ||
| $(CONTROLLER_GEN) object:headerFile="hack/boilerplate.go.txt" paths="./..." | ||
|
|
||
| .PHONY: fmt | ||
| fmt: ## Run go fmt against code. | ||
| go fmt ./... | ||
|
|
||
| .PHONY: vet | ||
| vet: ## Run go vet against code. | ||
| go vet ./... | ||
|
|
||
| .PHONY: test | ||
| test: manifests generate fmt vet envtest ## Run tests. | ||
| KUBEBUILDER_ASSETS="$(shell $(ENVTEST) use $(ENVTEST_K8S_VERSION) --bin-dir $(LOCALBIN) -p path)" go test ./... -coverprofile cover.out | ||
|
|
||
| GOLANGCI_LINT = $(shell pwd)/bin/golangci-lint | ||
| golangci-lint: | ||
| @[ -f $(GOLANGCI_LINT) ] || { \ | ||
| set -e ;\ | ||
| curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(shell dirname $(GOLANGCI_LINT)) v1.54.2 ;\ | ||
| } | ||
|
|
||
| .PHONY: lint | ||
| lint: golangci-lint ## Run golangci-lint linter & yamllint | ||
| $(GOLANGCI_LINT) run | ||
|
|
||
| .PHONY: lint-fix | ||
| lint-fix: golangci-lint ## Run golangci-lint linter and perform fixes | ||
| $(GOLANGCI_LINT) run --fix | ||
|
|
||
| ##@ Build | ||
|
|
||
| .PHONY: build | ||
| build: manifests generate fmt vet ## Build manager binary. | ||
| go build -o bin/manager cmd/main.go | ||
|
|
||
| .PHONY: run | ||
| run: manifests generate fmt vet ## Run a controller from your host. | ||
| go run ./cmd/main.go | ||
|
|
||
| # If you wish to build the manager image targeting other platforms you can use the --platform flag. | ||
| # (i.e. docker build --platform linux/arm64). However, you must enable docker buildKit for it. | ||
| # More info: https://docs.docker.com/develop/develop-images/build_enhancements/ | ||
| .PHONY: docker-build | ||
| docker-build: ## Build docker image with the manager. | ||
| $(CONTAINER_TOOL) build -t ${IMG} . | ||
|
|
||
| .PHONY: docker-push | ||
| docker-push: ## Push docker image with the manager. | ||
| $(CONTAINER_TOOL) push ${IMG} | ||
|
|
||
| # PLATFORMS defines the target platforms for the manager image be built to provide support to multiple | ||
| # architectures. (i.e. make docker-buildx IMG=myregistry/mypoperator:0.0.1). To use this option you need to: | ||
| # - be able to use docker buildx. More info: https://docs.docker.com/build/buildx/ | ||
| # - have enabled BuildKit. More info: https://docs.docker.com/develop/develop-images/build_enhancements/ | ||
| # - be able to push the image to your registry (i.e. if you do not set a valid value via IMG=<myregistry/image:<tag>> then the export will fail) | ||
| # To adequately provide solutions that are compatible with multiple platforms, you should consider using this option. | ||
| PLATFORMS ?= linux/arm64,linux/amd64,linux/s390x,linux/ppc64le | ||
| .PHONY: docker-buildx | ||
| docker-buildx: ## Build and push docker image for the manager for cross-platform support | ||
| # copy existing Dockerfile and insert --platform=${BUILDPLATFORM} into Dockerfile.cross, and preserve the original Dockerfile | ||
| sed -e '1 s/\(^FROM\)/FROM --platform=\$$\{BUILDPLATFORM\}/; t' -e ' 1,// s//FROM --platform=\$$\{BUILDPLATFORM\}/' Dockerfile > Dockerfile.cross | ||
| - $(CONTAINER_TOOL) buildx create --name project-v3-builder | ||
| $(CONTAINER_TOOL) buildx use project-v3-builder | ||
| - $(CONTAINER_TOOL) buildx build --push --platform=$(PLATFORMS) --tag ${IMG} -f Dockerfile.cross . | ||
| - $(CONTAINER_TOOL) buildx rm project-v3-builder | ||
| rm Dockerfile.cross | ||
|
|
||
| ##@ Deployment | ||
|
|
||
| ifndef ignore-not-found | ||
| ignore-not-found = false | ||
| endif | ||
|
|
||
| .PHONY: install | ||
| install: manifests kustomize ## Install CRDs into the K8s cluster specified in ~/.kube/config. | ||
| $(KUSTOMIZE) build config/crd | $(KUBECTL) apply -f - | ||
|
|
||
| .PHONY: uninstall | ||
| uninstall: manifests kustomize ## Uninstall CRDs from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion. | ||
| $(KUSTOMIZE) build config/crd | $(KUBECTL) delete --ignore-not-found=$(ignore-not-found) -f - | ||
|
|
||
| .PHONY: deploy | ||
| deploy: manifests kustomize ## Deploy controller to the K8s cluster specified in ~/.kube/config. | ||
| cd config/manager && $(KUSTOMIZE) edit set image controller=${IMG} | ||
| $(KUSTOMIZE) build config/default | $(KUBECTL) apply -f - | ||
|
|
||
| .PHONY: undeploy | ||
| undeploy: ## Undeploy controller from the K8s cluster specified in ~/.kube/config. Call with ignore-not-found=true to ignore resource not found errors during deletion. | ||
| $(KUSTOMIZE) build config/default | $(KUBECTL) delete --ignore-not-found=$(ignore-not-found) -f - | ||
|
|
||
| ##@ Build Dependencies | ||
|
|
||
| ## Location to install dependencies to | ||
| LOCALBIN ?= $(shell pwd)/bin | ||
| $(LOCALBIN): | ||
| mkdir -p $(LOCALBIN) | ||
|
|
||
| ## Tool Binaries | ||
| KUBECTL ?= kubectl | ||
| KUSTOMIZE ?= $(LOCALBIN)/kustomize | ||
| CONTROLLER_GEN ?= $(LOCALBIN)/controller-gen | ||
| ENVTEST ?= $(LOCALBIN)/setup-envtest | ||
|
|
||
| ## Tool Versions | ||
| KUSTOMIZE_VERSION ?= v5.1.1 | ||
| CONTROLLER_TOOLS_VERSION ?= v0.13.0 | ||
|
|
||
| .PHONY: kustomize | ||
| kustomize: $(KUSTOMIZE) ## Download kustomize locally if necessary. If wrong version is installed, it will be removed before downloading. | ||
| $(KUSTOMIZE): $(LOCALBIN) | ||
| @if test -x $(LOCALBIN)/kustomize && ! $(LOCALBIN)/kustomize version | grep -q $(KUSTOMIZE_VERSION); then \ | ||
| echo "$(LOCALBIN)/kustomize version is not expected $(KUSTOMIZE_VERSION). Removing it before installing."; \ | ||
| rm -rf $(LOCALBIN)/kustomize; \ | ||
| fi | ||
| test -s $(LOCALBIN)/kustomize || GOBIN=$(LOCALBIN) GO111MODULE=on go install sigs.k8s.io/kustomize/kustomize/v5@$(KUSTOMIZE_VERSION) | ||
|
|
||
| .PHONY: controller-gen | ||
| controller-gen: $(CONTROLLER_GEN) ## Download controller-gen locally if necessary. If wrong version is installed, it will be overwritten. | ||
| $(CONTROLLER_GEN): $(LOCALBIN) | ||
| test -s $(LOCALBIN)/controller-gen && $(LOCALBIN)/controller-gen --version | grep -q $(CONTROLLER_TOOLS_VERSION) || \ | ||
| GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-tools/cmd/controller-gen@$(CONTROLLER_TOOLS_VERSION) | ||
|
|
||
| .PHONY: envtest | ||
| envtest: $(ENVTEST) ## Download envtest-setup locally if necessary. | ||
| $(ENVTEST): $(LOCALBIN) | ||
| test -s $(LOCALBIN)/setup-envtest || GOBIN=$(LOCALBIN) go install sigs.k8s.io/controller-runtime/tools/setup-envtest@latest |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@camilamacedo86 why remove this? Even if its v4, we still need to test if we scaffold out 2 APIs. Or am I missing the code for it somewhere out of the diff files?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
See that this code was duplicated and it was not called only for project-v4-withdeploy-image sample
Therefore, this code was scaffolding the APIs using deploy image for the project-v4 sample when should not.
We should only to do this scaffold for the samples which specific uses the deploy-image.