2020-03-09 09:35:48 -04:00
|
|
|
BUILD_DIR_NAME ?= web
|
CI and local dev environment improvements
The need for this became very noticeable due to the slowness of filesystem access in docker-in-mac, with a full compile taking over a minute for me in docker. Using make to introduce incremental compile makes this near instantaneous outside of docker (if only a few files have changed), and quick enough inside docker.
With incremental compile via make, it compiles quickly enough that re-compiling and restarting the web service automatically when backend files change is quick enough now. This is how the service is run via docker-compose in https://github.com/sharelatex/sharelatex-dev-environment, so it shouldn't be necessary to manually restart the container each time a coffee file changes.
At the moment Jenkins pull web modules in via the GitSCM plugin, but I believe this is creating a dependency in Jenkins, where any commits to any of the modules causes all of the web branches to rebuild. By doing it via our own scripts we can hopefully avoid this. It also creates a build process which is reproducible locally.
**Note that at the moment in this PR all modules pull from `ja-dockerize-dev` branches, but these should be merged first, and this PR updated to point to the master branches before merging**. This is necessary for other changes to build process/docker-compose workflow.
As well as a Makefile for web, there is now a `Makefile.module`. This is copied into each module directory by the top-level Makefile, and is written in a way to be flexible and support unit tests, acceptance tests, front-end js for the ide and main, and the modules `app/coffee` directory, while allowing modules to have some of these missing (not all modules have e.g. acceptance tests, or front-end JS). This will allows us to refine the build process in future, without needing to update the Makefile in each module repo separately (I found this to be a painful part of this development).
This makes web compatible with the docker-compose workflow at https://github.com/sharelatex/sharelatex-dev-environment, where each service is running in its own docker container, with networking managed by docker.
Previously the Makefile was set up to run unit tests in docker with `make unit_tests`. This now just runs them natively. In the CI, they are run in docker anyway (all steps in Jenkins are), and locally, they run fine natively with `npm run test:unit`, or can be run in docker via https://github.com/sharelatex/sharelatex-dev-environment with `bin/run web_sl npm run test:unit`.
Previously we did a lot of juggling with only mounting source files (coffee, less, etc) into the docker container for acceptance tests. This was to avoid creating root owned files if the whole directory was mounted. Now instead the whole web directory is mounted read-only, with the compilation step done outside of the container before running the tests.
This allows the host and container to share the `node_modules` folder as well, which avoids needing to `npm install` twice on the CI box, and should speed up the build by a few minutes.
On macOS, this would cause a problem with compiled modules if you tried to use the same `node_modules` to run the app natively. However, if running via docker-compose in https://github.com/sharelatex/sharelatex-dev-environment, this is no longer a problem.
2017-12-28 15:11:27 -05:00
|
|
|
MODULE_NAME := $(notdir $(shell pwd))
|
|
|
|
|
MODULE_DIR := modules/$(MODULE_NAME)
|
2019-02-19 09:51:34 -05:00
|
|
|
PROJECT_NAME = web
|
2018-11-05 05:06:39 -05:00
|
|
|
|
2019-10-23 08:22:37 -04:00
|
|
|
DOCKER_COMPOSE_FLAGS ?= -f docker-compose.yml --log-level ERROR
|
2019-02-19 09:51:34 -05:00
|
|
|
DOCKER_COMPOSE := cd ../../ && \
|
|
|
|
|
MODULE_DIR=$(MODULE_DIR) \
|
|
|
|
|
BUILD_NUMBER=$(BUILD_NUMBER) \
|
|
|
|
|
BRANCH_NAME=$(BRANCH_NAME) \
|
|
|
|
|
PROJECT_NAME=$(PROJECT_NAME) \
|
|
|
|
|
MOCHA_GREP=${MOCHA_GREP} \
|
2019-10-23 08:22:37 -04:00
|
|
|
SHARELATEX_CONFIG=/app/$(MODULE_DIR)/test/acceptance/config/settings.test.coffee \
|
|
|
|
|
docker-compose ${DOCKER_COMPOSE_FLAGS}
|
|
|
|
|
|
2020-03-09 09:35:48 -04:00
|
|
|
DOCKER_COMPOSE_TEST_ACCEPTANCE := \
|
|
|
|
|
export COMPOSE_PROJECT_NAME=acceptance_test_$(BUILD_DIR_NAME)_$(MODULE_NAME) \
|
|
|
|
|
&& $(DOCKER_COMPOSE)
|
|
|
|
|
|
|
|
|
|
DOCKER_COMPOSE_TEST_UNIT := \
|
|
|
|
|
export COMPOSE_PROJECT_NAME=unit_test_$(BUILD_DIR_NAME)_$(MODULE_NAME) \
|
|
|
|
|
&& $(DOCKER_COMPOSE)
|
|
|
|
|
|
2019-10-23 08:22:37 -04:00
|
|
|
test_unit:
|
2020-03-09 09:35:48 -04:00
|
|
|
${DOCKER_COMPOSE_TEST_UNIT} run --rm test_unit npm -q run test:unit:run_dir -- ${MOCHA_ARGS} $(MODULE_DIR)/test/unit/src
|
|
|
|
|
|
|
|
|
|
ifeq (,$(wildcard test/acceptance))
|
|
|
|
|
test_acceptance:
|
|
|
|
|
clean_test_acceptance:
|
CI and local dev environment improvements
The need for this became very noticeable due to the slowness of filesystem access in docker-in-mac, with a full compile taking over a minute for me in docker. Using make to introduce incremental compile makes this near instantaneous outside of docker (if only a few files have changed), and quick enough inside docker.
With incremental compile via make, it compiles quickly enough that re-compiling and restarting the web service automatically when backend files change is quick enough now. This is how the service is run via docker-compose in https://github.com/sharelatex/sharelatex-dev-environment, so it shouldn't be necessary to manually restart the container each time a coffee file changes.
At the moment Jenkins pull web modules in via the GitSCM plugin, but I believe this is creating a dependency in Jenkins, where any commits to any of the modules causes all of the web branches to rebuild. By doing it via our own scripts we can hopefully avoid this. It also creates a build process which is reproducible locally.
**Note that at the moment in this PR all modules pull from `ja-dockerize-dev` branches, but these should be merged first, and this PR updated to point to the master branches before merging**. This is necessary for other changes to build process/docker-compose workflow.
As well as a Makefile for web, there is now a `Makefile.module`. This is copied into each module directory by the top-level Makefile, and is written in a way to be flexible and support unit tests, acceptance tests, front-end js for the ide and main, and the modules `app/coffee` directory, while allowing modules to have some of these missing (not all modules have e.g. acceptance tests, or front-end JS). This will allows us to refine the build process in future, without needing to update the Makefile in each module repo separately (I found this to be a painful part of this development).
This makes web compatible with the docker-compose workflow at https://github.com/sharelatex/sharelatex-dev-environment, where each service is running in its own docker container, with networking managed by docker.
Previously the Makefile was set up to run unit tests in docker with `make unit_tests`. This now just runs them natively. In the CI, they are run in docker anyway (all steps in Jenkins are), and locally, they run fine natively with `npm run test:unit`, or can be run in docker via https://github.com/sharelatex/sharelatex-dev-environment with `bin/run web_sl npm run test:unit`.
Previously we did a lot of juggling with only mounting source files (coffee, less, etc) into the docker container for acceptance tests. This was to avoid creating root owned files if the whole directory was mounted. Now instead the whole web directory is mounted read-only, with the compilation step done outside of the container before running the tests.
This allows the host and container to share the `node_modules` folder as well, which avoids needing to `npm install` twice on the CI box, and should speed up the build by a few minutes.
On macOS, this would cause a problem with compiled modules if you tried to use the same `node_modules` to run the app natively. However, if running via docker-compose in https://github.com/sharelatex/sharelatex-dev-environment, this is no longer a problem.
2017-12-28 15:11:27 -05:00
|
|
|
|
2020-03-09 09:35:48 -04:00
|
|
|
else
|
2018-12-13 04:07:55 -05:00
|
|
|
test_acceptance:
|
2020-03-09 09:35:48 -04:00
|
|
|
$(MAKE) --no-print-directory clean_test_acceptance
|
|
|
|
|
${DOCKER_COMPOSE_TEST_ACCEPTANCE} run --rm test_acceptance npm -q run test:acceptance:run_dir -- ${MOCHA_ARGS} $(MODULE_DIR)/test/acceptance/src
|
|
|
|
|
$(MAKE) --no-print-directory clean_test_acceptance
|
|
|
|
|
|
|
|
|
|
clean_test_acceptance:
|
|
|
|
|
${DOCKER_COMPOSE_TEST_ACCEPTANCE} down -v -t 0
|
|
|
|
|
|
|
|
|
|
endif
|
