ci, dev: remove frontend nginx version, dev stack with bundled front …

…by default - Use the gateway-front in the e2e tests - Simplify the integration tests step removing gateway and front images - Use the gateway front image for the front, removing the container front of the default stack - Create a Docker compose for the front devel stack Signed-off-by: Élyse Viard <[email protected]>
OpenRailAssociation · Jan 31, 2025 · fe1b2d6 · fe1b2d6
1 parent 79ce74c
commit fe1b2d6
Show file tree

Hide file tree

Showing 24 changed files with 370 additions and 326 deletions.
diff --git a/.github/scripts/bake-metadata.py b/.github/scripts/bake-metadata.py
@@ -38,9 +38,6 @@ def suffix(self):
     Target(name="editoast", image="editoast", release=True),
     Target(name="editoast-test", image="editoast", variant="test"),
 
-    Target(name="front-devel", image="front", variant="devel"),
-    Target(name="front-nginx", image="front", variant="nginx"),
-    Target(name="front-build", image="front", variant="build"),
     Target(name="front-tests", image="front", variant="tests"),
 
     Target(name="gateway-standalone", image="gateway", variant="standalone"),

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -27,7 +27,7 @@ jobs:
           - [core-build, core]
           - [editoast, editoast-test]
           - [gateway-test, gateway-standalone, gateway-front]
-          - [front-build, front-tests, front-devel, front-nginx]
+          - [front-tests]
           - [osrdyne, osrdyne-test]
     steps:
       - name: Checkout
@@ -105,12 +105,6 @@ jobs:
           echo "All retries failed, exiting."
           exit 1
 
-      - name: Upload front-build artifact
-        uses: actions/upload-artifact@v4
-        if: steps.bake-metadata.outputs.output_method == 'artifact' && contains(matrix.targets, 'front-build')
-        with:
-          name: front-build
-          path: osrd-front-build.tar
       - name: Upload core-build artifact
         uses: actions/upload-artifact@v4
         if: steps.bake-metadata.outputs.output_method == 'artifact' && contains(matrix.targets, 'core-build')
@@ -159,12 +153,6 @@ jobs:
         with:
           name: gateway-standalone
           path: osrd-gateway-standalone.tar
-      - name: Upload front-nginx artifact
-        uses: actions/upload-artifact@v4
-        if: steps.bake-metadata.outputs.output_method == 'artifact' && contains(matrix.targets, 'front-nginx')
-        with:
-          name: front-nginx
-          path: osrd-front-nginx.tar
       - name: Upload osrdyne artifact
         uses: actions/upload-artifact@v4
         if: steps.bake-metadata.outputs.output_method == 'artifact' && contains(matrix.targets, 'osrdyne')
@@ -191,6 +179,8 @@ jobs:
           docker build -t test_data - <Dockerfile.empty
           docker build -t static_assets - <Dockerfile.empty
           docker build -t front_tests:latest - <Dockerfile.empty
+          docker build -t front_build:latest - <Dockerfile.empty
+          docker build -t front_src:latest - <Dockerfile.empty
 
       - name: Find and check all Dockerfiles using docker build --check
         run: |
@@ -468,13 +458,13 @@ jobs:
         if: needs.build.outputs.output_method == 'artifact'
         uses: actions/download-artifact@v4
         with:
-          name: front-build
+          name: front-tests
           path: .
 
       - name: Load built images
         if: needs.build.outputs.output_method == 'artifact'
         run: |
-          docker load --input ./osrd-front-build.tar
+          docker load --input ./osrd-front-tests.tar
           docker image ls -a
 
       - name: Generate rtk bindings
@@ -483,7 +473,7 @@ jobs:
           -v $PWD/editoast:/editoast
           -v $PWD/gateway:/gateway
           -v $PWD/front/src/common/api:/app/src/common/api
-          ${{ fromJSON(needs.build.outputs.stable_tags).front-build }}
+          ${{ fromJSON(needs.build.outputs.stable_tags).front-tests }}
           npm run generate-types
 
       - name: Check for unexpected changes
@@ -679,18 +669,18 @@ jobs:
         with:
           name: editoast
           path: .
-      - name: Download built front-build image
+      - name: Download built front-tests image
         if: needs.build.outputs.output_method == 'artifact'
         uses: actions/download-artifact@v4
         with:
-          name: front-build
+          name: front-tests
           path: .
 
       - name: Load built images
         if: needs.build.outputs.output_method == 'artifact'
         run: |
           docker load --input ./osrd-editoast.tar
-          docker load --input ./osrd-front-build.tar
+          docker load --input ./osrd-front-tests.tar
 
       - name: Generate OpenAPI
         run: |
@@ -705,7 +695,7 @@ jobs:
       - name: Check for i18n API errors
         run: |
           docker run --name=front-i18n-api-error --net=host -v $PWD/output/openapi.yaml:/editoast/openapi.yaml \
-              ${{ fromJSON(needs.build.outputs.stable_tags).front-build }} \
+              ${{ fromJSON(needs.build.outputs.stable_tags).front-tests }} \
               npm run i18n-api-errors
           exit $(docker wait front-i18n-api-error)
 
@@ -849,33 +839,33 @@ jobs:
         if: needs.build.outputs.output_method == 'artifact'
         uses: actions/download-artifact@v4
         with:
-          name: front-build
+          name: front-tests
           path: .
 
       - name: Load built images
         if: needs.build.outputs.output_method == 'artifact'
         run: |
-          docker load --input ./osrd-front-build.tar
+          docker load --input ./osrd-front-tests.tar
 
       - name: Check code formatting
         run: |
           docker run --name=front-format --net=host \
-            ${{ fromJSON(needs.build.outputs.stable_tags).front-build }} \
+            ${{ fromJSON(needs.build.outputs.stable_tags).front-tests }} \
             npx prettier . --check
 
           exit $(docker wait front-format)
 
       - name: Check for i18n missing keys
         run: |
           docker run --name=front-i18n-checker --net=host \
-            ${{ fromJSON(needs.build.outputs.stable_tags).front-build }} \
+            ${{ fromJSON(needs.build.outputs.stable_tags).front-tests }} \
             npm run i18n-checker
           exit $(docker wait front-i18n-checker)
 
       - name: Execute tests within container
         run: |
           docker run --name=front-test --net=host -v $PWD/output:/app/tests/unit \
-            ${{ fromJSON(needs.build.outputs.stable_tags).front-build }} \
+            ${{ fromJSON(needs.build.outputs.stable_tags).front-tests }} \
             npm run test-coverage
 
           exit $(docker wait front-test)
@@ -900,12 +890,6 @@ jobs:
       # https://www.jameskerr.blog/posts/sharing-steps-in-github-action-workflows/
       - name: Checkout
         uses: actions/checkout@v4
-      - name: Download built front-tests image
-        if: needs.build.outputs.output_method == 'artifact'
-        uses: actions/download-artifact@v4
-        with:
-          name: front-tests
-          path: .
       - name: Download built editoast image
         if: needs.build.outputs.output_method == 'artifact'
         uses: actions/download-artifact@v4
@@ -918,18 +902,6 @@ jobs:
         with:
           name: core
           path: .
-      - name: Download built gateway-standalone image
-        if: needs.build.outputs.output_method == 'artifact'
-        uses: actions/download-artifact@v4
-        with:
-          name: gateway-standalone
-          path: .
-      - name: Download built front-nginx image
-        if: needs.build.outputs.output_method == 'artifact'
-        uses: actions/download-artifact@v4
-        with:
-          name: front-nginx
-          path: .
       - name: Download built osrdyne image
         if: needs.build.outputs.output_method == 'artifact'
         uses: actions/download-artifact@v4
@@ -939,11 +911,8 @@ jobs:
       - name: Load built images
         if: needs.build.outputs.output_method == 'artifact'
         run: |
-          docker load --input ./osrd-front-tests.tar
           docker load --input ./osrd-editoast.tar
           docker load --input ./osrd-core.tar
-          docker load --input ./osrd-gateway-standalone.tar
-          docker load --input ./osrd-front-nginx.tar
           docker load --input ./osrd-osrdyne.tar
       - name: Install poetry
         run: pipx install 'poetry<2.0'
@@ -961,14 +930,13 @@ jobs:
         id: start_integration_worker
         run: |
           set -e
-          export OSRD_FRONT_MODE=nginx
           export TAG='${{ needs.build.outputs.stable_version }}'
 
           # Inside /docker/osrdyne.yml, replace core_image "osrd-core:dev" with "osrd-core:$TAG"
           # to match the version of the core image we just built inside osrdyne
           sed -i "s/osrd-core:dev/osrd-core:$TAG/" docker/osrdyne.yml
 
-          services='editoast osrdyne front core gateway'
+          services='editoast osrdyne core'
           composes='-f docker-compose.yml'
           docker compose $composes pull --policy missing $services
           docker compose $composes up --no-build -d $services jaeger
@@ -1029,17 +997,11 @@ jobs:
         with:
           name: core
           path: .
-      - name: Download built gateway-standalone image
-        if: needs.build.outputs.output_method == 'artifact'
-        uses: actions/download-artifact@v4
-        with:
-          name: gateway-standalone
-          path: .
-      - name: Download built front-nginx image
+      - name: Download built gateway-front image
         if: needs.build.outputs.output_method == 'artifact'
         uses: actions/download-artifact@v4
         with:
-          name: front-nginx
+          name: gateway-front
           path: .
       - name: Download built osrdyne image
         if: needs.build.outputs.output_method == 'artifact'
@@ -1053,8 +1015,7 @@ jobs:
           docker load --input ./osrd-front-tests.tar
           docker load --input ./osrd-editoast.tar
           docker load --input ./osrd-core.tar
-          docker load --input ./osrd-gateway-standalone.tar
-          docker load --input ./osrd-front-nginx.tar
+          docker load --input ./osrd-gateway-front.tar
           docker load --input ./osrd-osrdyne.tar
 
       - name: Detect Playwright version
@@ -1079,14 +1040,14 @@ jobs:
         id: start_playwright_worker
         run: |
           set -e
-          export OSRD_FRONT_MODE=nginx
           export TAG='${{ needs.build.outputs.stable_version }}'
+          export GATEWAY_FLAVOR='front'
 
           # Inside /docker/osrdyne.yml, replace core_image "osrd-core:dev" with "osrd-core:$TAG"
           # to match the version of the core image we just built inside osrdyne
           sed -i "s/osrd-core:dev/osrd-core:$TAG/" docker/osrdyne.yml
 
-          services='editoast osrdyne front core gateway'
+          services='editoast osrdyne core gateway'
           composes='-f docker-compose.yml'
           docker compose $composes pull --policy missing $services
           docker compose $composes up --no-build -d $services jaeger

diff --git a/.gitignore b/.gitignore
@@ -7,3 +7,6 @@ __pycache__
 # Direnv
 .envrc
 .direnv
+
+# Helper script
+.osrd-compose-state
diff --git a/docker-compose.yml b/docker-compose.yml
@@ -5,6 +5,7 @@ volumes:
   valkey_data:
   rabbitmq_data:
 
+
 services:
   postgres:
     image: ${OSRD_POSTGIS_IMAGE:-postgis/postgis:16-3.4-alpine}
@@ -84,30 +85,6 @@ services:
     restart: "no"
     command: "true"
 
-  front:
-    image: ghcr.io/openrailassociation/osrd-edge/osrd-front:${TAG-dev}-${OSRD_FRONT_MODE-devel}
-    container_name: osrd-front
-    build:
-      context: front
-      additional_contexts:
-        test_data: tests/data
-      dockerfile: docker/Dockerfile.${OSRD_FRONT_MODE-devel}
-      args:
-        OSRD_GIT_DESCRIBE: development
-    environment:
-      FRONT_PORT: 3000 # only useful with the prod config
-      OSRD_EDITOAST_URL: /api
-    volumes:
-      - "./front:/app"
-      - "./tests/data:/tests/data"
-    restart: unless-stopped
-    ports: [ "3000:3000" ]
-    healthcheck:
-      test: [ "CMD", "curl", "-f", "http://localhost:3000" ]
-      start_period: 4s
-      interval: 5s
-      retries: 6
-
   editoast:
     image: ghcr.io/openrailassociation/osrd-edge/osrd-editoast:${TAG-dev}
     container_name: osrd-editoast
@@ -146,16 +123,16 @@ services:
       retries: 6
 
   gateway:
-    image: ghcr.io/openrailassociation/osrd-edge/osrd-gateway:${TAG-dev}-standalone
+    image: ghcr.io/openrailassociation/osrd-edge/osrd-gateway:${TAG-dev}-${GATEWAY_FLAVOR-front}
     container_name: osrd-gateway
     build:
       context: gateway
       dockerfile: Dockerfile
       args:
-        OSRD_GIT_DESCRIBE: ${OSRD_GIT_DESCRIBE}
+        OSRD_GIT_DESCRIBE: development
         CARGO_PROFILE: dev
-    volumes:
-      - "./docker/gateway.dev.simple.toml:/gateway.toml"
+      additional_contexts:
+        front_src: front
     restart: unless-stopped
     ports: [ "4000:4000" ]
 

diff --git a/docker/docker-bake-simple.hcl b/docker/docker-bake-simple.hcl