Makefile

# Copyright 2020 Intel Corporation
#
# SPDX-License-Identifier: GPL-3.0-only

top_srcdir = $(abspath .)
MAKEFLAGS += -r --no-print-directory

build_dir = $(top_srcdir)/build
build_bin_dir = $(build_dir)/bin
pkg_dir = $(top_srcdir)
cov_dir = $(top_srcdir)/.coverage
runuid := $(shell id -u)
nproc = $(shell nproc)
orig_go_path = $(shell go env GOPATH)

# The -Wno-deprecated-declarations option is required to suppress deprecation
# warnings in the gotk3 package. https://github.com/gotk3/gotk3/issues/420
ifneq ($(CGO_CFLAGS),)
export CGO_CFLAGS += -Wno-deprecated-declarations
else
export CGO_CFLAGS = $(shell go env CGO_CFLAGS) -Wno-deprecated-declarations
endif

export GOPATH=$(pkg_dir)
export GO_PACKAGE_PREFIX := github.com/clearlinux/clr-installer
export TESTS_DIR := $(top_srcdir)/tests/
export FUNCTIONAL_TEST_DIR := $(top_srcdir)/tests/functional/
export BASEBUILD_DIR := $(shell mktemp --dir --dry-run)
export BASEIMGNAME := baseline
export BASEIMG := $(TESTS_DIR)/$(BASEIMGNAME)
export BASEIMGLOG := $(BASEBUILD_DIR)/$(BASEIMGNAME).log
export TRAVIS_CONF = $(top_srcdir)/.travis.yml
export UPDATE_COVERAGE = 1
export GO111MODULE=auto
LOCAL_GOPATH := ${CURDIR}/.gopath
export GOPATH := ${LOCAL_GOPATH}
export GOFLAGS += -mod=vendor


# Required for tests to work well
export CLR_INSTALLER_LOCALE_DIR := $(top_srcdir)/locale
CLR_INSTALLER_TEST_HTTP_PORT ?= 8181
export TEST_HTTP_PORT = ${CLR_INSTALLER_TEST_HTTP_PORT}


THEME_DIR=$(DESTDIR)/usr/share/clr-installer/themes/
LOCALE_DIR=$(DESTDIR)/usr/share/locale
ISO_TEMPLATE_DIR=$(DESTDIR)/usr/share/clr-installer/iso_templates/
DESKTOP_DIR=$(DESTDIR)/usr/share/applications/
CONFIG_DIR=$(DESTDIR)/usr/share/defaults/clr-installer/
SYSTEMD_DIR=$(DESTDIR)/usr/lib/systemd/system/
PKIT_DIR=$(DESTDIR)/usr/share/polkit-1/
BASH_COMP_DIR=$(DESTDIR)/usr/share/bash-completion/completions/
ZSH_COMP_DIR=$(DESTDIR)/usr/share/zsh/site-functions/
BUILDDATE=$(shell date -u "+%Y-%m-%d_%H:%M:%S_%Z")

# Are we running from a Git Repo?
$(shell [ -d .git ] || git rev-parse --is-inside-work-tree > /dev/null 2>&1)
ifeq ($(.SHELLSTATUS),0)
IS_GIT_REPO=1
else
IS_GIT_REPO=0
endif

ifeq ($(IS_GIT_REPO),1)
# Use the git tag and SHA
# Standard build case from Git repo
VERSION=$(shell git describe --tags --always --dirty --match '[0-9]*.[0-9]*.[0-9]*' --exclude '[0-9]*.[0-9]*.[0-9]*.*[0-9]')
else
# If VERSION is defined in the environment, use it; otherwise...
ifeq ($(VERSION),)
# Attempt to parse from the directory name
# Building from a versioned source archive
mkfile_dir=$(shell dirname $(abspath $(lastword $(MAKEFILE_LIST))))
VERSION=$(shell basename $(mkfile_dir) | awk -F- '{print $$NF}')
endif
endif

# Validate the Version
validate_version:
ifeq ($(IS_GIT_REPO),0)
ifeq (,$(shell echo $(VERSION) | egrep '^[0-9]+.[0-9]+.[0-9]+$$' 2> /dev/null))
	@echo "Invalid version string: $(VERSION)"
	@exit 1
endif
endif

# Install
install: install-tui install-gui

install-common:
	@install -D -m 644 $(top_srcdir)/themes/clr-installer.theme $(THEME_DIR)/clr-installer.theme
	@install -D -m 644 $(top_srcdir)/themes/high-contrast.theme $(THEME_DIR)/high-contrast.theme
	@mkdir -p -m 755 $(LOCALE_DIR)/
	@cp -rp --no-preserve=ownership $(top_srcdir)/locale/* $(LOCALE_DIR)/
	@install -D -m 644 $(top_srcdir)/iso_templates/initrd_init_template $(ISO_TEMPLATE_DIR)/initrd_init_template
	@install -D -m 644 $(top_srcdir)/iso_templates/isolinux.cfg.template $(ISO_TEMPLATE_DIR)/isolinux.cfg.template
	@install -D -m 644 $(top_srcdir)/etc/clr-installer.yaml $(CONFIG_DIR)/clr-installer.yaml
	@install -D -m 644 $(top_srcdir)/etc/bundles.json $(CONFIG_DIR)/bundles.json
	@install -D -m 644 $(top_srcdir)/etc/kernels.json $(CONFIG_DIR)/kernels.json
	@install -D -m 644 $(top_srcdir)/etc/chpasswd $(CONFIG_DIR)/chpasswd
	@install -D -m 644 $(top_srcdir)/etc/systemd/clr-installer-provision.service $(SYSTEMD_DIR)/clr-installer-provision.service
	@install -D -m 644 $(top_srcdir)/completions/bash/clr-installer $(BASH_COMP_DIR)/clr-installer
	@install -D -m 644 $(top_srcdir)/completions/zsh/_clr-installer $(ZSH_COMP_DIR)/_clr-installer

install-tui: build-tui install-common
	@install -D -m 755 $(top_srcdir)/.gopath/bin/clr-installer-tui $(DESTDIR)/usr/bin/clr-installer

install-gui: build-gui install-common
	@install -D -m 755 $(top_srcdir)/.gopath/bin/clr-installer-gui $(DESTDIR)/usr/bin/clr-installer-gui
	@install -D -m 644 $(top_srcdir)/etc/org.clearlinux.clr-installer-gui.policy $(PKIT_DIR)/actions/org.clearlinux.clr-installer-gui.policy
	@install -D -m 644 $(top_srcdir)/etc/org.clearlinux.clr-installer-gui.rules $(PKIT_DIR)/rules.d/org.clearlinux.clr-installer-gui.rules
	@install -D -m 644 $(top_srcdir)/themes/clr.png $(THEME_DIR)/clr.png
	@install -D -m 644 $(top_srcdir)/themes/style.css $(THEME_DIR)/style.css
	@install -D -m 644 $(top_srcdir)/etc/clr-installer-gui.desktop $(DESKTOP_DIR)/clr-installer-gui.desktop

uninstall:
	@rm -f $(DESTDIR)/usr/bin/clr-installer
	@rm -f $(PKIT_DIR)/actions/org.clearlinux.clr-installer-gui.policy
	@rm -f $(PKIT_DIR)/rules.d/org.clearlinux.clr-installer-gui.rules
	@rm -f $(THEME_DIR)/clr-installer.theme
	@rm -f $(THEME_DIR)/high-contrast.theme
	@rm -f $(THEME_DIR)/clr.png
	@rm -f $(THEME_DIR)/style.css
	@rm -f $(LOCALE_DIR)/*/LC_MESSAGES/clr-installer.po
	@rm -f $(CONFIG_DIR)/clr-installer.yaml
	@rm -f $(CONFIG_DIR)/bundles.json
	@rm -f $(CONFIG_DIR)/kernels.json
	@rm -f $(DESKTOP_DIR)/clr-installer-gui.desktop
	@rm -f $(CONFIG_DIR)/chpasswd
	@rm -f $(DESTDIR)/var/lib/clr-installer/clr-installer.yaml
	@rm -f $(SYSTEMD_DIR)/clr-installer-provision.service

# Build
build: validate_version build-tui build-gui
	ln ${GOPATH}/bin/clr-installer-tui ${GOPATH}/bin/clr-installer

build-tui:
	@echo "MAKEFLAGS=${MAKEFLAGS}"
	go install -p ${nproc} -v \
		-ldflags="-X github.com/clearlinux/clr-installer/model.Version=${VERSION} \
		-X github.com/clearlinux/clr-installer/model.BuildDate=${BUILDDATE}" \
		${GO_PACKAGE_PREFIX}/clr-installer
	mv -f ${GOPATH}/bin/clr-installer ${GOPATH}/bin/clr-installer-tui

build-gui:
	@echo "MAKEFLAGS=${MAKEFLAGS}"
	go install -p ${nproc} -v -tags guiBuild \
		-ldflags="-X github.com/clearlinux/clr-installer/model.Version=${VERSION} \
		-X github.com/clearlinux/clr-installer/model.BuildDate=${BUILDDATE}" \
		${GO_PACKAGE_PREFIX}/clr-installer
	mv -f ${GOPATH}/bin/clr-installer ${GOPATH}/bin/clr-installer-gui

build-local-travis: validate_version
	@go install -p ${nproc} -v \
		-ldflags="-X github.com/clearlinux/clr-installer/model.Version=${VERSION} \
		-X github.com/clearlinux/clr-installer/model.BuildDate=${BUILDDATE}" \
		${GO_PACKAGE_PREFIX}/local-travis

#  Checks
check-coverage: build-local-travis
	@echo "local-travis simulation:"
	@$(top_srcdir)/.gopath/bin/local-travis

check: bundle-check
	@# Ensure no temp files are left behind
	@LSCMD='ls -lart --ignore="." /tmp'; \
	SHACMD='ls -art --ignore="." /tmp | sha512sum'; \
	BEFORELS=`eval $$LSCMD`; \
	BEFORESHA=`eval $$SHACMD`; \
	go test ${CHECK_VERBOSE} -cover ${GO_PACKAGE_PREFIX}/...; \
	if [ "$$?" != "0" ]; then \
		/bin/false; \
	else \
		AFTERSHA=`eval $$SHACMD`; \
		AFTERLS=`eval $$LSCMD`; \
		if [ "$$BEFORESHA" != "$$AFTERSHA" ]; then \
			echo "Test Failed: Temporary directory may not be clean!"; \
			echo "Left-over files:"; \
			echo "$$BEFORELS" > /tmp/beforels; \
			echo "$$AFTERLS" > /tmp/afterls; \
			diff -Nr /tmp/beforels /tmp/afterls; \
			/bin/false ; \
		fi; \
	fi; \

check-image: build-tui check-for-root-user
	@mkdir -p ${BASEBUILD_DIR}
	cd ${BASEBUILD_DIR} ; ${LOCAL_GOPATH}/bin/clr-installer-tui --config ${BASEIMG}.yaml --log-file ${BASEIMGLOG}
	@if [ ! -f "$(BASEBUILD_DIR)/${BASEIMGNAME}.iso" ] ; then \
		echo "Test Failed: Missing ${BASEIMGNAME}.iso"; \
		/bin/false; \
	fi
	@if [ ! -f "$(BASEBUILD_DIR)/${BASEIMGNAME}.img.xz" ] ; then \
		echo "Test Failed: Missing ${BASEIMGNAME}.img.xz"; \
		/bin/false; \
	fi
	@cd ${top_srcdir}
	@if [ -z "${NO_CLEANUP}" ] ; then \
		/bin/rm -rf ${BASEBUILD_DIR}; \
	else \
		echo "${BASEIMGNAME} results remain in ${BASEBUILD_DIR}"; \
		/bin/ls ${BASEBUILD_DIR}; \
	fi
	@echo "consider running 'sudo make clean' to remove the files built as root"

PHONY += check-for-root-user
check-for-root-user:
	@if [ "${runuid}" != "0" ] ; then \
		echo "Needs to be run as root; please use 'sudo'"; \
		/bin/false; \
	fi

PHONY += check-json-yaml
check-json-yaml: check-for-root-user
	@${top_srcdir}/tests/check-json-yaml.sh .
	@echo "consider running 'sudo make clean' to remove the files built as root"

PHONY += check-all-images
check-all-images: check-for-root-user
	@echo "This process runs serially and take a long time and should not be aborted!"
	@echo "Consider instead 'make check-all-images-screen'"
	@echo "Waiting 10 seconds to start..."
	@sleep 10
	@${top_srcdir}/tests/check-all-images.sh .
	@echo "consider running 'sudo make clean' to remove the files built as root"

PHONY += check-all-images-screen
check-all-images-screen: check-for-root-user
	@echo "Lauching screen sessions..."; \
	echo "Use <control>-a<controld>-d to detach and leave running."; \
	echo "	sudo screen -R # to recover session"
	@sleep 2
	@screen_log="screen-check-all-images.log"; \
	if [ -f $${screen_log} ] ; then \
		mv -f $${screen_log} $${screen_log}.save; \
	fi; \
	screen -L -Logfile $${screen_log} ${top_srcdir}/tests/check-all-images.sh . ; \
	echo "consider running 'sudo make clean' to remove the files built as root" ; \
	echo "Review results in $${screen_log}" ; \
	echo "Last 5 lines of $${screen_log}:" ; \
	echo "" ; \
	tail -5 $${screen_log}

PHONY += check-clean
check-clean:
	@go clean -testcache

PHONY += check-root
check-root:
	@sudo -E go test ${CHECK_VERBOSE} -cover ${GO_PACKAGE_PREFIX}/...

PHONY += bundle-check
bundle-check:
	@${top_srcdir}/scripts/bundle-check.sh

# coverage
# There is a bug between vet and test of duplication with mod flag inside GOFLAGS
# https://github.com/golang/go/issues/32471 looks this will resolve with go 1.15
# Till then we will Overide with GOFLAGS=""

PHONY += coverage
coverage: build
	@# Test for coverage and race conditions
	@rm -rf ${cov_dir}; \
	mkdir -p ${cov_dir}; \
	for pkg in $$(go list $$GO_PACKAGE_PREFIX/...); do \
		file="${cov_dir}/$$(echo $$pkg | tr / -).cover"; \
		go test -race -covermode="atomic" -coverprofile="$$file" "$$pkg"; \
		if [ "$$?" -ne 0 ]; then \
			exit 1; \
		fi \
	done; \
	echo "mode: count" > ${cov_dir}/cover.out; \
	grep -h -v "^mode:" ${cov_dir}/*.cover >>"${cov_dir}/cover.out"; \

PHONY += coverage-func
coverage-func: coverage
	@go tool cover -func="${cov_dir}/cover.out"

PHONY += coverage-html
coverage-html: coverage
	@go tool cover -html="${cov_dir}/cover.out"

# linters
PHONY += install-linters
install-linters:
	@if ! ${orig_go_path}/bin/golangci-lint --version &>/dev/null; then \
		echo "Installing linters..."; \
		curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh| sh -s -- -b ${orig_go_path}/bin; \
	fi

PHONY += install-linters-force
install-linters-force:
	echo "Force Installing linters..."
	curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh| sh -s -- -b ${orig_go_path}/bin

PHONY += update-linters
update-linters:
	@if ${orig_go_path}/bin/golangci-lint --version &>/dev/null; then \
		echo "Updating linters..."; \
		curl -sfL https://raw.githubusercontent.com/golangci/golangci-lint/master/install.sh| sh -s -- -b ${orig_go_path}/bin; \
	else \
		echo "Linters not installed"; \
		exit 1; \
	fi

PHONY += lint
lint: lint-release

PHONY += lint-release
lint-release: lint-all
	@echo "Linters complete"

PHONY += lint-core
lint-core: build install-linters
	@echo "Running linters"

PHONY += lint-all
lint-all: lint-core
	@echo "Running all linters using config file for default"
	@${orig_go_path}/bin/golangci-lint run --config $(top_srcdir)/.golangci.yml \
	./...

PHONY += tag
ifeq ($(IS_GIT_REPO),1)
tag:
	@if git diff-index --quiet HEAD &>/dev/null; then \
		if git diff @{upstream}.. --quiet &>/dev/null; then \
			echo "Create and push the Tag to GitHub"; \
			echo "git tag <version>"; \
			echo "git push <remote> <version>"; \
		else \
			echo "Unpushed changes; git push upstream and try again."; \
			exit 1; \
		fi \
	else \
		echo "Uncomiited changes; git commit and try again."; \
		exit 1; \
	fi
else
tag:
	@echo "Not running from Git Repo; tag will not work."
	@exit 1
endif

# clean
PHONY += clean
ifeq ($(IS_GIT_REPO),1)
clean:
	@go clean -modcache
	@rm -rf ${LOCAL_GOPATH}/{bin,src}
	@git clean -fdXq
else
clean:
	@go clean -modcache
	@rm -rf ${LOCAL_GOPATH}/{bin,src}
endif

# vendor management
# (dont execute vendor-init this on travis)
PHONY += vendor-init
vendor-init:
	@echo "Initializing Dependencies "
	@echo "--------------------------------"
	@go mod vendor

PHONY += vendor-status
vendor-status:
	@GOFLAGS="" go list -m -u --json all 2>/dev/null \
	| jq -r --slurp '.[] | [.Path, .Version, .Indirect, .Update.Version] | @csv' \
	| awk -v FS="," 'BEGIN{print "Module\t\t\t\t\t\tVersion\t\t\t\t\t\tInDirect\tAvailable-Update";print "============================================================================================================================="};{printf "%-50s%-50s%-10s%-50s\n",$$1,$$2==NULL? "NA":$$2,$$3, $$4}'

PHONY += vendor-update
vendor-update:
	@for pkg in `go list -m all | cut -d" " -f1`; do \
		if [ "$$pkg" != "github.com/clearlinux/clr-installer" ]; then \
			GOFLAGS="" go get -u $$pkg; \
		fi; \
	done
	@go mod vendor
	@go mod tidy

PHONY += vendor-check
vendor-check:
	@go mod tidy 2>/dev/null
	@go mod verify 2>/dev/null

PHONY += distclean
ifeq ($(IS_GIT_REPO),1)
dist-clean: clean
	@if [ "$$(git status -s)" = "" ]; then \
		git clean -fdxq; \
		git reset HEAD; \
		go clean -testcache; \
	else \
		echo "There are pending changes in the repository!"; \
		git status -s; \
		echo "Please check in changes or stash, and try again."; \
	fi
else
dist-clean: clean
	@go clean -testcache
endif

PHONY += functional-check
functional-check: check-for-root-user build
	@for test in $$(find $$FUNCTIONAL_TEST_DIR -name "*.bats" | sort); do \
		echo "Running $$test"; \
		bats $$test; \
	done

PHONY += dev-check-all
dev-check-all: check-for-root-user build lint functional-check check
	@echo "Running dev tests have passed"

PHONY += damage
damage:
	@echo "Building damage_file"
	go build tests/damage_file.go

all: build

PHONY += all

.PHONY = $(PHONY)
.DEFAULT_GOAL = all