Makefile 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377
  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. ifneq (,$(BUILD_DB_PROXY))
  112. cd $(ROOT)/maven && mvn install $(MAVEN_OPTIONS)
  113. endif
  114. .PHONY: parent-pom
  115. ###################################
  116. # virtual-env
  117. ###################################
  118. virtual-env: $(BLD_DIR_ENV)/stamp
  119. $(BLD_DIR_ENV)/stamp:
  120. @echo "--- Creating virtual environment at $(BLD_DIR_ENV)"
  121. $(SYS_PYTHON) $(VIRTUAL_BOOTSTRAP) \
  122. $(VIRTUALENV_OPTS) --system-site-packages $(BLD_DIR_ENV)
  123. @touch $@
  124. @echo "--- $(BLD_DIR_ENV) ready"
  125. .PHONY: virtual-env
  126. ###################################
  127. # Build desktop
  128. ###################################
  129. .PHONY: desktop
  130. # <<<< DEV ONLY
  131. desktop: parent-pom
  132. # END DEV ONLY >>>>
  133. desktop: virtual-env
  134. @$(MAKE) -C desktop
  135. ###################################
  136. # Build apps
  137. ###################################
  138. .PHONY: apps
  139. apps: desktop
  140. @$(MAKE) npm-install
  141. @$(MAKE) -C $(APPS_DIR) env-install
  142. @$(MAKE) create-static
  143. ###################################
  144. # Install binary dist
  145. ###################################
  146. INSTALL_CORE_FILES = \
  147. Makefile* $(wildcard *.mk) \
  148. ext \
  149. tools/app_reg \
  150. tools/virtual-bootstrap \
  151. tools/enable-python27.sh \
  152. tools/relocatable.sh \
  153. VERS* LICENSE* README* webpack-stats*.json
  154. .PHONY: install
  155. install: virtual-env install-check install-core-structure install-desktop install-apps install-env
  156. .PHONY: install-check
  157. install-check:
  158. @if [ -n '$(wildcard $(INSTALL_DIR)/*)' ] ; then \
  159. echo 'ERROR: $(INSTALL_DIR) not empty. Cowardly refusing to continue.' ; \
  160. false ; \
  161. fi
  162. .PHONY: install-core-structure
  163. install-core-structure:
  164. @echo --- Installing core source structure...
  165. @mkdir -p $(INSTALL_DIR)
  166. @tar cf - $(INSTALL_CORE_FILES) | tar -C $(INSTALL_DIR) -xf -
  167. @# Add some variables to Makefile to make sure that our virtualenv
  168. @# in the install root is the same one we built from - this also
  169. @# disables the check for python-devel packages which are no longer
  170. @# needed
  171. @echo "SYS_PYTHON=$(ENV_PYTHON_VERSION)" > $(INSTALL_DIR)/Makefile.buildvars
  172. @echo "SKIP_PYTHONDEV_CHECK=1" >> $(INSTALL_DIR)/Makefile.buildvars
  173. .PHONY: install-desktop
  174. install-desktop:
  175. @echo --- Installing Desktop core...
  176. INSTALL_DIR=$(realpath $(INSTALL_DIR)) $(MAKE) -C desktop install
  177. .PHONY: install-apps
  178. install-apps:
  179. @echo '--- Installing Applications...'
  180. INSTALL_DIR=$(realpath $(INSTALL_DIR)) $(MAKE) -C apps install
  181. .PHONY: install-env
  182. install-env:
  183. @echo --- Creating new virtual environment
  184. $(MAKE) -C $(INSTALL_DIR) virtual-env
  185. # Assumes Py2 as Py3 does not have `install` target anyway.
  186. # This is needed as somehow Hue commands (app_reg, collectstatic..) import modules with hard uneeded dependencies on those.
  187. # We have two virt-env: $(ENV_PIP) aka /build/hue for build and $(PREFIX)/hue/build/env for destination.
  188. @if [ "$(MAKECMDGOALS)" = "install" ]; then \
  189. $(PREFIX)/hue/build/env/bin/pip install $(PIP_MODULES); \
  190. fi
  191. # Alternative to ext-py directory but only due to the special case below.
  192. # Hackish way to get crypto to install with pre-compiled dependencies that now break as of today with Py2.
  193. @if [ "$(PYTHON_VER)" = "python2.7" ]; then \
  194. $(ENV_PIP) install --upgrade pip; \
  195. $(ENV_PIP) install $(PIP_MODULES); \
  196. fi
  197. @echo --- Setting up Desktop core
  198. $(MAKE) -C $(INSTALL_DIR)/desktop env-install
  199. @echo --- Setting up Applications
  200. $(MAKE) -C $(INSTALL_DIR)/apps env-install
  201. @echo --- Setting up Frontend assets
  202. cp $(ROOT)/package.json $(INSTALL_DIR)
  203. cp $(ROOT)/package-lock.json $(INSTALL_DIR)
  204. cp $(ROOT)/webpack.config*.js $(INSTALL_DIR)
  205. cp $(ROOT)/.babelrc $(INSTALL_DIR)
  206. cp $(ROOT)/tsconfig.json $(INSTALL_DIR)
  207. $(MAKE) -C $(INSTALL_DIR) npm-install
  208. @if [ "$(MAKECMDGOALS)" = "install" ]; then \
  209. $(MAKE) -C $(INSTALL_DIR) create-static; \
  210. fi
  211. ###################################
  212. # Frontend and static assets
  213. ###################################
  214. .PHONY: npm-install
  215. npm-install:
  216. npm --version
  217. node --version
  218. npm install
  219. npm run webpack
  220. npm run webpack-login
  221. npm run webpack-workers
  222. node_modules/.bin/removeNPMAbsolutePaths .
  223. @if [ "$(MAKECMDGOALS)" = "install" ]; then \
  224. rm -rf node_modules; \
  225. fi
  226. .PHONY: create-static
  227. create-static:
  228. ./build/env/bin/hue collectstatic --noinput
  229. # <<<< DEV ONLY
  230. .PHONY: doc
  231. doc:
  232. hugo --source docs/docs-site
  233. # END DEV ONLY >>>>
  234. ###################################
  235. # Internationalization
  236. ###################################
  237. # <<<< DEV ONLY
  238. .PHONY: locales
  239. locales:
  240. @$(MAKE) -C desktop compile-locales
  241. @$(MAKE) -C apps compile-locales
  242. # END DEV ONLY >>>>
  243. ###################################
  244. # Ace Editor
  245. ###################################
  246. # <<<< DEV ONLY
  247. .PHONY: ace
  248. ace:
  249. @cd tools/ace-editor && ./hue-ace.sh
  250. # END DEV ONLY >>>>
  251. ###################################
  252. # JISON Parser Generators
  253. ###################################
  254. # <<<< DEV ONLY
  255. .PHONY: global-search-parser
  256. global-search-parser:
  257. @pushd tools/jison/ && npm install && node generateParsers.js globalSearchParser && popd
  258. .PHONY: solr-all-parsers
  259. solr-all-parsers:
  260. @pushd tools/jison/ && npm install && node generateParsers.js solrQueryParser solrFormulaParser && popd
  261. .PHONY: solr-query-parser
  262. solr-query-parser:
  263. @pushd tools/jison/ && npm install && node generateParsers.js solrQueryParser && popd
  264. .PHONY: solr-formula-parser
  265. solr-formula-parser:
  266. @pushd tools/jison/ && npm install && node generateParsers.js solrFormulaParser && popd
  267. .PHONY: sql-all-parsers
  268. sql-all-parsers:
  269. @pushd tools/jison/ && npm install && node generateParsers.js generic hive impala && popd
  270. .PHONY: sql-autocomplete-parser
  271. sql-autocomplete-parser:
  272. @pushd tools/jison/ && npm install && node generateParsers.js genericAutocomp hiveAutocomp impalaAutocomp && popd
  273. .PHONY: sql-statement-parser
  274. sql-statement-parser:
  275. @pushd tools/jison/ && npm install && node generateParsers.js sqlStatementsParser && popd
  276. .PHONY: sql-syntax-parser
  277. sql-syntax-parser:
  278. @pushd tools/jison/ && npm install && node generateParsers.js genericSyntax hiveSyntax impalaSyntax && popd
  279. # END DEV ONLY >>>>
  280. ###################################
  281. # Cleanup
  282. ###################################
  283. .PHONY: clean
  284. clean:
  285. @$(MAKE) -C desktop clean
  286. @$(MAKE) -C apps clean
  287. # <<<< DEV ONLY
  288. @$(MAKE) -C docs clean
  289. # END DEV ONLY >>>>
  290. @rm -rf $(BLD_DIR_ENV)
  291. @rm -rf $(STATIC_DIR)
  292. #
  293. # Note: It is important for clean targets to *ONLY* clean products of the
  294. # build, and not misc runtime generated files. Don't abuse Makefile.
  295. #
  296. .PHONY: distclean
  297. distclean: clean
  298. @# Remove the other directories in build/
  299. @$(MAKE) -C desktop distclean
  300. @$(MAKE) -C apps distclean
  301. @rm -rf $(BLD_DIR)
  302. .PHONY: ext-clean
  303. ext-clean:
  304. @$(MAKE) -C desktop ext-clean
  305. @$(MAKE) -C apps ext-clean
  306. # <<<< DEV ONLY
  307. ###############################################
  308. # Misc (some used by automated test scripts)
  309. ###############################################
  310. test:
  311. DESKTOP_DEBUG=1 $(ENV_PYTHON) $(BLD_DIR_BIN)/hue test fast --with-xunit
  312. test-slow:
  313. DESKTOP_DEBUG=1 $(ENV_PYTHON) $(BLD_DIR_BIN)/hue test all --with-xunit --with-cover
  314. $(BLD_DIR_BIN)/coverage xml -i
  315. start-dev:
  316. DESKTOP_DEBUG=1 $(ENV_PYTHON) $(BLD_DIR_BIN)/hue runserver_plus
  317. devinstall:
  318. npm run devinstall
  319. css:
  320. npm run less
  321. # END DEV ONLY >>>>