Makefile 11 KB

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