Makefile 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426
  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. PPC64LE := $(shell uname -m)
  79. include $(ROOT)/Makefile.vars.priv
  80. ###################################
  81. # Error checking
  82. ###################################
  83. .PHONY: default
  84. default:
  85. @echo 'The build targets for Hue $(DESKTOP_VERSION) are:'
  86. @echo ' install : Install at $$PREFIX ($(INSTALL_DIR)); need desktop'
  87. @echo ' apps : Build and register all desktop apps; need desktop'
  88. @echo ' desktop : Build desktop core only'
  89. @echo ' clean : Remove desktop build products'
  90. @echo ' distclean : Remove desktop and thirdparty build products'
  91. # <<<< DEV ONLY
  92. @echo ' doc : Build documentation'
  93. @echo ' prod : Generate a tar file for production distribution'
  94. @echo ' locales : Extract strings and update dictionary of each locale'
  95. @echo ' ace : Builds the Ace Editor tool'
  96. # END DEV ONLY >>>>
  97. .PHONY: all
  98. all: default
  99. # <<<< DEV ONLY
  100. include Makefile.tarball
  101. ###################################
  102. # Build docs (unused)
  103. ###################################
  104. .PHONY: docs
  105. docs:
  106. @$(MAKE) -C docs
  107. # END DEV ONLY >>>>
  108. ###################################
  109. # Install parent POM
  110. ###################################
  111. parent-pom:
  112. ifneq (,$(BUILD_DB_PROXY))
  113. cd $(ROOT)/maven && mvn install $(MAVEN_OPTIONS)
  114. endif
  115. .PHONY: parent-pom
  116. ###################################
  117. # virtual-env
  118. ###################################
  119. .PHONY: virtual-env
  120. virtual-env: virtual-env2.7 virtual-env3.8 virtual-env3.9
  121. .PHONY: virtual-env2.7
  122. virtual-env2.7: $(BLD_DIR_ENV)/stamp
  123. $(BLD_DIR_ENV)/stamp:
  124. ifeq ($(PYTHON_VER),python2.7)
  125. @echo "--- Creating virtual environment at $(BLD_DIR_ENV) using $(PYTHON_VER)"
  126. @$(SYS_PYTHON) $(VIRTUAL_BOOTSTRAP) $(VIRTUALENV_OPTS) --system-site-packages $(BLD_DIR_ENV)
  127. @echo "--- Virtual environment $(BLD_DIR_ENV) ready"
  128. @touch $@
  129. @echo '--- Installing PIP_MODULES in virtual-env'
  130. @echo "--- start installing PIP_MODULES in virtual-env"
  131. @$(ENV_PIP) install --upgrade pip
  132. @$(ENV_PIP) install --upgrade --force-reinstall $(PIP_MODULES)
  133. @echo "--- done installing PIP_MODULES in virtual-env"
  134. endif
  135. .PHONY: virtual-env3.8
  136. virtual-env3.8: $(BLD_DIR_ENV)/stamp
  137. $(BLD_DIR_ENV)/stamp:
  138. ifeq ($(PYTHON_VER),python3.8)
  139. @echo "--- Creating virtual environment at $(BLD_DIR_ENV) using $(PYTHON_VER)"
  140. @$(SYS_PYTHON) -m pip install --upgrade pip==22.2.2
  141. @$(SYS_PIP) install virtualenv==20.19.0 virtualenv-make-relocatable==0.0.1
  142. @if [[ "ppc64le" == $(PPC64LE) ]]; then \
  143. $(SYS_PYTHON) -m venv $(BLD_DIR_ENV); \
  144. fi
  145. @virtualenv -p $(PYTHON_VER) $(BLD_DIR_ENV)
  146. @echo "--- Virtual environment $(BLD_DIR_ENV) ready"
  147. @touch $@
  148. @echo '--- Installing PIP_MODULES in virtual-env'
  149. @if [[ "ppc64le" == $(PPC64LE) ]]; then \
  150. echo '--- Installing $(REQUIREMENT_PPC64LE_FILE) into virtual-env via $(ENV_PIP)'; \
  151. $(ENV_PIP) install -r $(REQUIREMENT_PPC64LE_FILE); \
  152. echo '--- Finished $(REQUIREMENT_PPC64LE_FILE) into virtual-env'; \
  153. else \
  154. echo '--- Installing $(REQUIREMENT_FILE) into virtual-env via $(ENV_PIP)'; \
  155. $(ENV_PIP) install -r $(REQUIREMENT_FILE); \
  156. echo '--- Finished $(REQUIREMENT_FILE) into virtual-env'; \
  157. fi
  158. @$(ENV_PIP) install $(NAVOPTAPI_WHL)
  159. @echo '--- Finished $(NAVOPTAPI_WHL) into virtual-env'
  160. @touch $(REQUIREMENT_DOT_FILE)
  161. endif
  162. .PHONY: virtual-env3.9
  163. virtual-env3.9: $(BLD_DIR_ENV)/stamp
  164. $(BLD_DIR_ENV)/stamp:
  165. ifeq ($(PYTHON_VER),python3.9)
  166. @echo "--- Creating virtual environment at $(BLD_DIR_ENV) using $(PYTHON_VER)"
  167. @$(SYS_PYTHON) -m pip install --upgrade pip==22.2.2
  168. @$(SYS_PIP) install virtualenv==20.19.0 virtualenv-make-relocatable==0.0.1
  169. @if [[ "ppc64le" == $(PPC64LE) ]]; then \
  170. $(SYS_PYTHON) -m venv $(BLD_DIR_ENV); \
  171. fi
  172. @virtualenv -p $(PYTHON_VER) $(BLD_DIR_ENV)
  173. @echo "--- Virtual environment $(BLD_DIR_ENV) ready"
  174. @touch $@
  175. @echo '--- Installing PIP_MODULES in virtual-env'
  176. @if [[ "ppc64le" == $(PPC64LE) ]]; then \
  177. echo '--- Installing $(REQUIREMENT_PPC64LE_FILE_PY39) into virtual-env via $(ENV_PIP)'; \
  178. $(ENV_PIP) install -r $(REQUIREMENT_PPC64LE_FILE_PY39); \
  179. echo '--- Finished $(REQUIREMENT_PPC64LE_FILE_PY39) into virtual-env'; \
  180. else \
  181. echo '--- Installing $(REQUIREMENT_FILE) into virtual-env via $(ENV_PIP)'; \
  182. $(ENV_PIP) install -r $(REQUIREMENT_FILE); \
  183. echo '--- Finished $(REQUIREMENT_FILE) into virtual-env'; \
  184. fi
  185. @$(ENV_PIP) install $(NAVOPTAPI_WHL)
  186. @echo '--- Finished $(NAVOPTAPI_WHL) into virtual-env'
  187. @touch $(REQUIREMENT_DOT_FILE)
  188. endif
  189. ###################################
  190. # Build desktop
  191. ###################################
  192. .PHONY: desktop
  193. # <<<< DEV ONLY
  194. desktop: parent-pom
  195. # END DEV ONLY >>>>
  196. desktop: virtual-env
  197. @$(MAKE) -C desktop
  198. ###################################
  199. # Build apps
  200. ###################################
  201. .PHONY: apps
  202. apps: desktop
  203. @$(MAKE) npm-install
  204. @$(MAKE) -C $(APPS_DIR) env-install
  205. @$(MAKE) create-static
  206. ###################################
  207. # Install binary dist
  208. ###################################
  209. INSTALL_CORE_FILES = \
  210. Makefile* $(wildcard *.mk) \
  211. ext \
  212. tools/app_reg \
  213. tools/virtual-bootstrap \
  214. tools/enable-python27.sh \
  215. tools/relocatable.sh \
  216. VERS* LICENSE* README*
  217. .PHONY: install
  218. install: virtual-env install-check install-core-structure install-desktop install-apps install-env
  219. .PHONY: install-check
  220. install-check:
  221. @if [ -n '$(wildcard $(INSTALL_DIR)/*)' ] ; then \
  222. echo 'ERROR: $(INSTALL_DIR) not empty. Cowardly refusing to continue.' ; \
  223. false ; \
  224. fi
  225. .PHONY: install-core-structure
  226. install-core-structure:
  227. @echo --- Installing core source structure in $(INSTALL_DIR)...
  228. @mkdir -p $(INSTALL_DIR)
  229. @tar cf - $(INSTALL_CORE_FILES) | tar -C $(INSTALL_DIR) -xf -
  230. @# Add some variables to Makefile to make sure that our virtualenv
  231. @# in the install root is the same one we built from - this also
  232. @# disables the check for python-devel packages which are no longer
  233. @# needed
  234. @echo "SYS_PYTHON=$(ENV_PYTHON_VERSION)" > $(INSTALL_DIR)/Makefile.buildvars
  235. @echo "SKIP_PYTHONDEV_CHECK=1" >> $(INSTALL_DIR)/Makefile.buildvars
  236. .PHONY: install-desktop
  237. install-desktop:
  238. @echo --- Installing Desktop core...
  239. INSTALL_DIR=$(realpath $(INSTALL_DIR)) $(MAKE) -C desktop install
  240. .PHONY: install-apps
  241. install-apps:
  242. @echo '--- Installing Applications...'
  243. INSTALL_DIR=$(realpath $(INSTALL_DIR)) $(MAKE) -C apps install
  244. .PHONY: install-env
  245. install-env:
  246. @echo --- Creating new virtual environment
  247. $(MAKE) -C $(INSTALL_DIR) virtual-env
  248. @echo --- Setting up Desktop core
  249. $(MAKE) -C $(INSTALL_DIR)/desktop env-install
  250. @echo --- Setting up Applications
  251. $(MAKE) -C $(INSTALL_DIR)/apps env-install
  252. @echo --- Setting up Frontend assets
  253. cp $(ROOT)/package.json $(INSTALL_DIR)
  254. cp $(ROOT)/package-lock.json $(INSTALL_DIR)
  255. cp $(ROOT)/webpack.config*.js $(INSTALL_DIR)
  256. cp $(ROOT)/babel.config.js $(INSTALL_DIR)
  257. cp $(ROOT)/tsconfig.json $(INSTALL_DIR)
  258. $(MAKE) -C $(INSTALL_DIR) npm-install
  259. $(MAKE) -C $(INSTALL_DIR) create-static
  260. ###################################
  261. # Frontend and static assets
  262. ###################################
  263. .PHONY: npm-install
  264. npm-install:
  265. npm --version
  266. node --version
  267. npm install
  268. npm run webpack
  269. npm run webpack-login
  270. npm run webpack-workers
  271. node_modules/.bin/removeNPMAbsolutePaths .
  272. rm -rf node_modules
  273. .PHONY: create-static
  274. create-static:
  275. ./build/env/bin/python ./build/env/bin/hue collectstatic --noinput
  276. # <<<< DEV ONLY
  277. .PHONY: doc
  278. doc:
  279. hugo --source docs/docs-site
  280. # END DEV ONLY >>>>
  281. ###################################
  282. # Internationalization
  283. ###################################
  284. # <<<< DEV ONLY
  285. .PHONY: locales
  286. locales:
  287. @$(MAKE) -C desktop compile-locales
  288. @$(MAKE) -C apps compile-locales
  289. # END DEV ONLY >>>>
  290. ###################################
  291. # Ace Editor
  292. ###################################
  293. # <<<< DEV ONLY
  294. .PHONY: ace
  295. ace:
  296. @cd tools/ace-editor && ./hue-ace.sh
  297. # END DEV ONLY >>>>
  298. ###################################
  299. # JISON Parser Generators
  300. ###################################
  301. # <<<< DEV ONLY
  302. .PHONY: global-search-parser
  303. global-search-parser:
  304. @pushd tools/jison/ && npm install && node generateParsers.js globalSearchParser && popd
  305. .PHONY: solr-all-parsers
  306. solr-all-parsers:
  307. @pushd tools/jison/ && npm install && node generateParsers.js solrQueryParser solrFormulaParser && popd
  308. .PHONY: solr-query-parser
  309. solr-query-parser:
  310. @pushd tools/jison/ && npm install && node generateParsers.js solrQueryParser && popd
  311. .PHONY: solr-formula-parser
  312. solr-formula-parser:
  313. @pushd tools/jison/ && npm install && node generateParsers.js solrFormulaParser && popd
  314. .PHONY: sql-all-parsers
  315. sql-all-parsers:
  316. @pushd tools/jison/ && npm install && node generateParsers.js generic hive impala && popd
  317. .PHONY: sql-autocomplete-parser
  318. sql-autocomplete-parser:
  319. @pushd tools/jison/ && npm install && node generateParsers.js genericAutocomp hiveAutocomp impalaAutocomp && popd
  320. .PHONY: sql-statement-parser
  321. sql-statement-parser:
  322. @pushd tools/jison/ && npm install && node generateParsers.js sqlStatementsParser && popd
  323. .PHONY: sql-syntax-parser
  324. sql-syntax-parser:
  325. @pushd tools/jison/ && npm install && node generateParsers.js genericSyntax hiveSyntax impalaSyntax && popd
  326. # END DEV ONLY >>>>
  327. ###################################
  328. # Cleanup
  329. ###################################
  330. .PHONY: clean
  331. clean:
  332. @$(MAKE) -C desktop clean
  333. @$(MAKE) -C apps clean
  334. # <<<< DEV ONLY
  335. @$(MAKE) -C docs clean
  336. # END DEV ONLY >>>>
  337. @rm -rf $(BLD_DIR_ENV)
  338. @rm -rf $(STATIC_DIR)
  339. #
  340. # Note: It is important for clean targets to *ONLY* clean products of the
  341. # build, and not misc runtime generated files. Don't abuse Makefile.
  342. #
  343. .PHONY: distclean
  344. distclean: clean
  345. @# Remove the other directories in build/
  346. @$(MAKE) -C desktop distclean
  347. @$(MAKE) -C apps distclean
  348. @rm -rf $(BLD_DIR)
  349. .PHONY: ext-clean
  350. ext-clean:
  351. @$(MAKE) -C desktop ext-clean
  352. @$(MAKE) -C apps ext-clean
  353. # <<<< DEV ONLY
  354. ###############################################
  355. # Misc (some used by automated test scripts)
  356. ###############################################
  357. test:
  358. DESKTOP_DEBUG=1 $(ENV_PYTHON) $(BLD_DIR_BIN)/hue test fast --with-xunit
  359. test-slow:
  360. DESKTOP_DEBUG=1 $(ENV_PYTHON) $(BLD_DIR_BIN)/hue test all --with-xunit --with-cover
  361. $(BLD_DIR_BIN)/coverage xml -i
  362. start-dev:
  363. DESKTOP_DEBUG=1 $(ENV_PYTHON) $(BLD_DIR_BIN)/hue runserver_plus
  364. devinstall:
  365. npm run devinstall
  366. css:
  367. npm run less
  368. # END DEV ONLY >>>>