Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve security analysis api #1967

Merged
merged 6 commits into from
Feb 15, 2022
Merged

Improve security analysis api #1967

merged 6 commits into from
Feb 15, 2022

Conversation

flo-dup
Copy link
Contributor

@flo-dup flo-dup commented Feb 9, 2022

Please check if the PR fulfills these requirements

  • The commit message follows our guidelines
  • Tests for the changes have been added (for bug fixes / features)
  • Docs have been added / updated (for bug fixes / features)

Does this PR already have an issue describing the problem ?
Yes, fixes partially #1966

What kind of change does this PR introduce?
Design bug

What is the current behavior?
Almost all SecurityAnalysis run methods have no arguments for contingencies and therefore launch an analysis on an empty list of contingencies, which is useless.

What is the new behavior (if this is a feature change)?
All SecurityAnalysis run methods have contingencies list or provider as argument:

  • contingencies provider if the computationManager is among the arguments of the given run method
  • contingencies list otherwise

Does this PR introduce a breaking change or deprecate an API? Yes

  • The Breaking Change or Deprecated label has been added
  • The migration guide has been updated in the github wiki (What changes might users need to make in their application due to this PR?)

Signed-off-by: Florian Dupuy <florian.dupuy@rte-france.com>
Signed-off-by: Florian Dupuy <florian.dupuy@rte-france.com>
Signed-off-by: Florian Dupuy <florian.dupuy@rte-france.com>
Signed-off-by: Florian Dupuy <florian.dupuy@rte-france.com>
@flo-dup flo-dup force-pushed the improve_security_analysis_api branch from 8077efd to b68ff69 Compare February 11, 2022 09:51
@flo-dup flo-dup added the Breaking Change API is broken label Feb 11, 2022
@flo-dup flo-dup requested a review from geofjamg February 11, 2022 10:12
# Conflicts:
#	security-analysis/security-analysis-default/src/test/java/com/powsybl/security/impl/SecurityAnalysisTest.java
Signed-off-by: Geoffroy Jamgotchian <geoffroy.jamgotchian@rte-france.com>
@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

95.5% 95.5% Coverage
0.0% 0.0% Duplication

@miovd miovd merged commit 2d6efb6 into main Feb 15, 2022
@miovd miovd deleted the improve_security_analysis_api branch February 15, 2022 15:29
colinepiloquet pushed a commit that referenced this pull request Mar 8, 2022
Signed-off-by: Florian Dupuy <florian.dupuy@rte-france.com>
Co-authored-by: Geoffroy Jamgotchian <geoffroy.jamgotchian@rte-france.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Breaking Change API is broken
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants