-
Notifications
You must be signed in to change notification settings - Fork 61
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[4375] Add support for impact analysis before tool execution
Bug: #4375 Signed-off-by: Florian ROUËNÉ <[email protected]>
- Loading branch information
Showing
61 changed files
with
2,573 additions
and
924 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
72 changes: 72 additions & 0 deletions
72
integration-tests/cypress/e2e/project/impactanalysis/diagram-impact-analysis.cy.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,72 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2025 Obeo. | ||
| * This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v2.0 | ||
| * which accompanies this distribution, and is available at | ||
| * https://www.eclipse.org/legal/epl-2.0/ | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| * | ||
| * Contributors: | ||
| * Obeo - initial API and implementation | ||
| *******************************************************************************/ | ||
| import { Studio } from '../../../usecases/Studio'; | ||
| import { Details } from '../../../workbench/Details'; | ||
| import { Diagram } from '../../../workbench/Diagram'; | ||
| import { Explorer } from '../../../workbench/Explorer'; | ||
| import { ImpactAnalysis } from '../../../workbench/ImpactAnalysis'; | ||
|
|
||
| describe('Impact analysis - diagram', () => { | ||
| const domainName: string = 'diagramImpactAnalysis'; | ||
| context('Given a view with a node tool with impact analysis', () => { | ||
| context('When we create a new instance project', () => { | ||
| let instanceProjectId: string = ''; | ||
| const diagramDescriptionName = `${domainName} - simple node`; | ||
| const diagramTitle = 'Impact analysis diagram'; | ||
|
|
||
| beforeEach(() => { | ||
| const studio = new Studio(); | ||
| studio.createProjectFromDomain('Cypress - Studio Instance', domainName, 'Root').then((res) => { | ||
| instanceProjectId = res.projectId; | ||
| }); | ||
| }); | ||
|
|
||
| afterEach(() => cy.deleteProject(instanceProjectId)); | ||
|
|
||
| it('Then the tool trigger the impact analysis dialog with the good report', () => { | ||
| const explorer = new Explorer(); | ||
| const diagram = new Diagram(); | ||
| const details = new Details(); | ||
| const impactAnalysis = new ImpactAnalysis(); | ||
| explorer.createObject('Root', 'entity1s-Entity1'); | ||
| details.getTextField('Name').type('InitialName{enter}'); | ||
| new Explorer().createRepresentation('Root', diagramDescriptionName, diagramTitle); | ||
| diagram.fitToScreen(); | ||
| diagram.getNodes('Impact analysis diagram', 'InitialName').findByTestId('Label - InitialName').click(); | ||
| diagram.getPalette().should('exist'); | ||
| diagram.getPalette().findByTestId('tool-Tool with impact analysis').click(); | ||
| impactAnalysis.getImpactAnalysisDialog().should('exist'); | ||
| impactAnalysis.getNbElementModified().should('contain', 'Elements modified: 2'); | ||
| impactAnalysis.getNbElementCreated().should('contain', 'Elements added: 1'); | ||
| }); | ||
|
|
||
| it('Then after impact analysis it is possible to confirm the tool execution', () => { | ||
| const explorer = new Explorer(); | ||
| const diagram = new Diagram(); | ||
| const details = new Details(); | ||
| const impactAnalysis = new ImpactAnalysis(); | ||
| explorer.createObject('Root', 'entity1s-Entity1'); | ||
| details.getTextField('Name').type('InitialName{enter}'); | ||
| new Explorer().createRepresentation('Root', diagramDescriptionName, diagramTitle); | ||
| diagram.fitToScreen(); | ||
| diagram.getNodes('Impact analysis diagram', 'InitialName').findByTestId('Label - InitialName').click(); | ||
| diagram.getPalette().should('exist'); | ||
| diagram.getPalette().findByTestId('tool-Tool with impact analysis').click(); | ||
| impactAnalysis.getImpactAnalysisDialog().should('exist'); | ||
| impactAnalysis.confirmExecution(); | ||
| diagram.getNodes('Impact analysis diagram', 'newName').should('exist'); | ||
| diagram.getNodes('Impact analysis diagram', 'InitialName').should('not.exist'); | ||
| }); | ||
| }); | ||
| }); | ||
| }); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2025 Obeo. | ||
| * This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v2.0 | ||
| * which accompanies this distribution, and is available at | ||
| * https://www.eclipse.org/legal/epl-2.0/ | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| * | ||
| * Contributors: | ||
| * Obeo - initial API and implementation | ||
| *******************************************************************************/ | ||
|
|
||
| export class ImpactAnalysis { | ||
| public getImpactAnalysisDialog(): Cypress.Chainable<JQuery<HTMLElement>> { | ||
| return cy.getByTestId('impact-analysis-dialog'); | ||
| } | ||
|
|
||
| public cancelExecution(): void { | ||
| cy.getByTestId('impact-analysis-dialog-button-cancel').click(); | ||
| } | ||
|
|
||
| public confirmExecution(): void { | ||
| cy.getByTestId('impact-analysis-dialog-button-ok').click(); | ||
| } | ||
|
|
||
| public getNbElementCreated(): Cypress.Chainable<JQuery<HTMLElement>> { | ||
| return cy.getByTestId('impact-analysis-report-nbElementCreated').should('exist'); | ||
| } | ||
|
|
||
| public getNbElementDeleted(): Cypress.Chainable<JQuery<HTMLElement>> { | ||
| return cy.getByTestId('impact-analysis-report-nbElementDeleted').should('exist'); | ||
| } | ||
|
|
||
| public getNbElementModified(): Cypress.Chainable<JQuery<HTMLElement>> { | ||
| return cy.getByTestId('impact-analysis-report-nbElementModified').should('exist'); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
32 changes: 32 additions & 0 deletions
32
...ain/java/org/eclipse/sirius/components/collaborative/api/IToolRepresentationExecutor.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,32 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2025 Obeo. | ||
| * This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v2.0 | ||
| * which accompanies this distribution, and is available at | ||
| * https://www.eclipse.org/legal/epl-2.0/ | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| * | ||
| * Contributors: | ||
| * Obeo - initial API and implementation | ||
| *******************************************************************************/ | ||
| package org.eclipse.sirius.components.collaborative.api; | ||
|
|
||
| import java.util.List; | ||
|
|
||
| import org.eclipse.sirius.components.collaborative.dto.ToolVariable; | ||
| import org.eclipse.sirius.components.core.api.IEditingContext; | ||
| import org.eclipse.sirius.components.representations.IRepresentation; | ||
| import org.eclipse.sirius.components.representations.IStatus; | ||
|
|
||
| /** | ||
| * Used to execute a tool on a representation. | ||
| * | ||
| * @author frouene | ||
| */ | ||
| public interface IToolRepresentationExecutor { | ||
|
|
||
| boolean canExecute(IEditingContext editingContext, IRepresentation representation); | ||
|
|
||
| IStatus execute(IEditingContext editingContext, IRepresentation representation, String toolId, String targetObjectId, List<ToolVariable> variables); | ||
| } |
24 changes: 24 additions & 0 deletions
24
...e/src/main/java/org/eclipse/sirius/components/collaborative/dto/ImpactAnalysisReport.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2025 Obeo. | ||
| * This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v2.0 | ||
| * which accompanies this distribution, and is available at | ||
| * https://www.eclipse.org/legal/epl-2.0/ | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| * | ||
| * Contributors: | ||
| * Obeo - initial API and implementation | ||
| *******************************************************************************/ | ||
| package org.eclipse.sirius.components.collaborative.dto; | ||
|
|
||
| import java.util.List; | ||
|
|
||
| /** | ||
| * Report with data to display on an impact analysis. | ||
| * | ||
| * @author frouene | ||
| */ | ||
| public record ImpactAnalysisReport(int nbElementDeleted, int nbElementModified, int nbElementCreated, List<String> additionalReports) { | ||
|
|
||
| } |
27 changes: 27 additions & 0 deletions
27
...n/java/org/eclipse/sirius/components/collaborative/dto/InvokeImpactAnalysisToolInput.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2025 Obeo. | ||
| * This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v2.0 | ||
| * which accompanies this distribution, and is available at | ||
| * https://www.eclipse.org/legal/epl-2.0/ | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| * | ||
| * Contributors: | ||
| * Obeo - initial API and implementation | ||
| *******************************************************************************/ | ||
| package org.eclipse.sirius.components.collaborative.dto; | ||
|
|
||
| import java.util.List; | ||
| import java.util.UUID; | ||
|
|
||
| import org.eclipse.sirius.components.core.api.IInput; | ||
|
|
||
| /** | ||
| * The input for the "impact analysis" query. | ||
| * | ||
| * @author frouene | ||
| */ | ||
| public record InvokeImpactAnalysisToolInput(UUID id, String editingContextId, String representationId, String toolId, String targetObjectId, List<ToolVariable> variables) implements IInput { | ||
|
|
||
| } |
34 changes: 34 additions & 0 deletions
34
...g/eclipse/sirius/components/collaborative/dto/InvokeImpactAnalysisToolSuccessPayload.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,34 @@ | ||
| /******************************************************************************* | ||
| * Copyright (c) 2022, 2025 Obeo. | ||
| * This program and the accompanying materials | ||
| * are made available under the terms of the Eclipse Public License v2.0 | ||
| * which accompanies this distribution, and is available at | ||
| * https://www.eclipse.org/legal/epl-2.0/ | ||
| * | ||
| * SPDX-License-Identifier: EPL-2.0 | ||
| * | ||
| * Contributors: | ||
| * Obeo - initial API and implementation | ||
| *******************************************************************************/ | ||
| package org.eclipse.sirius.components.collaborative.dto; | ||
|
|
||
| import java.util.List; | ||
| import java.util.Objects; | ||
| import java.util.UUID; | ||
|
|
||
| import org.eclipse.sirius.components.core.api.IPayload; | ||
| import org.eclipse.sirius.components.representations.Message; | ||
|
|
||
| /** | ||
| * The "initial direct edit element label" success payload. | ||
| * | ||
| * @author gcoutable | ||
| */ | ||
| public record InvokeImpactAnalysisToolSuccessPayload(UUID id, ImpactAnalysisReport impactAnalysisReport, List<Message> messages) implements IPayload { | ||
|
|
||
| public InvokeImpactAnalysisToolSuccessPayload { | ||
| Objects.requireNonNull(id); | ||
| Objects.requireNonNull(impactAnalysisReport); | ||
| Objects.requireNonNull(messages); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
10 changes: 10 additions & 0 deletions
10
...backend/sirius-components-collaborative/src/main/resources/schema/impactanalysis.graphqls
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| extend type RepresentationMetadata { | ||
| impactAnalysisReport(toolId: ID!, targetObjectId: ID!, variables: [ToolVariable!]!): ImpactAnalysisReport! | ||
| } | ||
|
|
||
| type ImpactAnalysisReport { | ||
| nbElementDeleted: Int! | ||
| nbElementModified: Int! | ||
| nbElementCreated: Int! | ||
| additionalReports: [String!]! | ||
| } |
Oops, something went wrong.