wip - Unify boilerplate

.github/workflows/lint.yml

@@ -19,6 +19,8 @@ jobs:
     steps:
       - name: Checkout
         uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
       - name: Set up Go
         uses: actions/setup-go@v3
         with:

Dockerfile.datacatalog

@@ -23,6 +23,7 @@ RUN GRPC_HEALTH_PROBE_VERSION=v0.4.11 && \
 
 WORKDIR /go/src/github.com/flyteorg/datacatalog
 
+COPY boilerplate ../boilerplate
 COPY datacatalog .
 COPY flyteadmin ../flyteadmin
 COPY flytecopilot ../flytecopilot

Dockerfile.flyteadmin

@@ -23,6 +23,7 @@ RUN GRPC_HEALTH_PROBE_VERSION=v0.4.11 && \
 
 WORKDIR /go/src/github.com/flyteorg/flyteadmin
 
+COPY boilerplate ../boilerplate
 COPY datacatalog ../datacatalog
 COPY flyteadmin .
 COPY flytecopilot ../flytecopilot

Dockerfile.flytecopilot

@@ -13,6 +13,7 @@ RUN apk add git openssh-client make curl
 
 WORKDIR /go/src/github.com/flyteorg/flytecopilot
 
+COPY boilerplate ../boilerplate
 COPY datacatalog ../datacatalog
 COPY flyteadmin ../flyteadmin
 COPY flytecopilot .

Dockerfile.flytepropeller

@@ -13,6 +13,7 @@ RUN apk add git openssh-client make curl
 
 WORKDIR /go/src/github.com/flyteorg/flytepropeller
 
+COPY boilerplate ../boilerplate
 COPY datacatalog ../datacatalog
 COPY flyteadmin ../flyteadmin
 COPY flytecopilot ../flytecopilot

Dockerfile.flytescheduler

@@ -16,6 +16,7 @@ RUN mkdir /artifacts
 
 WORKDIR /go/src/github.com/flyteorg/flyteadmin
 
+COPY boilerplate ../boilerplate
 COPY datacatalog ../datacatalog
 COPY flyteadmin .
 COPY flytecopilot ../flytecopilot

Makefile

@@ -11,6 +11,8 @@ GIT_HASH := $(shell git rev-parse --short HEAD)
 TIMESTAMP := $(shell date '+%Y-%m-%d')
 PACKAGE ?=github.com/flyteorg/flytestdlib
 LD_FLAGS="-s -w -X $(PACKAGE)/version.Version=$(GIT_VERSION) -X $(PACKAGE)/version.Build=$(GIT_HASH) -X $(PACKAGE)/version.BuildTime=$(TIMESTAMP)"
+COMPONENTS := datacatalog flyteadmin flytecopilot flyteidl flyteplugins flytepropeller flytestdlib
+
 
 .PHONY: cmd/single/dist
 cmd/single/dist: export FLYTECONSOLE_VERSION ?= latest
@@ -26,10 +28,6 @@ compile: cmd/single/dist
 linux_compile: cmd/single/dist
 	GOOS=linux GOARCH=amd64 CGO_ENABLED=0  go build -tags console -v -o /artifacts/flyte -ldflags=$(LD_FLAGS) ./cmd/
 
-.PHONY: update_boilerplate
-update_boilerplate:
-	@boilerplate/update.sh
-
 .PHONY: kustomize
 kustomize:
 	KUSTOMIZE_VERSION=3.9.2 bash script/generate_kustomize.sh
@@ -105,13 +103,39 @@ build_native_flyte:
 	--build-arg FLYTECONSOLE_VERSION=$(FLYTECONSOLE_VERSION) \
 	--tag flyte-binary:native .
 
-.PHONY: go-tidy
-go-tidy:
+go-tidy-all:  ## Run go mod tidy in all components
 	go mod tidy
-	make -C datacatalog go-tidy
-	make -C flyteadmin go-tidy
-	make -C flyteidl go-tidy
-	make -C flytepropeller go-tidy
-	make -C flyteplugins go-tidy
-	make -C flytestdlib go-tidy
-	make -C flytecopilot go-tidy
+	$(MAKE) $(addsuffix -go-tidy,$(COMPONENTS))
+
+generate-all:  ## Run `make generate` on all components
+	$(MAKE) $(addsuffix -generate,$(COMPONENTS))
+
+lint-all:  ## Lint all components
+	$(MAKE) $(addsuffix -lint,$(COMPONENTS))
+
+test_unit-all:  ## Run `make test_unit` on all components
+	$(MAKE) $(addsuffix -test_unit,$(COMPONENTS))
+
+$(COMPONENTS:%=%-go-tidy):
+	make -C $(@:-go-tidy=) go-tidy
+
+$(COMPONENTS:%=%-goimports):
+	make -C $(@:-goimports=) goimports
+
+$(COMPONENTS:%=%-generate):
+	make -C $(@:-generate=) generate
+
+$(COMPONENTS:%=%-lint):
+	make -C $(@:-lint=) lint
+
+$(COMPONENTS:%=%-test_unit):
+	make -C $(@:-test_unit=) test_unit
+
+.PHONY: build-component-image
+build-component-image:  ## Build a component image
+# Check if COMPONENT is set and contained in COMPONENTS
+ifndef COMPONENT
+	$(error COMPONENT environment variable is not set)
+endif
+	@echo "Building $(COMPONENT) image"
+	@docker buildx build -f Dockerfile.$(COMPONENT) .

boilerplate/flyte/golang_test_targets/Makefile

@@ -1,27 +1,22 @@
-# WARNING: THIS FILE IS MANAGED IN THE 'BOILERPLATE' REPO AND COPIED TO OTHER REPOSITORIES.
-# ONLY EDIT THIS FILE FROM WITHIN THE 'FLYTEORG/BOILERPLATE' REPOSITORY:
-#
-# TO OPT OUT OF UPDATES, SEE https://github.com/flyteorg/boilerplate/blob/master/Readme.rst
-
+clean:
+	rm -rf bin
 
 .PHONY: download_tooling
 download_tooling: #download dependencies (including test deps) for the package
-	@boilerplate/flyte/golang_test_targets/download_tooling.sh
+	@../boilerplate/flyte/golang_test_targets/download_tooling.sh
 
 .PHONY: generate
 generate: download_tooling #generate go code
-	@boilerplate/flyte/golang_test_targets/go-gen.sh
+	@../boilerplate/flyte/golang_test_targets/go-gen.sh
+
+.PHONY: go-tidy
+go-tidy: ## Runs go mod tidy
+	go mod tidy
 
 .PHONY: lint
 lint: download_tooling #lints the package for common code smells
 	GL_DEBUG=linters_output,env golangci-lint run --deadline=5m --exclude deprecated -v
 
-# If code is failing goimports linter, this will fix.
-# skips 'vendor'
-.PHONY: goimports
-goimports:
-	@boilerplate/flyte/golang_test_targets/goimports
-
 .PHONY: mod_download
 mod_download: #download dependencies (including test deps) for the package
 	go mod download
@@ -50,8 +45,7 @@ test_unit_cover:
 test_unit_visual:
 	go test ./... -coverprofile /tmp/cover.out -covermode=count
 	go tool cover -html=/tmp/cover.out
-	
+
 .PHONY: test_unit_codecov
 test_unit_codecov:
 	go test ./... -race -coverprofile=coverage.txt -covermode=atomic
-	curl -s https://codecov.io/bash > codecov_bash.sh && bash codecov_bash.sh

boilerplate/flyte/golang_test_targets/download_tooling.sh

@@ -16,23 +16,22 @@ set -e
 # List of tools to go get
 # In the format of "<cli>:<package>" or ":<package>" if no cli
 tools=(
-  "github.com/EngHabu/mockery/cmd/mockery"
-  "github.com/flyteorg/flytestdlib/cli/pflags@latest"
-  "github.com/golangci/golangci-lint/cmd/golangci-lint"
-  "github.com/daixiang0/gci"
-  "github.com/alvaroloes/enumer"
-  "github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc"
+	"github.com/EngHabu/mockery/cmd/mockery"
+	"github.com/flyteorg/flytestdlib/cli/pflags@latest"
+	"github.com/golangci/golangci-lint/cmd/golangci-lint"
+	"github.com/daixiang0/gci"
+	"github.com/alvaroloes/enumer"
+	"github.com/pseudomuto/protoc-gen-doc/cmd/protoc-gen-doc"
 )
 
 tmp_dir=$(mktemp -d -t gotooling-XXX)
 echo "Using temp directory ${tmp_dir}"
-cp -R boilerplate/flyte/golang_support_tools/* $tmp_dir
+cp -R ../boilerplate/flyte/golang_support_tools/* $tmp_dir
 pushd "$tmp_dir"
 
-for tool in "${tools[@]}"
-do
-    echo "Installing ${tool}"
-    GO111MODULE=on go install $tool
+for tool in "${tools[@]}"; do
+	echo "Installing ${tool}"
+	GO111MODULE=on go install $tool
 done
 
 popd

datacatalog/Makefile

@@ -1,11 +1,6 @@
 export REPOSITORY=datacatalog
-include boilerplate/flyte/docker_build/Makefile
-include boilerplate/flyte/golang_test_targets/Makefile
-
-.PHONY: update_boilerplate
-update_boilerplate:
-	@curl https://raw.githubusercontent.com/flyteorg/boilerplate/master/boilerplate/update.sh -o boilerplate/update.sh
-	@boilerplate/update.sh
+include ../boilerplate/flyte/docker_build/Makefile
+include ../boilerplate/flyte/golang_test_targets/Makefile
 
 .PHONY: compile
 compile:
@@ -17,11 +12,3 @@ linux_compile: export CGO_ENABLED ?= 0
 linux_compile: export GOOS ?= linux
 linux_compile:
 	go build -o /artifacts/datacatalog ./cmd/
-
-.PHONY: generate
-generate:
-	@go generate ./...
-
-.PHONY: go-tidy
-go-tidy:
-	go mod tidy