Makefile

.PHONY: all render register build run up compile reload netsims down
.PHONY: dev-setup dev-venv dev-nso-libs dev-install dev-check dev-format dev-lint dev-type-check dev-clean

# Makefile for building, creating and cleaning
# the NSO and CXTA containers for this development environment.

# Requirements:
# 1. Docker and Docker Compose installed and running.
# 2. BuildKit enabled (usually default in recent Docker versions, or set DOCKER_BUILDKIT=1).
# 3. A 'docker-compose.yml' file defining the services for NSO and CXTA, plus the runtime secrets.
# 4. A 'Dockerfile' for the NSO custom image, configured to use BuildKit's

# Default target: build and then up
all: up dev-setup

# Target to render the templates in this repository (*j2 files) with the information from config.yaml
render:
	@echo "--- ✨ Rendering templates ---"
	./setup/render-templates.sh

# Target to mount a local Docker registry on localhost:5000 for your NSO container image,
# in case it comes from a clean `docker loads` and it is not hosted in a registry
register:
	@echo "--- 📤 Mounting local registry (if needed) ---"
	./setup/mount-registry-server.sh

# Target to build the Docker image with secrets
# The Dockerfile in the repository is used for this
# The Docker BuildKit is used for best security practices - The secrets are not recorded in the layers history
build:
	@echo "--- 🏗️ Building NSO custom image with BuildKit secrets ---"
	./setup/build-image.sh

# Target to run the docker compose services with healthcheck
# We don't know how long the NSO container is going to take to become healthy.
# as it depends on the artifacts and NEDs from the custom image.
# Therefore, we are using a script instead of a fixed timed.
run:
	@echo "--- 🚀 Starting Docker Compose services ---"
	./setup/run-services.sh

# Target to run the `packages reload` command in the CLI
# of the NSO container
compile:
	@echo "--- 🛠️ Compiling your services ---"
	./setup/compile-packages.sh

# Target to run the `packages reload` command in the CLI
# of the NSO container
reload:
	@echo "--- 🔀 Reloading the services ---"
	./setup/packages-reload.sh

# Target to create and onboard the netsim devices
# in the NSO container
netsims:
	@echo "--- ⬇️ Loading preconfiguration files ---"
	./setup/load-preconfigs.sh
	@echo "--- 🛸 Loading netsims ---"
	./setup/load-netsims.sh

# Target to start Docker Compose services
up: render register build run compile reload netsims

# Target to stop Docker Compose services
down:
	@echo "--- 🛑 Stopping Docker Compose services ---"
	docker compose down

# ==============================================================================
# Development Environment Setup Targets
# ==============================================================================

# Python virtual environment paths
VENV_DIR := .venv
VENV_PYTHON := $(VENV_DIR)/bin/python
VENV_PIP := $(VENV_DIR)/bin/pip
VENV_BLACK := $(VENV_DIR)/bin/black
VENV_ISORT := $(VENV_DIR)/bin/isort
VENV_MYPY := $(VENV_DIR)/bin/mypy
VENV_PYLINT := $(VENV_DIR)/bin/pylint

# NSO Python library paths
NSO_CONTAINER := my-nso-dev
NSO_PYAPI_SRC := /opt/ncs/current/src/ncs/pyapi
NSO_PYAPI_LOCAL := ./ncs-pyapi

# Target to create Python virtual environment
dev-venv:
	@echo "--- 🐍 Creating Python virtual environment ---"
	@if [ ! -d "$(VENV_DIR)" ]; then \
		python3 -m venv $(VENV_DIR); \
		echo "--- ✅ Virtual environment created at $(VENV_DIR) ---"; \
	else \
		echo "--- ℹ️  Virtual environment already exists ---"; \
	fi

# Target to extract NSO Python libraries from container
dev-nso-libs:
	@echo "--- 📚 Extracting NSO Python libraries from container ---"
	@if ! docker ps --format '{{.Names}}' | grep -q "^$(NSO_CONTAINER)$$"; then \
		echo "--- ❌ ERROR: Container $(NSO_CONTAINER) is not running ---"; \
		echo "--- ℹ️  Please start the container first with 'make up' ---"; \
		exit 1; \
	fi
	@if [ -d "$(NSO_PYAPI_LOCAL)" ]; then \
		echo "--- ℹ️  Removing existing NSO libraries at $(NSO_PYAPI_LOCAL) ---"; \
		rm -rf $(NSO_PYAPI_LOCAL); \
	fi
	@echo "--- 📦 Copying NSO Python API from container (using tar to handle symlinks) ---"
	@mkdir -p $(NSO_PYAPI_LOCAL)
	docker exec $(NSO_CONTAINER) tar -C $(NSO_PYAPI_SRC) -cf - . | tar -C $(NSO_PYAPI_LOCAL) -xf - --exclude='*.lua'
	@echo "--- 🔧 Cleaning up broken symlinks (if any) ---"
	@find $(NSO_PYAPI_LOCAL) -type l ! -exec test -e {} \; -delete 2>/dev/null || true
	@echo "--- ✅ NSO Python libraries extracted to $(NSO_PYAPI_LOCAL) ---"

# Target to setup the complete development environment
dev-setup: dev-venv dev-nso-libs dev-install
	@echo "--- ✅ Development environment setup complete! ---"
	@echo ""
	@echo "Next steps:"
	@echo "  1. Activate the virtual environment: source $(VENV_DIR)/bin/activate"
	@echo "  2. Restart VS Code to apply settings"
	@echo "  3. Select the Python interpreter from $(VENV_DIR) in VS Code"
	@echo "  4. Start coding - GitHub Copilot will follow your standards"
	@echo "  5. Run 'make dev-check' before committing"

# Target to install all required Python development tools
dev-install: dev-venv
	@echo "--- 📦 Installing Python development tools in virtual environment ---"
	$(VENV_PIP) install --upgrade pip
	$(VENV_PIP) install black isort mypy pylint
	@if [ -d "$(NSO_PYAPI_LOCAL)" ]; then \
		echo "--- 📚 Configuring NSO Python libraries ---"; \
		SITE_PACKAGES=$$(find $(VENV_DIR)/lib -type d -name "site-packages" | head -n 1); \
		if [ -n "$$SITE_PACKAGES" ]; then \
			echo "$(shell pwd)/$(NSO_PYAPI_LOCAL)" > "$$SITE_PACKAGES/ncs-pyapi.pth"; \
			echo "--- ✅ NSO Python libraries configured in virtual environment ---"; \
		else \
			echo "--- ❌ ERROR: Could not find site-packages directory ---"; \
			exit 1; \
		fi; \
	else \
		echo "--- ⚠️  NSO libraries not found at $(NSO_PYAPI_LOCAL) ---"; \
		echo "--- ℹ️  Run 'make dev-nso-libs' to extract them from the container ---"; \
	fi
	@echo "--- ✅ Development tools installed ---"

# Target to run all code quality checks manually
dev-check: dev-format dev-lint dev-type-check
	@echo "--- ✅ All code quality checks passed! ---"

# Target to format code with Black and isort
dev-format: dev-venv
	@echo "--- 🎨 Formatting code with Black ---"
	$(VENV_BLACK) python/ packages/ || true
	@echo "--- 📚 Sorting imports with isort ---"
	$(VENV_ISORT) python/ packages/ || true
	@echo "--- ✅ Code formatting complete ---"

# Target to run linting checks
dev-lint: dev-venv
	@echo "--- 🔍 Running pylint ---"
	find python packages -name "*.py" -type f | xargs $(VENV_PYLINT) || true
	@echo "--- ✅ Linting complete ---"

# Target to run type checking with mypy
dev-type-check: dev-venv
	@echo "--- 🔎 Running type checks with mypy ---"
	@DIRS=""; \
	if [ -d "python" ]; then DIRS="$$DIRS python"; fi; \
	if [ -d "packages" ]; then DIRS="$$DIRS packages"; fi; \
	if [ -n "$$DIRS" ]; then \
		$(VENV_MYPY) $$DIRS || true; \
	else \
		echo "--- ℹ️  No Python directories found to type check ---"; \
	fi
	@echo "--- ✅ Type checking complete ---"

# Target to clean Python cache and build artifacts
dev-clean:
	@echo "--- 🧹 Cleaning Python cache and artifacts ---"
	find . -type d -name "__pycache__" -exec rm -rf {} + 2>/dev/null || true
	find . -type d -name "*.egg-info" -exec rm -rf {} + 2>/dev/null || true
	find . -type f -name "*.pyc" -delete 2>/dev/null || true
	find . -type f -name "*.pyo" -delete 2>/dev/null || true
	find . -type d -name ".mypy_cache" -exec rm -rf {} + 2>/dev/null || true
	find . -type d -name ".pytest_cache" -exec rm -rf {} + 2>/dev/null || true
	@echo "--- 🗑️  Removing virtual environment ---"
	rm -rf $(VENV_DIR)
	@echo "--- 🗑️  Removing extracted NSO libraries ---"
	rm -rf $(NSO_PYAPI_LOCAL)
	@echo "--- ✅ Cleanup complete ---"