Skip to content

[Dev] Add a run directory when developing locally #1398

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.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open

[Dev] Add a run directory when developing locally #1398

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
fa9c600
creates a run directory under build to use when developing locally
sean-breen Nov 19, 2025
8e14fc3
add back missing target
sean-breen Nov 19, 2025
2c33f50
Merge branch 'main' into add-run-directory
sean-breen Nov 21, 2025
c03e7ed
add back external file server to mock management target
sean-breen Nov 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 28 additions & 17 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,10 +19,10 @@ GOBIN ?= $$(go env GOPATH)/bin
# | amazonlinux | 2, 2023 | |
# | ubuntu | 22.04, 24.04 25.04 | |
# | debian | bullseye-slim, bookworm-slim, trixie-slim | |
# | alpine | 3.19, 3.20, 3.21 3.22 | |
# | redhatenterprise | 8, 9, 10 | |
# | rockylinux | 8, 9, 10 | |
# | almalinux | 8, 9, 10 | |
# | alpine | 3.19, 3.20, 3.21 3.22 | |
# | oraclelinux | 8, 9, 10 | |
# | suse | sle15 | |
# # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
Expand All @@ -36,17 +36,19 @@ IMAGE_PATH ?= "/nginx/agent"
TAG ?= ""
NGINX_LICENSE_JWT ?= ""

BUILD_DIR := build
TEST_BUILD_DIR := build/test
CERTS_DIR := build/certs
BUILD_DIR := $(shell pwd)/build
RUN_DIR := $(BUILD_DIR)/run
TEST_BUILD_DIR := $(BUILD_DIR)/test
CERTS_DIR := $(BUILD_DIR)/certs
DOCS_DIR := docs
PROTO_DIR := proto
BINARY_NAME := nginx-agent
PROJECT_DIR = cmd/agent
PROJECT_FILE = main.go
COLLECTOR_PATH ?= /etc/nginx-agent/opentelemetry-collector-agent.yaml
LIB_DIR ?= /var/lib/nginx-agent
DIRS = $(BUILD_DIR) $(TEST_BUILD_DIR) $(BUILD_DIR)/$(DOCS_DIR) $(BUILD_DIR)/$(DOCS_DIR)/$(PROTO_DIR)
BINARY_NAME := nginx-agent
PROJECT_DIR = cmd/agent
PROJECT_FILE = main.go
LOG_PATH ?= $(RUN_DIR)/agent.log
COLLECTOR_PATH ?= $(RUN_DIR)
LIB_DIR ?= $(RUN_DIR)
DIRS = $(BUILD_DIR) $(RUN_DIR) $(TEST_BUILD_DIR) $(BUILD_DIR)/$(DOCS_DIR) $(BUILD_DIR)/$(DOCS_DIR)/$(PROTO_DIR)
$(shell mkdir -p $(DIRS))

VERSION ?= $(shell git describe --match "v[0-9]*" --abbrev=0 --tags)
Expand All @@ -67,8 +69,8 @@ APK_PACKAGE := ./build/$(PACKAGE_NAME).apk
DEB_PACKAGE := ./build/$(PACKAGE_NAME).deb
RPM_PACKAGE := ./build/$(PACKAGE_NAME).rpm

MOCK_MANAGEMENT_PLANE_CONFIG_DIRECTORY ?=
MOCK_MANAGEMENT_PLANE_EXTERNAL_FILE_SERVER ?=
MOCK_MANAGEMENT_PLANE_CONFIG_DIRECTORY ?=
MOCK_MANAGEMENT_PLANE_EXTERNAL_FILE_SERVER ?=
MOCK_MANAGEMENT_PLANE_LOG_LEVEL ?= INFO
MOCK_MANAGEMENT_PLANE_GRPC_ADDRESS ?= 127.0.0.1:0
MOCK_MANAGEMENT_PLANE_API_ADDRESS ?= 127.0.0.1:0
Expand Down Expand Up @@ -163,7 +165,7 @@ build-mock-management-otel-collector:
mkdir -p $(BUILD_DIR)/mock-management-otel-collector
@CGO_ENABLED=0 GOARCH=$(OSARCH) GOOS=linux $(GOBUILD) -o $(BUILD_DIR)/mock-management-otel-collector/collector test/mock/collector/mock-collector/main.go

integration-test: $(SELECTED_PACKAGE) build-mock-management-plane-grpc
integration-test: $(SELECTED_PACKAGE) build-mock-management-plane-grpc
TEST_ENV="Container" CONTAINER_OS_TYPE=$(CONTAINER_OS_TYPE) BUILD_TARGET="install-agent-local" CONTAINER_NGINX_IMAGE_REGISTRY=${CONTAINER_NGINX_IMAGE_REGISTRY} \
PACKAGES_REPO=$(OSS_PACKAGES_REPO) PACKAGE_NAME=$(PACKAGE_NAME) BASE_IMAGE=$(BASE_IMAGE) DOCKERFILE_PATH=$(DOCKERFILE_PATH) IMAGE_PATH=$(IMAGE_PATH) TAG=${IMAGE_TAG} \
OS_VERSION=$(OS_VERSION) OS_RELEASE=$(OS_RELEASE) \
Expand All @@ -179,9 +181,8 @@ official-image-integration-test: $(SELECTED_PACKAGE) build-mock-management-plane
TEST_ENV="Container" CONTAINER_OS_TYPE=$(CONTAINER_OS_TYPE) CONTAINER_NGINX_IMAGE_REGISTRY=${CONTAINER_NGINX_IMAGE_REGISTRY} BUILD_TARGET="install" \
PACKAGES_REPO=$(OSS_PACKAGES_REPO) TAG=${TAG} PACKAGE_NAME=$(PACKAGE_NAME) BASE_IMAGE=$(BASE_IMAGE) DOCKERFILE_PATH=$(OFFICIAL_IMAGE_DOCKERFILE_PATH) \
OS_VERSION=$(OS_VERSION) OS_RELEASE=$(OS_RELEASE) IMAGE_PATH=$(IMAGE_PATH) \
NGINX_LICENSE_JWT=$(NGINX_LICENSE_JWT) \
go test -v ./test/integration/managementplane ./test/integration/auxiliarycommandserver

metrics-test: $(SELECTED_PACKAGE) build-mock-management-otel-collector
TEST_ENV="Container" CONTAINER_OS_TYPE=$(CONTAINER_OS_TYPE) CONTAINER_NGINX_IMAGE_REGISTRY=${CONTAINER_NGINX_IMAGE_REGISTRY} BUILD_TARGET="install" \
PACKAGES_REPO=$(OSS_PACKAGES_REPO) TAG=${TAG} PACKAGE_NAME=$(PACKAGE_NAME) BASE_IMAGE=$(BASE_IMAGE) DOCKERFILE_PATH=$(OFFICIAL_IMAGE_DOCKERFILE_PATH) \
Expand All @@ -202,15 +203,25 @@ run: build ## Run code

dev: ## Run agent executable
@echo "🚀 Running App"
NGINX_AGENT_COLLECTOR_CONFIG_PATH=$(COLLECTOR_PATH) NGINX_AGENT_LIB_DIR=$(LIB_DIR) $(GORUN) -ldflags=$(DEBUG_LDFLAGS) $(PROJECT_DIR)/$(PROJECT_FILE)
touch $(LOG_PATH)
NGINX_AGENT_COLLECTOR_CONFIG_PATH=$(COLLECTOR_PATH)/opentelemetry-collector-agent.yaml \
NGINX_AGENT_COLLECTOR_LOG_LEVEL="DEBUG" \
NGINX_AGENT_COLLECTOR_LOG_PATH=$(COLLECTOR_PATH)/otel.log \
NGINX_AGENT_LIB_DIR=$(LIB_DIR) \
$(GORUN) -ldflags=$(DEBUG_LDFLAGS) $(PROJECT_DIR)/$(PROJECT_FILE)

race-condition-dev: ## Run agent executable with race condition detection
@echo "🏎️ Running app with race condition detection enabled"
$(GORUN) -race $(PROJECT_DIR)/$(PROJECT_FILE)

run-mock-management-grpc-server: ## Run mock management plane gRPC server
@echo "🖲️ Running mock management plane gRPC server"
$(GORUN) test/mock/grpc/cmd/main.go -configDirectory=$(MOCK_MANAGEMENT_PLANE_CONFIG_DIRECTORY) -logLevel=$(MOCK_MANAGEMENT_PLANE_LOG_LEVEL) -grpcAddress=$(MOCK_MANAGEMENT_PLANE_GRPC_ADDRESS) -apiAddress=$(MOCK_MANAGEMENT_PLANE_API_ADDRESS) -externalFileServer=$(MOCK_MANAGEMENT_PLANE_EXTERNAL_FILE_SERVER)
$(GORUN) test/mock/grpc/cmd/main.go \
-configDirectory=$(MOCK_MANAGEMENT_PLANE_CONFIG_DIRECTORY) \
-logLevel=$(MOCK_MANAGEMENT_PLANE_LOG_LEVEL) \
-grpcAddress=$(MOCK_MANAGEMENT_PLANE_GRPC_ADDRESS) \
-apiAddress=$(MOCK_MANAGEMENT_PLANE_API_ADDRESS) \
-externalFileServer=$(MOCK_MANAGEMENT_PLANE_EXTERNAL_FILE_SERVER)


.PHONY: build-test-nginx-plus-and-nap-image
Expand Down
Loading