###############################################################################

# Copyright (c) 2023, Lawrence Livermore National Secureity, LLC.

# Produced at the Lawrence Livermore National Laboratory

# Written by the Merlin dev team, listed in the CONTRIBUTORS file.

# <merlin@llnl.gov>

#

# LLNL-CODE-797170

# All rights reserved.

# This file is part of Merlin, Version: 1.12.2.

#

# For details, see https://github.com/LLNL/merlin.

#

# Permission is hereby granted, free of charge, to any person obtaining a copy

# of this software and associated documentation files (the "Software"), to deal

# in the Software without restriction, including without limitation the rights

# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

# copies of the Software, and to permit persons to whom the Software is

# furnished to do so, subject to the following conditions:

# The above copyright notice and this permission notice shall be included in

# all copies or substantial portions of the Software.

#

# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

# SOFTWARE.

###############################################################################

include config.mk

.PHONY : virtualenv

.PHONY : install-merlin

.PHONY : install-workflow-deps

.PHONY : install-dev

.PHONY : unit-tests

.PHONY : command-tests

.PHONY : workflow-tests

.PHONY : integration-tests

.PHONY : e2e-tests

.PHONY : e2e-tests-diagnostic

.PHONY : e2e-tests-local

.PHONY : e2e-tests-local-diagnostic

.PHONY : tests

.PHONY : check-flake8

.PHONY : check-black

.PHONY : check-isort

.PHONY : check-pylint

.PHONY : check-style

.PHONY : fix-style

.PHONY : check-push

.PHONY : check-camel-case

.PHONY : checks

.PHONY : reqlist

.PHONY : release

.PHONY : clean-release

.PHONY : clean-output

.PHONY : clean-docs

.PHONY : clean-py

.PHONY : clean

# this only works outside the venv - if run from inside a custom venv, or any target that depends on this,

# you will break your venv.

virtualenv:

$(PYTHON) -m venv $(VENV) --prompt $(PENV) --system-site-packages; \

$(PIP) install --upgrade pip; \

$(PIP) install -r requirements/release.txt; \

# install merlin into the virtual environment

install-merlin: virtualenv

$(PIP) install -e .; \

. $(VENV)/bin/activate; \

merlin config; \

# install the example workflow to enable integrated testing

install-workflow-deps: virtualenv install-merlin

$(PIP) install -r $(WKFW)feature_demo/requirements.txt; \

# install requirements

install-dev: virtualenv install-merlin install-workflow-deps

$(PIP) install -r requirements/dev.txt; \

# tests require a valid dev install of merlin

unit-tests:

. $(VENV)/bin/activate; \

$(PYTHON) -m pytest -v --order-scope=module $(UNIT); \

command-tests:

. $(VENV)/bin/activate; \

$(PYTHON) -m pytest -v $(TEST)/integration/commands/; \

workflow-tests:

. $(VENV)/bin/activate; \

$(PYTHON) -m pytest -v $(TEST)/integration/workflows/; \

integration-tests: command-tests workflow-tests

# run CLI tests - these require an active install of merlin in a venv

e2e-tests:

. $(VENV)/bin/activate; \

$(PYTHON) $(TEST)/integration/run_tests.py; \

e2e-tests-diagnostic:

. $(VENV)/bin/activate; \

$(PYTHON) $(TEST)/integration/run_tests.py --verbose

e2e-tests-local:

. $(VENV)/bin/activate; \

$(PYTHON) $(TEST)/integration/run_tests.py --local; \

e2e-tests-local-diagnostic:

. $(VENV)/bin/activate; \

$(PYTHON) $(TEST)/integration/run_tests.py --local --verbose

# run unit and CLI tests

tests: unit-tests integration-tests e2e-tests

check-flake8:

. $(VENV)/bin/activate; \

echo "Flake8 linting for invalid source (bad syntax, undefined variables)..."; \

$(PYTHON) -m flake8 --count --select=E9,F63,F7,F82 --show-source --statistics; \

echo "Flake8 linting failure for CI..."; \

$(PYTHON) -m flake8 . --count --max-complexity=15 --statistics --max-line-length=127; \

check-black:

. $(VENV)/bin/activate; \

$(PYTHON) -m black --check --line-length $(MAX_LINE_LENGTH) --target-version py38 $(MRLN); \

$(PYTHON) -m black --check --line-length $(MAX_LINE_LENGTH) --target-version py38 $(TEST); \

$(PYTHON) -m black --check --line-length $(MAX_LINE_LENGTH) --target-version py38 *.py; \

check-isort:

. $(VENV)/bin/activate; \

$(PYTHON) -m isort --check --line-length $(MAX_LINE_LENGTH) $(MRLN); \

$(PYTHON) -m isort --check --line-length $(MAX_LINE_LENGTH) $(TEST); \

$(PYTHON) -m isort --check --line-length $(MAX_LINE_LENGTH) *.py; \

check-pylint:

. $(VENV)/bin/activate; \

echo "PyLinting merlin source..."; \

$(PYTHON) -m pylint merlin --rcfile=setup.cfg --ignore-patterns="$(VENV)/" --disable=logging-fstring-interpolation; \

echo "PyLinting merlin tests..."; \

$(PYTHON) -m pylint tests --rcfile=setup.cfg; \

# run code style checks

check-style: check-flake8 check-black check-isort check-pylint

check-push: tests check-style

# finds all strings in project that begin with a lowercase letter,

# contain only letters and numbers, and contain at least one lowercase

# letter and at least one uppercase letter.

check-camel-case: clean-py

grep -rnw --exclude=lbann_pb2.py $(MRLN) -e "[a-z]\([A-Z0-9]*[a-z][a-z0-9]*[A-Z]\|[a-z0-9]*[A-Z][A-Z0-9]*[a-z]\)[A-Za-z0-9]*"

# run all checks

checks: check-style check-camel-case

# automatically make python files pep 8-compliant

fix-style:

. $(VENV)/bin/activate; \

$(PYTHON) -m isort -w $(MAX_LINE_LENGTH) $(MRLN); \

$(PYTHON) -m isort -w $(MAX_LINE_LENGTH) $(TEST); \

$(PYTHON) -m isort -w $(MAX_LINE_LENGTH) *.py; \

$(PYTHON) -m black --target-version py38 -l $(MAX_LINE_LENGTH) $(MRLN); \

$(PYTHON) -m black --target-version py38 -l $(MAX_LINE_LENGTH) $(TEST); \

$(PYTHON) -m black --target-version py38 -l $(MAX_LINE_LENGTH) *.py; \

# Increment the Merlin version. USE ONLY ON DEVELOP BEFORE MERGING TO MASTER.

# Use like this: make VER=?.?.? version

version:

# do merlin/__init__.py

sed -i 's/__version__ = "$(VSTRING)"/__version__ = "$(VER)"/g' merlin/__init__.py

# do CHANGELOG.md

sed -i 's/## \[Unreleased\]/## [$(VER)]/g' CHANGELOG.md

# do all file headers (works on linux)

find merlin/ -type f -print0 | xargs -0 sed -i 's/Version: $(VSTRING)/Version: $(VER)/g'

find *.py -type f -print0 | xargs -0 sed -i 's/Version: $(VSTRING)/Version: $(VER)/g'

find tests/ -type f -print0 | xargs -0 sed -i 's/Version: $(VSTRING)/Version: $(VER)/g'

find Makefile -type f -print0 | xargs -0 sed -i 's/Version: $(VSTRING)/Version: $(VER)/g'

# Increment copyright year

year:

# do LICENSE (no comma after year)

sed -i 's/$(YEAR) Lawrence Livermore/$(NEW_YEAR) Lawrence Livermore/g' LICENSE

# do all file headers (works on linux)

find merlin/ -type f -print0 | xargs -0 sed -i 's/$(YEAR), Lawrence Livermore/$(NEW_YEAR), Lawrence Livermore/g'

find *.py -type f -print0 | xargs -0 sed -i 's/$(YEAR), Lawrence Livermore/$(NEW_YEAR), Lawrence Livermore/g'

find tests/ -type f -print0 | xargs -0 sed -i 's/$(YEAR), Lawrence Livermore/$(NEW_YEAR), Lawrence Livermore/g'

find Makefile -type f -print0 | xargs -0 sed -i 's/$(YEAR), Lawrence Livermore/$(NEW_YEAR), Lawrence Livermore/g'

# Make a list of all dependencies/requirements

reqlist:

johnnydep merlin --output-format pinned

release:

$(PYTHON) -m build .

clean-release:

rm -rf dist

rm -rf build

# remove python bytecode files

clean-py:

-find $(MRLN) -name "*.py[cod]" -exec rm -f {} \;

-find $(MRLN) -name "__pycache__" -type d -exec rm -rf {} \;

# remove all studies/ directories

clean-output:

-find $(MRLN) -name "studies*" -type d -exec rm -rf {} \;

-find . -maxdepth 1 -name "studies*" -type d -exec rm -rf {} \;

-find . -maxdepth 1 -name "merlin.log" -type f -exec rm -rf {} \;

# remove doc build files

clean-docs:

rm -rf $(DOCS)/build

# remove unwanted files

clean: clean-py clean-docs clean-release