Makefile 12 KB

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