Makefile

#!/usr/bin/make -f

# This software was developed at the National Institute of Standards
# and Technology by employees of the Federal Government in the course
# of their official duties. Pursuant to Title 17 Section 105 of the
# United States Code, this software is not subject to copyright
# protection within the United States. NIST assumes no responsibility
# whatsoever for its use by other parties, and makes no guarantees,
# expressed or implied, about its quality, reliability, or any other
# characteristic.
#
# We would appreciate acknowledgement if the software is used.

SHELL := /bin/bash

PYTHON3 ?= python3

all: \
  .venv-pre-commit/var/.pre-commit-built.log

.PHONY: \
  check-docs \
  check-mypy \
  check-supply-chain \
  check-supply-chain-pre-commit \
  check-supply-chain-submodules \
  docs \
  docs-figs \
  docs-tests

.git_submodule_init.done.log: \
  .gitmodules
	git submodule init deps/dfxml
	git submodule update deps/dfxml
	$(MAKE) \
	  --directory deps/dfxml \
	  .git_submodule_init.done.log
	touch $@

# This virtual environment is meant to be built once and then persist, even through 'make clean'.
# If a recipe is written to remove this flag file, it should first run `pre-commit uninstall`.
.venv-pre-commit/var/.pre-commit-built.log:
	rm -rf .venv-pre-commit
	test -r .pre-commit-config.yaml \
	  || (echo "ERROR:Makefile:pre-commit is expected to install for this repository, but .pre-commit-config.yaml does not seem to exist." >&2 ; exit 1)
	$(PYTHON3) -m venv \
	  .venv-pre-commit
	source .venv-pre-commit/bin/activate \
	  && pip install \
	    --upgrade \
	    pip \
	    setuptools \
	    wheel
	source .venv-pre-commit/bin/activate \
	  && pip install \
	    pre-commit
	source .venv-pre-commit/bin/activate \
	  && pre-commit install
	mkdir -p \
	  .venv-pre-commit/var
	touch $@

check: \
  .venv-pre-commit/var/.pre-commit-built.log \
  check-mypy
	$(MAKE) \
	  --directory tests \
	  check

check-docs: \
  check-docs-figs \
  check-docs-tests

check-docs-figs:
	$(MAKE) \
	  --directory figs \
	  check

check-docs-tests:
	$(MAKE) \
	  PYTHON3=$(PYTHON3) \
	  --directory tests \
	  check-docs

check-mypy: \
  .git_submodule_init.done.log
	$(MAKE) \
	  PYTHON3=$(PYTHON3) \
	  --directory tests \
	  check
  
check-supply-chain: \
  check-mypy \
  check-supply-chain-pre-commit \
  check-supply-chain-submodules

# Update pre-commit configuration and use the updated config file to
# review code.  Only have Make exit if 'pre-commit run' modifies files.
check-supply-chain-pre-commit: \
  .venv-pre-commit/var/.pre-commit-built.log
	source .venv-pre-commit/bin/activate \
	  && pre-commit autoupdate
	git diff \
	  --exit-code \
	  .pre-commit-config.yaml \
	  || ( \
	      source .venv-pre-commit/bin/activate \
	        && pre-commit run \
	          --all-files \
	          --config .pre-commit-config.yaml \
	    ) \
	    || git diff \
	      --exit-code \
	      --stat \
	      || ( \
	          echo \
	            "WARNING:Makefile:pre-commit configuration can be updated.  It appears the update would change file formatting." \
	            >&2 \
	            ; exit 1 \
                )
	@git diff \
	  --exit-code \
	  .pre-commit-config.yaml \
	  || echo \
	    "INFO:Makefile:pre-commit configuration can be updated.  It appears the update would not change file formatting." \
	    >&2

check-supply-chain-submodules: \
  .git_submodule_init.done.log
	git submodule update \
	  --remote
	git diff \
	  --exit-code \
	  --ignore-submodules=dirty \
	  deps

clean:
	@$(MAKE) --directory figs clean
	@$(MAKE) --directory tests clean
	@rm -f .*.done.log

docs: \
  docs-figs \
  docs-tests

docs-figs:
	$(MAKE) \
	  --directory figs

docs-tests:
	$(MAKE) \
	  PYTHON3=$(PYTHON3) \
	  --directory tests \
	  docs

download:
	$(MAKE) \
	  PYTHON3=$(PYTHON3) \
	  --directory tests \
	  .venv.done.log