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