Makefile 10.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359
  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 ' doc : Build documentation'
  92. @echo ' prod : Generate a tar file for production distribution'
  93. @echo ' locales : Extract strings and update dictionary of each locale'
  94. @echo ' ace : Builds the Ace Editor tool'
  95. # END DEV ONLY >>>>
  96. .PHONY: all
  97. all: default
  98. # <<<< DEV ONLY
  99. include Makefile.tarball
  100. ###################################
  101. # Build docs (unused)
  102. ###################################
  103. .PHONY: docs
  104. docs:
  105. @$(MAKE) -C docs
  106. # END DEV ONLY >>>>
  107. ###################################
  108. # Install parent POM
  109. ###################################
  110. parent-pom:
  111. cd $(ROOT)/maven && mvn install $(MAVEN_OPTIONS)
  112. .PHONY: parent-pom
  113. ###################################
  114. # virtual-env
  115. ###################################
  116. virtual-env: $(BLD_DIR_ENV)/stamp
  117. $(BLD_DIR_ENV)/stamp:
  118. @echo "--- Creating virtual environment at $(BLD_DIR_ENV)"
  119. $(SYS_PYTHON) $(VIRTUAL_BOOTSTRAP) \
  120. $(VIRTUALENV_OPTS) --system-site-packages $(BLD_DIR_ENV)
  121. @touch $@
  122. @echo "--- $(BLD_DIR_ENV) ready"
  123. .PHONY: virtual-env
  124. ###################################
  125. # Build desktop
  126. ###################################
  127. .PHONY: desktop
  128. # <<<< DEV ONLY
  129. desktop: parent-pom
  130. # END DEV ONLY >>>>
  131. desktop: virtual-env
  132. @$(MAKE) -C desktop
  133. ###################################
  134. # Build apps
  135. ###################################
  136. .PHONY: apps
  137. apps: desktop
  138. @$(MAKE) npm-install
  139. @$(MAKE) -C $(APPS_DIR) env-install
  140. @$(MAKE) create-static
  141. ###################################
  142. # Install binary dist
  143. ###################################
  144. INSTALL_CORE_FILES = \
  145. Makefile* $(wildcard *.mk) \
  146. ext \
  147. tools/app_reg \
  148. tools/virtual-bootstrap \
  149. tools/enable-python27.sh \
  150. tools/relocatable.sh \
  151. VERS* LICENSE* README* webpack-stats*.json
  152. .PHONY: install
  153. install: virtual-env install-check install-core-structure install-desktop install-apps install-env
  154. .PHONY: install-check
  155. install-check:
  156. @if [ -n '$(wildcard $(INSTALL_DIR)/*)' ] ; then \
  157. echo 'ERROR: $(INSTALL_DIR) not empty. Cowardly refusing to continue.' ; \
  158. false ; \
  159. fi
  160. .PHONY: install-core-structure
  161. install-core-structure:
  162. @echo --- Installing core source structure...
  163. @mkdir -p $(INSTALL_DIR)
  164. @tar cf - $(INSTALL_CORE_FILES) | tar -C $(INSTALL_DIR) -xf -
  165. @# Add some variables to Makefile to make sure that our virtualenv
  166. @# in the install root is the same one we built from - this also
  167. @# disables the check for python-devel packages which are no longer
  168. @# needed
  169. @echo "SYS_PYTHON=$(ENV_PYTHON_VERSION)" > $(INSTALL_DIR)/Makefile.buildvars
  170. @echo "SKIP_PYTHONDEV_CHECK=1" >> $(INSTALL_DIR)/Makefile.buildvars
  171. .PHONY: install-desktop
  172. install-desktop:
  173. @echo --- Installing Desktop core...
  174. INSTALL_DIR=$(realpath $(INSTALL_DIR)) $(MAKE) -C desktop install
  175. .PHONY: install-apps
  176. install-apps:
  177. @echo '--- Installing Applications...'
  178. INSTALL_DIR=$(realpath $(INSTALL_DIR)) $(MAKE) -C apps install
  179. .PHONY: install-env
  180. install-env:
  181. @echo --- Creating new virtual environment
  182. $(MAKE) -C $(INSTALL_DIR) virtual-env
  183. @echo --- Setting up Desktop core
  184. $(MAKE) -C $(INSTALL_DIR)/desktop env-install
  185. @echo --- Setting up Applications
  186. $(MAKE) -C $(INSTALL_DIR)/apps env-install
  187. @echo --- Setting up Frontend assets
  188. cp $(ROOT)/package.json $(INSTALL_DIR)
  189. cp $(ROOT)/webpack.config*.js $(INSTALL_DIR)
  190. cp $(ROOT)/.babelrc $(INSTALL_DIR)
  191. $(MAKE) -C $(INSTALL_DIR) npm-install
  192. @if [ "$(MAKECMDGOALS)" = "install" ]; then \
  193. $(MAKE) -C $(INSTALL_DIR) create-static; \
  194. fi
  195. ###################################
  196. # Frontend and static assets
  197. ###################################
  198. .PHONY: npm-install
  199. npm-install:
  200. npm install
  201. npm run webpack
  202. npm run webpack-login
  203. npm run webpack-workers
  204. node_modules/.bin/removeNPMAbsolutePaths .
  205. @if [ "$(MAKECMDGOALS)" = "install" ]; then \
  206. rm -rf node_modules; \
  207. fi
  208. .PHONY: create-static
  209. create-static:
  210. ./build/env/bin/hue collectstatic --noinput
  211. # <<<< DEV ONLY
  212. .PHONY: doc
  213. doc:
  214. hugo --source docs/docs-site
  215. # END DEV ONLY >>>>
  216. ###################################
  217. # Internationalization
  218. ###################################
  219. # <<<< DEV ONLY
  220. .PHONY: locales
  221. locales:
  222. @$(MAKE) -C desktop compile-locales
  223. @$(MAKE) -C apps compile-locales
  224. # END DEV ONLY >>>>
  225. ###################################
  226. # Ace Editor
  227. ###################################
  228. # <<<< DEV ONLY
  229. .PHONY: ace
  230. ace:
  231. @cd tools/ace-editor && ./hue-ace.sh
  232. # END DEV ONLY >>>>
  233. ###################################
  234. # JISON Parser Generators
  235. ###################################
  236. # <<<< DEV ONLY
  237. .PHONY: global-search-parser
  238. global-search-parser:
  239. @node tools/jison/generateParsers.js globalSearchParser
  240. .PHONY: solr-all-parsers
  241. solr-all-parsers:
  242. @node tools/jison/generateParsers.js solrQueryParser solrFormulaParser
  243. .PHONY: solr-query-parser
  244. solr-query-parser:
  245. @node tools/jison/generateParsers.js solrQueryParser
  246. .PHONY: solr-formula-parser
  247. solr-formula-parser:
  248. @node tools/jison/generateParsers.js solrFormulaParser
  249. .PHONY: sql-all-parsers
  250. sql-all-parsers:
  251. @node tools/jison/generateParsers.js generic hive impala
  252. .PHONY: sql-autocomplete-parser
  253. sql-autocomplete-parser:
  254. @node tools/jison/generateParsers.js genericAutocomp hiveAutocomp impalaAutocomp
  255. .PHONY: sql-statement-parser
  256. sql-statement-parser:
  257. @node tools/jison/generateParsers.js sqlStatementsParser
  258. .PHONY: sql-syntax-parser
  259. sql-syntax-parser:
  260. @node tools/jison/generateParsers.js genericSyntax hiveSyntax impalaSyntax
  261. # END DEV ONLY >>>>
  262. ###################################
  263. # Cleanup
  264. ###################################
  265. .PHONY: clean
  266. clean:
  267. @$(MAKE) -C desktop clean
  268. @$(MAKE) -C apps clean
  269. # <<<< DEV ONLY
  270. @$(MAKE) -C docs clean
  271. # END DEV ONLY >>>>
  272. @rm -rf $(BLD_DIR_ENV)
  273. @rm -rf $(STATIC_DIR)
  274. #
  275. # Note: It is important for clean targets to *ONLY* clean products of the
  276. # build, and not misc runtime generated files. Don't abuse Makefile.
  277. #
  278. .PHONY: distclean
  279. distclean: clean
  280. @# Remove the other directories in build/
  281. @$(MAKE) -C desktop distclean
  282. @$(MAKE) -C apps distclean
  283. @rm -rf $(BLD_DIR)
  284. .PHONY: ext-clean
  285. ext-clean:
  286. @$(MAKE) -C desktop ext-clean
  287. @$(MAKE) -C apps ext-clean
  288. # <<<< DEV ONLY
  289. ###############################################
  290. # Misc (some used by automated test scripts)
  291. ###############################################
  292. test:
  293. DESKTOP_DEBUG=1 $(ENV_PYTHON) $(BLD_DIR_BIN)/hue test fast --with-xunit
  294. test-slow:
  295. DESKTOP_DEBUG=1 $(ENV_PYTHON) $(BLD_DIR_BIN)/hue test all --with-xunit --with-cover
  296. $(BLD_DIR_BIN)/coverage xml -i
  297. start-dev:
  298. DESKTOP_DEBUG=1 $(ENV_PYTHON) $(BLD_DIR_BIN)/hue runserver_plus
  299. devinstall:
  300. npm run devinstall
  301. css:
  302. npm run less
  303. # END DEV ONLY >>>>