Makefile

# Makefile for https://github.com/markosamuli/linux-machine
#
# Self-documented help from:
# https://marmelab.com/blog/2016/02/29/auto-documented-makefile.html

###
# Makefile configuration
###

.DEFAULT_GOAL := help

# We want our output silent by default, use VERBOSE=1 make <command> ...
# to get verbose output.
ifndef VERBOSE
.SILENT:
endif

###
# Define environment variables in the beginning of the file
###

UNAME_S  := $(shell uname -s)

ANSIBLE_BIN    = $(shell ansible --version 2>&1 | head -1 | grep -q 'ansible 2' && command -v ansible)
BREW_BIN       = $(shell command -v brew 2>/dev/null)
GO_BIN         = $(shell command -v go 2>/dev/null)
LYNIS_BIN      = $(shell command -v lynis 2>/dev/null)
PYENV_BIN      = $(shell command -v pyenv 2>/dev/null)
PRE_COMMIT_BIN = $(shell pre-commit --version 2>&1 | head -1 | grep -q 'pre-commit [12]\.' && command -v pre-commit)
PYLINT_BIN     = $(shell pylint --version 2>&1 | head -1 | grep -q 'pylint 2' && command -v pylint)
SHELLCHECK_BIN = $(shell command -v shellcheck 2>/dev/null)
SHFMT_BIN      = $(shell command -v shfmt 2>/dev/null)

###
# Define local variables after environment variables
###

# Paths to supported Git hooks
pre_commit_hooks = .git/hooks/pre-commit
pre_push_hooks 	 = .git/hooks/pre-push
commit_msg_hooks = .git/hooks/commit-msg
git_hooks = $(pre_commit_hooks) $(pre_push_hooks) $(commit_msg_hooks)

###
# Setup
###

.PHONY: setup
setup: setup-ansible setup-requirements ## setup requirements for running playbooks

.PHONY: setup-dev
setup-dev: setup-ansible setup-dev-requirements setup-git-hooks ## setup requirements for local development

###
# Setup: Python, pyenv and virtualenv
###

.PHONY: setup-pyenv
setup-pyenv:
ifeq ($(PYENV_BIN),)
	$(MAKE) install-python
endif

.PHONY: setup-pyenv-virtualenv
setup-pyenv-virtualenv: setup-pyenv
	./scripts/create_virtualenv.sh

.PHONY: setup-requirements
setup-requirements: setup-pyenv-virtualenv
	pip install -q -r requirements.txt

.PHONY: setup-dev-requirements
setup-dev-requirements: setup-pyenv-virtualenv
	pip install -q -r requirements.dev.txt

###
# Setup: Homebrew
###

.PHONY: setup-homebrew
setup-homebrew:
ifeq ($(BREW_BIN),)
ifeq ($(UNAME_S),Linux)
	$(MAKE) install-linuxbrew
endif
ifeq ($(UNAME_S),Darwin)
	./setup --no-install-ansible --no-run-playbook --no-install-roles
endif
endif

###
# Setup: pre-commit and Git hooks
###

.PHONY: setup-pre-commit
setup-pre-commit:
ifeq ($(PRE_COMMIT_BIN),)
	$(MAKE) setup-dev-requirements
endif

.PHONY: setup-git-hooks
setup-git-hooks: $(git_hooks)

$(pre_commit_hooks): | setup-pre-commit
	pre-commit install --install-hooks

$(pre_push_hooks): | setup-pre-commit
	pre-commit install --install-hooks -t pre-push

$(commit_msg_hooks): | setup-pre-commit
	pre-commit install --install-hooks -t commit-msg

###
# Setup: Go
###

.PHONY: setup-golang
setup-golang:
ifeq ($(GO_BIN),)
	$(MAKE) install-golang
endif

###
# Setup: Lynis
###

.PHONY: setup-lynis
setup-lynis:
ifeq ($(LYNIS_BIN),)
	$(MAKE) install-security
endif


###
# Setup: Shellcheck and shfmt
###

.PHONY: setup-shellcheck
setup-shellcheck:
ifeq ($(SHELLCHECK_BIN),)
	./setup -q -t shellcheck
endif

.PHONY: setup-shfmt
setup-shfmt: setup-golang
ifeq ($(SHFMT_BIN),)
	GO111MODULE=on go get mvdan.cc/sh/v3/cmd/shfmt
endif

###
# Setup: pylint
###

.PHONY: setup-pylint
setup-pylint:
ifeq ($(PYLINT_BIN),)
	$(MAKE) setup-dev-requirements
endif

###
# Setup: Ansible roles
###

playbooks/roles/zzet.rbenv:
	./setup --no-run-playbook

playbooks/roles/markosamuli.%:
	./setup --no-run-playbook

###
# Linting and formatting
###

.PHONY: lint
lint: setup-pre-commit setup-shfmt setup-shellcheck setup-pylint  ## run pre-commit hooks on all files
	pre-commit run -a

.PHONY: format-python
format-python: setup-pre-commit  ## format Python files
	-pre-commit run -a requirements-txt-fixer
	-pre-commit run -a black

.PHONY: lint-python
lint-python: setup-pre-commit setup-pylint format-python  ## lint and format Python files
	pre-commit run -a check-ast
	pre-commit run -a flake8
	pre-commit run -a pylint

.PHONY: lint-travis
lint-travis: setup-pre-commit  ## lint .travis.yml file
	pre-commit run -a travis-lint

###
# Setup: Ansible
###

.PHONY: setup-ansible
setup-ansible:
ifeq ($(ANSIBLE_BIN),)
	$(MAKE) install-ansible
endif

.PHONY: install-ansible
install-ansible:  ## install Ansible without roles or running playbooks
	./setup \
		--install-ansible \
		--no-run-playbook \
		--no-install-roles

.PHONY: install-roles
install-roles:  ## install Ansible roles
	./setup --no-run-playbook

.PHONY: list-tags
list-tags:  # list Ansible tags
	./setup --no-run-playbook --no-install-roles -l

.PHONY: clean-roles
clean-roles: setup-requirements  ## remove outdated Ansible roles
	./scripts/clean_roles.py

.PHONY: update-roles
update-roles: setup-ansible ## update Ansible roles in the requirements.yml file
	./setup --no-install-ansible --update-roles --no-run-playbook

.PHONY: latest-roles
latest-roles: update-roles clean-roles install-roles  # update Ansible roles and install new versions

###
# Tools
###

.PHONY: audit
audit: setup-lynis  ## audit system with Lynis
	sudo lynis audit system

.PHONY: permissions
permissions: fix-permissions

.PHONY: fix-permissions
fix-permissions: setup ## fix permissions in user home directory
	USER_HOME_FIX_PERMISSIONS=true ./setup -q -t permissions

###
# Configure system with the playbooks
###

.PHONY: install
install:  ## install everything with default options
	./setup

.PHONY: antivirus
antivirus: install-antivirus

.PHONY: install-antivirus
install-antivirus: setup ## install antivirus software
	./scripts/configure.py install_antivirus true
	./setup -q -t antivirus

.PHONY: aws
aws: install-aws

.PHONY: install-aws
install-aws: setup playbooks/roles/markosamuli.aws_tools  ## install AWS tools
	./scripts/configure.py install_aws true
	./setup -q -t aws

.PHONY: docker
docker: install-docker

.PHONY: install-docker
install-docker: setup ## install Docker
	./scripts/configure.py install_docker true
	./setup -q -t docker

.PHONY: editors
editors: install-editors

.PHONY: install-editors
install-editors: setup ## install IDEs and code editors
	./setup -q -t editors

.PHONY: gcloud
gcloud: install-gcloud

.PHONY: install-gcloud
install-gcloud: setup playbooks/roles/markosamuli.gcloud  ## install Google Cloud SDK
	./scripts/configure.py install_gcloud true
	./setup -q -t gcloud

.PHONY: go
go: install-golang

.PHONY: golang
golang: install-golang

.PHONY: install-golang
install-golang: setup playbooks/roles/markosamuli.golang  ## install Go programming language
	./scripts/configure.py install_golang true
	./setup -q -t golang

.PHONY: linuxbrew
linuxbrew: install-linuxbrew

.PHONY: install-linuxbrew
install-linuxbrew: setup playbooks/roles/markosamuli.linuxbrew  ## install Homebrew on Linux
ifeq ($(UNAME_S),Linux)
	./scripts/configure.py install_linuxbrew true
	./setup -q -t linuxbrew
else
	$(error "operating system $(UNAME_S) not supported")
endif

.PHONY: lua
lua: install-lua

.PHONY: install-lua
install-lua: setup ## install Lua programming language
	./scripts/configure.py install_lua true
	./setup -q -t lua

.PHONY: monitoring
monitoring: install-monitoring

.PHONY: install-monitoring
install-monitoring: setup ## install monitoring tools
	./scripts/configure.py install_monitoring true
	./setup -q -t monitoring

.PHONY: node
node: install-node

.PHONY: install-node
install-node: setup playbooks/roles/markosamuli.nvm ## install Node.js with NVM
	./scripts/configure.py install_nodejs true
	./setup -q -t node,nvm

.PHONY: productivity
productivity: install-productivity

.PHONY: install-productivity
install-productivity: setup ## install productivity tools
	./scripts/configure.py install_productivity true
	./setup -q -t productivity

.PHONY: python
python: install-python

# Do not create virtualenv if Python is not installed yet
.PHONY: install-python
install-python: setup-ansible playbooks/roles/markosamuli.pyenv ## install Python with pyenv
	./setup -q -t python,pyenv

.PHONY: ruby
ruby: install-ruby

.PHONY: install-ruby
install-ruby: setup playbooks/roles/zzet.rbenv ## install Ruby with rbenv
	./scripts/configure.py install_ruby true
	./setup -q -t ruby,rbenv

.PHONY: rust
rust: install-rust

.PHONY: install-rust
install-rust: setup playbooks/roles/markosamuli.rust ## install Rust programming language
	./scripts/configure.py install_rust true
	./setup -q -t rust

.PHONY: security
security: install-security

.PHONY: install-security
install-security: setup ## install security tools
	./scripts/configure.py install_security true
	./setup -q -t security

.PHONY: security
security: install-security-hardening

.PHONY: install-security-hardening
install-security-hardening: setup ## install security hardening software
	./scripts/configure.py install_security_hardening true
	./setup -q -t security-hardening

.PHONY: shellcheck
shellcheck: install-shellcheck

.PHONY: install-shellcheck
install-shellcheck: setup ## install shellcheck
	./setup -q -t shellcheck

.PHONY: terraform
terraform: install-terraform

.PHONY: install-terraform
install-terraform: setup ## install Terraform
	./scripts/configure.py install_terraform true
	./setup -q -t terraform

.PHONY: tools
tools: install-tools

.PHONY: install-tools
install-tools: setup ## install tools
	./setup -q -t tools

.PHONY: zsh
zsh: install-zsh

.PHONY: install-zsh
install-zsh: setup ## install zsh
	./scripts/configure.py install_zsh true
	./setup -q -t zsh

###
# Clean
###

.PHONY: clean
clean:  ## delete local development dependencies
	-rm -rf playbooks/roles/markosamuli.*
	-rm -rf playbooks/roles/zzet.rbenv
	./scripts/delete_virtualenv.sh

###
# This Makefile uses self-documenting help commands
###

.PHONY: help
help:  ## print this help
	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort -d | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'