Makefile 20 KB

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