#
|
# CDDL HEADER START
|
#
|
# The contents of this file are subject to the terms of the
|
# Common Development and Distribution License (the "License").
|
# You may not use this file except in compliance with the License.
|
#
|
# You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
|
# or http://www.opensolaris.org/os/licensing.
|
# See the License for the specific language governing permissions
|
# and limitations under the License.
|
#
|
# When distributing Covered Code, include this CDDL HEADER in each
|
# file and include the License file at usr/src/OPENSOLARIS.LICENSE.
|
# If applicable, add the following below this CDDL HEADER, with the
|
# fields enclosed by brackets "[]" replaced with your own identifying
|
# information: Portions Copyright [yyyy] [name of copyright owner]
|
#
|
# CDDL HEADER END
|
#
|
# Copyright (c) 2010, 2016, Oracle and/or its affiliates. All rights reserved.
|
#
|
|
# Particular python runtime is always required (at least to run setup.py)
|
PYTHON_REQUIRED_PACKAGES += runtime/python
|
|
define python-rule
|
$(BUILD_DIR)/%-$(1)/.built: PYTHON_VERSION=$(1)
|
$(BUILD_DIR)/%-$(1)/.installed: PYTHON_VERSION=$(1)
|
$(BUILD_DIR)/%-$(1)/.tested: PYTHON_VERSION=$(1)
|
$(BUILD_DIR)/%-$(1)/.tested-and-compared: PYTHON_VERSION=$(1)
|
endef
|
|
$(foreach pyver, $(PYTHON_VERSIONS), $(eval $(call python-rule,$(pyver))))
|
|
$(BUILD_DIR)/$(MACH32)-%/.built: BITS=32
|
$(BUILD_DIR)/$(MACH64)-%/.built: BITS=64
|
$(BUILD_DIR)/$(MACH32)-%/.installed: BITS=32
|
$(BUILD_DIR)/$(MACH64)-%/.installed: BITS=64
|
$(BUILD_DIR)/$(MACH32)-%/.tested: BITS=32
|
$(BUILD_DIR)/$(MACH64)-%/.tested: BITS=64
|
$(BUILD_DIR)/$(MACH32)-%/.tested-and-compared: BITS=32
|
$(BUILD_DIR)/$(MACH64)-%/.tested-and-compared: BITS=64
|
|
PYTHON_32_VERSIONS = $(filter-out $(PYTHON_64_ONLY_VERSIONS), $(PYTHON_VERSIONS))
|
|
BUILD_32 = $(PYTHON_32_VERSIONS:%=$(BUILD_DIR)/$(MACH32)-%/.built)
|
BUILD_64 = $(PYTHON_VERSIONS:%=$(BUILD_DIR)/$(MACH64)-%/.built)
|
BUILD_NO_ARCH = $(PYTHON_VERSIONS:%=$(BUILD_DIR)/$(MACH)-%/.built)
|
|
ifeq ($(filter-out $(PYTHON_64_ONLY_VERSIONS), $(PYTHON_VERSION)),)
|
BUILD_32_and_64 = $(BUILD_64)
|
endif
|
|
INSTALL_32 = $(PYTHON_32_VERSIONS:%=$(BUILD_DIR)/$(MACH32)-%/.installed)
|
INSTALL_64 = $(PYTHON_VERSIONS:%=$(BUILD_DIR)/$(MACH64)-%/.installed)
|
INSTALL_NO_ARCH = $(PYTHON_VERSIONS:%=$(BUILD_DIR)/$(MACH)-%/.installed)
|
|
PYTHON_ENV = CC="$(CC)"
|
PYTHON_ENV += CFLAGS="$(CFLAGS)"
|
PYTHON_ENV += PKG_CONFIG_PATH="$(PKG_CONFIG_PATH)"
|
|
COMPONENT_BUILD_ENV += $(PYTHON_ENV)
|
COMPONENT_INSTALL_ENV += $(PYTHON_ENV)
|
COMPONENT_TEST_ENV += $(PYTHON_ENV)
|
|
# Make sure the default Python version is installed last and so is the
|
# canonical version. This is needed for components that keep PYTHON_VERSIONS
|
# set to more than single value, but deliver unversioned binaries in usr/bin or
|
# other overlapping files.
|
define python-order-rule
|
$(BUILD_DIR)/%-$(PYTHON_VERSION)/.installed: $(BUILD_DIR)/%-$(1)/.installed
|
endef
|
$(foreach pyver,$(filter-out $(PYTHON_VERSION),$(PYTHON_VERSIONS)),$(eval $(call python-order-rule,$(pyver))))
|
|
# We need to copy the source dir to avoid its modification by install target
|
# where egg-info is re-generated
|
CLONEY_ARGS = CLONEY_MODE="copy"
|
|
COMPONENT_BUILD_CMD = $(PYTHON) setup.py --no-user-cfg build
|
|
# build the configured source
|
$(BUILD_DIR)/%/.built: $(SOURCE_DIR)/.prep
|
$(RM) -r $(@D) ; $(MKDIR) $(@D)
|
$(ENV) $(CLONEY_ARGS) $(CLONEY) $(SOURCE_DIR) $(@D)
|
$(COMPONENT_PRE_BUILD_ACTION)
|
(cd $(@D) ; $(ENV) $(COMPONENT_BUILD_ENV) \
|
$(COMPONENT_BUILD_CMD) $(COMPONENT_BUILD_ARGS))
|
$(COMPONENT_POST_BUILD_ACTION)
|
$(TOUCH) $@
|
|
|
COMPONENT_INSTALL_CMD = $(PYTHON) setup.py --no-user-cfg install
|
|
COMPONENT_INSTALL_ARGS += --root $(PROTO_DIR)
|
COMPONENT_INSTALL_ARGS += --install-lib=$(PYTHON_LIB)
|
COMPONENT_INSTALL_ARGS += --install-data=$(PYTHON_DATA)
|
COMPONENT_INSTALL_ARGS += --skip-build
|
COMPONENT_INSTALL_ARGS += --force
|
|
# install the built source into a prototype area
|
$(BUILD_DIR)/%/.installed: $(BUILD_DIR)/%/.built
|
$(COMPONENT_PRE_INSTALL_ACTION)
|
(cd $(@D) ; $(ENV) $(COMPONENT_INSTALL_ENV) \
|
$(COMPONENT_INSTALL_CMD) $(COMPONENT_INSTALL_ARGS))
|
$(COMPONENT_POST_INSTALL_ACTION)
|
$(TOUCH) $@
|
|
ifeq ($(strip $(SINGLE_PYTHON_VERSION)),no)
|
# Rename binaries in /usr/bin to contain version number
|
COMPONENT_POST_INSTALL_ACTION += \
|
for f in $(PROTOUSRBINDIR)/* ; do \
|
[[ -f $$f ]] || continue ; \
|
for v in $(PYTHON_VERSIONS) ; do \
|
[[ "$$f" == "$${f%%-$$v}" ]] || continue 2 ; \
|
done ; \
|
$(MV) $$f $$f-$(PYTHON_VERSION) ; \
|
done ;
|
endif
|
|
# Define Python version specific filenames for tests.
|
ifeq ($(strip $(USE_COMMON_TEST_MASTER)),no)
|
COMPONENT_TEST_MASTER = $(COMPONENT_TEST_RESULTS_DIR)/results-$(PYTHON_VERSION).master
|
endif
|
COMPONENT_TEST_BUILD_DIR = $(BUILD_DIR)/test-$(PYTHON_VERSION)
|
COMPONENT_TEST_OUTPUT = $(COMPONENT_TEST_BUILD_DIR)/test-$(PYTHON_VERSION)-results
|
COMPONENT_TEST_DIFFS = $(COMPONENT_TEST_BUILD_DIR)/test-$(PYTHON_VERSION)-diffs
|
COMPONENT_TEST_SNAPSHOT = $(COMPONENT_TEST_BUILD_DIR)/results-$(PYTHON_VERSION).snapshot
|
COMPONENT_TEST_TRANSFORM_CMD = $(COMPONENT_TEST_BUILD_DIR)/transform-$(PYTHON_VERSION)-results
|
|
# Normalize Python test results.
|
COMPONENT_TEST_TRANSFORMS += "-e 's/^\(Ran [0-9]\{1,\} tests\) in .*$$/\1/'" # delete timing from test results
|
|
COMPONENT_TEST_DEP = $(BUILD_DIR)/%/.built
|
|
# determine the type of tests we want to run.
|
ifeq ($(strip $(wildcard $(COMPONENT_TEST_RESULTS_DIR)/results-*.master)),)
|
TEST_32 = $(PYTHON_32_VERSIONS:%=$(BUILD_DIR)/$(MACH32)-%/.tested)
|
TEST_64 = $(PYTHON_VERSIONS:%=$(BUILD_DIR)/$(MACH64)-%/.tested)
|
TEST_NO_ARCH = $(PYTHON_VERSIONS:%=$(BUILD_DIR)/$(MACH)-%/.tested)
|
else
|
TEST_32 = $(PYTHON_32_VERSIONS:%=$(BUILD_DIR)/$(MACH32)-%/.tested-and-compared)
|
TEST_64 = $(PYTHON_VERSIONS:%=$(BUILD_DIR)/$(MACH64)-%/.tested-and-compared)
|
TEST_NO_ARCH = $(PYTHON_VERSIONS:%=$(BUILD_DIR)/$(MACH)-%/.tested-and-compared)
|
endif
|
|
#
|
# Testing in the Python world is complex. Python projects usually do not
|
# support Makefile with common 'check' or 'test' target to get built bits
|
# tested.
|
#
|
# De facto standard way to test Python projects these days is tox which is
|
# designed and used primarily for release testing; to make sure the released
|
# python project runs on all supported Python versions, platforms, etc. tox
|
# does so using virtualenv and creates isolated test environments where the
|
# tested package together with all its dependencies is automatically installed
|
# (using pip) and tested. This is great for Python projects developers but it
|
# is hardly usable for operating system distributions like OpenIndiana.
|
#
|
# We do not need such release testing. Instead we need something closer to
|
# integration testing: we need to test the built component in our real
|
# environment without automatic installation of any dependencies using pip. In
|
# addition, we need to run tests only for Python versions we actually support
|
# and the component is built for.
|
#
|
# To achieve that we do few things. First, to avoid isolated environments
|
# (virtualenv) we run tox with the tox-current-env plugin. Second, to test
|
# only Python versions we are interested in we use -e option for tox to select
|
# single Python version only. Since we run separate test target per Python
|
# version this will make sure we test all needed Python versions.
|
#
|
# The tox tool itself uses some other tools under the hood to run tests, for
|
# example pytest. Some projects could even support pytest testing directly
|
# without support for tox. For such projects we offer separate "pytest"-style
|
# testing.
|
#
|
# For projects that do not support testing using neither tox nor pytest we
|
# offer (deprecated) "setup.py test" testing too.
|
#
|
# The TEST_STYLE variable is used to select (or force) particular test style
|
# for Python projects. Valid values are:
|
#
|
# tox - "tox"-style testing
|
# pytest - "pytest"-style testing
|
# setup.py - "setup.py test"-style testing
|
# none - no testing is supported at all
|
#
|
|
TEST_STYLE ?= tox
|
ifeq ($(strip $(TEST_STYLE)),tox)
|
COMPONENT_TEST_CMD = $(TOX)
|
COMPONENT_TEST_ARGS = --current-env --no-provision --recreate
|
COMPONENT_TEST_TARGETS = -e py$(shell echo $(PYTHON_VERSION) | tr -d .)
|
|
# Normalize tox test results.
|
COMPONENT_TEST_TRANSFORMS += "-e '0,/^py[0-9]\{1,\} run-test: /d'" # strip initial header
|
COMPONENT_TEST_TRANSFORMS += "-e '/^cachedir: /d'" # depends on Python version and is useless
|
COMPONENT_TEST_TRANSFORMS += "-e '/^ py[0-9]\{1,\}: commands succeeded$$/d'" # remove line with Python version
|
|
# tox package together with the tox-current-env plugin is needed
|
USERLAND_REQUIRED_PACKAGES += library/python/tox
|
USERLAND_REQUIRED_PACKAGES += library/python/tox-current-env
|
else ifeq ($(strip $(TEST_STYLE)),pytest)
|
COMPONENT_TEST_CMD = $(PYTHON) -m pytest
|
COMPONENT_TEST_ARGS =
|
COMPONENT_TEST_TARGETS =
|
|
USERLAND_REQUIRED_PACKAGES += library/python/pytest
|
else ifeq ($(strip $(TEST_STYLE)),setup.py)
|
# Old and deprecated "setup.py test"-style testing
|
COMPONENT_TEST_CMD = $(PYTHON) setup.py
|
COMPONENT_TEST_ARGS = --no-user-cfg
|
COMPONENT_TEST_TARGETS = test
|
else ifeq ($(strip $(TEST_STYLE)),none)
|
TEST_TARGET = $(NO_TESTS)
|
endif
|
|
# Normalize pytest test results. The pytest framework could be used either
|
# directly or via tox or setup.py so add these transforms for all test styles
|
# unconditionally.
|
COMPONENT_TEST_TRANSFORMS += "-e '/^platform sunos5 --/d'" # line with version details
|
COMPONENT_TEST_TRANSFORMS += "-e '/^Using --randomly-seed=[0-9]\{1,\}$$/d'" # this is random
|
COMPONENT_TEST_TRANSFORMS += "-e '/^benchmark: /d'" # line with version details
|
COMPONENT_TEST_TRANSFORMS += "-e '/^plugins: /d'" # order of listed plugins could vary
|
COMPONENT_TEST_TRANSFORMS += "-e '/^-\{1,\} coverage: /,/^TOTAL/d'" # remove coverage report
|
# sort list of pytest unit tests and drop percentage
|
COMPONENT_TEST_TRANSFORMS += \
|
"| ( $(GSED) -u -e '/^=\{1,\} test session starts /q' ; $(GSED) -u -e '/^$$/q' ; $(GSED) -u -e 's/ *\[...%\]$$//' -e '/^$$/Q' | LC_ALL=C $(GSORT) ; echo ; $(CAT) ) | $(COMPONENT_TEST_TRANSFORMER)"
|
COMPONENT_TEST_TRANSFORMS += \
|
"-e 's/=\{1,\} \(.*\) in [0-9]\{1,\}\.[0-9]\{1,\}s =\{1,\}$$/======== \1 ========/'" # remove timing
|
|
# test the built source
|
$(BUILD_DIR)/%/.tested-and-compared: $(COMPONENT_TEST_DEP)
|
$(RM) -rf $(COMPONENT_TEST_BUILD_DIR)
|
$(MKDIR) $(COMPONENT_TEST_BUILD_DIR)
|
$(COMPONENT_PRE_TEST_ACTION)
|
-(cd $(COMPONENT_TEST_DIR) ; \
|
$(COMPONENT_TEST_ENV_CMD) $(COMPONENT_TEST_ENV) \
|
$(COMPONENT_TEST_CMD) \
|
$(COMPONENT_TEST_ARGS) $(COMPONENT_TEST_TARGETS)) \
|
&> $(COMPONENT_TEST_OUTPUT)
|
$(COMPONENT_POST_TEST_ACTION)
|
$(COMPONENT_TEST_CREATE_TRANSFORMS)
|
$(COMPONENT_TEST_PERFORM_TRANSFORM)
|
$(COMPONENT_TEST_COMPARE)
|
$(COMPONENT_TEST_CLEANUP)
|
$(TOUCH) $@
|
|
$(BUILD_DIR)/%/.tested: SHELLOPTS=pipefail
|
$(BUILD_DIR)/%/.tested: $(COMPONENT_TEST_DEP)
|
$(RM) -rf $(COMPONENT_TEST_BUILD_DIR)
|
$(MKDIR) $(COMPONENT_TEST_BUILD_DIR)
|
$(COMPONENT_PRE_TEST_ACTION)
|
(cd $(COMPONENT_TEST_DIR) ; \
|
$(COMPONENT_TEST_ENV_CMD) $(COMPONENT_TEST_ENV) \
|
$(COMPONENT_TEST_CMD) \
|
$(COMPONENT_TEST_ARGS) $(COMPONENT_TEST_TARGETS)) \
|
|& $(TEE) $(COMPONENT_TEST_OUTPUT)
|
$(COMPONENT_POST_TEST_ACTION)
|
$(COMPONENT_TEST_CREATE_TRANSFORMS)
|
$(COMPONENT_TEST_PERFORM_TRANSFORM)
|
$(COMPONENT_TEST_CLEANUP)
|
$(TOUCH) $@
|
|
|
ifeq ($(strip $(SINGLE_PYTHON_VERSION)),no)
|
# We need to add -$(PYV) to package fmri
|
GENERATE_EXTRA_CMD += | \
|
$(GSED) -e 's/^\(set name=pkg.fmri [^@]*\)\(.*\)$$/\1-$$(PYV)\2/'
|
endif
|
|
|
clean::
|
$(RM) -r $(SOURCE_DIR) $(BUILD_DIR)
|
|
# Make it easy to construct a URL for a pypi source download. This
|
# construct supports an optional call to a number from
|
# NUM_EXTRA_ARCHIVES for multiple archive downloads.
|
pypi_url_multi = pypi:///$(COMPONENT_NAME_$(1))==$(COMPONENT_VERSION_$(1))
|
pypi_url_single = pypi:///$(COMPONENT_NAME)==$(COMPONENT_VERSION)
|
pypi_url = $(if $(COMPONENT_NAME_$(1)),$(pypi_url_multi),$(pypi_url_single))
|
