front: add e2e tests for add paced train feature

SharglutDev · SharglutDev · commit d56137c66b41 · 2025-02-25T10:29:37.000Z
Signed-off-by: SharglutDev &lt;p.filimon75@gmail.com&gt;
diff --git a/front/src/common/BootstrapSNCF/ModalSNCF/ModalHeaderSNCF.tsx b/front/src/common/BootstrapSNCF/ModalSNCF/ModalHeaderSNCF.tsx
@@ -19,7 +19,13 @@ const ModalHeaderSNCF = ({
       <div className="modal-header">
         {children}
         {withCloseButton && (
-          <button type="button" className="close" aria-label="Close" onClick={closeModal}>
+          <button
+            data-testid="modal-close-button"
+            type="button"
+            className="close"
+            aria-label="Close"
+            onClick={closeModal}
+          >
             <span aria-hidden="true">&times;</span>
           </button>
         )}
diff --git a/front/src/common/Tabs.tsx b/front/src/common/Tabs.tsx
@@ -41,11 +41,10 @@ const Tabs = ({ tabs, pills = false, fullWidth = false, fullHeight = false }: Ta
         {tabs.map((tab, index) => (
           <div
             data-testid={`tab-${tab.id}`}
-            className={cx(
-              'tab',
-              index === activeTabIndex && 'active',
-              tab.withWarning && 'warning'
-            )}
+            className={cx('tab', {
+              active: index === activeTabIndex,
+              warning: tab.withWarning,
+            })}
             key={`tab-${tab.label}-${index}}`}
             role="button"
             tabIndex={0}
diff --git a/front/src/common/UserSettings.tsx b/front/src/common/UserSettings.tsx
@@ -65,7 +65,7 @@ const UserSettings = () => {
               <SwitchSNCF
                 id="paced-train-switch"
                 type="switch"
-                name={t('operationalStudies/scenario:pacedTrain.pacedTrain')}
+                name="paced-train-switch"
                 checked={userPreferences.showPacedTrains}
                 onChange={() =>
                   dispatch(
diff --git a/front/src/modules/trainschedule/components/ManageTrainSchedule/AddTrainScheduleButton.tsx b/front/src/modules/trainschedule/components/ManageTrainSchedule/AddTrainScheduleButton.tsx
@@ -114,7 +114,7 @@ const AddTrainScheduleButton = ({
       type="button"
       disabled={infraState !== 'CACHED'}
       onClick={createTrainSchedules}
-      data-testid="add-train-schedules"
+      data-testid="add-train"
     >
       <span className="mr-2">
         <Plus size="lg" />
diff --git a/front/src/modules/trainschedule/components/ManageTrainSchedule/TrainSettings.tsx b/front/src/modules/trainschedule/components/ManageTrainSchedule/TrainSettings.tsx
@@ -87,7 +87,7 @@ export default function TrainSettings() {
               <span className="text-nowrap">{t('trainScheduleName')}</span>
             </>
           }
-          id="trainSchedule-name"
+          id="train-name"
           onChange={(e: React.ChangeEvent<HTMLInputElement>) => setName(e.target.value)}
           value={name}
           isInvalid={isInvalidTrainScheduleName}
@@ -107,7 +107,7 @@ export default function TrainSettings() {
               <small className="text-nowrap">{t('trainScheduleDepartureTime')}</small>
             </>
           }
-          id="trainSchedule-startTime"
+          id="train-start-time"
           onChange={(e: React.ChangeEvent<HTMLInputElement>) => setStartTime(e.target.value)}
           value={startTime}
           isInvalid={!startTime}
@@ -124,7 +124,7 @@ export default function TrainSettings() {
               <small className="text-nowrap">{t('trainScheduleInitialSpeed')}</small>
             </>
           }
-          id="trainSchedule-initialSpeed"
+          id="train-initial-speed"
           onChange={(e: React.ChangeEvent<HTMLInputElement>) => setInitialSpeed(+e.target.value)}
           value={initialSpeed}
           min={0}
diff --git a/front/tests/005-operational-studies.spec.ts b/front/tests/005-operational-studies.spec.ts
@@ -8,17 +8,27 @@ import type {
   Study,
 } from 'common/api/osrdEditoastApi';
 
-import { electricRollingStockName } from './assets/project-const';
+import { NEW_PACED_TRAIN_SETTINGS } from './assets/operational-studies-const';
+import { dualModeRollingStockName, electricRollingStockName } from './assets/project-const';
 import test from './logging-fixture';
 import RoutePage from './pages/op-route-page-model';
 import OperationalStudiesPage from './pages/operational-studies-page-model';
 import RollingStockSelectorPage from './pages/rollingstock-selector-page-model';
-import { waitForInfraStateToBeCached } from './utils';
+import { getTranslations, waitForInfraStateToBeCached } from './utils';
 import { getInfra, getRollingStock } from './utils/api-setup';
+import readJsonFile from './utils/file-utils';
 import createScenario from './utils/scenario';
 import { deleteScenario } from './utils/teardown-utils';
+import type { ManageTrainScheduleTranslations } from './utils/types';
 
-test.describe('Verify simulation configuration in operational studies', () => {
+const enTranslations: ManageTrainScheduleTranslations = readJsonFile(
+  'public/locales/en/operationalStudies/manageTrainSchedule.json'
+);
+const frTranslations: ManageTrainScheduleTranslations = readJsonFile(
+  'public/locales/fr/operationalStudies/manageTrainSchedule.json'
+);
+
+test.describe('Verify simulation configuration in operational studies for train schedules and paced trains', () => {
   test.slow();
 
   let rollingstockPage: RollingStockSelectorPage;
@@ -29,10 +39,15 @@ test.describe('Verify simulation configuration in operational studies', () => {
   let scenario: Scenario;
   let infra: Infra;
   let rollingStock: LightRollingStock;
+  let translations: ManageTrainScheduleTranslations;
 
-  test.beforeAll('Fetch rolling stock and infrastructure ', async () => {
+  test.beforeAll('Fetch infrastructure and get translations', async () => {
     rollingStock = await getRollingStock(electricRollingStockName);
     infra = await getInfra();
+    translations = getTranslations({
+      en: enTranslations,
+      fr: frTranslations,
+    });
   });
 
   test.beforeEach('Set up the project, study, and scenario', async ({ page }) => {
@@ -50,6 +65,53 @@ test.describe('Verify simulation configuration in operational studies', () => {
   });
 
   /** *************** Test **************** */
+  test('Add a paced train', async ({ page }) => {
+    // Navigate to the scenario page for the given project and study
+    await page.goto(
+      `/operational-studies/projects/${project.id}/studies/${study.id}/scenarios/${scenario.id}`
+    );
+
+    await operationalStudiesPage.checkPacedTrainSwitch();
+
+    // Wait for infra to be in 'CACHED' state before proceeding
+    await waitForInfraStateToBeCached(infra.id);
+
+    // Click the button to add a train schedule or paced train
+    await operationalStudiesPage.clickOnAddTrainButton();
+
+    // Verify that all configuration buttons and inputs are visible and have their proper default values
+    await operationalStudiesPage.checkInputsAndButtons(translations, scenario.creation_date);
+
+    // Verify that all tabs are visible and their default behavior is correct
+    await operationalStudiesPage.checkTabs();
+
+    // Check the define paced train checkbox
+    await operationalStudiesPage.checkPacedTrainModeAndVerifyInputs(translations);
+
+    // Test the paced train mode behavior
+    await operationalStudiesPage.testPacedTrainMode(translations);
+
+    // Set the paced train inputs
+    await operationalStudiesPage.fillPacedTrainSettings(NEW_PACED_TRAIN_SETTINGS);
+
+    // Select a rolling stock
+    await rollingstockPage.selectRollingStock(dualModeRollingStockName);
+
+    // Select an itinerary
+    await operationalStudiesPage.clickOnRouteTab();
+    await routePage.performPathfindingByTrigram('MWS', 'NES');
+    await operationalStudiesPage.checkPathfindingDistance('33.950 km');
+
+    // TODO : update this part when paced train endpoints are delivered to find a fine configuration for it
+    // Change some time and stops
+
+    // Adding Train Schedule
+    await operationalStudiesPage.addTrainSchedule();
+
+    // TODO : update the test to verify the newly added paced train (for now nothing happens when clicking on the button)
+  });
+
+  // TODO Paced train : Remove this test in https://github.com/OpenRailAssociation/osrd/issues/10791
   test('Pathfinding with rolling stock and composition code', async ({ page }) => {
     // Page models
 
diff --git a/front/tests/assets/operational-studies-const.ts b/front/tests/assets/operational-studies-const.ts
@@ -0,0 +1,22 @@
+import type { PacedTrainSettings } from '../utils/types';
+
+export const DEFAULT_PACED_TRAIN_SETTINGS: Pick<
+  PacedTrainSettings,
+  'timeRangeDuration' | 'cadence'
+> = {
+  timeRangeDuration: '120',
+  cadence: '60',
+};
+
+export const PACED_TRAIN_SETTINGS_TEST: Pick<PacedTrainSettings, 'timeRangeDuration' | 'cadence'> =
+  {
+    timeRangeDuration: '180',
+    cadence: '30',
+  };
+
+export const NEW_PACED_TRAIN_SETTINGS: PacedTrainSettings = {
+  name: 'Paced train test',
+  startTime: '08:35:40',
+  timeRangeDuration: '150',
+  cadence: '20',
+};
diff --git a/front/tests/pages/operational-studies-page-model.ts b/front/tests/pages/operational-studies-page-model.ts
@@ -1,7 +1,12 @@
 import { expect, type Locator, type Page } from '@playwright/test';
 
 import CommonPage from './common-page-model';
+import {
+  DEFAULT_PACED_TRAIN_SETTINGS,
+  PACED_TRAIN_SETTINGS_TEST,
+} from '../assets/operational-studies-const';
 import readJsonFile from '../utils/file-utils';
+import type { ManageTrainScheduleTranslations, PacedTrainSettings } from '../utils/types';
 
 const manageTrainScheduleTranslation: { trainAdded: string } = readJsonFile(
   'public/locales/fr/operationalStudies/manageTrainSchedule.json'
@@ -24,9 +29,29 @@ class OperationalStudiesPage extends CommonPage {
 
   private readonly trainCountInput: Locator;
 
-  private readonly trainScheduleNameInput: Locator;
+  private readonly operationStudiesSettings: Locator;
 
-  private readonly addTrainScheduleButton: Locator;
+  private readonly userSettings: Locator;
+
+  private readonly modalCloseButton: Locator;
+
+  private readonly pacedTrainSwitch: Locator;
+
+  private readonly definePacedTrainCheckbox: Locator;
+
+  private readonly definePacedTrainCheckboxLabel: Locator;
+
+  private readonly pacedTrainTimeRangeDurationInput: Locator;
+
+  private readonly pacedTrainCadenceInput: Locator;
+
+  private readonly trainNameInput: Locator;
+
+  private readonly trainInitialSpeedInput: Locator;
+
+  private readonly trainTagsInput: Locator;
+
+  private readonly addTrainButton: Locator;
 
   private readonly trainTimetable: Locator;
 
@@ -42,11 +67,21 @@ class OperationalStudiesPage extends CommonPage {
     this.routeTab = page.getByTestId('tab-pathfinding');
     this.simulationSettingsTab = page.getByTestId('tab-simulation-settings');
     this.timesAndStopsTab = page.getByTestId('tab-timesStops');
-    this.startTimeField = page.locator('#trainSchedule-startTime');
+    this.startTimeField = page.locator('#train-start-time');
     this.returnSimulationResultButton = page.getByTestId('return-simulation-result');
     this.trainCountInput = page.locator('#osrdconf-traincount');
-    this.addTrainScheduleButton = page.getByTestId('add-train-schedules');
-    this.trainScheduleNameInput = page.locator('#trainSchedule-name');
+    this.operationStudiesSettings = page.getByTestId('dropdown-sncf');
+    this.userSettings = page.getByTestId('user-settings-btn');
+    this.modalCloseButton = page.getByTestId('modal-close-button');
+    this.pacedTrainSwitch = page.getByTestId('paced-train-switch');
+    this.definePacedTrainCheckbox = page.locator('#define-paced-train');
+    this.definePacedTrainCheckboxLabel = page.locator('label[for="define-paced-train"]');
+    this.pacedTrainTimeRangeDurationInput = page.locator('#paced-train-time-range-duration');
+    this.pacedTrainCadenceInput = page.locator('#paced-train-cadence');
+    this.addTrainButton = page.getByTestId('add-train');
+    this.trainNameInput = page.locator('#train-name');
+    this.trainInitialSpeedInput = page.locator('#train-initial-speed');
+    this.trainTagsInput = page.getByTestId('chips-input');
 
     this.trainTimetable = page
       .locator('.scenario-timetable-trains')
@@ -118,14 +153,117 @@ class OperationalStudiesPage extends CommonPage {
     await this.trainCountInput.fill(trainCount);
   }
 
+  // TODO Paced train : remove this (and all related locator and data-testid) in https://github.com/OpenRailAssociation/osrd/issues/10791
+  async checkPacedTrainSwitch() {
+    await expect(this.operationStudiesSettings).toBeVisible();
+    await this.operationStudiesSettings.click();
+
+    await expect(this.userSettings).toBeVisible();
+    await this.userSettings.click();
+
+    await expect(this.pacedTrainSwitch).toBeVisible();
+    await expect(this.pacedTrainSwitch).not.toBeChecked();
+    await this.pacedTrainSwitch.click();
+    await expect(this.pacedTrainSwitch).toBeChecked();
+
+    await this.modalCloseButton.click();
+  }
+
+  async checkInputsAndButtons(translations: ManageTrainScheduleTranslations, date: string) {
+    await expect(this.addTrainButton).toBeVisible();
+    await expect(this.addTrainButton).toHaveText(translations.addTrainSchedule);
+    await expect(this.definePacedTrainCheckboxLabel).toBeVisible();
+    await expect(this.definePacedTrainCheckboxLabel).toHaveText(
+      translations.pacedTrains.defineService
+    );
+    await expect(this.definePacedTrainCheckbox).not.toBeChecked();
+    await expect(this.returnSimulationResultButton).toBeVisible();
+    await expect(this.trainNameInput).toBeVisible();
+
+    await expect(this.startTimeField).toBeVisible();
+    const startTimeDate = new Date(await this.startTimeField.inputValue());
+    const scenarioCreationDate = new Date(date);
+    const isSameDate =
+      startTimeDate.getFullYear() === scenarioCreationDate.getFullYear() &&
+      startTimeDate.getMonth() === scenarioCreationDate.getMonth() &&
+      startTimeDate.getDate() === scenarioCreationDate.getDate();
+    expect(isSameDate).toBe(true);
+
+    await expect(this.trainInitialSpeedInput).toBeVisible();
+    await expect(this.trainInitialSpeedInput).toHaveValue('0');
+
+    await expect(this.trainTagsInput).toBeVisible();
+  }
+
+  async checkTabs() {
+    await expect(this.rollingStockTab).toBeVisible();
+    await expect(this.routeTab).toBeVisible();
+    await expect(this.timesAndStopsTab).toBeVisible();
+    await expect(this.simulationSettingsTab).toBeVisible();
+
+    await expect(this.rollingStockTab).toHaveClass(/active/);
+    await this.verifyTabWarningPresence();
+  }
+
+  async checkPacedTrainModeAndVerifyInputs(translations: ManageTrainScheduleTranslations) {
+    await this.definePacedTrainCheckboxLabel.click();
+    await expect(this.addTrainButton).toHaveText(translations.addPacedTrain);
+    await expect(this.pacedTrainTimeRangeDurationInput).toBeVisible();
+    await expect(this.pacedTrainTimeRangeDurationInput).toHaveValue(
+      DEFAULT_PACED_TRAIN_SETTINGS.timeRangeDuration
+    );
+    await expect(this.pacedTrainCadenceInput).toBeVisible();
+    await expect(this.pacedTrainCadenceInput).toHaveValue(DEFAULT_PACED_TRAIN_SETTINGS.cadence);
+  }
+
+  async testPacedTrainMode(translations: ManageTrainScheduleTranslations) {
+    await this.setTimeRangeDuration(PACED_TRAIN_SETTINGS_TEST.timeRangeDuration);
+    await this.setCadence(PACED_TRAIN_SETTINGS_TEST.cadence);
+    await this.definePacedTrainCheckboxLabel.click();
+    await expect(this.addTrainButton).toHaveText(translations.addTrainSchedule);
+    await expect(this.pacedTrainTimeRangeDurationInput).not.toBeVisible();
+    await expect(this.pacedTrainCadenceInput).not.toBeVisible();
+
+    await this.definePacedTrainCheckboxLabel.click();
+    await expect(this.addTrainButton).toHaveText(translations.addPacedTrain);
+    await expect(this.pacedTrainTimeRangeDurationInput).toBeVisible();
+    await expect(this.pacedTrainTimeRangeDurationInput).toHaveValue(
+      PACED_TRAIN_SETTINGS_TEST.timeRangeDuration
+    );
+    await expect(this.pacedTrainCadenceInput).toBeVisible();
+    await expect(this.pacedTrainCadenceInput).toHaveValue(PACED_TRAIN_SETTINGS_TEST.cadence);
+  }
+
+  async fillPacedTrainSettings({
+    name,
+    startTime,
+    timeRangeDuration,
+    cadence,
+  }: PacedTrainSettings) {
+    await this.setTrainScheduleName(name);
+    await this.setTrainStartTime(startTime);
+    await this.setTimeRangeDuration(timeRangeDuration);
+    await this.setCadence(cadence);
+  }
+
+  async setTimeRangeDuration(timeRangeDuration: string) {
+    await this.pacedTrainTimeRangeDurationInput.fill(timeRangeDuration);
+    await expect(this.pacedTrainTimeRangeDurationInput).toHaveValue(timeRangeDuration);
+  }
+
+  async setCadence(cadence: string) {
+    await this.pacedTrainCadenceInput.fill(cadence);
+    await expect(this.pacedTrainCadenceInput).toHaveValue(cadence);
+  }
+
   async addTrainSchedule() {
-    await this.addTrainScheduleButton.click();
+    await this.addTrainButton.click();
     await this.closeToastNotification();
   }
 
   async setTrainScheduleName(name: string) {
-    await this.trainScheduleNameInput.fill(name);
-    await expect(this.trainScheduleNameInput).toHaveValue(name);
+    await this.trainNameInput.fill(name);
+    await expect(this.trainNameInput).toHaveValue(name);
   }
 
   async checkNumberOfTrains(number: number) {
diff --git a/front/tests/utils/types.ts b/front/tests/utils/types.ts

Original file line number	Diff line number	Diff line change
`@@ -114,7 +114,7 @@ const AddTrainScheduleButton = ({`
`114`	`114`	`type="button"`
`115`	`115`	`disabled={infraState !== 'CACHED'}`
`116`	`116`	`onClick={createTrainSchedules}`
`117`		`- data-testid="add-train-schedules"`
	`117`	`+ data-testid="add-train"`
`118`	`118`	`>`
`119`	`119`	`<span className="mr-2">`
`120`	`120`	`<Plus size="lg" />`