From 9ffbbf025475bb1e81e720adfe3e7eb7d8e974fb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Th=C3=A9ophile=20Diot?= Date: Thu, 4 Apr 2024 17:11:52 +0100 Subject: [PATCH] Add automatic tests for backup plugin --- tests/core/backup/Dockerfile | 14 + tests/core/backup/docker-compose.mariadb.yml | 17 + tests/core/backup/docker-compose.mysql.yml | 17 + tests/core/backup/docker-compose.postgres.yml | 15 + tests/core/backup/docker-compose.test.yml | 29 ++ tests/core/backup/docker-compose.yml | 77 ++++ tests/core/backup/main.py | 129 ++++++ tests/core/backup/ready.conf | 8 + tests/core/backup/requirements.in | 1 + tests/core/backup/requirements.txt | 124 ++++++ tests/core/backup/test.sh | 385 ++++++++++++++++++ 11 files changed, 816 insertions(+) create mode 100644 tests/core/backup/Dockerfile create mode 100644 tests/core/backup/docker-compose.mariadb.yml create mode 100644 tests/core/backup/docker-compose.mysql.yml create mode 100644 tests/core/backup/docker-compose.postgres.yml create mode 100644 tests/core/backup/docker-compose.test.yml create mode 100644 tests/core/backup/docker-compose.yml create mode 100644 tests/core/backup/main.py create mode 100644 tests/core/backup/ready.conf create mode 100644 tests/core/backup/requirements.in create mode 100644 tests/core/backup/requirements.txt create mode 100755 tests/core/backup/test.sh diff --git a/tests/core/backup/Dockerfile b/tests/core/backup/Dockerfile new file mode 100644 index 000000000..0e7f437e4 --- /dev/null +++ b/tests/core/backup/Dockerfile @@ -0,0 +1,14 @@ +FROM python:3.12.2-alpine3.19@sha256:25a82f6f8b720a6a257d58e478a0a5517448006e010c85273f4d9c706819478c + +WORKDIR /tmp + +COPY requirements.txt . + +RUN MAKEFLAGS="-j $(nproc)" pip install --no-cache-dir --require-hashes --no-deps -r requirements.txt && \ + rm -f requirements.txt + +WORKDIR /opt/tests + +COPY main.py . + +ENTRYPOINT [ "python3", "main.py" ] diff --git a/tests/core/backup/docker-compose.mariadb.yml b/tests/core/backup/docker-compose.mariadb.yml new file mode 100644 index 000000000..fc12e345a --- /dev/null +++ b/tests/core/backup/docker-compose.mariadb.yml @@ -0,0 +1,17 @@ +version: "3.5" + +services: + bw-db: + image: mariadb:10.10 + command: --default-authentication-plugin=mysql_native_password + environment: + - MYSQL_RANDOM_ROOT_PASSWORD=yes + - MYSQL_DATABASE=db + - MYSQL_USER=bunkerweb + - MYSQL_PASSWORD=secret + networks: + - bw-docker + +networks: + bw-docker: + external: true diff --git a/tests/core/backup/docker-compose.mysql.yml b/tests/core/backup/docker-compose.mysql.yml new file mode 100644 index 000000000..e971edbf2 --- /dev/null +++ b/tests/core/backup/docker-compose.mysql.yml @@ -0,0 +1,17 @@ +version: "3.5" + +services: + bw-db: + image: mysql:8.0 + command: --default-authentication-plugin=mysql_native_password + environment: + - MYSQL_RANDOM_ROOT_PASSWORD=yes + - MYSQL_DATABASE=db + - MYSQL_USER=bunkerweb + - MYSQL_PASSWORD=secret + networks: + - bw-docker + +networks: + bw-docker: + external: true diff --git a/tests/core/backup/docker-compose.postgres.yml b/tests/core/backup/docker-compose.postgres.yml new file mode 100644 index 000000000..45b2b033b --- /dev/null +++ b/tests/core/backup/docker-compose.postgres.yml @@ -0,0 +1,15 @@ +version: "3.5" + +services: + bw-db: + image: postgres:15.1 + environment: + - POSTGRES_USER=bunkerweb + - POSTGRES_PASSWORD=secret + - POSTGRES_DB=db + networks: + - bw-docker + +networks: + bw-docker: + external: true diff --git a/tests/core/backup/docker-compose.test.yml b/tests/core/backup/docker-compose.test.yml new file mode 100644 index 000000000..175b9e870 --- /dev/null +++ b/tests/core/backup/docker-compose.test.yml @@ -0,0 +1,29 @@ +version: "3.5" + +services: + tests: + build: . + volumes: + - /var/run/docker.sock:/var/run/docker.sock:ro + environment: + PYTHONUNBUFFERED: "1" + DATABASE_URI: "sqlite:////var/lib/bunkerweb/db.sqlite3" + USE_BACKUP: "yes" + BACKUP_DIRECTORY: "/var/lib/bunkerweb/backups" + BACKUP_ROTATION: "7" + extra_hosts: + - "www.example.com:192.168.0.2" + networks: + bw-docker: + bw-services: + ipv4_address: 192.168.0.3 + +volumes: + bw-data: + external: true + +networks: + bw-services: + external: true + bw-docker: + external: true diff --git a/tests/core/backup/docker-compose.yml b/tests/core/backup/docker-compose.yml new file mode 100644 index 000000000..6188f781c --- /dev/null +++ b/tests/core/backup/docker-compose.yml @@ -0,0 +1,77 @@ +version: "3.5" + +services: + bw: + image: bunkerity/bunkerweb:1.5.7 + pull_policy: never + labels: + - "bunkerweb.INSTANCE=yes" + environment: + API_WHITELIST_IP: "127.0.0.0/8 10.20.30.0/24" + MULTISITE: "no" + HTTP_PORT: "80" + USE_BUNKERNET: "no" + USE_BLACKLIST: "no" + SEND_ANONYMOUS_REPORT: "no" + USE_REVERSE_PROXY: "yes" + REVERSE_PROXY_HOST: "http://app1:8080" + REVERSE_PROXY_URL: "/" + LOG_LEVEL: "info" + + # ? Backup settings + USE_BACKUP: "yes" + BACKUP_DIRECTORY: "/var/lib/bunkerweb/backups" + BACKUP_ROTATION: "7" + networks: + bw-universe: + bw-services: + ipv4_address: 192.168.0.2 + + bw-scheduler: + image: bunkerity/bunkerweb-scheduler:1.5.7 + pull_policy: never + labels: + - "bunkerweb.SCHEDULER=yes" + depends_on: + - bw + - bw-docker + volumes: + - bw-data:/data/lib + environment: + DOCKER_HOST: "tcp://bw-docker:2375" + LOG_LEVEL: "debug" + + # ? DATABASE settings + DATABASE_URI: "sqlite:////var/lib/bunkerweb/db.sqlite3" + networks: + - bw-universe + - bw-docker + + bw-docker: + image: tecnativa/docker-socket-proxy:nightly + volumes: + - /var/run/docker.sock:/var/run/docker.sock:ro + environment: + CONTAINERS: "1" + networks: + - bw-docker + +volumes: + bw-data: + name: bw-data + +networks: + bw-universe: + name: bw-universe + ipam: + driver: default + config: + - subnet: 10.20.30.0/24 + bw-services: + name: bw-services + ipam: + driver: default + config: + - subnet: 192.168.0.0/24 + bw-docker: + external: true diff --git a/tests/core/backup/main.py b/tests/core/backup/main.py new file mode 100644 index 000000000..675152b55 --- /dev/null +++ b/tests/core/backup/main.py @@ -0,0 +1,129 @@ +from datetime import datetime +from os import getenv +from subprocess import PIPE, Popen +from time import sleep +from traceback import format_exc +from typing import List, Optional, Tuple, Union + +from docker import DockerClient +from docker.models.containers import Container + +try: + use_backup = getenv("USE_BACKUP", "no") == "yes" + backup_dir = getenv("BACKUP_DIRECTORY", "/var/lib/bunkerweb/backups") + backup_rotation = int(getenv("BACKUP_ROTATION", "7")) + + if backup_rotation < 1: + backup_rotation = 1 + + scheduler_instance: Optional[Container] = None + if getenv("TEST_TYPE", "docker") == "docker": + docker_client = DockerClient(base_url=getenv("DOCKER_HOST", "unix:///var/run/docker.sock")) + + scheduler_instances = docker_client.containers.list(filters={"label": "bunkerweb.SCHEDULER"}) + + if not scheduler_instances: + print("❌ Scheduler instance not found ...", flush=True) + exit(1) + + scheduler_instance = scheduler_instances[0] # type: ignore + + def exec_command(command: Union[str, List[str]]) -> Tuple[int, str, str]: + if scheduler_instance: + result = scheduler_instance.exec_run(command) + + assert isinstance(result.exit_code, int), "Exit code is not an integer" + assert isinstance(result.output, bytes), "Output is not bytes" + + return result.exit_code, result.output.decode() if result.output else "", "" + + result = Popen(command, stderr=PIPE, stdout=PIPE, universal_newlines=True, text=True) + stdout, stderr = result.communicate() + return result.returncode, stdout, stderr + + print(f"ℹ️ Generating {backup_rotation + 1} backups ...", flush=True) + + for _ in range(backup_rotation + 1): + result = exec_command(["bwcli", "plugin", "backup", "save"]) + if result[0] != 0: + print(f"❌ Backup failed:\nstdout={result[1]}\nstderr={result[2]}", flush=True) + exit(1) + + print("ℹ️ Checking backup directory ...", flush=True) + + result = exec_command(["ls", backup_dir]) + + if result[0] != 0: + print(f"❌ Backup directory not found:\nstdout={result[1]}\nstderr={result[2]}", flush=True) + exit(1) + + backup_files = result[1].split("\n")[:-1] + if len(backup_files) < backup_rotation + 1: + print(f"❌ Backup files count is less than expected:\nstdout={result[1]}\nstderr={result[2]}", flush=True) + exit(1) + + print("ℹ️ Backups are generated successfully", flush=True) + + print("ℹ️ Reloading BunkerWeb ...", flush=True) + + current_time = datetime.now() + if scheduler_instance: + scheduler_instance.restart() + scheduler_instance.reload() + + while scheduler_instance.health != "healthy" and (datetime.now() - current_time).seconds < 60: + print("⏳ Waiting for the scheduler to be healthy, retrying in 1s ...", flush=True) + scheduler_instance.reload() + sleep(1) + + if scheduler_instance.health != "healthy": + print("❌ The scheduler took too long to be healthy, exiting ...", flush=True) + exit(1) + else: + exit_code = exec_command(["sudo", "truncate", "-s", "0", "/var/log/bunkerweb/error.log"])[0] + if exit_code != 0: + print("❌ An error occurred when truncating the error log, exiting ...", flush=True) + exit(1) + + exit_code = exec_command(["sudo", "systemctl", "restart", "bunkerweb"])[0] + if exit_code != 0: + print("❌ An error occurred when restarting BunkerWeb, exiting ...", flush=True) + exit(1) + + ready = False + while not ready and (datetime.now() - current_time).seconds < 60: + print("⏳ Waiting for BunkerWeb to be ready, retrying in 1s ...", flush=True) + exit_code, stdout, stderr = exec_command(["sudo", "grep", "BunkerWeb is ready", "/var/log/bunkerweb/error.log"]) + if exit_code == 0: + ready = True + sleep(1) + + if not ready: + print("❌ BunkerWeb took too long to be ready, exiting ...", flush=True) + exit(1) + + print("ℹ️ Checking rotated backups ...", flush=True) + + result = exec_command(["ls", backup_dir]) + + if result[0] != 0: + print(f"❌ Backup directory not found:\nstdout={result[1]}\nstderr={result[2]}", flush=True) + exit(1) + + if use_backup: + backup_files = result[1].split("\n")[:-1] + if len(backup_files) != backup_rotation: + print(f"❌ Backup files count is more than expected, the rotation failed:\nstdout={result[1]}\nstderr={result[2]}", flush=True) + exit(1) + else: + backup_files = result[1].split("\n")[:-1] + if len(backup_files) != backup_rotation + 1: + print(f"❌ Backup files count is not as expected, the rotation failed:\nstdout={result[1]}\nstderr={result[2]}", flush=True) + exit(1) + + print("✅ Backup tests completed successfully", flush=True) +except SystemExit as se: + exit(se.code) +except: + print(f"❌ Something went wrong, exiting ...\n{format_exc()}", flush=True) + exit(1) diff --git a/tests/core/backup/ready.conf b/tests/core/backup/ready.conf new file mode 100644 index 000000000..de1f24404 --- /dev/null +++ b/tests/core/backup/ready.conf @@ -0,0 +1,8 @@ +location /ready { + default_type 'text/plain'; + rewrite_by_lua_block { + ngx.print('ready') + ngx.flush(true) + ngx.exit(ngx.HTTP_OK) + } +} diff --git a/tests/core/backup/requirements.in b/tests/core/backup/requirements.in new file mode 100644 index 000000000..901105d06 --- /dev/null +++ b/tests/core/backup/requirements.in @@ -0,0 +1 @@ +docker==7.0.0 diff --git a/tests/core/backup/requirements.txt b/tests/core/backup/requirements.txt new file mode 100644 index 000000000..62b78e731 --- /dev/null +++ b/tests/core/backup/requirements.txt @@ -0,0 +1,124 @@ +# +# This file is autogenerated by pip-compile with Python 3.9 +# by the following command: +# +# pip-compile --allow-unsafe --generate-hashes --strip-extras requirements.in +# +certifi==2024.2.2 \ + --hash=sha256:0569859f95fc761b18b45ef421b1290a0f65f147e92a1e5eb3e635f9a5e4e66f \ + --hash=sha256:dc383c07b76109f368f6106eee2b593b04a011ea4d55f652c6ca24a754d1cdd1 + # via requests +charset-normalizer==3.3.2 \ + --hash=sha256:06435b539f889b1f6f4ac1758871aae42dc3a8c0e24ac9e60c2384973ad73027 \ + --hash=sha256:06a81e93cd441c56a9b65d8e1d043daeb97a3d0856d177d5c90ba85acb3db087 \ + --hash=sha256:0a55554a2fa0d408816b3b5cedf0045f4b8e1a6065aec45849de2d6f3f8e9786 \ + --hash=sha256:0b2b64d2bb6d3fb9112bafa732def486049e63de9618b5843bcdd081d8144cd8 \ + --hash=sha256:10955842570876604d404661fbccbc9c7e684caf432c09c715ec38fbae45ae09 \ + --hash=sha256:122c7fa62b130ed55f8f285bfd56d5f4b4a5b503609d181f9ad85e55c89f4185 \ + --hash=sha256:1ceae2f17a9c33cb48e3263960dc5fc8005351ee19db217e9b1bb15d28c02574 \ + --hash=sha256:1d3193f4a680c64b4b6a9115943538edb896edc190f0b222e73761716519268e \ + --hash=sha256:1f79682fbe303db92bc2b1136016a38a42e835d932bab5b3b1bfcfbf0640e519 \ + --hash=sha256:2127566c664442652f024c837091890cb1942c30937add288223dc895793f898 \ + --hash=sha256:22afcb9f253dac0696b5a4be4a1c0f8762f8239e21b99680099abd9b2b1b2269 \ + --hash=sha256:25baf083bf6f6b341f4121c2f3c548875ee6f5339300e08be3f2b2ba1721cdd3 \ + --hash=sha256:2e81c7b9c8979ce92ed306c249d46894776a909505d8f5a4ba55b14206e3222f \ + --hash=sha256:3287761bc4ee9e33561a7e058c72ac0938c4f57fe49a09eae428fd88aafe7bb6 \ + --hash=sha256:34d1c8da1e78d2e001f363791c98a272bb734000fcef47a491c1e3b0505657a8 \ + --hash=sha256:37e55c8e51c236f95b033f6fb391d7d7970ba5fe7ff453dad675e88cf303377a \ + --hash=sha256:3d47fa203a7bd9c5b6cee4736ee84ca03b8ef23193c0d1ca99b5089f72645c73 \ + --hash=sha256:3e4d1f6587322d2788836a99c69062fbb091331ec940e02d12d179c1d53e25fc \ + --hash=sha256:42cb296636fcc8b0644486d15c12376cb9fa75443e00fb25de0b8602e64c1714 \ + --hash=sha256:45485e01ff4d3630ec0d9617310448a8702f70e9c01906b0d0118bdf9d124cf2 \ + --hash=sha256:4a78b2b446bd7c934f5dcedc588903fb2f5eec172f3d29e52a9096a43722adfc \ + --hash=sha256:4ab2fe47fae9e0f9dee8c04187ce5d09f48eabe611be8259444906793ab7cbce \ + --hash=sha256:4d0d1650369165a14e14e1e47b372cfcb31d6ab44e6e33cb2d4e57265290044d \ + --hash=sha256:549a3a73da901d5bc3ce8d24e0600d1fa85524c10287f6004fbab87672bf3e1e \ + --hash=sha256:55086ee1064215781fff39a1af09518bc9255b50d6333f2e4c74ca09fac6a8f6 \ + --hash=sha256:572c3763a264ba47b3cf708a44ce965d98555f618ca42c926a9c1616d8f34269 \ + --hash=sha256:573f6eac48f4769d667c4442081b1794f52919e7edada77495aaed9236d13a96 \ + --hash=sha256:5b4c145409bef602a690e7cfad0a15a55c13320ff7a3ad7ca59c13bb8ba4d45d \ + --hash=sha256:6463effa3186ea09411d50efc7d85360b38d5f09b870c48e4600f63af490e56a \ + --hash=sha256:65f6f63034100ead094b8744b3b97965785388f308a64cf8d7c34f2f2e5be0c4 \ + --hash=sha256:663946639d296df6a2bb2aa51b60a2454ca1cb29835324c640dafb5ff2131a77 \ + --hash=sha256:6897af51655e3691ff853668779c7bad41579facacf5fd7253b0133308cf000d \ + --hash=sha256:68d1f8a9e9e37c1223b656399be5d6b448dea850bed7d0f87a8311f1ff3dabb0 \ + --hash=sha256:6ac7ffc7ad6d040517be39eb591cac5ff87416c2537df6ba3cba3bae290c0fed \ + --hash=sha256:6b3251890fff30ee142c44144871185dbe13b11bab478a88887a639655be1068 \ + --hash=sha256:6c4caeef8fa63d06bd437cd4bdcf3ffefe6738fb1b25951440d80dc7df8c03ac \ + --hash=sha256:6ef1d82a3af9d3eecdba2321dc1b3c238245d890843e040e41e470ffa64c3e25 \ + --hash=sha256:753f10e867343b4511128c6ed8c82f7bec3bd026875576dfd88483c5c73b2fd8 \ + --hash=sha256:7cd13a2e3ddeed6913a65e66e94b51d80a041145a026c27e6bb76c31a853c6ab \ + --hash=sha256:7ed9e526742851e8d5cc9e6cf41427dfc6068d4f5a3bb03659444b4cabf6bc26 \ + --hash=sha256:7f04c839ed0b6b98b1a7501a002144b76c18fb1c1850c8b98d458ac269e26ed2 \ + --hash=sha256:802fe99cca7457642125a8a88a084cef28ff0cf9407060f7b93dca5aa25480db \ + --hash=sha256:80402cd6ee291dcb72644d6eac93785fe2c8b9cb30893c1af5b8fdd753b9d40f \ + --hash=sha256:8465322196c8b4d7ab6d1e049e4c5cb460d0394da4a27d23cc242fbf0034b6b5 \ + --hash=sha256:86216b5cee4b06df986d214f664305142d9c76df9b6512be2738aa72a2048f99 \ + --hash=sha256:87d1351268731db79e0f8e745d92493ee2841c974128ef629dc518b937d9194c \ + --hash=sha256:8bdb58ff7ba23002a4c5808d608e4e6c687175724f54a5dade5fa8c67b604e4d \ + --hash=sha256:8c622a5fe39a48f78944a87d4fb8a53ee07344641b0562c540d840748571b811 \ + --hash=sha256:8d756e44e94489e49571086ef83b2bb8ce311e730092d2c34ca8f7d925cb20aa \ + --hash=sha256:8f4a014bc36d3c57402e2977dada34f9c12300af536839dc38c0beab8878f38a \ + --hash=sha256:9063e24fdb1e498ab71cb7419e24622516c4a04476b17a2dab57e8baa30d6e03 \ + --hash=sha256:90d558489962fd4918143277a773316e56c72da56ec7aa3dc3dbbe20fdfed15b \ + --hash=sha256:923c0c831b7cfcb071580d3f46c4baf50f174be571576556269530f4bbd79d04 \ + --hash=sha256:95f2a5796329323b8f0512e09dbb7a1860c46a39da62ecb2324f116fa8fdc85c \ + --hash=sha256:96b02a3dc4381e5494fad39be677abcb5e6634bf7b4fa83a6dd3112607547001 \ + --hash=sha256:9f96df6923e21816da7e0ad3fd47dd8f94b2a5ce594e00677c0013018b813458 \ + --hash=sha256:a10af20b82360ab00827f916a6058451b723b4e65030c5a18577c8b2de5b3389 \ + --hash=sha256:a50aebfa173e157099939b17f18600f72f84eed3049e743b68ad15bd69b6bf99 \ + --hash=sha256:a981a536974bbc7a512cf44ed14938cf01030a99e9b3a06dd59578882f06f985 \ + --hash=sha256:a9a8e9031d613fd2009c182b69c7b2c1ef8239a0efb1df3f7c8da66d5dd3d537 \ + --hash=sha256:ae5f4161f18c61806f411a13b0310bea87f987c7d2ecdbdaad0e94eb2e404238 \ + --hash=sha256:aed38f6e4fb3f5d6bf81bfa990a07806be9d83cf7bacef998ab1a9bd660a581f \ + --hash=sha256:b01b88d45a6fcb69667cd6d2f7a9aeb4bf53760d7fc536bf679ec94fe9f3ff3d \ + --hash=sha256:b261ccdec7821281dade748d088bb6e9b69e6d15b30652b74cbbac25e280b796 \ + --hash=sha256:b2b0a0c0517616b6869869f8c581d4eb2dd83a4d79e0ebcb7d373ef9956aeb0a \ + --hash=sha256:b4a23f61ce87adf89be746c8a8974fe1c823c891d8f86eb218bb957c924bb143 \ + --hash=sha256:bd8f7df7d12c2db9fab40bdd87a7c09b1530128315d047a086fa3ae3435cb3a8 \ + --hash=sha256:beb58fe5cdb101e3a055192ac291b7a21e3b7ef4f67fa1d74e331a7f2124341c \ + --hash=sha256:c002b4ffc0be611f0d9da932eb0f704fe2602a9a949d1f738e4c34c75b0863d5 \ + --hash=sha256:c083af607d2515612056a31f0a8d9e0fcb5876b7bfc0abad3ecd275bc4ebc2d5 \ + --hash=sha256:c180f51afb394e165eafe4ac2936a14bee3eb10debc9d9e4db8958fe36afe711 \ + --hash=sha256:c235ebd9baae02f1b77bcea61bce332cb4331dc3617d254df3323aa01ab47bd4 \ + --hash=sha256:cd70574b12bb8a4d2aaa0094515df2463cb429d8536cfb6c7ce983246983e5a6 \ + --hash=sha256:d0eccceffcb53201b5bfebb52600a5fb483a20b61da9dbc885f8b103cbe7598c \ + --hash=sha256:d965bba47ddeec8cd560687584e88cf699fd28f192ceb452d1d7ee807c5597b7 \ + --hash=sha256:db364eca23f876da6f9e16c9da0df51aa4f104a972735574842618b8c6d999d4 \ + --hash=sha256:ddbb2551d7e0102e7252db79ba445cdab71b26640817ab1e3e3648dad515003b \ + --hash=sha256:deb6be0ac38ece9ba87dea880e438f25ca3eddfac8b002a2ec3d9183a454e8ae \ + --hash=sha256:e06ed3eb3218bc64786f7db41917d4e686cc4856944f53d5bdf83a6884432e12 \ + --hash=sha256:e27ad930a842b4c5eb8ac0016b0a54f5aebbe679340c26101df33424142c143c \ + --hash=sha256:e537484df0d8f426ce2afb2d0f8e1c3d0b114b83f8850e5f2fbea0e797bd82ae \ + --hash=sha256:eb00ed941194665c332bf8e078baf037d6c35d7c4f3102ea2d4f16ca94a26dc8 \ + --hash=sha256:eb6904c354526e758fda7167b33005998fb68c46fbc10e013ca97f21ca5c8887 \ + --hash=sha256:eb8821e09e916165e160797a6c17edda0679379a4be5c716c260e836e122f54b \ + --hash=sha256:efcb3f6676480691518c177e3b465bcddf57cea040302f9f4e6e191af91174d4 \ + --hash=sha256:f27273b60488abe721a075bcca6d7f3964f9f6f067c8c4c605743023d7d3944f \ + --hash=sha256:f30c3cb33b24454a82faecaf01b19c18562b1e89558fb6c56de4d9118a032fd5 \ + --hash=sha256:fb69256e180cb6c8a894fee62b3afebae785babc1ee98b81cdf68bbca1987f33 \ + --hash=sha256:fd1abc0d89e30cc4e02e4064dc67fcc51bd941eb395c502aac3ec19fab46b519 \ + --hash=sha256:ff8fa367d09b717b2a17a052544193ad76cd49979c805768879cb63d9ca50561 + # via requests +docker==7.0.0 \ + --hash=sha256:12ba681f2777a0ad28ffbcc846a69c31b4dfd9752b47eb425a274ee269c5e14b \ + --hash=sha256:323736fb92cd9418fc5e7133bc953e11a9da04f4483f828b527db553f1e7e5a3 + # via -r requirements.in +idna==3.6 \ + --hash=sha256:9ecdbbd083b06798ae1e86adcbfe8ab1479cf864e4ee30fe4e46a003d12491ca \ + --hash=sha256:c05567e9c24a6b9faaa835c4821bad0590fbb9d5779e7caa6e1cc4978e7eb24f + # via requests +packaging==24.0 \ + --hash=sha256:2ddfb553fdf02fb784c234c7ba6ccc288296ceabec964ad2eae3777778130bc5 \ + --hash=sha256:eb82c5e3e56209074766e6885bb04b8c38a0c015d0a30036ebe7ece34c9989e9 + # via docker +requests==2.31.0 \ + --hash=sha256:58cd2187c01e70e6e26505bca751777aa9f2ee0b7f4300988b709f44e013003f \ + --hash=sha256:942c5a758f98d790eaed1a29cb6eefc7ffb0d1cf7af05c3d2791656dbd6ad1e1 + # via docker +urllib3==2.2.1 \ + --hash=sha256:450b20ec296a467077128bff42b73080516e71b56ff59a60a02bef2232c4fa9d \ + --hash=sha256:d0570876c61ab9e520d776c38acbbb5b05a776d3f9ff98a5c8fd5162a444cf19 + # via + # docker + # requests diff --git a/tests/core/backup/test.sh b/tests/core/backup/test.sh new file mode 100755 index 000000000..46661e13d --- /dev/null +++ b/tests/core/backup/test.sh @@ -0,0 +1,385 @@ +#!/bin/bash + +integration=$1 + +if [ -z "$integration" ] ; then + echo "💾 Please provide an integration name as argument ❌" + exit 1 +elif [ "$integration" != "docker" ] && [ "$integration" != "linux" ] ; then + echo "💾 Integration \"$integration\" is not supported ❌" + exit 1 +fi + +echo "💾 Building backup stack for integration \"$integration\" ..." + +# Starting stack +if [ "$integration" == "docker" ] ; then + docker compose pull bw-docker + # shellcheck disable=SC2181 + if [ $? -ne 0 ] ; then + echo "💾 Pull failed ❌" + exit 1 + fi + docker compose -f docker-compose.mariadb.yml pull bw-db + # shellcheck disable=SC2181 + if [ $? -ne 0 ] ; then + echo "💾 Pull failed ❌" + exit 1 + fi + docker compose -f docker-compose.mysql.yml pull bw-db + # shellcheck disable=SC2181 + if [ $? -ne 0 ] ; then + echo "💾 Pull failed ❌" + exit 1 + fi + docker compose -f docker-compose.postgres.yml pull bw-db + # shellcheck disable=SC2181 + if [ $? -ne 0 ] ; then + echo "💾 Pull failed ❌" + exit 1 + fi + docker compose -f docker-compose.test.yml build + # shellcheck disable=SC2181 + if [ $? -ne 0 ] ; then + echo "💾 Build failed ❌" + exit 1 + fi +else + sudo systemctl stop bunkerweb + echo "DATABASE_URI=sqlite:////var/lib/bunkerweb/db.sqlite3" | sudo tee -a /etc/bunkerweb/variables.env + echo "USE_BACKUP=yes" | sudo tee -a /etc/bunkerweb/variables.env + echo "BACKUP_DIRECTORY=/var/lib/bunkerweb/backups" | sudo tee -a /etc/bunkerweb/variables.env + echo "BACKUP_ROTATION=7" | sudo tee -a /etc/bunkerweb/variables.env + sudo touch /var/www/html/index.html + export TEST_TYPE="linux" +fi + +manual=0 +end=0 +# shellcheck disable=SC2120 +cleanup_stack () { + exit_code=$? + if [[ $end -eq 1 || $exit_code = 1 ]] || [[ $end -eq 0 && $exit_code = 0 ]] && [ $manual = 0 ] ; then + if [ "$integration" == "docker" ] ; then + find . -type f -name 'docker-compose.*' -exec sed -i 's@DATABASE_URI: ".*"$@DATABASE_URI: "sqlite:////var/lib/bunkerweb/db.sqlite3"@' {} \; + find . -type f -name 'docker-compose.*' -exec sed -i 's@USE_BACKUP: ".*"$@USE_BACKUP: "yes"@' {} \; + find . -type f -name 'docker-compose.*' -exec sed -i 's@BACKUP_DIRECTORY: ".*"$@BACKUP_DIRECTORY: "/var/lib/bunkerweb/backups"@' {} \; + find . -type f -name 'docker-compose.*' -exec sed -i 's@BACKUP_ROTATION: ".*"$@BACKUP_ROTATION: "7"@' {} \; + else + sudo sed -i '/^DATABASE_URI/d' /etc/bunkerweb/variables.env + sudo sed -i '/^USE_BACKUP/d' /etc/bunkerweb/variables.env + sudo sed -i '/^BACKUP_DIRECTORY/d' /etc/bunkerweb/variables.env + sudo sed -i '/^BACKUP_ROTATION/d' /etc/bunkerweb/variables.env + unset DATABASE_URI + unset USE_BACKUP + unset BACKUP_DIRECTORY + unset BACKUP_SCHEDULE + unset BACKUP_ROTATION + fi + if [[ $end -eq 1 && $exit_code = 0 ]] ; then + return + fi + fi + + echo "💾 Cleaning up current stack ..." + + if [ "$integration" == "docker" ] ; then + soft_cleanup=$1 + if [ "$soft_cleanup" = "1" ] ; then + docker compose down + else + docker compose down -v --remove-orphans + fi + + if [[ $end -eq 0 && $exit_code = 1 ]] && [ $manual = 0 ] ; then + echo "💾 Removing bw-docker network ..." + + docker network rm bw-docker + + # shellcheck disable=SC2181 + if [ $? -ne 0 ] ; then + echo "💾 Network removal failed ❌" + exit 1 + fi + fi + else + sudo systemctl stop bunkerweb + sudo truncate -s 0 /var/log/bunkerweb/error.log + fi + + # shellcheck disable=SC2181 + if [ $? -ne 0 ] ; then + echo "💾 Cleanup failed ❌" + exit 1 + fi + + echo "💾 Cleaning up current stack done ✅" +} + +# Cleanup stack on exit +trap cleanup_stack EXIT + +starting_stack () { + echo "💾 Starting stack ..." + if [ "$integration" == "docker" ] ; then + docker compose up -d + # shellcheck disable=SC2181 + if [ $? -ne 0 ] ; then + echo "💾 Up failed, retrying ... ⚠️" + manual=1 + cleanup_stack + if [ "$test" = "mariadb" ] ; then + docker compose -f docker-compose.mariadb.yml up -d + if [ $? -ne 0 ] ; then + echo "💾 Up failed ❌" + exit 1 + fi + elif [ "$test" = "mysql" ] ; then + docker compose -f docker-compose.mysql.yml up -d + if [ $? -ne 0 ] ; then + echo "💾 Up failed ❌" + exit 1 + fi + elif [ "$test" = "postgres" ] ; then + docker compose -f docker-compose.postgres.yml up -d + if [ $? -ne 0 ] ; then + echo "💾 Up failed ❌" + exit 1 + fi + fi + manual=0 + docker compose up -d + # shellcheck disable=SC2181 + if [ $? -ne 0 ] ; then + echo "💾 Up failed ❌" + exit 1 + fi + fi + else + sudo systemctl start bunkerweb + # shellcheck disable=SC2181 + if [ $? -ne 0 ] ; then + echo "💾 Start failed ❌" + exit 1 + fi + fi +} + +waiting_stack () { + # Check if stack is healthy + echo "💾 Waiting for stack to be healthy ..." + i=0 + if [ "$integration" == "docker" ] ; then + while [ $i -lt 120 ] ; do + containers=("backup-bw-1" "backup-bw-scheduler-1") + healthy="true" + for container in "${containers[@]}" ; do + check="$(docker inspect --format "{{json .State.Health }}" "$container" | grep "healthy")" + if [ "$check" = "" ] ; then + healthy="false" + break + fi + done + if [ "$healthy" = "true" ] ; then + echo "💾 Docker stack is healthy ✅" + break + fi + sleep 1 + i=$((i+1)) + done + if [ $i -ge 120 ] ; then + docker compose logs + echo "💾 Docker stack is not healthy ❌" + echo "🛡️ Showing BunkerWeb and BunkerWeb Scheduler logs ..." + docker compose logs bw bw-scheduler + exit 1 + fi + else + healthy="false" + retries=0 + while [[ $healthy = "false" && $retries -lt 5 ]] ; do + while [ $i -lt 120 ] ; do + if sudo grep -q "BunkerWeb is ready" "/var/log/bunkerweb/error.log" ; then + echo "💾 Linux stack is healthy ✅" + break + fi + sleep 1 + i=$((i+1)) + done + if [ $i -ge 120 ] ; then + sudo journalctl -u bunkerweb --no-pager + echo "🛡️ Showing BunkerWeb error logs ..." + sudo cat /var/log/bunkerweb/error.log + echo "🛡️ Showing BunkerWeb access logs ..." + sudo cat /var/log/bunkerweb/access.log + echo "💾 Linux stack is not healthy ❌" + exit 1 + fi + + if sudo journalctl -u bunkerweb --no-pager | grep -q "SYSTEMCTL - ❌ " ; then + echo "💾 ⚠ Linux stack got an issue, restarting ..." + sudo journalctl --rotate + sudo journalctl --vacuum-time=1s + manual=1 + cleanup_stack + manual=0 + sudo systemctl start bunkerweb + retries=$((retries+1)) + else + healthy="true" + fi + done + if [ "$retries" -ge 5 ] ; then + echo "💾 Linux stack could not be healthy ❌" + exit 1 + fi + fi +} + +tests="activated deactivated tweaked" + +if [ "$integration" == "docker" ] ; then + tests="$tests mariadb mysql postgres" +fi + +for test in $tests +do + if [ "$integration" == "docker" ] ; then + echo "💾 Creating the bw-docker network ..." + docker network create bw-docker + fi + + if [ "$test" = "activated" ] ; then + echo "💾 Running tests with the default settings ..." + elif [ "$test" = "deactivated" ] ; then + echo "💾 Running tests with the backup deactivated ..." + if [ "$integration" == "docker" ] ; then + find . -type f -name 'docker-compose.*' -exec sed -i 's@USE_BACKUP: ".*"$@USE_BACKUP: "no"@' {} \; + else + sudo sed -i 's@USE_BACKUP=yes@USE_BACKUP=no@' /etc/bunkerweb/variables.env + export USE_BACKUP="no" + fi + elif [ "$test" = "tweaked" ] ; then + echo "💾 Running tests with tweaked backup settings ..." + if [ "$integration" == "docker" ] ; then + find . -type f -name 'docker-compose.*' -exec sed -i 's@USE_BACKUP: ".*"$@USE_BACKUP: "yes"@' {} \; + find . -type f -name 'docker-compose.*' -exec sed -i 's@BACKUP_DIRECTORY: ".*"$@BACKUP_DIRECTORY: "/var/lib/bunkerweb/tmp_backups"@' {} \; + find . -type f -name 'docker-compose.*' -exec sed -i 's@BACKUP_ROTATION: ".*"$@BACKUP_ROTATION: "2"@' {} \; + else + sudo sed -i 's@USE_BACKUP=no@USE_BACKUP=yes@' /etc/bunkerweb/variables.env + sudo sed -i 's@BACKUP_DIRECTORY=/var/lib/bunkerweb/backups@BACKUP_DIRECTORY=/var/lib/bunkerweb/tmp_backups@' /etc/bunkerweb/variables.env + sudo sed -i 's@BACKUP_ROTATION=7@BACKUP_ROTATION=2@' /etc/bunkerweb/variables.env + unset USE_BACKUP + export BACKUP_DIRECTORY="/var/lib/bunkerweb/tmp_backups" + export BACKUP_ROTATION="2" + fi + elif [ "$test" = "mariadb" ] ; then + echo "💾 Running tests with MariaDB database ..." + find . -type f -name 'docker-compose.*' -exec sed -i 's@DATABASE_URI: ".*"$@DATABASE_URI: "mariadb+pymysql://bunkerweb:secret\@bw-db:3306/db"@' {} \; + + echo "💾 Starting mariadb ..." + docker compose -f docker-compose.mariadb.yml up -d + # shellcheck disable=SC2181 + if [ $? -ne 0 ] ; then + echo "💾 Up failed, retrying ... ⚠️" + manual=1 + cleanup_stack + manual=0 + docker compose -f docker-compose.mariadb.yml up -d + # shellcheck disable=SC2181 + if [ $? -ne 0 ] ; then + echo "💾 Up failed ❌" + exit 1 + fi + fi + elif [ "$test" = "mysql" ] ; then + echo "💾 Running tests with MySQL database ..." + find . -type f -name 'docker-compose.*' -exec sed -i 's@DATABASE_URI: ".*"$@DATABASE_URI: "mysql+pymysql://bunkerweb:secret\@bw-db:3306/db"@' {} \; + + echo "💾 Starting mysql ..." + docker compose -f docker-compose.mysql.yml up -d + # shellcheck disable=SC2181 + if [ $? -ne 0 ] ; then + echo "💾 Up failed, retrying ... ⚠️" + manual=1 + cleanup_stack + manual=0 + docker compose -f docker-compose.mysql.yml up -d + # shellcheck disable=SC2181 + if [ $? -ne 0 ] ; then + echo "💾 Up failed ❌" + exit 1 + fi + fi + elif [ "$test" = "postgres" ] ; then + echo "💾 Running tests with PostgreSQL database ..." + find . -type f -name 'docker-compose.*' -exec sed -i 's@DATABASE_URI: ".*"$@DATABASE_URI: "postgresql+psycopg://bunkerweb:secret\@bw-db:5432/db"@' {} \; + + echo "💾 Starting postgres ..." + docker compose -f docker-compose.postgres.yml up -d + # shellcheck disable=SC2181 + if [ $? -ne 0 ] ; then + echo "💾 Up failed, retrying ... ⚠️" + manual=1 + cleanup_stack + manual=0 + docker compose -f docker-compose.postgres.yml up -d + # shellcheck disable=SC2181 + if [ $? -ne 0 ] ; then + echo "💾 Up failed ❌" + exit 1 + fi + fi + fi + + starting_stack + + waiting_stack + + # Start tests + + if [ "$integration" == "docker" ] ; then + docker compose -f docker-compose.test.yml up --abort-on-container-exit --exit-code-from tests + else + sudo -E python3 main.py + fi + + # shellcheck disable=SC2181 + if [ $? -ne 0 ] ; then + echo "💾 Test \"$test\" failed ❌" + echo "🛡️ Showing BunkerWeb and BunkerWeb Scheduler logs ..." + if [ "$integration" == "docker" ] ; then + docker compose logs bw bw-scheduler + else + sudo journalctl -u bunkerweb --no-pager + echo "🛡️ Showing BunkerWeb error logs ..." + sudo cat /var/log/bunkerweb/error.log + echo "🛡️ Showing BunkerWeb access logs ..." + sudo cat /var/log/bunkerweb/access.log + fi + exit 1 + else + echo "💾 Test \"$test\" succeeded ✅" + fi + + manual=1 + cleanup_stack + manual=0 + + echo " " + + if [ "$integration" == "docker" ] ; then + echo "💾 Removing bw-docker network ..." + + docker network rm bw-docker + + # shellcheck disable=SC2181 + if [ $? -ne 0 ] ; then + echo "💾 Network removal failed ❌" + exit 1 + fi + fi +done + +end=1 +echo "💾 Tests are done ! ✅"