Makefile 7.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255
  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. # <<<< DEV ONLY
  19. #
  20. # Hue Build Process Overview
  21. # =======================================
  22. # This build process handles different types of builds:
  23. #
  24. # - The production release build, the main task of which is to install
  25. # Desktop in the local system. The main build products are:
  26. #
  27. # * build/env - The virtual environment, where Desktop core
  28. # and various apps install into.
  29. #
  30. # - The development build, which includes test and debugging tools. It
  31. # generates the production release, which boils down to a tarball that is
  32. # downloaded and installed. Additional build products include:
  33. #
  34. # * build/release/prod - The production tarball.
  35. # * build/docs - General Desktop and SDK docs.
  36. #
  37. # We achieve this by selecting the parts to be distributed, and by stripping
  38. # the Makefile's. Lines enclosed by the "DEV ONLY" marks are stripped for the
  39. # general release. Targets are split/expanded using multiple rules and
  40. # double-colon rules. The idea is to use almost identical build logic for the
  41. # different flavours.
  42. #
  43. # Logic Flow
  44. # ==========
  45. # Here we summarize the flow of the build logic. Lines represent dependency.
  46. #
  47. # virtual-bootstrap.py
  48. # |
  49. # virtual-env (./env)
  50. # |
  51. # +----------+
  52. # | |
  53. # | V
  54. # | desktop <--- recursive make in /desktop
  55. # | |
  56. # | V
  57. # | apps <--- recursive make in /apps
  58. # |
  59. # V
  60. # prod tarball <-- selective copying into /build/release/...
  61. #
  62. #
  63. # Application Build
  64. # =================
  65. # An app typically includes $(ROOT)/Makefile.sdk, which provides the standard
  66. # targets and facilities. ROOT, which points to the Hue installation root, is
  67. # always passed in.
  68. #
  69. # The application may also choose to not use the Hue build facilities. In that
  70. # case, its Makefile still receives $(ROOT), and needs to provide several
  71. # targets as specified in Makefile.sdk.
  72. #
  73. # END DEV ONLY >>>>
  74. ###################################
  75. # Global variables
  76. ###################################
  77. ROOT := $(realpath .)
  78. include $(ROOT)/Makefile.vars.priv
  79. ###################################
  80. # Error checking
  81. ###################################
  82. .PHONY: default
  83. default:
  84. @echo 'The build targets for Hue $(DESKTOP_VERSION) are:'
  85. @echo ' install : Install at $$PREFIX ($(INSTALL_DIR)); need desktop'
  86. @echo ' apps : Build and register all desktop apps; need desktop'
  87. @echo ' desktop : Build desktop core only'
  88. @echo ' clean : Remove desktop build products'
  89. @echo ' distclean : Remove desktop and thirdparty build products'
  90. # <<<< DEV ONLY
  91. @echo ' docs : Build documentation'
  92. @echo ' prod : Generate a tar file for production distribution'
  93. # END DEV ONLY >>>>
  94. .PHONY: all
  95. all: default
  96. # <<<< DEV ONLY
  97. include Makefile.tarball
  98. ###################################
  99. # Build docs
  100. ###################################
  101. .PHONY: docs
  102. docs:
  103. @$(MAKE) -C docs
  104. # END DEV ONLY >>>>
  105. ###################################
  106. # Install parent POM
  107. ###################################
  108. parent-pom:
  109. cd $(ROOT)/maven && mvn install $(MAVEN_OPTIONS)
  110. .PHONY: parent-pom
  111. ###################################
  112. # virtual-env
  113. ###################################
  114. virtual-env: $(BLD_DIR_ENV)/stamp
  115. $(BLD_DIR_ENV)/stamp:
  116. @echo "--- Creating virtual environment at $(BLD_DIR_ENV)"
  117. $(SYS_PYTHON) $(VIRTUAL_BOOTSTRAP) \
  118. $(VIRTUALENV_OPTS) --no-site-packages $(BLD_DIR_ENV)
  119. @touch $@
  120. @echo "--- $(BLD_DIR_ENV) ready"
  121. .PHONY: virtual-env
  122. ###################################
  123. # Build desktop
  124. ###################################
  125. .PHONY: desktop
  126. # <<<< DEV ONLY
  127. desktop: parent-pom
  128. # END DEV ONLY >>>>
  129. desktop: virtual-env
  130. @$(MAKE) -C desktop
  131. ###################################
  132. # Build apps
  133. ###################################
  134. .PHONY: apps
  135. apps: desktop
  136. @$(MAKE) -C $(APPS_DIR) env-install
  137. ###################################
  138. # Install binary dist
  139. ###################################
  140. INSTALL_CORE_FILES = \
  141. Makefile* $(wildcard *.mk) \
  142. ext \
  143. tools/app_reg \
  144. tools/virtual-bootstrap \
  145. tools/relocatable.sh \
  146. VERS* LICENSE* README*
  147. .PHONY: install
  148. install: virtual-env install-check install-core-structure install-desktop install-apps install-env
  149. .PHONY: install-check
  150. install-check:
  151. @if [ -n '$(wildcard $(INSTALL_DIR)/*)' ] ; then \
  152. echo 'ERROR: $(INSTALL_DIR) not empty. Cowardly refusing to continue.' ; \
  153. false ; \
  154. fi
  155. .PHONY: install-core-structure
  156. install-core-structure:
  157. @echo --- Installing core source structure...
  158. @mkdir -p $(INSTALL_DIR)
  159. @tar cf - $(INSTALL_CORE_FILES) | tar -C $(INSTALL_DIR) -xf -
  160. @# Add some variables to Makefile to make sure that our virtualenv
  161. @# in the install root is the same one we built from - this also
  162. @# disables the check for python-devel packages which are no longer
  163. @# needed
  164. @echo "SYS_PYTHON=$(ENV_PYTHON_VERSION)" > $(INSTALL_DIR)/Makefile.buildvars
  165. @echo "SKIP_PYTHONDEV_CHECK=1" >> $(INSTALL_DIR)/Makefile.buildvars
  166. .PHONY: install-desktop
  167. install-desktop:
  168. @echo --- Installing Desktop core...
  169. INSTALL_DIR=$(realpath $(INSTALL_DIR)) $(MAKE) -C desktop install
  170. .PHONY: install-apps
  171. install-apps:
  172. @echo '--- Installing Applications...'
  173. INSTALL_DIR=$(realpath $(INSTALL_DIR)) $(MAKE) -C apps install
  174. .PHONY: install-env
  175. install-env:
  176. @echo --- Creating new virtual environment
  177. $(MAKE) -C $(INSTALL_DIR) virtual-env
  178. @echo --- Setting up Desktop core
  179. $(MAKE) -C $(INSTALL_DIR)/desktop env-install
  180. @echo --- Setting up Applications
  181. $(MAKE) -C $(INSTALL_DIR)/apps env-install
  182. @echo --- Setting up Desktop database
  183. $(MAKE) -C $(INSTALL_DIR)/desktop syncdb
  184. ###################################
  185. # Cleanup
  186. ###################################
  187. .PHONY: clean
  188. clean:
  189. @rm -rf $(BLD_DIR_ENV)
  190. @$(MAKE) -C desktop clean
  191. @$(MAKE) -C apps clean
  192. # <<<< DEV ONLY
  193. @$(MAKE) -C docs clean
  194. # END DEV ONLY >>>>
  195. #
  196. # Note: It is important for clean targets to *ONLY* clean products of the
  197. # build, and not misc runtime generated files. Don't abuse Makefile.
  198. #
  199. .PHONY: distclean
  200. distclean: clean
  201. @# Remove the other directories in build/
  202. @rm -rf $(BLD_DIR)
  203. @$(MAKE) -C desktop distclean
  204. @$(MAKE) -C apps distclean
  205. .PHONY: ext-clean
  206. ext-clean:
  207. @$(MAKE) -C desktop ext-clean
  208. @$(MAKE) -C apps ext-clean
  209. # <<<< DEV ONLY
  210. ###############################################
  211. # Misc (some used by automated test scripts)
  212. ###############################################
  213. java-test:
  214. mvn -f desktop/libs/hadoop/java/pom.xml test $(MAVEN_OPTIONS)
  215. test: java-test
  216. DESKTOP_DEBUG=1 $(ENV_PYTHON) $(BLD_DIR_BIN)/hue test fast --with-xunit
  217. test-slow: java-test
  218. DESKTOP_DEBUG=1 $(ENV_PYTHON) $(BLD_DIR_BIN)/hue test all --with-xunit --with-cover
  219. $(BLD_DIR_BIN)/coverage xml
  220. start-dev:
  221. DESKTOP_DEBUG=1 $(ENV_PYTHON) $(BLD_DIR_BIN)/hue runserver_plus
  222. # END DEV ONLY >>>>