scripts: add script to load the osrd instance of a given PR and run it concurently to the dev instance

EthanPERRUZZA · EthanPERRUZZA · commit e0152b07c7f4 · 2024-10-07T10:13:02.000Z
Signed-off-by: Ethan Perruzza &lt;ethan.perruzza@gmail.com&gt;
diff --git a/docker/docker-compose.host.yml b/docker/docker-compose.host.yml
@@ -44,6 +44,7 @@ services:
     network_mode: host
     environment:
       OSRDYNE__WORKER_DRIVER__HOST_NETWORKING: "true"
+      OSRDYNE__WORKER_DRIVER__NETWORK: ""
       OSRDYNE__WORKER_DRIVER__DEFAULT_ENV: > 
         [
         "CORE_EDITOAST_URL=http://127.0.0.1:8090",
diff --git a/docker/docker-compose.pr-tests.yml b/docker/docker-compose.pr-tests.yml
@@ -0,0 +1,169 @@
+## This Docker Compose file is used by the pr-infra-compose.sh script.
+# More explanation on its purpose can be found in the script.
+#
+# This Docker Compose file is very similar to the one used for the development
+# environment, except that no services are built (all images are pulled from DockerHub),
+# and all ports have been adjusted (by adding +1 or +2 if the +1 port was already in use)
+# so that both instances can run concurrently on the same computer.
+
+volumes:
+  psql_data:
+  redis_data:
+  rabbitmq_data:
+
+networks:
+  pr-tests:
+    name: osrd_pr_test
+
+services:
+  postgres:
+    image: ${OSRD_POSTGIS_IMAGE:-postgis/postgis:16-3.4-alpine}
+    container_name: osrd-postgres-pr-tests
+    user: postgres
+    restart: unless-stopped
+    ports: ["5433:5433"]
+    environment:
+      POSTGRES_PASSWORD: "password"
+    command: -c port=5433
+    volumes:
+      - "psql_data:/var/lib/postgresql/data"
+      - "../docker/init_db.sql:/docker-entrypoint-initdb.d/init.sql"
+    healthcheck:
+      test: ["CMD", "pg_isready", "-d", "postgres://osrd:password@postgres:5433/osrd"]
+      start_period: 4s
+      interval: 5s
+    networks:
+      - pr-tests
+
+  redis:
+    image: valkey/valkey:alpine
+    container_name: osrd-redis-pr-tests
+    restart: unless-stopped
+    ports: ["6380:6380"]
+    volumes:
+      - "redis_data:/data"
+      - "../docker/valkey.conf:/etc/valkey.conf"
+    command: "valkey-server /etc/valkey.conf --port 6380 --save 30 1 --loglevel warning"
+    healthcheck:
+      test: ["CMD", "valkey-cli", "-p" , "6380", "ping"]
+      start_period: 4s
+      interval: 5s
+    networks:
+      - pr-tests
+
+  rabbitmq:
+    image: rabbitmq:3-management
+    container_name: osrd-rabbitmq-pr-tests
+    ports:
+      - "5673:5673"
+      - "15673:15673"
+    environment:
+      RABBITMQ_DEFAULT_USER: osrd
+      RABBITMQ_DEFAULT_PASS: password
+      RABBITMQ_DIST_PORT: 25673
+      RABBITMQ_CONFIG_FILE: "/etc/rabbitmq/rabbitmq.conf"
+    volumes:
+      - rabbitmq_data:/var/lib/rabbitmq
+      - ../docker/rabbitmq-pr-tests.conf:/etc/rabbitmq/rabbitmq.conf
+    healthcheck:
+      test: ["CMD", "rabbitmqctl", "status"]
+      interval: 15s
+      timeout: 30s
+      retries: 3
+    networks:
+      - pr-tests
+
+  core:
+    image: ghcr.io/openrailassociation/osrd-edge/osrd-core:${PR_NB}
+    container_name: osrd-core-dummy-pr-tests
+    restart: "no"
+    command: "true"
+    networks:
+      - pr-tests
+
+  editoast:
+    image: ghcr.io/openrailassociation/osrd-edge/osrd-editoast:${PR_NB}
+    container_name: osrd-editoast-pr-tests
+    depends_on:
+      postgres: {condition: service_healthy}
+      redis: {condition: service_healthy}
+      rabbitmq: {condition: service_healthy}
+    restart: unless-stopped
+    ports: ["8091:8091"]
+    environment:
+      EDITOAST_PORT: 8091
+      ROOT_URL: "http://localhost:8091"
+      REDIS_URL: "redis://redis:6380"
+      DATABASE_URL: "postgres://osrd:password@postgres:5433/osrd"
+      TELEMETRY_KIND: "opentelemetry"
+      TELEMETRY_ENDPOINT: "http://jaeger:4319"
+      OSRD_MQ_URL: "amqp://osrd:password@osrd-rabbitmq-pr-tests:5673/%2f"
+      OSRDYNE_API_URL: "http://osrd-osrdyne-pr-tests:4243/"
+    command:
+      - /bin/sh
+      - -c
+      - "diesel migration run && exec editoast runserver"
+    healthcheck:
+      test: ["CMD", "curl", "-f", "http://localhost:8091/health"]
+      start_period: 4s
+      interval: 5s
+    networks:
+      - pr-tests
+
+  osrd-images:
+    image: ghcr.io/openrailassociation/osrd-stable/osrd-images:${TAG_IMAGES-v1.0.0}
+    container_name: osrd-images-pr-tests
+    restart: unless-stopped
+    environment:
+      - NGINX_PORT=8081
+    ports: ["8081:8081"]
+    networks:
+      - pr-tests
+
+  gateway:
+    image: ghcr.io/openrailassociation/osrd-edge/osrd-gateway:${PR_NB}-front
+    container_name: osrd-gateway-pr-tests
+    volumes:
+      - "../docker/gateway.pr-tests.simple.toml:/srv/gateway.toml"
+    restart: unless-stopped
+    ports: ["4001:4001"]
+    networks:
+      - pr-tests
+
+  osrdyne:
+    image: ghcr.io/openrailassociation/osrd-edge/osrd-osrdyne:${PR_NB}
+    container_name: osrd-osrdyne-pr-tests
+    depends_on:
+      rabbitmq: {condition: service_healthy}
+    volumes:
+      - ${DOCKER_SOCKET:-/var/run/docker.sock}:/var/run/docker.sock
+      - ../docker/osrdyne-pr-tests.yml:/osrdyne.yml
+    command: osrdyne
+    restart: unless-stopped
+    ports: ["4243:4243"]
+    environment:
+      OSRDYNE__WORKER_DRIVER__WORKER_IMAGE: "ghcr.io/openrailassociation/osrd-edge/osrd-core:${PR_NB}"
+      RUST_LOG: "info"
+    networks:
+      - pr-tests
+
+  jaeger:
+    image: jaegertracing/all-in-one:latest
+    container_name: osrd-jaeger-pr-tests
+    restart: unless-stopped
+    command: --collector.otlp.grpc.host-port :4319 --collector.otlp.http.host-port :4320 --query.http-server.host-port :16687 --collector.grpc-server.host-port :14251
+    ports:
+      - "4319:4319"
+      - "4320:4320"
+      - "16687:16687"
+    networks:
+      - pr-tests
+
+  wait-healthy:
+    depends_on:
+      editoast: {condition: service_healthy}
+    restart: "no"
+    image: alpine:latest
+    command: "true"
+    networks:
+      - pr-tests
diff --git a/docker/gateway.pr-tests.simple.toml b/docker/gateway.pr-tests.simple.toml
@@ -0,0 +1,43 @@
+# This config file is copied into the default dev container
+
+# generate a production key with this command:
+# python3 -c "import secrets, base64; print(base64.standard_b64encode(secrets.token_bytes(64)).decode())"
+secret_key = "NOT+A+SECRET++NOT+A+SECRET++NOT+A+SECRET++NOT+A+SECRET++NOT+A+SECRET++NOT+A+SECRET++NOT+A+SECRET"
+
+listen_addr = "0.0.0.0"
+port = 4001
+
+[telemetry.tracing]
+enable = true
+type = "Otlp"
+service_name = "gateway"
+endpoint = "http://osrd-jaeger-pr-tests:4319"
+
+
+[static_files]
+root_folder = "/srv/front"
+redirect_404_to_index = true
+
+
+[[targets]]
+tracing_name = "editoast"
+prefix = "/api"
+upstream = "http://osrd-editoast-pr-tests:8091"
+require_auth = true
+
+[[targets]]
+tracing_name = "images"
+prefix = "/images"
+upstream = "http://osrd-images:8080"
+require_auth = false
+
+
+[auth]
+default_provider = "mock"
+secure_cookies = false
+
+[[auth.providers]]
+type = "Mocked"
+provider_id = "mock"
+username = "Example User"
+require_login = false
diff --git a/docker/init_db.sql b/docker/init_db.sql
@@ -1,12 +1,18 @@
 create user osrd with password 'password' createdb;
 
--- Create template_osrd databse
+-- Create template_osrd database
 create database template_osrd WITH IS_TEMPLATE true;
+
+-- Connect to template_osrd
 \c template_osrd
+
+-- Enable required extensions
 create extension postgis;
 create extension pg_trgm;
 create extension unaccent;
 
+-- Grant privileges to user
 grant all privileges on schema public to osrd;
 
+-- Create osrd database using template_osrd
 create database osrd TEMPLATE template_osrd;
diff --git a/docker/osrdyne-pr-tests.yml b/docker/osrdyne-pr-tests.yml
@@ -0,0 +1,16 @@
+worker_driver:
+  type: "DockerDriver"
+  network: "osrd_pr_test"
+  container_prefix: "osrd"
+  container_command: ["sh", "-c", "exec java $JAVA_OPTS -ea -jar /app/osrd_core.jar worker"]
+  default_env:
+      - "CORE_EDITOAST_URL=http://osrd-editoast-pr-tests:8091"
+      - "JAVA_TOOL_OPTIONS=-javaagent:/app/opentelemetry-javaagent.jar"
+      - "CORE_MONITOR_TYPE=opentelemetry"
+      - "OTEL_EXPORTER_OTLP_TRACES_PROTOCOL=grpc"
+      - "OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://osrd-jaeger-pr-tests:4319"
+      - "OTEL_METRICS_EXPORTER=none"
+      - "OTEL_LOGS_EXPORTER=none"
+amqp_uri: "amqp://osrd:password@osrd-rabbitmq-pr-tests:5673/%2f"
+management_port: 15673
+api_address: "0.0.0.0:4243"
diff --git a/docker/osrdyne.yml b/docker/osrdyne.yml
@@ -1,6 +1,7 @@
 worker_driver:
   type: "DockerDriver"
   worker_image: "ghcr.io/openrailassociation/osrd-edge/osrd-core:dev"
+  network: "osrd_default"
   container_prefix: "osrd"
   container_command: ["sh", "-c", "exec java $JAVA_OPTS -ea -jar /app/osrd_core.jar worker"]
   default_env:
diff --git a/docker/rabbitmq-pr-tests.conf b/docker/rabbitmq-pr-tests.conf
@@ -0,0 +1,4 @@
+listeners.tcp.port = 5673
+management.tcp.port = 15673
+distribution.listener.port_range.min = 25673
+distribution.listener.port_range.max = 25673
diff --git a/osrdyne/src/drivers/docker.rs b/osrdyne/src/drivers/docker.rs
@@ -30,6 +30,8 @@ pub struct DockerDriverOptions {
     pub default_env: Vec<String>,
     // Should the containers be started in host networking mode
     pub host_networking: Option<bool>,
+    /// The network to start the worker container in
+    pub network: String,
 }
 
 pub struct DockerDriver {
@@ -95,7 +97,7 @@ impl WorkerDriver for DockerDriver {
 
             let mut networking_config = Some(NetworkingConfig {
                 endpoints_config: HashMap::from([(
-                    "osrd_default".to_string(),
+                    self.options.network.clone(),
                     bollard::models::EndpointSettings {
                         ..Default::default()
                     },
diff --git a/scripts/cleanup-db.sh b/scripts/cleanup-db.sh
@@ -14,9 +14,23 @@ if [ "$#" -ne 0 ]; then
   exit 1
 fi
 
+# These variables are necessary to load the infra on the correct instance (the pr-infra or the dev one)
+OSRD_POSTGRES="osrd-postgres"
+OSRD_EDITOAST="osrd-editoast"
+OSRD_REDIS="osrd-redis"
+OSRD_POSTGRES_PORT=5432
+OSRD_REDIS_PORT=6379
+if [ "$PR_TEST" -eq 1 ]; then
+  OSRD_POSTGRES="osrd-postgres-pr-tests"
+  OSRD_EDITOAST="osrd-editoast-pr-tests"
+  OSRD_REDIS="osrd-redis-pr-tests"
+  OSRD_POSTGRES_PORT=5433
+  OSRD_REDIS_PORT=6380
+fi
+
 # Check if the database exists
 echo "Checking database exists..."
-DB_EXISTS="$(docker exec osrd-postgres psql -c "SELECT EXISTS (SELECT FROM pg_stat_database WHERE datname = 'osrd');")"
+DB_EXISTS="$(docker exec $OSRD_POSTGRES psql -p $OSRD_POSTGRES_PORT -c "SELECT EXISTS (SELECT FROM pg_stat_database WHERE datname = 'osrd');")"
 DB_EXISTS="$(echo "$DB_EXISTS" | grep -o -E '[tf]$')"
 
 if [ $DB_EXISTS = 't' ]; then
@@ -30,12 +44,12 @@ if [ $DB_EXISTS = 't' ]; then
   echo "Checking database availability..."
 
   # if editoast is running, shut it down.
-  if [ "$(docker ps -q -f name=osrd-editoast)" ]; then
-    echo "Stopping editoast..."
-    docker stop osrd-editoast
+  if [ "$(docker ps -q -f name=$OSRD_EDITOAST)" ]; then
+    echo "Stopping $OSRD_EDITOAST..."
+    docker stop "$OSRD_EDITOAST"
   fi
 
-  DB_CONN="$(docker exec osrd-postgres psql -c "SELECT numbackends FROM pg_stat_database WHERE datname = 'osrd';")"
+  DB_CONN="$(docker exec "$OSRD_POSTGRES" psql -p "$OSRD_POSTGRES_PORT" -c "SELECT numbackends FROM pg_stat_database WHERE datname = 'osrd';")"
   DB_CONN="$(echo "$DB_CONN" | grep -o -E '[0-9]+$')"
 
   if [ $DB_CONN -ne 0 ]; then
@@ -47,17 +61,17 @@ if [ $DB_EXISTS = 't' ]; then
 
   # Drop database
   echo "Deleting osrd database..."
-  docker exec osrd-postgres psql -c 'DROP DATABASE osrd;' > /dev/null
+  docker exec "$OSRD_POSTGRES" psql -p "$OSRD_POSTGRES_PORT" -c 'DROP DATABASE osrd;' > /dev/null
 fi
 
 echo "Initialize new database (no migration)..."
 # Here I remove the first line of the script cause the user already exists
-docker exec osrd-postgres sh -c 'cat /docker-entrypoint-initdb.d/init.sql | tail -n 1 > /tmp/init.sql'
-docker exec osrd-postgres psql -f //tmp/init.sql > /dev/null
+docker exec "$OSRD_POSTGRES" sh -c 'cat /docker-entrypoint-initdb.d/init.sql | tail -n 1 > /tmp/init.sql'
+docker exec "$OSRD_POSTGRES" psql -p "$OSRD_POSTGRES_PORT" -f //tmp/init.sql > /dev/null
 
 # Clear Redis Cache
 echo "Deleting redis cache..."
-docker exec osrd-redis valkey-cli FLUSHALL > /dev/null 2>&1 || docker volume rm -f osrd_redis_data > /dev/null
+docker exec "$OSRD_REDIS" valkey-cli -p "$OSRD_REDIS_PORT" FLUSHALL > /dev/null 2>&1 || docker volume rm -f osrd_redis_data > /dev/null
 
 echo "Cleanup done!\n"
 echo "You may want to apply migrations if you don't load a backup:"
diff --git a/scripts/load-backup.sh b/scripts/load-backup.sh
@@ -36,17 +36,25 @@ else
   exit 2
 fi
 
+# These variables are necessary to load the infra on the correct instance (the pr-infra or the dev one)
+OSRD_POSTGRES="osrd-postgres"
+OSRD_POSTGRES_PORT=5432
+if [ "$PR_TEST" -eq 1 ]; then
+  OSRD_POSTGRES="osrd-postgres-pr-tests"
+  OSRD_POSTGRES_PORT=5433
+fi
+
 $(dirname "$0")/cleanup-db.sh # Cleanup and init db (no migration)
 
 # Copy needed files to the container
-docker cp "$BACKUP_PATH" osrd-postgres:tmp/backup-osrd
+docker cp "$BACKUP_PATH" "$OSRD_POSTGRES:tmp/backup-osrd"
 
 # restoring the backend can partialy fail, and that's sometimes ok
 echo "Restore backup..."
-docker exec osrd-postgres pg_restore --if-exists -c -d osrd -x //tmp/backup-osrd > /dev/null
+docker exec "$OSRD_POSTGRES" pg_restore --if-exists -p "$OSRD_POSTGRES_PORT" -c -d osrd -x //tmp/backup-osrd > /dev/null
 
 # analyze db for performances
 echo "Analyze for performances..."
-docker exec osrd-postgres psql -d osrd -c 'ANALYZE;' > /dev/null
+docker exec "$OSRD_POSTGRES" psql -p "$OSRD_POSTGRES_PORT" -d osrd -c 'ANALYZE;' > /dev/null
 
 echo "Load backup done!"
diff --git a/scripts/pr-infra-compose.sh b/scripts/pr-infra-compose.sh

Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,7 @@ services:`
`44`	`44`	`network_mode: host`
`45`	`45`	`environment:`
`46`	`46`	`OSRDYNE__WORKER_DRIVER__HOST_NETWORKING: "true"`
	`47`	`+ OSRDYNE__WORKER_DRIVER__NETWORK: ""`
`47`	`48`	`OSRDYNE__WORKER_DRIVER__DEFAULT_ENV: >`
`48`	`49`	`[`
`49`	`50`	`"CORE_EDITOAST_URL=http://127.0.0.1:8090",`