refactor: Update Makefile target names to match finch cli (#70)

refactor: update Makefile target names to match finch cli

Signed-off-by: Swagat Bora <[email protected]>

Author: swagatbora90

.github/workflows/ci.yaml

@@ -63,7 +63,7 @@ jobs:
       - name: Build and run unit tests
         run: |
           make build
-          make run-unit-tests
+          make test-unit
   e2e-test:
     runs-on: ubuntu-latest
     steps:
@@ -83,4 +83,4 @@ jobs:
       - name: Start finch-daemon
         run: sudo bin/finch-daemon  --debug --socket-owner $UID &
       - name: Run e2e test
-        run: sudo make run-e2e-tests
+        run: sudo make test-e2e

Makefile

@@ -53,8 +53,8 @@ ifneq ("$(wildcard /run/finch.sock)","")
 	sudo unlink /run/finch.sock
 endif
 
-.PHONY: code-gen
-code-gen: linux
+.PHONY:  gen-code
+ gen-code: linux
 	rm -rf ./pkg/mocks
 	GOBIN=$(BIN) go install github.com/golang/mock/mockgen
 	GOBIN=$(BIN) go install golang.org/x/tools/cmd/stringer
@@ -72,36 +72,36 @@ GOLINT=$(BIN)/golangci-lint
 $(GOLINT): linux
 	curl -sSfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh | sh -s -- -b $(BIN) v1.60.3
 
-.PHONY: golint
-golint: linux $(GOLINT) 
+.PHONY: lint
+lint: linux $(GOLINT)
 	$(GOLINT) run ./...
 
-.PHONY: run-unit-tests
-run-unit-tests: linux
+.PHONY: test-unit
+test-unit: linux
 	$(GINKGO) $(GFLAGS) ./...
 
-.PHONY: licenses
-licenses:
-	PATH=$(BIN):$(PATH) go-licenses report --template="scripts/third-party-license.tpl" --ignore github.com/runfinch ./... > THIRD_PARTY_LICENSES
-
 # Runs tests in headless dlv mode, must specify package directory with PKG_DIR
 PKG_DIR ?= .
-.PHONY: debug-unit-tests
-debug-unit-tests: linux $(DLV)
+.PHONY: test-unit-debug
+test-unit-debug: linux $(DLV)
 	sudo $(DLV) --listen=:2345 --headless=true --api-version=2 test $(PKG_DIR)
 
+.PHONY: test-e2e
+test-e2e: linux
+	DOCKER_HOST="unix:///run/finch.sock" \
+	DOCKER_API_VERSION="v1.41" \
+	TEST_E2E=1 \
+	$(GINKGO) $(GFLAGS) ./e2e/...
+
+.PHONY: licenses
+licenses:
+	PATH=$(BIN):$(PATH) go-licenses report --template="scripts/third-party-license.tpl" --ignore github.com/runfinch ./... > THIRD_PARTY_LICENSES
+
 .PHONY: coverage
 coverage: linux
 	$(GINKGO) -r -v -race --trace --cover --coverprofile="coverage-report.out" ./...
 	go tool cover -html="coverage-report.out" -o="unit-test-coverage-report.html"
 
-.PHONY: run-e2e-tests
-run-e2e-tests: linux
-	DOCKER_HOST="unix:///run/finch.sock" \
-	DOCKER_API_VERSION="v1.41" \
-	RUN_E2E_TESTS=1 \
-	$(GINKGO) $(GFLAGS) ./e2e/...
-
 .PHONY: release
 release: linux
 	@echo "$@"

README.md

@@ -32,7 +32,7 @@ Getting started with Finch Daemon on Linux only requires a few steps:
    make
    sudo bin/finch-daemon --debug --socket-owner $UID
    ```
-5. Test any changes with `make run-unit-tests` and `sudo make run-e2e-tests`
+5. Test any changes with `make test-unit` and `sudo make test-e2e`
 
 
 ## Creating a systemd service

e2e/e2e_test.go

@@ -16,8 +16,8 @@ import (
 )
 
 func TestRun(t *testing.T) {
-	if os.Getenv("RUN_E2E_TESTS") != "1" {
-		t.Skip("E2E tests skipped. Set RUN_E2E_TESTS=1 to run these tests")
+	if os.Getenv("TEST_E2E") != "1" {
+		t.Skip("E2E tests skipped. Set TEST_E2E=1 to run these tests")
 	}
 	// TODO : Make this configurable
 	runtimeExe := "nerdctl"