Makefile refactoring to minimize the number of targets (#397)

* Renamed EPP Dockerfile for naming consistency

Signed-off-by: Shmuel Kallner <kallner@il.ibm.com>

* Make use of % in targets to minimize number of targets

Signed-off-by: Shmuel Kallner <kallner@il.ibm.com>

* make build/test now builds/tests the sidecar as well

Signed-off-by: Shmuel Kallner <kallner@il.ibm.com>

---------

Signed-off-by: Shmuel Kallner <kallner@il.ibm.com>

Author: shmuelk

.github/workflows/ci-pr-checks.yaml

@@ -48,7 +48,7 @@ jobs:
       - name: Run make test
         shell: bash 
         run: |
-          make test sidecar-test
+          make test
 
       - name: Archive code coverage results
         uses: actions/upload-artifact@v4
@@ -59,4 +59,4 @@ jobs:
       - name: Run make build
         shell: bash
         run: |
-          make build sidecar-build
+          make build

.github/workflows/ci-release.yaml

@@ -40,7 +40,7 @@ jobs:
       - name: Build and push EPP image
         uses: ./.github/actions/docker-build-and-push
         with:
-          docker-file: Dockerfile
+          docker-file: Dockerfile.epp
           tag: ${{ steps.tag.outputs.tag }}
           image-name: ${{ steps.version.outputs.project_name }}
           registry: ghcr.io/llm-d

Dockerfile Dockerfile.eppDockerfile renamed to Dockerfile.epp

@@ -14,7 +14,7 @@ IMAGE_TAG_BASE ?= $(IMAGE_REGISTRY)/$(PROJECT_NAME)
 EPP_TAG ?= dev
 IMG = $(IMAGE_TAG_BASE):$(EPP_TAG)
 SIDECAR_TAG ?= dev
-SIDECAR_IMAGE_TAG_BASE ?= ghcr.io/llm-d/$(SIDECAR_IMAGE_NAME)
+SIDECAR_IMAGE_TAG_BASE ?= $(IMAGE_REGISTRY)/$(SIDECAR_IMAGE_NAME)
 SIDECAR_IMG = $(SIDECAR_IMAGE_TAG_BASE):$(SIDECAR_TAG)
 NAMESPACE ?= hc4ai-operator
 
@@ -51,6 +51,16 @@ BUILD_REF ?= $(shell git describe --abbrev=0 2>/dev/null)
 # go source files
 SRC = $(shell find . -type f -name '*.go')
 
+# Internal variables for generic targets
+epp_IMAGE = $(IMG)
+sidecar_IMAGE = $(SIDECAR_IMG)
+epp_NAME = epp
+sidecar_NAME = $(SIDECAR_NAME)
+epp_LDFLAGS = -ldflags="$(LDFLAGS)"
+sidecar_LDFLAGS =
+epp_TEST_FILES = go list ./... | grep -v /test/ | grep -v ./pkg/sidecar/
+sidecar_TEST_FILES = go list ./pkg/sidecar/...
+
 .PHONY: help
 help: ## Print 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)
@@ -61,7 +71,7 @@ LDFLAGS ?= -extldflags '-L$(shell pwd)/lib'
 CGO_ENABLED=1
 TOKENIZER_LIB = lib/libtokenizers.a
 # Extract RELEASE_VERSION from Dockerfile
-TOKENIZER_VERSION := $(shell grep '^ARG RELEASE_VERSION=' Dockerfile | cut -d'=' -f2)
+TOKENIZER_VERSION := $(shell grep '^ARG RELEASE_VERSION=' Dockerfile.epp | cut -d'=' -f2)
 
 .PHONY: download-tokenizer
 download-tokenizer: $(TOKENIZER_LIB)
@@ -89,9 +99,12 @@ format: ## Format Go source files
 test: test-unit test-e2e ## Run unit tests and e2e tests
 
 .PHONY: test-unit
-test-unit: download-tokenizer install-dependencies ## Run unit tests
+test-unit: epp-test-unit sidecar-test-unit
+
+.PHONY: %-test-unit
+%-test-unit: download-tokenizer install-dependencies ## Run unit tests
 	@printf "\033[33;1m==== Running Unit Tests ====\033[0m\n"
-	go test -ldflags="$(LDFLAGS)" -cover -coverprofile=coverage.out -v $$(echo $$(go list ./... | grep -v /test/))
+	go test $($*_LDFLAGS) -cover -coverprofile=coverage-$*.out -v $$($($*_TEST_FILES) | tr '\n' ' ')
 
 .PHONY: test-integration
 test-integration: download-tokenizer install-dependencies ## Run integration tests
@@ -108,14 +121,6 @@ post-deploy-test: ## Run post deployment tests
 	echo Success!
 	@echo "Post-deployment tests passed."
 
-.PHONY: sidecar-test
-sidecar-test: sidecar-test-unit ## Run Sidecar tests
-
-.PHONY: sidecar-test-unit
-sidecar-test-unit: ## Run Sidecar unit tests
-	@printf "\033[33;1m==== Running tests ====\033[0m\n"
-	go test -v $$(echo $$(go list ./pkg/sidecar/...)) -ginkgo.v
-
 .PHONY: lint
 lint: check-golangci-lint check-typos ## Run lint
 	@printf "\033[33;1m==== Running linting ====\033[0m\n"
@@ -125,47 +130,36 @@ lint: check-golangci-lint check-typos ## Run lint
 ##@ Build
 
 .PHONY: build
-build: check-go install-dependencies download-tokenizer ## Build the project
-	@printf "\033[33;1m==== Building ====\033[0m\n"
-	go build -ldflags="$(LDFLAGS)" -o bin/epp cmd/epp/main.go
+build: epp-build sidecar-build ## Build the project
 
-.PHONY: sidecar-build
-sidecar-build: check-go ## Build the Sidecar
-	@printf "\033[33;1m==== Building the Sidecar ====\033[0m\n"
-	go build -o bin/$(SIDECAR_NAME) cmd/$(SIDECAR_NAME)/main.go
+.PHONY: %-build
+%-build: check-go install-dependencies download-tokenizer ## Build the project
+	@printf "\033[33;1m==== Building ====\033[0m\n"
+	go build $($*_LDFLAGS) -o bin/$($*_NAME) cmd/$($*_NAME)/main.go
 
 ##@ Container Build/Push
 
 .PHONY:	image-build
-image-build: check-container-tool ## Build Docker image ## Build Docker image using $(CONTAINER_TOOL)
-	@printf "\033[33;1m==== Building Docker image $(IMG) ====\033[0m\n"
+image-build: epp-image-build sidecar-image-build ## Build Docker image
+
+.PHONY:	%-image-build
+%-image-build: check-container-tool ## Build Docker image ## Build Docker image using $(CONTAINER_TOOL)
+	@printf "\033[33;1m==== Building Docker image $($*_IMAGE) ====\033[0m\n"
 	$(CONTAINER_TOOL) build \
 		--platform linux/$(TARGETARCH) \
  		--build-arg TARGETOS=linux \
 		--build-arg TARGETARCH=$(TARGETARCH) \
 		--build-arg COMMIT_SHA=${GIT_COMMIT_SHA} \
 		--build-arg BUILD_REF=${BUILD_REF} \
- 		-t $(IMG) .
+ 		-t $($*_IMAGE) -f Dockerfile.$* .
 
 .PHONY: image-push
-image-push: check-container-tool ## Push Docker image $(IMG) to registry
-	@printf "\033[33;1m==== Pushing Docker image $(IMG) ====\033[0m\n"
-	$(CONTAINER_TOOL) push $(IMG)
-
-.PHONY: sidecar-image-build
-sidecar-image-build: check-container-tool ## Build Sidecar Docker image ## Build Sidecar Docker image using $(CONTAINER_TOOL)
-	@printf "\033[33;1m==== Building Sidecar Docker image $(SIDECAR_IMG) ====\033[0m\n"
-	$(CONTAINER_TOOL) build \
-		--build-arg TARGETOS=linux \
-		--build-arg TARGETARCH=$(TARGETARCH) \
-		--build-arg COMMIT_SHA=${GIT_COMMIT_SHA} \
-		--build-arg BUILD_REF=${BUILD_REF} \
-		-t $(SIDECAR_IMG) -f Dockerfile.sidecar .
+image-push: epp-image-push sidecar-image-push ## Push Docker images to registry
 
-.PHONY: sidecar-image-push
-sidecar-image-push: check-container-tool load-version-json ## Push Sidecar Docker image $(SIDECAR_IMG) to registry
-	@printf "\033[33;1m==== Pushing Sidecar Docker image $(SIDECAR_IMG) ====\033[0m\n"
-	$(CONTAINER_TOOL) push $(SIDECAR_IMG)
+.PHONY: %-image-push
+%-image-push: check-container-tool load-version-json ## Push Docker image to registry
+	@printf "\033[33;1m==== Pushing Docker image $($*_IMAGE) ====\033[0m\n"
+	$(CONTAINER_TOOL) push $($*_IMAGE)
 
 ##@ Install/Uninstall Targets