Makefile.sdk 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246
  1. #
  2. # Licensed to Cloudera, Inc. under one
  3. # or more contributor license agreements. See the NOTICE file
  4. # distributed with this work for additional information
  5. # regarding copyright ownership. Cloudera, Inc. licenses this file
  6. # to you under the Apache License, Version 2.0 (the
  7. # "License"); you may not use this file except in compliance
  8. # with the License. You may obtain a copy of the License at
  9. #
  10. # http://www.apache.org/licenses/LICENSE-2.0
  11. #
  12. # Unless required by applicable law or agreed to in writing, software
  13. # distributed under the License is distributed on an "AS IS" BASIS,
  14. # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  15. # See the License for the specific language governing permissions and
  16. # limitations under the License.
  17. #
  18. #
  19. # A Makefile to be (optionally) included by any SDK applications.
  20. #
  21. # This Makefile assumes the following environment variables:
  22. # ROOT
  23. # Points to the root of the Hue installation. From here, we
  24. # can include $(ROOT)/Makefile.vars to access various variables.
  25. #
  26. # This Makefile (or any custom application Makefile) MUST provide the following
  27. # targets:
  28. # egg-info
  29. # Responsible for creating the egg-info directory for the application.
  30. #
  31. # ext-eggs
  32. # Responsible for creating a Python egg for each external Python
  33. # dependency. These eggs should be placed in the
  34. # $(APP_ROOT)/ext-py/<package>/dist directory.
  35. #
  36. # clean
  37. # Remove build products.
  38. #
  39. # sdist
  40. # Responsible for making a source distribution directory at
  41. # $(APP_ROOT)/build/sdist/$(APP_NAME).
  42. #
  43. # install-bdist
  44. # Responsible for installing a built distribution to a target directory,
  45. # as specified by $(INSTALL_DIR).
  46. #
  47. include $(ROOT)/Makefile.vars
  48. SETUPTOOLS_NAME = $(shell $(ENV_PYTHON) setup.py --name)
  49. APP_ROOT := $(realpath .)
  50. APP_NAME ?= $(SETUPTOOLS_NAME)
  51. APP_VERSION ?= $(shell $(ENV_PYTHON) setup.py --version)
  52. APP_FULL_NAME ?= $(APP_NAME)-$(APP_VERSION)
  53. RSYNC_OPT ?= --copy-unsafe-links -a
  54. BUILD_DIR := $(APP_ROOT)/build
  55. EGG_INFO_DIR := $(APP_ROOT)/src/$(SETUPTOOLS_NAME).egg-info
  56. .PHONY: default
  57. default::
  58. @echo 'The build targets for $(APP_NAME) are: (*) is required'
  59. @echo ' compile : Compile $(APP_NAME)'
  60. @echo ' egg-info * : Create a python egg for $(APP_NAME)'
  61. @echo ' ext-eggs * : Create python eggs for external dependencies'
  62. @echo ' sdist * : Create a source distribution tree and tarball'
  63. @echo ' bdist : Create a built distribution tree'
  64. @echo ' install-bdist *: Install a built distribution to a target location'
  65. @echo ' ext-env-install: Install external dependencies into virtual-env'
  66. @echo ' ext-clean : Clean external dependencies'
  67. @echo ' clean * : Clean $(APP_NAME). Requires ext-clean'
  68. @echo ' distclean : Dist clean $(APP_NAME). Requires clean'
  69. .PHONY: egg
  70. egg-info: compile $(EGG_INFO_DIR)
  71. $(EGG_INFO_DIR): $(APP_ROOT)/setup.py
  72. @echo '--- Making egg-info for $(APP_NAME)'
  73. @$(ENV_PYTHON) setup.py -q egg_info
  74. # Hook to allow extra build steps (eg java builds)
  75. .PHONY: compile
  76. compile:
  77. ##############################
  78. # The following installs the external Python dependencies under the ext-py/
  79. # directory.
  80. EXT_PY_DIRS := $(wildcard ext-py/*)
  81. EXT_PYS := $(notdir $(EXT_PY_DIRS))
  82. ext_py_stamp = $(BUILD_DIR)/$(1)/$(2).stamp
  83. ##############################
  84. # Macros
  85. ##############################
  86. EXT_PY_EGG_TARGETS := $(EXT_PYS:%=$(call ext_py_stamp,%,egg))
  87. EXT_PY_CLEAN_TARGETS := $(EXT_PYS:%=$(call ext_py_stamp,%,clean))
  88. EXT_PY_ENV_INSTALL_TARGETS := $(EXT_PYS:%=$(call ext_py_stamp,%,env-install))
  89. $(EXT_PY_EGG_TARGETS): CUR_EXT_PY=$(notdir $(@D))
  90. $(EXT_PY_CLEAN_TARGETS): CUR_EXT_PY=$(notdir $(@D))
  91. $(EXT_PY_ENV_INSTALL_TARGETS): CUR_EXT_PY=$(notdir $(@D))
  92. #
  93. # ext-eggs
  94. # Builds a binary egg for any 3rd party package that are based on the
  95. # earlier distutils (rather than setuptools).
  96. #
  97. .PHONY: ext-eggs
  98. ext-eggs: $(EXT_PY_EGG_TARGETS)
  99. $(EXT_PY_EGG_TARGETS):
  100. @echo '--- Building egg for $(CUR_EXT_PY)'
  101. @cd ext-py/$(CUR_EXT_PY) && $(ENV_PYTHON) \
  102. -c '__import__("setuptools.sandbox").sandbox.run_setup("setup.py", __import__("sys").argv[1:])' \
  103. bdist_egg
  104. @mkdir -p $(@D) && touch $@
  105. #
  106. # ext-clean
  107. # Clean the 3rd party package. This will NOT uninstall it from Desktop.
  108. #
  109. .PHONY: ext-clean
  110. ext-clean: $(EXT_PY_CLEAN_TARGETS)
  111. $(EXT_PY_CLEAN_TARGETS):
  112. @echo '--- Cleaning $(CUR_EXT_PY)'
  113. @rm -Rf $(BUILD_DIR)/$(CUR_EXT_PY)
  114. @cd ext-py/$(CUR_EXT_PY) && rm -Rf dist build temp *.egg-info
  115. @find ext-py/$(CUR_EXT_PY) -name \*.egg-info -o -name \*.py[co] -prune -exec rm -Rf {} \;
  116. #
  117. # ext-env-install
  118. # Install all 3rd party packages into the Desktop environment. Used by
  119. # desktop core. We look for egg files in two locations:
  120. # (1) ext-py/<pkg>/dist/*.egg
  121. # (2) ext-eggs/*.egg
  122. #
  123. .PHONY: ext-env-install
  124. ext-env-install: ext-eggs $(EXT_PY_ENV_INSTALL_TARGETS)
  125. @for i in $(wildcard ext-eggs/*.egg) ; do \
  126. echo "--- Installing $$i into virtual environment" ; \
  127. $(ENV_EASY_INSTALL) -Z -N $$i 2> /dev/null ; \
  128. done
  129. $(EXT_PY_ENV_INSTALL_TARGETS):
  130. @echo '--- Installing $(CUR_EXT_PY) into virtual environment'
  131. @# If there are no binary eggs, maybe this package decided
  132. @# it wasn't necessary. If the build had failed, the command that produced
  133. @# the egg should have thrown an error.
  134. @cd ext-py/$(CUR_EXT_PY) && [ ! -e dist ] || $(ENV_EASY_INSTALL) -Z -N dist/*egg 2>/dev/null
  135. @mkdir -p $(@D) && touch $@
  136. .PHONY: clean
  137. clean:: ext-clean
  138. @echo --- Cleaning $(APP_NAME)
  139. @# Use SYS_PYTHON because ENV_PYTHON may not be available.
  140. @$(SYS_PYTHON) setup.py clean || :
  141. @rm -Rf $(BUILD_DIR) dist
  142. @find . -name \*.egg-info -prune -exec rm -Rf {} \;
  143. @find . -name \*.py[co] -exec rm -f {} \;
  144. .PHONY: distclean
  145. distclean:: clean
  146. #####################################
  147. # Distribution builds
  148. #####################################
  149. # Items that should not be included in the source/built distribution.
  150. # Apps can list this in their own Makefile before including this file
  151. # in order to exclude their own sources, non-distributables, etc.
  152. # This list is rsync friendly.
  153. COMMON_EXCLUDES := \
  154. --exclude=build \
  155. --exclude=\*.py[co] \
  156. --exclude=.\*.sw[op] \
  157. --exclude=~\* \
  158. --exclude=.gitignore \
  159. --exclude=tag \
  160. --exclude=target
  161. SDIST_EXCLUDES += $(COMMON_EXCLUDES) --exclude=java-lib
  162. BDIST_EXCLUDES += $(COMMON_EXCLUDES) --exclude=ext-py
  163. SDIST_DIR := $(BUILD_DIR)/sdist/$(APP_FULL_NAME)
  164. BDIST_DIR := $(BUILD_DIR)/bdist/$(APP_FULL_NAME)
  165. SDIST_TGZ := $(BUILD_DIR)/sdist/$(APP_FULL_NAME).tgz
  166. #
  167. # sdist
  168. # Simply copy the essential sources to the target directory.
  169. #
  170. .PHONY: sdist
  171. sdist:
  172. @echo '--- Making source distribution at $(SDIST_DIR)'
  173. @rm -rf $(SDIST_DIR)
  174. @mkdir -p $(SDIST_DIR)
  175. @# Copy sources of our app
  176. @rsync $(RSYNC_OPT) ./ $(SDIST_DIR)/ $(SDIST_EXCLUDES)
  177. @$(MAKE) -C $(SDIST_DIR) clean
  178. @# Also make a tarball
  179. @tar -C $(SDIST_DIR)/.. -czf $(SDIST_TGZ) $(APP_FULL_NAME)
  180. @echo "--- Created $(SDIST_TGZ)"
  181. #
  182. # bdist
  183. # Like sdist. For ext-py, we copy the eggs only (into a separate ext-eggs
  184. # directory). Apps with non-python source (e.g. Java, C) should also
  185. # exclude the source files.
  186. #
  187. .PHONY: bdist
  188. bdist: ext-eggs compile
  189. @echo '--- Making built distribution at $(BDIST_DIR)'
  190. @rm -rf $(BDIST_DIR)
  191. @mkdir -p $(BDIST_DIR)
  192. @# Copy built sources of our app
  193. @rsync $(RSYNC_OPT) ./ $(BDIST_DIR)/ $(BDIST_EXCLUDES)
  194. @# Copy thirdparty eggs into the ext-eggs dir
  195. @mkdir -p $(BDIST_DIR)/ext-eggs
  196. @if test -n '$(wildcard ext-py/*/dist)' ; then \
  197. find ext-py/*/dist -type f -name '*.egg' -exec cp {} $(BDIST_DIR)/ext-eggs \; ; \
  198. fi
  199. #
  200. # install-bdist
  201. # Install the built distribution in $(INSTALL_DIR).
  202. # NOTE that this does NOT install the app into the virtual environment.
  203. #
  204. .PHONY: install-bdist
  205. install-bdist: bdist
  206. @echo "--- Install built distribution for $(APP_NAME) at $(INSTALL_DIR)"
  207. @# Check that INSTALL_DIR is empty
  208. @if [ -n '$(wildcard $(INSTALL_DIR)/*)' ] ; then \
  209. echo 'ERROR: $(INSTALL_DIR) not empty. Cowardly refusing to continue.' ; \
  210. false ; \
  211. fi
  212. @mkdir -p $(INSTALL_DIR)
  213. @rsync -a $(BDIST_DIR)/ $(INSTALL_DIR)