sgammon/canteen

#
#    canteen: makefile
#
#   :author: Sam Gammon <sam@keen.io>
#   :copyright: (c) Sam Gammon, 2014
#   :license: This software makes use of the MIT Open Source License.
#             A copy of this library is included as ``LICENSE.md`` in
#             the root of the project.
#


SHELL := /bin/bash

## Vars
DEPS?=1
TESTS?=1
SHELL?=bash
BUILDBOT?=1
VIRTUALENV?=1
DISTRIBUTIONS ?= bdist_egg sdist bdist_dumb
BUILDROOT?=./
TEST_FLAGS?=
TEST_REPORTS_TARGET?=dist/test-reports
BINPATH?=$(BUILDROOT)bin/
TEST_RESULTS?=$(BUILDROOT).develop/tests/xunit
COVERAGE_RESULTS?=$(BUILDROOT).develop/coverage/xunit


## Colors + Texts
STOP=\x1b[;0m
RED=\x1b[31;01m
GREEN=\x1b[32;01m
CYAN=\x1b[36;01m
YELLOW=\x1b[33;01m
MAGENTA=\x1b[35;01m

OK=$(GREEN)[OK]$(STOP)
ERROR=$(RED)[ERROR]$(STOP)
WARN=$(YELLOW)[WARN]$(STOP)


## Functions
define say
    @printf "$(CYAN)"
    @echo $1
    @printf "$(STOP)"
endef

define okay
    @printf "$(GREEN)"
    @echo $1 $2
    @printf "$(STOP)"
endef

define warn
    @printf "$(YELLOW)"
    @echo $1 $2
    @printf "$(STOP)"
endef

define error
    @printf "$(RED)"
    @echo $1 $2
    @printf "$(STOP)"
endef


all: clean .Python develop test package ready

ready:
    @echo
    $(call okay,"~~ canteen ready ~~")
    @echo


ifeq ($(TESTS),1)
test:
    $(call say,"Running testsuite...")
    @rm -fv ./.coverage
    @mkdir -p $(TEST_RESULTS) $(COVERAGE_RESULTS)
    @-$(BINPATH)nosetests --with-coverage \
                            --cover-package=canteen \
                            --cover-html \
                            --cover-xml \
                            --with-xunit \
                            --cover-html-dir=.develop/coverage/html \
                            --cover-xml-file=.develop/coverage/clover.xml \
                            --xunit-file=.develop/tests/xunit.xml $(TEST_FLAGS) canteen_tests
else
test:
    $(call warn,"Skipping tests.")
endif

build: .Python dependencies templates
    $(call say,"Building framework...")
    @$(BINPATH)python setup.py build
    $(call okay,"Framework built successfully.")

package: test
    $(call say,"Building release packages...")
    @$(BINPATH)python setup.py $(DISTRIBUTIONS)
    $(call okay,"Framework release packages built.")

ifeq ($(DEPS),1)
develop: build
    $(call say,"Installing dev dependencies...")
    @$(BINPATH)pip install -q --upgrade -r dev_requirements.txt

    $(call say,"Building framework for development...")
    -@$(BINPATH)python setup.py develop
else
develop: build
    $(call say,"Building framework for development...")
    -@$(BINPATH)python setup.py develop
endif

templates:
    $(call say,"Building framework templates...")
    -@$(BINPATH)python -B -c "from canteen import template; template.TemplateCompiler.framework(run=True)"
    $(call okay,"Templates built. Moving on.")

ifeq ($(DEPS),1)
dependencies:
    $(call say,"Installing runtime dependencies (this may take a moment)...")
    @$(BINPATH)python -c "import colorlog" > /dev/null 2> /dev/null || $(BINPATH)pip -q install colorlog
    @$(BINPATH)pip install -q --upgrade -r requirements.txt
    $(call okay,"Runtime dependencies ready.")
else
dependencies:
    $(call warn,"Skipping dependencies...")
endif

clean:
    $(call say,"Cleaning buildspace...")
    @rm -fr build/

    $(call say,"Cleaning egginfo...")
    @rm -fr canteen.egg-info

    $(call say,"Cleaning object files...")
    @find $(BUILDROOT) -name "*.pyc" -delete
    @find $(BUILDROOT) -name "*.pyo" -delete

distclean: clean
    $(call say,"Cleaning environment...")
    @rm -fr .Python lib include

    $(call say,"Resetting codebase...")
    @git reset --hard

    $(call say,"Cleaning codebase...")
    @git clean -xdf

    $(call okay,"~~ codebase cleaned. ~~")

ifeq ($(VIRTUALENV),1)
.Python:
    @which pip > /dev/null || sudo easy_install pip
    @which virtualenv > /dev/null || pip install virtualenv

    $(call say,"Preparing virtual environment...")
    @virtualenv $(BUILDROOT) > /dev/null
    $(call okay,"Virtual environment ready.")
else
.Python:
    $(call warn,"Skipping virtual environment...")
endif

ifeq ($(BUILDBOT),1)
ci-environment:
    $(call say,"Preparing CI environment...")
    @mkdir -p bin/ && \
        ln -s $(shell which pip) bin/pip && \
        ln -s $(shell which python) bin/python && \
        ln -s $(shell which nosetests) bin/nosetests;
    @virtualenv --version || sudo pip install --upgrade virtualenv
    @-bin/pip uninstall -y coverage==3.7.1
    @-bin/pip install -y "coverage>=4.0"
    @coveralls --help 2> /dev/null || bin/pip install --upgrade coveralls

release-package:
    $(call say,"Packaging release...")
    @tar -czvf release.tar.gz dist/*

report-package: reports.tar.gz
    $(call say,"Installing test reports...")
    @mkdir -p $(TEST_REPORTS_TARGET) $(TEST_REPORTS_TARGET)/coverage/
    @-cp -frv .develop/tests/* $(TEST_REPORTS_TARGET)/
    @-cp -frv .develop/coverage/* $(TEST_REPORTS_TARGET)/coverage/

reports.tar.gz:
    $(call say,"Building test/coverage report tarball...")
    @cd .develop && tar -czvf ../reports.tar.gz tests coverage
endif