Makefile 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548
  1. DOCKER_COMPOSE_FLAGS ?= -f docker-compose.yml
  2. BUILD_NUMBER ?= local
  3. BRANCH_NAME ?= $(shell git rev-parse --abbrev-ref HEAD)
  4. PROJECT_NAME = web
  5. BUILD_DIR_NAME = $(shell pwd | xargs basename | tr -cd '[a-zA-Z0-9_.\-]')
  6. export SHARELATEX_CONFIG ?= /overleaf/services/web/test/acceptance/config/settings.test.saas.js
  7. export BASE_CONFIG ?= ${SHARELATEX_CONFIG}
  8. CFG_SAAS=/overleaf/services/web/test/acceptance/config/settings.test.saas.js
  9. CFG_SERVER_CE=/overleaf/services/web/test/acceptance/config/settings.test.server-ce.js
  10. CFG_SERVER_PRO=/overleaf/services/web/test/acceptance/config/settings.test.server-pro.js
  11. DOCKER_COMPOSE := BUILD_NUMBER=$(BUILD_NUMBER) \
  12. BRANCH_NAME=$(BRANCH_NAME) \
  13. PROJECT_NAME=$(PROJECT_NAME) \
  14. MOCHA_GREP=${MOCHA_GREP} \
  15. docker-compose ${DOCKER_COMPOSE_FLAGS}
  16. MODULE_DIRS := $(shell find modules -mindepth 1 -maxdepth 1 -type d -not -name '.git' )
  17. MODULE_MAKEFILES := $(MODULE_DIRS:=/Makefile)
  18. MODULE_NAME=$(shell basename $(MODULE))
  19. $(MODULE_MAKEFILES): Makefile.module
  20. cp Makefile.module $@ || diff Makefile.module $@
  21. #
  22. # Clean
  23. #
  24. clean:
  25. -$(DOCKER_COMPOSE) down --rmi local
  26. -COMPOSE_PROJECT_NAME=unit_test_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down --rmi local
  27. -COMPOSE_PROJECT_NAME=unit_test_all_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down --rmi local
  28. -COMPOSE_PROJECT_NAME=unit_test_parallel_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down --rmi local
  29. -COMPOSE_PROJECT_NAME=unit_test_parallel_make_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down --rmi local
  30. -COMPOSE_PROJECT_NAME=acceptance_test_saas_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down --rmi local
  31. -COMPOSE_PROJECT_NAME=acceptance_test_server_ce_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down --rmi local
  32. -COMPOSE_PROJECT_NAME=acceptance_test_server_pro_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down --rmi local
  33. -COMPOSE_PROJECT_NAME=acceptance_modules_merged_saas_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down --rmi local
  34. -COMPOSE_PROJECT_NAME=acceptance_modules_merged_saas_1_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down --rmi local
  35. -COMPOSE_PROJECT_NAME=acceptance_modules_merged_saas_2_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down --rmi local
  36. -COMPOSE_PROJECT_NAME=acceptance_modules_merged_saas_3_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down --rmi local
  37. -COMPOSE_PROJECT_NAME=acceptance_modules_merged_saas_4_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down --rmi local
  38. -COMPOSE_PROJECT_NAME=acceptance_modules_merged_server_ce_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down --rmi local
  39. -COMPOSE_PROJECT_NAME=acceptance_modules_merged_server_pro_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down --rmi local
  40. -COMPOSE_PROJECT_NAME=karma_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down --rmi local
  41. -COMPOSE_PROJECT_NAME=karma_test_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down --rmi local
  42. -COMPOSE_PROJECT_NAME=frontend_test_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down --rmi local
  43. -COMPOSE_PROJECT_NAME=tar_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down --rmi local
  44. clean_ci:
  45. $(DOCKER_COMPOSE) down -v -t 0
  46. docker container list | grep 'days ago' | cut -d ' ' -f 1 - | xargs -r docker container stop
  47. docker image prune -af --filter "until=48h"
  48. docker network prune -f
  49. #
  50. # Tests
  51. #
  52. test: test_unit test_karma test_acceptance test_frontend test_frontend_ct
  53. test_module: test_unit_module test_acceptance_module
  54. #
  55. # Unit tests
  56. #
  57. test_unit: test_unit_all
  58. test_unit_all:
  59. COMPOSE_PROJECT_NAME=unit_test_all_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) run --rm test_unit npm run test:unit:all
  60. COMPOSE_PROJECT_NAME=unit_test_all_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down -v -t 0
  61. test_unit_all_silent:
  62. COMPOSE_PROJECT_NAME=unit_test_all_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) run --rm test_unit npm run test:unit:all:silent
  63. COMPOSE_PROJECT_NAME=unit_test_all_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down -v -t 0
  64. test_unit_app:
  65. COMPOSE_PROJECT_NAME=unit_test_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down -v -t 0
  66. COMPOSE_PROJECT_NAME=unit_test_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) run --name unit_test_$(BUILD_DIR_NAME) --rm test_unit
  67. COMPOSE_PROJECT_NAME=unit_test_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down -v -t 0
  68. TEST_SUITES = $(sort $(filter-out \
  69. $(wildcard test/unit/src/helpers/*), \
  70. $(wildcard test/unit/src/*/*)))
  71. MOCHA_CMD_LINE = \
  72. mocha \
  73. --exit \
  74. --file test/unit/bootstrap.js \
  75. --grep=${MOCHA_GREP} \
  76. --reporter spec \
  77. --timeout 25000 \
  78. .PHONY: $(TEST_SUITES)
  79. $(TEST_SUITES):
  80. $(MOCHA_CMD_LINE) $@
  81. J ?= 1
  82. test_unit_app_parallel_gnu_make: $(TEST_SUITES)
  83. test_unit_app_parallel_gnu_make_docker: export COMPOSE_PROJECT_NAME = \
  84. unit_test_parallel_make_$(BUILD_DIR_NAME)
  85. test_unit_app_parallel_gnu_make_docker:
  86. $(DOCKER_COMPOSE) down -v -t 0
  87. $(DOCKER_COMPOSE) run --rm test_unit \
  88. make test_unit_app_parallel_gnu_make --output-sync -j $(J)
  89. $(DOCKER_COMPOSE) down -v -t 0
  90. TEST_UNIT_MODULES = $(MODULE_DIRS:=/test_unit)
  91. $(TEST_UNIT_MODULES): %/test_unit: %/Makefile
  92. test_unit_modules: $(TEST_UNIT_MODULES)
  93. test_unit_module:
  94. $(MAKE) modules/$(MODULE_NAME)/test_unit
  95. #
  96. # Karma frontend tests
  97. #
  98. test_karma: build_test_karma test_karma_run
  99. test_karma_run:
  100. COMPOSE_PROJECT_NAME=karma_test_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down -v -t 0
  101. COMPOSE_PROJECT_NAME=karma_test_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) run --rm test_karma
  102. COMPOSE_PROJECT_NAME=karma_test_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down -v -t 0
  103. test_karma_build_run: build_test_karma test_karma_run
  104. #
  105. # Frontend tests
  106. #
  107. test_frontend:
  108. COMPOSE_PROJECT_NAME=frontend_test_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down -v -t 0
  109. COMPOSE_PROJECT_NAME=frontend_test_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) run --rm test_frontend
  110. COMPOSE_PROJECT_NAME=frontend_test_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down -v -t 0
  111. #
  112. # Frontend component tests in Cypress
  113. #
  114. test_frontend_ct:
  115. COMPOSE_PROJECT_NAME=frontend_test_ct_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down -v -t 0
  116. COMPOSE_PROJECT_NAME=frontend_test_ct_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) run --rm test_frontend_ct
  117. COMPOSE_PROJECT_NAME=frontend_test_ct_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down -v -t 0
  118. #
  119. # Acceptance tests
  120. #
  121. test_acceptance: test_acceptance_app test_acceptance_modules
  122. test_acceptance_saas: test_acceptance_app_saas test_acceptance_modules_merged_saas
  123. test_acceptance_server_ce: test_acceptance_app_server_ce test_acceptance_modules_merged_server_ce
  124. test_acceptance_server_pro: test_acceptance_app_server_pro test_acceptance_modules_merged_server_pro
  125. TEST_ACCEPTANCE_APP := \
  126. test_acceptance_app_saas \
  127. test_acceptance_app_server_ce \
  128. test_acceptance_app_server_pro \
  129. test_acceptance_app: $(TEST_ACCEPTANCE_APP)
  130. test_acceptance_app_saas: export COMPOSE_PROJECT_NAME=acceptance_test_saas_$(BUILD_DIR_NAME)
  131. test_acceptance_app_saas: export SHARELATEX_CONFIG=$(CFG_SAAS)
  132. test_acceptance_app_server_ce: export COMPOSE_PROJECT_NAME=acceptance_test_server_ce_$(BUILD_DIR_NAME)
  133. test_acceptance_app_server_ce: export SHARELATEX_CONFIG=$(CFG_SERVER_CE)
  134. test_acceptance_app_server_pro: export COMPOSE_PROJECT_NAME=acceptance_test_server_pro_$(BUILD_DIR_NAME)
  135. test_acceptance_app_server_pro: export SHARELATEX_CONFIG=$(CFG_SERVER_PRO)
  136. $(TEST_ACCEPTANCE_APP):
  137. $(DOCKER_COMPOSE) down -v -t 0
  138. $(DOCKER_COMPOSE) run --rm test_acceptance
  139. $(DOCKER_COMPOSE) down -v -t 0
  140. # We are using _make magic_ for turning these file-targets into calls to
  141. # sub-Makefiles in the individual modules.
  142. # These sub-Makefiles need to be kept in sync with the template, hence we
  143. # add a dependency on each modules Makefile and cross-link that to the
  144. # template at the very top of this file.
  145. # Example: `web$ make modules/server-ce-scripts/test_acceptance_server_ce`
  146. # Description: Run the acceptance tests of the server-ce-scripts module in a
  147. # Server CE Environment.
  148. # Break down:
  149. # Target: modules/server-ce-scripts/test_acceptance_server_ce
  150. # -> depends on modules/server-ce-scripts/Makefile
  151. # -> add environment variable BASE_CONFIG=$(CFG_SERVER_CE)
  152. # -> BASE_CONFIG=/overleaf/services/web/test/acceptance/config/settings.test.server-ce.js
  153. # -> automatic target: `make -C server-ce-scripts test_acceptance_server_ce`
  154. # -> automatic target: run `make test_acceptance_server_ce` in module
  155. # Target: modules/server-ce-scripts/Makefile
  156. # -> depends on Makefile.module
  157. # -> automatic target: copies the file when changed
  158. TEST_ACCEPTANCE_MODULES = $(MODULE_DIRS:=/test_acceptance)
  159. $(TEST_ACCEPTANCE_MODULES): %/test_acceptance: %/Makefile
  160. $(TEST_ACCEPTANCE_MODULES): modules/%/test_acceptance:
  161. $(MAKE) test_acceptance_module MODULE_NAME=$*
  162. TEST_ACCEPTANCE_MODULES_SAAS = $(MODULE_DIRS:=/test_acceptance_saas)
  163. $(TEST_ACCEPTANCE_MODULES_SAAS): %/test_acceptance_saas: %/Makefile
  164. $(TEST_ACCEPTANCE_MODULES_SAAS): export BASE_CONFIG = $(CFG_SAAS)
  165. # This line adds `/test_acceptance_saas` suffix to all items in $(MODULE_DIRS).
  166. TEST_ACCEPTANCE_MODULES_SERVER_CE = $(MODULE_DIRS:=/test_acceptance_server_ce)
  167. # This line adds a dependency on the modules Makefile.
  168. $(TEST_ACCEPTANCE_MODULES_SERVER_CE): %/test_acceptance_server_ce: %/Makefile
  169. # This line adds the environment variable BASE_CONFIG=$(CFG_SERVER_CE) to all
  170. # invocations of `web$ make modules/foo/test_acceptance_server_ce`.
  171. $(TEST_ACCEPTANCE_MODULES_SERVER_CE): export BASE_CONFIG = $(CFG_SERVER_CE)
  172. TEST_ACCEPTANCE_MODULES_SERVER_PRO = $(MODULE_DIRS:=/test_acceptance_server_pro)
  173. $(TEST_ACCEPTANCE_MODULES_SERVER_PRO): %/test_acceptance_server_pro: %/Makefile
  174. $(TEST_ACCEPTANCE_MODULES_SERVER_PRO): export BASE_CONFIG = $(CFG_SERVER_PRO)
  175. CLEAN_TEST_ACCEPTANCE_MODULES = $(MODULE_DIRS:=/clean_test_acceptance)
  176. $(CLEAN_TEST_ACCEPTANCE_MODULES): %/clean_test_acceptance: %/Makefile
  177. clean_test_acceptance_modules: $(CLEAN_TEST_ACCEPTANCE_MODULES)
  178. clean_ci: clean_test_acceptance_modules
  179. test_acceptance_module_noop:
  180. @echo
  181. @echo Module '$(MODULE_NAME)' does not run in ${LABEL}.
  182. @echo
  183. TEST_ACCEPTANCE_MODULE_MAYBE_IN := \
  184. test_acceptance_module_maybe_in_saas \
  185. test_acceptance_module_maybe_in_server_ce \
  186. test_acceptance_module_maybe_in_server_pro \
  187. test_acceptance_module: $(TEST_ACCEPTANCE_MODULE_MAYBE_IN)
  188. test_acceptance_module_maybe_in_saas: export BASE_CONFIG=$(CFG_SAAS)
  189. test_acceptance_module_maybe_in_server_ce: export BASE_CONFIG=$(CFG_SERVER_CE)
  190. test_acceptance_module_maybe_in_server_pro: export BASE_CONFIG=$(CFG_SERVER_PRO)
  191. # We need to figure out whether the module is loaded in a given environment.
  192. # This information is stored in the (base-)settings.
  193. # We get the full list of modules and check for a matching module entry.
  194. # Either the grep will find and emit the module, or exits with code 1, which
  195. # we handle with a fallback to a noop make target.
  196. # Run the node command in a docker-compose container which provides the needed
  197. # npm dependencies (from disk in dev-env or from the CI image in CI).
  198. # Pick the test_unit service which is very light-weight -- the test_acceptance
  199. # service would start mongo/redis.
  200. $(TEST_ACCEPTANCE_MODULE_MAYBE_IN): test_acceptance_module_maybe_in_%:
  201. $(MAKE) $(shell \
  202. SHARELATEX_CONFIG=$(BASE_CONFIG) \
  203. $(DOCKER_COMPOSE) run --rm test_unit \
  204. node test/acceptance/getModuleTargets test_acceptance_$* \
  205. | grep -e /$(MODULE_NAME)/ || echo test_acceptance_module_noop LABEL=$* \
  206. )
  207. # See docs for test_acceptance_server_ce how this works.
  208. test_acceptance_module_saas: export BASE_CONFIG = $(CFG_SAAS)
  209. test_acceptance_module_saas:
  210. $(MAKE) modules/$(MODULE_NAME)/test_acceptance_saas
  211. test_acceptance_module_server_ce: export BASE_CONFIG = $(CFG_SERVER_CE)
  212. test_acceptance_module_server_ce:
  213. $(MAKE) modules/$(MODULE_NAME)/test_acceptance_server_ce
  214. test_acceptance_module_server_pro: export BASE_CONFIG = $(CFG_SERVER_PRO)
  215. test_acceptance_module_server_pro:
  216. $(MAKE) modules/$(MODULE_NAME)/test_acceptance_server_pro
  217. # See docs for test_acceptance_server_ce how this works.
  218. TEST_ACCEPTANCE_MODULES_MERGED_INNER = $(MODULE_DIRS:=/test_acceptance_merged_inner)
  219. $(TEST_ACCEPTANCE_MODULES_MERGED_INNER): %/test_acceptance_merged_inner: %/Makefile
  220. test_acceptance_modules_merged_inner:
  221. $(MAKE) $(shell \
  222. SHARELATEX_CONFIG=$(BASE_CONFIG) \
  223. node test/acceptance/getModuleTargets test_acceptance_merged_inner \
  224. )
  225. # inner loop for running saas tests in parallel
  226. no_more_targets:
  227. # If we ever have more than 40 modules, we need to add _5 targets to all the places and have it START at 41.
  228. test_acceptance_modules_merged_inner_1: export START=1
  229. test_acceptance_modules_merged_inner_2: export START=11
  230. test_acceptance_modules_merged_inner_3: export START=21
  231. test_acceptance_modules_merged_inner_4: export START=31
  232. TEST_ACCEPTANCE_MODULES_MERGED_INNER_SPLIT = \
  233. test_acceptance_modules_merged_inner_1 \
  234. test_acceptance_modules_merged_inner_2 \
  235. test_acceptance_modules_merged_inner_3 \
  236. test_acceptance_modules_merged_inner_4 \
  237. # The node script prints one module per line.
  238. # Using tail and head we skip over the first n=START entries and print the last 10.
  239. # Finally we check with grep for any targets in a batch and print a fallback if none were found.
  240. $(TEST_ACCEPTANCE_MODULES_MERGED_INNER_SPLIT):
  241. $(MAKE) $(shell \
  242. SHARELATEX_CONFIG=$(BASE_CONFIG) \
  243. node test/acceptance/getModuleTargets test_acceptance_merged_inner \
  244. | tail -n+$(START) | head -n 10 \
  245. | grep -e . || echo no_more_targets \
  246. )
  247. # See docs for test_acceptance_server_ce how this works.
  248. test_acceptance_modules_merged_saas: export COMPOSE_PROJECT_NAME = \
  249. acceptance_test_modules_merged_saas_$(BUILD_DIR_NAME)
  250. test_acceptance_modules_merged_saas: export BASE_CONFIG = $(CFG_SAAS)
  251. test_acceptance_modules_merged_server_ce: export COMPOSE_PROJECT_NAME = \
  252. acceptance_test_modules_merged_server_ce_$(BUILD_DIR_NAME)
  253. test_acceptance_modules_merged_server_ce: export BASE_CONFIG = $(CFG_SERVER_CE)
  254. test_acceptance_modules_merged_server_pro: export COMPOSE_PROJECT_NAME = \
  255. acceptance_test_modules_merged_server_pro_$(BUILD_DIR_NAME)
  256. test_acceptance_modules_merged_server_pro: export BASE_CONFIG = $(CFG_SERVER_PRO)
  257. # All these variants run the same command.
  258. # Each target has a different set of environment defined above.
  259. TEST_ACCEPTANCE_MODULES_MERGED_VARIANTS = \
  260. test_acceptance_modules_merged_saas \
  261. test_acceptance_modules_merged_server_ce \
  262. test_acceptance_modules_merged_server_pro \
  263. $(TEST_ACCEPTANCE_MODULES_MERGED_VARIANTS):
  264. $(DOCKER_COMPOSE) down -v -t 0
  265. $(DOCKER_COMPOSE) run --rm test_acceptance make test_acceptance_modules_merged_inner
  266. $(DOCKER_COMPOSE) down -v -t 0
  267. # outer loop for running saas tests in parallel
  268. TEST_ACCEPTANCE_MODULES_MERGED_SPLIT_SAAS = \
  269. test_acceptance_modules_merged_saas_1 \
  270. test_acceptance_modules_merged_saas_2 \
  271. test_acceptance_modules_merged_saas_3 \
  272. test_acceptance_modules_merged_saas_4 \
  273. test_acceptance_modules_merged_saas_1: export COMPOSE_PROJECT_NAME = \
  274. acceptance_test_modules_merged_saas_1_$(BUILD_DIR_NAME)
  275. test_acceptance_modules_merged_saas_2: export COMPOSE_PROJECT_NAME = \
  276. acceptance_test_modules_merged_saas_2_$(BUILD_DIR_NAME)
  277. test_acceptance_modules_merged_saas_3: export COMPOSE_PROJECT_NAME = \
  278. acceptance_test_modules_merged_saas_3_$(BUILD_DIR_NAME)
  279. test_acceptance_modules_merged_saas_4: export COMPOSE_PROJECT_NAME = \
  280. acceptance_test_modules_merged_saas_4_$(BUILD_DIR_NAME)
  281. $(TEST_ACCEPTANCE_MODULES_MERGED_SPLIT_SAAS): export BASE_CONFIG = $(CFG_SAAS)
  282. $(TEST_ACCEPTANCE_MODULES_MERGED_SPLIT_SAAS): test_acceptance_modules_merged_saas_%:
  283. $(DOCKER_COMPOSE) down -v -t 0
  284. $(DOCKER_COMPOSE) run --rm test_acceptance make test_acceptance_modules_merged_inner_$*
  285. $(DOCKER_COMPOSE) down -v -t 0
  286. test_acceptance_modules: $(TEST_ACCEPTANCE_MODULES_MERGED_VARIANTS)
  287. #
  288. # CI tests
  289. #
  290. ci:
  291. MOCHA_ARGS="--reporter tap" \
  292. $(MAKE) test
  293. #
  294. # Lint & format
  295. #
  296. ORG_PATH = /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
  297. RUN_LINT_FORMAT ?= \
  298. docker run --rm ci/$(PROJECT_NAME):$(BRANCH_NAME)-$(BUILD_NUMBER)
  299. NODE_MODULES_PATH := ${PATH}:${PWD}/node_modules/.bin:/overleaf/services/web/node_modules/.bin
  300. WITH_NODE_MODULES_PATH = \
  301. format_backend \
  302. format_frontend \
  303. format_misc \
  304. format_styles \
  305. format_test_app_unit \
  306. format_test_app_rest \
  307. format_test_modules \
  308. $(TEST_SUITES) \
  309. $(WITH_NODE_MODULES_PATH): export PATH=$(NODE_MODULES_PATH)
  310. lint: lint_backend
  311. lint_backend:
  312. npx eslint \
  313. 'app.{js,ts,tsx}' \
  314. 'app/**/*.{js,ts,tsx}' \
  315. 'modules/*/index.{js,ts,tsx}' \
  316. 'modules/*/app/**/*.{js,ts,tsx}' \
  317. --max-warnings=0
  318. lint: lint_frontend
  319. lint_frontend:
  320. npx eslint \
  321. 'frontend/**/*.{js,ts,tsx}' \
  322. 'modules/**/frontend/**/*.{js,ts,tsx}' \
  323. --max-warnings=0
  324. lint: lint_test
  325. lint_test: lint_test_app
  326. lint_test_app: lint_test_app_unit
  327. lint_test_app_unit:
  328. npx eslint \
  329. 'test/unit/**/*.{js,ts,tsx}' \
  330. --max-warnings=0
  331. lint_test_app: lint_test_app_rest
  332. lint_test_app_rest:
  333. npx eslint \
  334. 'test/**/*.{js,ts,tsx}' \
  335. --ignore-pattern 'test/unit/**/*.{js,ts,tsx}' \
  336. --max-warnings=0
  337. lint_test: lint_test_modules
  338. lint_test_modules:
  339. npx eslint \
  340. 'modules/*/test/**/*.{js,ts,tsx}' \
  341. --max-warnings=0
  342. lint: lint_misc
  343. # migrations, scripts, webpack config, karma config
  344. lint_misc:
  345. npx eslint . \
  346. --ignore-pattern 'app.{js,ts,tsx}' \
  347. --ignore-pattern 'app/**/*.{js,ts,tsx}' \
  348. --ignore-pattern 'modules/*/app/**/*.{js,ts,tsx}' \
  349. --ignore-pattern 'modules/*/index.{js,ts,tsx}' \
  350. --ignore-pattern 'frontend/**/*.{js,ts,tsx}' \
  351. --ignore-pattern 'modules/**/frontend/**/*.{js,ts,tsx}' \
  352. --ignore-pattern 'test/**/*.{js,ts,tsx}' \
  353. --ignore-pattern 'modules/*/test/**/*.{js,ts,tsx}' \
  354. --max-warnings=0
  355. lint: lint_pug
  356. lint_pug:
  357. bin/lint_pug_templates
  358. lint: lint_locales
  359. lint_locales:
  360. bin/lint_locales
  361. lint: lint_flag_res_send_usage
  362. lint_flag_res_send_usage:
  363. bin/lint_flag_res_send_usage
  364. lint: typecheck_frontend
  365. typecheck_frontend:
  366. npx tsc --noEmit
  367. lint_in_docker:
  368. $(RUN_LINT_FORMAT) make lint -j --output-sync
  369. format: format_js
  370. format_js:
  371. npm run --silent format
  372. format: format_styles
  373. format_styles:
  374. npm run --silent format:styles
  375. format_fix:
  376. npm run --silent format:fix
  377. format_styles_fix:
  378. npm run --silent format:styles:fix
  379. format_in_docker:
  380. $(RUN_LINT_FORMAT) make format -j --output-sync
  381. #
  382. # Build & publish
  383. #
  384. IMAGE_CI ?= ci/$(PROJECT_NAME):$(BRANCH_NAME)-$(BUILD_NUMBER)
  385. IMAGE_REPO ?= gcr.io/overleaf-ops/$(PROJECT_NAME)
  386. IMAGE_REPO_BRANCH ?= $(IMAGE_REPO):$(BRANCH_NAME)
  387. IMAGE_REPO_MAIN ?= $(IMAGE_REPO):main
  388. IMAGE_REPO_MASTER ?= $(IMAGE_REPO):master
  389. IMAGE_REPO_FINAL ?= $(IMAGE_REPO_BRANCH)-$(BUILD_NUMBER)
  390. export SENTRY_RELEASE ?= ${COMMIT_SHA}
  391. build_deps:
  392. docker build --pull \
  393. --cache-from $(IMAGE_REPO_BRANCH)-deps \
  394. --cache-from $(IMAGE_REPO_MAIN)-deps \
  395. --cache-from $(IMAGE_REPO_MASTER)-deps \
  396. --tag $(IMAGE_REPO_BRANCH)-deps \
  397. --target deps \
  398. --file Dockerfile \
  399. ../..
  400. build_dev:
  401. docker build \
  402. --build-arg SENTRY_RELEASE \
  403. --cache-from $(IMAGE_REPO_BRANCH)-deps \
  404. --cache-from $(IMAGE_CI)-dev \
  405. --tag $(IMAGE_CI) \
  406. --tag $(IMAGE_CI)-dev \
  407. --target dev \
  408. --file Dockerfile \
  409. ../..
  410. build_webpack:
  411. $(MAKE) build_webpack_once \
  412. || $(MAKE) build_webpack_once
  413. build_webpack_once:
  414. docker build \
  415. --build-arg SENTRY_RELEASE \
  416. --cache-from $(IMAGE_CI)-dev \
  417. --cache-from $(IMAGE_CI)-webpack \
  418. --tag $(IMAGE_CI)-webpack \
  419. --target webpack \
  420. --file Dockerfile \
  421. ../..
  422. build:
  423. docker build \
  424. --build-arg SENTRY_RELEASE \
  425. --cache-from $(IMAGE_CI)-webpack \
  426. --cache-from $(IMAGE_REPO_FINAL) \
  427. --tag $(IMAGE_REPO_FINAL) \
  428. --file Dockerfile \
  429. ../..
  430. build_test_karma:
  431. COMPOSE_PROJECT_NAME=karma_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) build test_karma
  432. publish:
  433. docker push $(DOCKER_REPO)/$(PROJECT_NAME):$(BRANCH_NAME)-$(BUILD_NUMBER)
  434. tar:
  435. COMPOSE_PROJECT_NAME=tar_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) run --rm tar
  436. COMPOSE_PROJECT_NAME=tar_$(BUILD_DIR_NAME) $(DOCKER_COMPOSE) down -v -t 0
  437. MODULE_TARGETS = \
  438. $(TEST_ACCEPTANCE_MODULES_SAAS) \
  439. $(TEST_ACCEPTANCE_MODULES_SERVER_CE) \
  440. $(TEST_ACCEPTANCE_MODULES_SERVER_PRO) \
  441. $(TEST_ACCEPTANCE_MODULES_MERGED_INNER) \
  442. $(CLEAN_TEST_ACCEPTANCE_MODULES) \
  443. $(TEST_UNIT_MODULES) \
  444. $(MODULE_TARGETS):
  445. $(MAKE) -C $(dir $@) $(notdir $@) BUILD_DIR_NAME=$(BUILD_DIR_NAME)
  446. .PHONY:
  447. $(MODULE_TARGETS) \
  448. compile_modules compile_modules_full clean_ci \
  449. test test_module test_unit test_unit_app \
  450. test_unit_modules test_unit_module test_karma test_karma_run \
  451. test_karma_build_run test_frontend test_acceptance test_acceptance_app \
  452. test_acceptance_modules test_acceptance_module ci format format_fix lint \
  453. build build_test_karma publish tar