Makefile

TMPL_DIR := templates-cfg
OP_TMPL_DIR := templates-op
BUILD_DIR := build
DATA_DIR := data
SHIM_DIR := src/shim
LIBS := -lzmq
CFLAGS :=
BUILD_ARCH := $(shell dpkg-architecture -q DEB_BUILD_ARCH)
J2LINT := $(shell command -v j2lint 2> /dev/null)

config_xml_src = $(wildcard interface-definitions/*.xml.in)
config_xml_obj = $(config_xml_src:.xml.in=.xml)
op_xml_src = $(wildcard op-mode-definitions/*.xml.in)
op_xml_obj = $(op_xml_src:.xml.in=.xml)

.PHONY: libvyosconfig
libvyosconfig:
	@if [ ! -f /usr/lib/libvyosconfig.so.0 ]; then \
		make -C libvyosconfig clean ; \
		make -C libvyosconfig all ; \
		sudo make -C libvyosconfig install ; \
	fi

%.xml: %.xml.in
	@echo Generating $(BUILD_DIR)/$@ from $<
	mkdir -p $(BUILD_DIR)/$(dir $@)
	$(CURDIR)/scripts/transclude-template $< > $(BUILD_DIR)/$@

.PHONY: interface_definitions
.ONESHELL:
interface_definitions: libvyosconfig $(config_xml_obj)
	rm -rf $(TMPL_DIR); mkdir -p $(TMPL_DIR)

	$(CURDIR)/scripts/override-default $(BUILD_DIR)/interface-definitions

	find $(BUILD_DIR)/interface-definitions -type f -name "*.xml" | xargs -I {} $(CURDIR)/scripts/build-command-templates {} $(CURDIR)/schema/interface_definition.rng $(TMPL_DIR) || exit 1

	$(CURDIR)/python/vyos/xml_ref/generate_cache.py --xml-dir $(BUILD_DIR)/interface-definitions --internal-cache $(DATA_DIR)/reftree.cache || exit 1

	# XXX: delete top level node.def's that now live in other packages
	# IPSec VPN EAP-RADIUS does not support source-address
	rm -rf $(TMPL_DIR)/vpn/ipsec/remote-access/radius/source-address

	# T2472 - EIGRP support
	rm -rf $(TMPL_DIR)/protocols/eigrp
	# T2773 - EIGRP support for VRF
	rm -rf $(TMPL_DIR)/vrf/name/node.tag/protocols/eigrp

	# XXX: test if there are empty node.def files - this is not allowed as these
	# could mask help strings or mandatory priority statements
	find $(TMPL_DIR) -name node.def -type f -empty -exec false {} + || sh -c 'echo "There are empty node.def files! Check your interface definitions." && exit 1'


.PHONY: op_mode_definitions
.ONESHELL:
op_mode_definitions: $(op_xml_obj)
	rm -rf $(OP_TMPL_DIR); mkdir -p $(OP_TMPL_DIR)

	find $(BUILD_DIR)/op-mode-definitions/ -type f -name "*.xml" | xargs -I {} $(CURDIR)/scripts/build-command-op-templates {} $(CURDIR)/schema/op-mode-definition.rng $(OP_TMPL_DIR) || exit 1

	$(CURDIR)/python/vyos/xml_ref/generate_op_cache.py --xml-dir $(BUILD_DIR)/op-mode-definitions --export-json $(DATA_DIR)/op_cache.json || exit 1

	# XXX: tcpdump, ping, traceroute and mtr must be able to recursivly call themselves as the
	# options are provided from the scripts themselves
	ln -s ../node.tag $(OP_TMPL_DIR)/ping/node.tag/node.tag/
	ln -s ../node.tag $(OP_TMPL_DIR)/traceroute/node.tag/node.tag/
	ln -s ../node.tag $(OP_TMPL_DIR)/mtr/node.tag/node.tag/
	ln -s ../node.tag $(OP_TMPL_DIR)/monitor/traceroute/node.tag/node.tag/
	ln -s ../node.tag $(OP_TMPL_DIR)/monitor/traffic/interface/node.tag/node.tag/
	ln -s ../node.tag $(OP_TMPL_DIR)/execute/port-scan/host/node.tag/node.tag/

	# XXX: test if there are empty node.def files - this is not allowed as these
	# could mask help strings or mandatory priority statements
	find $(OP_TMPL_DIR) -name node.def -type f -empty -exec false {} + || sh -c 'echo "There are empty node.def files! Check your interface definitions." && exit 1'

.PHONY: vyshim
vyshim:
	$(MAKE) -C $(SHIM_DIR)

.PHONY: all
all: clean copyright libvyosconfig pylint interface_definitions op_mode_definitions test j2lint vyshim generate-configd-include-json

.PHONY: copyright
copyright:
	@if git grep -q -E "Copyright( \(C\))? (19|20)[0-9]{2}(-[0-9]{4})? VyOS maintainers"; then \
		echo "Error: Legacy copyright notice found."; \
		exit 1; \
	fi

.PHONY: clean
clean:
	rm -rf $(BUILD_DIR)
	rm -rf $(TMPL_DIR)
	rm -rf $(OP_TMPL_DIR)
	$(MAKE) -C $(SHIM_DIR) clean

.PHONY: test
test: generate-configd-include-json
	set -e; python3 -m compileall -q -x '/vmware-tools/scripts/' .
	PYTHONPATH=python/ python3 -m nose2 -v

.PHONY: check_migration_scripts_executable
.ONESHELL:
check_migration_scripts_executable:
	@echo "Checking if migration scripts have executable bit set..."
	find src/migration-scripts -type f -not -executable -print -exec false {} + || sh -c 'echo "Found files that are not executable! Add permissions." && exit 1'

.PHONE: pylint
pylint: interface_definitions
	@echo Running "pylint ..."
	@set -e; \
	PYTHONPATH="python/:smoketest/scripts/cli/" pylint --errors-only $(shell git ls-files python/**/*.py src/conf_mode/*.py src/op_mode/*.py src/migration-scripts src/services/vyos* smoketest/scripts); \
	PYTHONPATH=python/ pylint --disable=all --enable=W0611 $(shell git ls-files *.py src/migration-scripts src/services)

.PHONY: j2lint
j2lint:
ifndef J2LINT
	$(error "j2lint binary not found, consider installing: pip install git+https://github.com/aristanetworks/j2lint.git@341b5d5db86")
endif
	$(J2LINT) data/

.PHONY: sonar
sonar:
	sonar-scanner -X -Dsonar.login=${SONAR_TOKEN}

deb:
	dpkg-buildpackage -uc -us -tc -b

.PHONY: generate-configd-include-json
generate-configd-include-json:
	@scripts/generate-configd-include-json.py

.PHONY: schema
schema:
	trang -I rnc -O rng schema/interface_definition.rnc schema/interface_definition.rng
	trang -I rnc -O rng schema/op-mode-definition.rnc schema/op-mode-definition.rng