overleaf/server-ce/test/Makefile

all: test-e2e

# We are updating the docker compose config via the host-admin service.
# The host-admin service is running inside docker and has its own file-system layout.
# We need to have both file-system layouts agree on the path for the docker compose project.
# Notable the container labels com.docker.compose.project.working_dir and com.docker.compose.project.config_files need to match when creating containers from the docker host (how you started things) and from host-admin (how tests reconfigure the instance).
export PWD = $(shell pwd)
export MONOREPO = $(shell cd ../../ && pwd)

export TEX_LIVE_DOCKER_IMAGE ?= us-east1-docker.pkg.dev/overleaf-ops/ol-docker/texlive-full:2023.1
export ALL_TEX_LIVE_DOCKER_IMAGES ?= us-east1-docker.pkg.dev/overleaf-ops/ol-docker/texlive-full:2023.1,us-east1-docker.pkg.dev/overleaf-ops/ol-docker/texlive-full:2022.1
export IMAGE_TAG_CE ?= sharelatex/sharelatex:main
export IMAGE_TAG_PRO ?= us-east1-docker.pkg.dev/overleaf-ops/ol-docker/pro:main
export IMAGE_TAG_GIT_BRIDGE ?= us-east1-docker.pkg.dev/overleaf-ops/ol-docker/git-bridge:main
export CYPRESS_SHARD ?=
export COMPOSE_PROJECT_NAME ?= test
export USER_UID=$(shell id -u)
export USER_GID=$(shell id -g)
IMAGE_TAG_PRO_BASE := $(shell echo $(IMAGE_TAG_PRO) | sed -E s/:.+//)

print-debug-logs:
	-docker compose logs --timestamps --tail=100 e2e
	-docker compose logs --timestamps --tail=100 mongo
	-docker compose logs --timestamps --tail=100 redis
	-docker compose logs --timestamps --tail=100 mailtrap
	-docker compose logs --timestamps --tail=100 saml
	-docker compose logs --timestamps --tail=100 ldap
	-docker compose logs --timestamps --tail=100 git-bridge
	-docker compose logs --timestamps --tail=100 host-admin
	-docker compose logs --timestamps sharelatex
	-docker compose exec sharelatex bash -c 'tail -n100 /var/log/overleaf/*.log'

test-e2e-native:
	docker compose -f docker-compose.yml -f docker-compose.native.yml up --no-log-prefix sharelatex host-admin -d
	CYPRESS_BASE_URL='http://127.0.0.1:3231' \
	CYPRESS_HOST_ADMIN_URL='http://127.0.0.1:3232' \
	CYPRESS_SAML_URL='http://127.0.0.1:3233' \
	CYPRESS_MAILTRAP_URL='http://127.0.0.1:3234' \
		yarn run cypress:open

# For testing "native" on Linux
test-e2e-native-linux:
	docker compose -f docker-compose.yml -f docker-compose.native.yml up --no-log-prefix sharelatex host-admin -d
	CYPRESS_BASE_URL='http://127.0.0.1:3231' \
	CYPRESS_HOST_ADMIN_URL='http://127.0.0.1:3232' \
	CYPRESS_SAML_URL='http://127.0.0.1:3233' \
	CYPRESS_MAILTRAP_URL='http://127.0.0.1:3234' \
		docker compose -f docker-compose.yml -f docker-compose.native.yml up --no-log-prefix cypress

test-e2e:
	docker compose build host-admin e2e
	docker compose up --detach --wait host-admin
	docker compose up --detach --wait mongo
	docker compose up --no-log-prefix --exit-code-from=e2e e2e host-admin

test-e2e-open:
	docker compose up --detach --wait host-admin
	docker compose up --detach --wait mongo
	docker compose up --no-log-prefix --exit-code-from=e2e-open e2e-open host-admin

SHARD_PROJECT_NAMES = \
	test-ce-default \
	test-ce-custom-1 \
	test-pro-default-1 \
	test-pro-default-2 \
	test-pro-custom-1 \
	test-pro-custom-2 \
	test-pro-custom-3 \
	test-pro-custom-4
CLEAN_SHARDS=$(addprefix clean/,$(SHARD_PROJECT_NAMES))
clean: $(CLEAN_SHARDS)
	-docker compose run --no-deps --rm --entrypoint rm host-admin -rf docker-compose.override.yml docker-compose.*_*.yml reports/ data/
	-docker compose down --remove-orphans --rmi local --timeout 0 --volumes

$(CLEAN_SHARDS): clean/%:
	-COMPOSE_PROJECT_NAME=$* docker compose down --remove-orphans --rmi local --timeout 0 --volumes

prefetch: prefetch_default
prefetch_default: prefetch_default_compose
prefetch_default_compose:
	docker compose pull e2e mongo redis

prefetch_default: prefetch_default_compose_build
prefetch_default_compose_build:
	docker compose build host-admin e2e

prefetch: prefetch_custom
prefetch_custom: prefetch_custom_compose_pull
prefetch_custom_compose_pull:
	docker compose pull saml ldap

prefetch_custom: prefetch_custom_texlive_2023
prefetch_custom_texlive_2023:
	docker pull us-east1-docker.pkg.dev/overleaf-ops/ol-docker/texlive-full:2023.1
	docker tag us-east1-docker.pkg.dev/overleaf-ops/ol-docker/texlive-full:2023.1 quay.io/sharelatex/texlive-full:2023.1

prefetch_custom: prefetch_custom_texlive_2022
prefetch_custom_texlive_2022:
	docker pull us-east1-docker.pkg.dev/overleaf-ops/ol-docker/texlive-full:2022.1
	docker tag us-east1-docker.pkg.dev/overleaf-ops/ol-docker/texlive-full:2022.1 quay.io/sharelatex/texlive-full:2022.1

prefetch_custom: prefetch_old_4_2
prefetch_old_4_2:
	docker pull $(IMAGE_TAG_PRO_BASE):4.2

prefetch_custom: prefetch_old_5_0
prefetch_old_5_0:
	docker pull $(IMAGE_TAG_PRO_BASE):5.0

prefetch_custom: build_hotfix_5_5_5
build_hotfix_5_5_5:
	docker pull $(IMAGE_TAG_PRO_BASE):5.5.4
	cd ../../server-pro/hotfix/5.5.5 && docker build --build-arg BASE_IMAGE=$(IMAGE_TAG_PRO_BASE):5.5.4 -t $(IMAGE_TAG_PRO_BASE):5.5.5 .

# Google Cloud Build runs on a very ancient Docker version that does not support the subdir flag.
# Use services -> mailtrap -> build -> context = https://github.com/dbck/docker-mailtrap.git#v1.5.0:build in docker-compose.yml eventually.
prefetch_default_compose_build: build_mailtrap
build_mailtrap:
	git clone https://github.com/dbck/docker-mailtrap.git || true && cd docker-mailtrap && git checkout v1.5.0
	docker build -t mailtrap docker-mailtrap/build

prefetch_default_compose_build: build_cypress
build_cypress:
	docker compose build e2e

.PHONY: test-e2e test-e2e-open