python = not-set
verbose = not-set
debug = not-set

ifneq ($(python), not-set)
PYTHON=$(python)
else
PYTHON=python
endif

# we need the python path to point one level up to access the package
# and executables
PYPATH=PYTHONPATH=..:

# common args for running tests
TEST_ARGS=-m unittest discover

ifeq ($(debug), not-set)
    ifeq ($(verbose), not-set)
        # summary only output
        TEST_ARGS+=--buffer
    else
        # show individual test summary
        TEST_ARGS+=--buffer --verbose
    endif
else
    # show detailed test output
    TEST_ARGS+=--verbose
endif


# auto reformat the code
AUTOPEP8=autopep8
AUTOPEP8_ARGS=--aggressive --in-place 

# run lint
PYLINT=pylint
PYLINT_ARGS=-j 2 --rcfile=.pylint.rc

# code coverage
COVERAGE=coverage
COVERAGE_ARGS=--rcfile=.coveragerc

# source files
SRC = \
	../checkout_externals \
	../manic/*.py

CHECKOUT_EXE = ../checkout_externals

TEST_DIR = .

README = ../README.md

#
# testing
#
.PHONY : utest
utest : FORCE
	$(PYPATH) $(PYTHON) $(TEST_ARGS) --pattern 'test_unit_*.py'

.PHONY : stest
stest : FORCE
	$(PYPATH) $(PYTHON) $(TEST_ARGS) --pattern 'test_sys_*.py'

.PHONY : test
test : utest stest

#
# documentation
#
.PHONY : readme
readme : $(CHECKOUT_EXE)
	printf "%s\n\n" "-- AUTOMATICALLY GENERATED FILE. DO NOT EDIT --" > $(README)
	printf "%s" '[![Build Status](https://travis-ci.org/ESMCI/manage_externals.svg?branch=master)](https://travis-ci.org/ESMCI/manage_externals)' >> $(README)
	printf "%s" '[![Coverage Status](https://coveralls.io/repos/github/ESMCI/manage_externals/badge.svg?branch=master)](https://coveralls.io/github/ESMCI/manage_externals?branch=master)' >> $(README)
	printf "\n%s\n" '```' >> $(README)
	$(CHECKOUT_EXE) --help >> $(README)

#
# coding standards
#
.PHONY : style
style : FORCE
	$(AUTOPEP8) $(AUTOPEP8_ARGS) --recursive $(SRC) $(TEST_DIR)/test_*.py

.PHONY : lint
lint : FORCE
	$(PYLINT) $(PYLINT_ARGS) $(SRC) $(TEST_DIR)/test_*.py

.PHONY : stylint
stylint : style lint

.PHONY : coverage
# Need to use a single coverage run with a single pattern rather than
# using two separate commands with separate patterns for test_unit_*.py
# and test_sys_*.py: The latter clobbers some results from the first
# run, even if we use the --append flag to 'coverage run'.
coverage : FORCE
	$(PYPATH) $(COVERAGE) erase
	$(PYPATH) $(COVERAGE) run $(COVERAGE_ARGS) $(TEST_ARGS) --pattern 'test_*.py'
	$(PYPATH) $(COVERAGE) html

#
# virtual environment creation
#
.PHONY : env
env : FORCE
	$(PYPATH) virtualenv --python $(PYTHON) $@_$(PYTHON)
	. $@_$(PYTHON)/bin/activate; pip install -r requirements.txt

#
# utilites
#
.PHONY : clean
clean : FORCE
	-rm -rf *~ *.pyc tmp fake htmlcov

.PHONY : clobber
clobber : clean
	-rm -rf env_*

FORCE :