From e44b56c04436076c389402c71ad2b03dcc21d582 Mon Sep 17 00:00:00 2001 From: FranckLecuyer <47824306+FranckLecuyer@users.noreply.github.com> Date: Tue, 14 Apr 2020 15:43:30 +0200 Subject: [PATCH] Create network modification server (#1) Signed-off-by: Franck LECUYER --- .github/workflows/maven.yml | 58 +++ .gitignore | 5 + LICENSE | 373 ++++++++++++++++++ README.md | 8 +- checkstyle.xml | 72 ++++ pom.xml | 186 +++++++++ .../server/NetworkModificationApi.java | 18 + .../NetworkModificationApplication.java | 22 ++ .../server/NetworkModificationController.java | 44 +++ .../server/NetworkModificationService.java | 50 +++ .../NetworkModificationSwaggerConfig.java | 51 +++ src/main/resources/application.yml | 9 + .../server/NetworkModificationTest.java | 154 ++++++++ 13 files changed, 1049 insertions(+), 1 deletion(-) create mode 100644 .github/workflows/maven.yml create mode 100644 .gitignore create mode 100644 LICENSE create mode 100644 checkstyle.xml create mode 100644 pom.xml create mode 100644 src/main/java/org/gridsuite/modification/server/NetworkModificationApi.java create mode 100644 src/main/java/org/gridsuite/modification/server/NetworkModificationApplication.java create mode 100644 src/main/java/org/gridsuite/modification/server/NetworkModificationController.java create mode 100644 src/main/java/org/gridsuite/modification/server/NetworkModificationService.java create mode 100644 src/main/java/org/gridsuite/modification/server/NetworkModificationSwaggerConfig.java create mode 100644 src/main/resources/application.yml create mode 100644 src/test/java/org/gridsuite/modification/server/NetworkModificationTest.java diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml new file mode 100644 index 000000000..eb25cf134 --- /dev/null +++ b/.github/workflows/maven.yml @@ -0,0 +1,58 @@ +name: CI + +on: + push: + repository_dispatch: + types: network_store_updated + +jobs: + build: + + runs-on: ubuntu-latest + + steps: + - name: Set up JDK 11 + uses: actions/setup-java@v1 + with: + java-version: 11 + + - name: Checkout network store sources + uses: actions/checkout@v1 + with: + repository: powsybl/powsybl-network-store + ref: refs/heads/master + + - name: Build and install network store client with Maven + run: mvn --batch-mode -Pclient -DskipTests=true --file ../powsybl-network-store/pom.xml install + + - name: Checkout sources + uses: actions/checkout@v1 + + - name: Build with Maven + run: mvn --batch-mode -P jacoco,perform-integration-test install + + - name: Run SonarCloud analysis + run: > + mvn --batch-mode -DskipTests sonar:sonar + -Dsonar.host.url=https://sonarcloud.io + -Dsonar.organization=gridsuite + -Dsonar.projectKey=org.gridsuite:network-modification-server + env: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }} + + - name: Build Docker image + if: github.ref == 'refs/heads/master' + run: > + mvn --batch-mode jib:build + -Djib.httpTimeout=60000 + -Djib.to.image=docker.io/gridsuite/network-modification-server + -Djib.to.auth.username=powsyblci + -Djib.to.auth.password=${{ secrets.DOCKERHUB_TOKEN }} + + - name: Broadcast update event + if: github.ref == 'refs/heads/master' + uses: gridsuite/broadcast-event@master + with: + token: ${{ secrets.REPO_ACCESS_TOKEN }} + event-type: network_modification_server_updated diff --git a/.gitignore b/.gitignore new file mode 100644 index 000000000..6055d8a58 --- /dev/null +++ b/.gitignore @@ -0,0 +1,5 @@ +target/ + +# IntelliJ +/.idea +*.iml diff --git a/LICENSE b/LICENSE new file mode 100644 index 000000000..a612ad981 --- /dev/null +++ b/LICENSE @@ -0,0 +1,373 @@ +Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. diff --git a/README.md b/README.md index bad76319a..041bf0e9d 100644 --- a/README.md +++ b/README.md @@ -1 +1,7 @@ -# network-modification-server \ No newline at end of file +# network-modification-server + +[![Actions Status](https://github.com/gridsuite/network-modification-server/workflows/CI/badge.svg)](https://github.com/gridsuite/network-modification-server/actions) +[![Coverage Status](https://sonarcloud.io/api/project_badges/measure?project=org.gridsuite%3Anetwork-modification-server&metric=coverage)](https://sonarcloud.io/component_measures?id=org.gridsuite%3Anetwork-modification-server&metric=coverage) +[![MPL-2.0 License](https://img.shields.io/badge/license-MPL_2.0-blue.svg)](https://www.mozilla.org/en-US/MPL/2.0/) + +Server to modify the network based on spring-boot. diff --git a/checkstyle.xml b/checkstyle.xml new file mode 100644 index 000000000..9fc274fd8 --- /dev/null +++ b/checkstyle.xml @@ -0,0 +1,72 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/pom.xml b/pom.xml new file mode 100644 index 000000000..23e25b4d7 --- /dev/null +++ b/pom.xml @@ -0,0 +1,186 @@ + + + + 4.0.0 + + + com.powsybl + powsybl-parent + 3 + + + org.gridsuite + gridsuite-network-modification-server + 1.0.0-SNAPSHOT + + jar + Network modification server + Network modification service + http://www.gridsuite.org + + + scm:git:https://github.com/gridsuite/network-modification-server.git + scm:git:https://github.com/gridsuite/network-modification-server.git + https://github.com/gridsuite/network-modification-server + + + + + Franck LECUYER + franck.lecuyer@rte-france.com + RTE + http://www.rte-france.com + + + + + UTF-8 + + 11 + + 20.0 + 2.28.2 + 2.1.5.RELEASE + 2.9.2 + + 3.1.0 + 1.0.0-SNAPSHOT + + + + + jacoco + + false + + + + + org.jacoco + jacoco-maven-plugin + ${maven.jacoco.version} + + + + **/generated/**/* + + + + + prepare-agent + + prepare-agent + + + + report + test + + report + + + + + + + + + + + + + org.springframework.boot + spring-boot-dependencies + ${springboot.version} + pom + import + + + com.google.guava + guava + ${guava.version} + + + + + + + + io.springfox + springfox-swagger-ui + ${springfox.version} + + + io.springfox + springfox-swagger2 + ${springfox.version} + + + org.springframework.boot + spring-boot-starter-actuator + + + org.springframework.boot + spring-boot-starter-web + + + + com.powsybl + powsybl-network-store-client + ${powsybl-network-store.version} + + + + com.powsybl + powsybl-iidm-api + ${powsybl-core.version} + + + + + com.powsybl + powsybl-config-classic + ${powsybl-core.version} + runtime + + + + com.powsybl + powsybl-iidm-impl + ${powsybl-core.version} + runtime + + + + + org.mockito + mockito-core + ${mockito.version} + test + + + junit + junit + test + + + org.springframework + spring-test + test + + + org.springframework.boot + spring-boot-test-autoconfigure + test + + + diff --git a/src/main/java/org/gridsuite/modification/server/NetworkModificationApi.java b/src/main/java/org/gridsuite/modification/server/NetworkModificationApi.java new file mode 100644 index 000000000..06fb85415 --- /dev/null +++ b/src/main/java/org/gridsuite/modification/server/NetworkModificationApi.java @@ -0,0 +1,18 @@ +/** + * Copyright (c) 2020, RTE (http://www.rte-france.com) + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ +package org.gridsuite.modification.server; + +/** + * @author Franck Lecuyer + */ +public final class NetworkModificationApi { + + private NetworkModificationApi() { + } + + public static final String API_VERSION = "v1"; +} diff --git a/src/main/java/org/gridsuite/modification/server/NetworkModificationApplication.java b/src/main/java/org/gridsuite/modification/server/NetworkModificationApplication.java new file mode 100644 index 000000000..c2bc8ef0e --- /dev/null +++ b/src/main/java/org/gridsuite/modification/server/NetworkModificationApplication.java @@ -0,0 +1,22 @@ +/** + * Copyright (c) 2020, RTE (http://www.rte-france.com) + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ +package org.gridsuite.modification.server; + +import org.springframework.boot.SpringApplication; +import org.springframework.boot.autoconfigure.SpringBootApplication; + +/** + * @author Franck Lecuyer + */ +@SuppressWarnings("checkstyle:HideUtilityClassConstructor") +@SpringBootApplication +public class NetworkModificationApplication { + + public static void main(String[] args) { + SpringApplication.run(NetworkModificationApplication.class, args); + } +} diff --git a/src/main/java/org/gridsuite/modification/server/NetworkModificationController.java b/src/main/java/org/gridsuite/modification/server/NetworkModificationController.java new file mode 100644 index 000000000..1f9d52efb --- /dev/null +++ b/src/main/java/org/gridsuite/modification/server/NetworkModificationController.java @@ -0,0 +1,44 @@ +/** + * Copyright (c) 2020, RTE (http://www.rte-france.com) + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ +package org.gridsuite.modification.server; + +import io.swagger.annotations.*; + +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; +import org.springframework.context.annotation.ComponentScan; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.*; + +import javax.inject.Inject; +import java.util.UUID; + +/** + * @author Franck Lecuyer + */ +@RestController +@RequestMapping(value = "/" + NetworkModificationApi.API_VERSION + "/") +@Api(tags = "network-modification-server") +@ComponentScan(basePackageClasses = NetworkModificationService.class) +public class NetworkModificationController { + + private static final Logger LOGGER = LoggerFactory.getLogger(NetworkModificationController.class); + + @Inject + private NetworkModificationService networkModificationService; + + @PutMapping(value = "/networks/{networkUuid}/switches/{switchId}") + @ApiOperation(value = "change a switch state in the network") + @ApiResponses(value = {@ApiResponse(code = 200, message = "The switch state has been changed")}) + public ResponseEntity changeSwitchState( + @ApiParam(value = "Network UUID") @PathVariable("networkUuid") UUID networkUuid, + @ApiParam(value = "Switch ID") @PathVariable("switchId") String switchId, + @RequestParam("open") String open) { + networkModificationService.changeSwitchState(networkUuid, switchId, open); + return ResponseEntity.ok().build(); + } +} diff --git a/src/main/java/org/gridsuite/modification/server/NetworkModificationService.java b/src/main/java/org/gridsuite/modification/server/NetworkModificationService.java new file mode 100644 index 000000000..f34186bda --- /dev/null +++ b/src/main/java/org/gridsuite/modification/server/NetworkModificationService.java @@ -0,0 +1,50 @@ +/** + * Copyright (c) 2020, RTE (http://www.rte-france.com) + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ +package org.gridsuite.modification.server; + +import com.powsybl.commons.PowsyblException; +import com.powsybl.iidm.network.Network; +import com.powsybl.iidm.network.Switch; +import com.powsybl.network.store.client.NetworkStoreService; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.context.annotation.ComponentScan; +import org.springframework.http.HttpStatus; +import org.springframework.stereotype.Service; +import org.springframework.web.server.ResponseStatusException; + +import java.util.UUID; + +/** + * @author Franck Lecuyer + */ +@ComponentScan(basePackageClasses = {NetworkStoreService.class}) +@Service +class NetworkModificationService { + + @Autowired + private NetworkStoreService networkStoreService; + + private Network getNetwork(UUID networkUuid) { + try { + return networkStoreService.getNetwork(networkUuid); + } catch (PowsyblException e) { + throw new ResponseStatusException(HttpStatus.NOT_FOUND, "Network '" + networkUuid + "' not found"); + } + } + + void changeSwitchState(UUID networkUuid, String switchId, String open) { + Network network = getNetwork(networkUuid); + Switch sw = network.getSwitch(switchId); + if (sw == null) { + throw new ResponseStatusException(HttpStatus.NOT_FOUND, "Switch " + switchId + " not found"); + } + + sw.setOpen(Boolean.parseBoolean(open)); + + networkStoreService.flush(network); + } +} diff --git a/src/main/java/org/gridsuite/modification/server/NetworkModificationSwaggerConfig.java b/src/main/java/org/gridsuite/modification/server/NetworkModificationSwaggerConfig.java new file mode 100644 index 000000000..a905fae2c --- /dev/null +++ b/src/main/java/org/gridsuite/modification/server/NetworkModificationSwaggerConfig.java @@ -0,0 +1,51 @@ +/** + * Copyright (c) 2020, RTE (http://www.rte-france.com) + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ +package org.gridsuite.modification.server; + +import com.google.common.base.Predicate; +import com.google.common.base.Predicates; +import org.springframework.context.annotation.Bean; +import org.springframework.context.annotation.Configuration; +import springfox.documentation.builders.ApiInfoBuilder; +import springfox.documentation.builders.PathSelectors; +import springfox.documentation.builders.RequestHandlerSelectors; +import springfox.documentation.service.ApiInfo; +import springfox.documentation.spi.DocumentationType; +import springfox.documentation.spring.web.plugins.Docket; +import springfox.documentation.swagger2.annotations.EnableSwagger2; + +/** + * @author Franck Lecuyer + */ +@Configuration +@EnableSwagger2 +public class NetworkModificationSwaggerConfig { + @Bean + public Docket produceApi() { + return new Docket(DocumentationType.SWAGGER_2) + .apiInfo(apiInfo()) + .select() + .apis(RequestHandlerSelectors.basePackage(NetworkModificationController.class.getPackage().getName())) + .paths(paths()) + .build(); + } + + // Describe your apis + private ApiInfo apiInfo() { + return new ApiInfoBuilder() + .title("Network modification API") + .description("This is the documentation of network modification REST API") + .build(); + } + + // Only select apis that matches the given Predicates. + private static Predicate paths() { + // Match all paths except /error + return Predicates.and(PathSelectors.regex("/" + ".*"), + Predicates.not(PathSelectors.regex("/error.*"))); + } +} diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml new file mode 100644 index 000000000..cf721e00c --- /dev/null +++ b/src/main/resources/application.yml @@ -0,0 +1,9 @@ +spring: + application: + name: netork-modification-server + +server: + port: 5007 + +network-store-server: + base-uri: http://localhost:8080 diff --git a/src/test/java/org/gridsuite/modification/server/NetworkModificationTest.java b/src/test/java/org/gridsuite/modification/server/NetworkModificationTest.java new file mode 100644 index 000000000..775a57fb6 --- /dev/null +++ b/src/test/java/org/gridsuite/modification/server/NetworkModificationTest.java @@ -0,0 +1,154 @@ +/** + * Copyright (c) 2020, RTE (http://www.rte-france.com) + * This Source Code Form is subject to the terms of the Mozilla Public + * License, v. 2.0. If a copy of the MPL was not distributed with this + * file, You can obtain one at http://mozilla.org/MPL/2.0/. + */ +package org.gridsuite.modification.server; + +import com.powsybl.commons.PowsyblException; +import com.powsybl.iidm.network.*; +import com.powsybl.network.store.client.NetworkStoreService; +import com.powsybl.sld.iidm.extensions.BusbarSectionPosition; +import com.powsybl.sld.iidm.extensions.ConnectablePosition; +import org.junit.Before; +import org.junit.Test; +import org.junit.runner.RunWith; +import org.mockito.MockitoAnnotations; +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest; +import org.springframework.boot.test.mock.mockito.MockBean; +import org.springframework.test.context.ContextConfiguration; +import org.springframework.test.context.junit4.SpringRunner; +import org.springframework.test.web.servlet.MockMvc; + +import java.util.UUID; + +import static org.mockito.BDDMockito.given; +import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.put; +import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status; + +/** + * @author Franck Lecuyer + */ +@RunWith(SpringRunner.class) +@WebMvcTest(NetworkModificationController.class) +@ContextConfiguration(classes = {NetworkModificationApplication.class}) +public class NetworkModificationTest { + + @Autowired + private MockMvc mvc; + + @MockBean + private NetworkStoreService networkStoreService; + + @Before + public void setUp() { + MockitoAnnotations.initMocks(this); + } + + @Test + public void test() throws Exception { + UUID testNetworkId = UUID.fromString("7928181c-7977-4592-ba19-88027e4254e4"); + UUID notFoundNetworkId = UUID.fromString("aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa"); + + given(networkStoreService.getNetwork(testNetworkId)).willReturn(createNetwork()); + given(networkStoreService.getNetwork(notFoundNetworkId)).willThrow(new PowsyblException()); + + // network not existing + mvc.perform(put("/v1/networks/{networkUuid}/switches/{switchId}/", notFoundNetworkId, "v1b1").param("open", "true")) + .andExpect(status().isNotFound()); + + // switch not existing + mvc.perform(put("/v1/networks/{networkUuid}/switches/{switchId}", testNetworkId, "notFound").param("open", "true")) + .andExpect(status().isNotFound()); + + // switch opening + mvc.perform(put("/v1/networks/{networkUuid}/switches/{switchId}", testNetworkId, "v1b1").param("open", "true")) + .andExpect(status().isOk()); + + // switch closing + mvc.perform(put("/v1/networks/{networkUuid}/switches/{switchId}", testNetworkId, "v2b1").param("open", "false")) + .andExpect(status().isOk()); + } + + public static Network createNetwork() { + Network network = Network.create("test", "test"); + + Substation s1 = createSubstation(network, "s1", "s1", Country.FR); + VoltageLevel v1 = createVoltageLevel(s1, "v1", "v1", TopologyKind.NODE_BREAKER, 380.0, 20); + createBusBarSection(v1, "1.1", "1.1", 0, 1, 1); + createSwitch(v1, "v1d1", "v1d1", SwitchKind.DISCONNECTOR, true, false, false, 0, 1); + createSwitch(v1, "v1b1", "v1b1", SwitchKind.BREAKER, true, false, false, 1, 2); + createLoad(v1, "v1load", "v1load", "v1load", 1, ConnectablePosition.Direction.TOP, 2, 0., 0.); + + VoltageLevel v2 = createVoltageLevel(s1, "v2", "v2", TopologyKind.NODE_BREAKER, 225.0, 20); + createBusBarSection(v2, "1A", "1A", 0, 1, 1); + createBusBarSection(v2, "1B", "1B", 1, 1, 2); + createSwitch(v2, "v2d1", "v2d1", SwitchKind.DISCONNECTOR, true, false, false, 0, 2); + createSwitch(v2, "v2b1", "v2b1", SwitchKind.BREAKER, true, true, false, 2, 3); + createSwitch(v2, "v2d2", "v2d2", SwitchKind.DISCONNECTOR, true, false, false, 3, 1); + createSwitch(v2, "v2dload", "v2dload", SwitchKind.DISCONNECTOR, true, false, false, 1, 4); + createSwitch(v2, "v2bload", "v2bload", SwitchKind.BREAKER, true, false, false, 4, 5); + createLoad(v2, "v2load", "v2load", "v2load", 1, ConnectablePosition.Direction.BOTTOM, 5, 0., 0.); + + return network; + } + + private static Substation createSubstation(Network n, String id, String name, Country country) { + return n.newSubstation() + .setId(id) + .setName(name) + .setCountry(country) + .add(); + } + + private static VoltageLevel createVoltageLevel(Substation s, String id, String name, + TopologyKind topology, double vNom, int nodeCount) { + VoltageLevel vl = s.newVoltageLevel() + .setId(id) + .setName(name) + .setTopologyKind(topology) + .setNominalV(vNom) + .add(); + if (topology == TopologyKind.NODE_BREAKER) { + vl.getNodeBreakerView().setNodeCount(nodeCount); + } + return vl; + } + + private static void createBusBarSection(VoltageLevel vl, String id, String name, int node, int busbarIndex, int sectionIndex) { + BusbarSection bbs = vl.getNodeBreakerView().newBusbarSection() + .setId(id) + .setName(name) + .setNode(node) + .add(); + bbs.addExtension(BusbarSectionPosition.class, new BusbarSectionPosition(bbs, busbarIndex, sectionIndex)); + } + + private static void createSwitch(VoltageLevel vl, String id, String name, SwitchKind kind, boolean retained, boolean open, boolean fictitious, int node1, int node2) { + vl.getNodeBreakerView().newSwitch() + .setId(id) + .setName(name) + .setKind(kind) + .setRetained(retained) + .setOpen(open) + .setFictitious(fictitious) + .setNode1(node1) + .setNode2(node2) + .add(); + } + + private static void createLoad(VoltageLevel vl, String id, String name, String feederName, int feederOrder, + ConnectablePosition.Direction direction, int node, double p0, double q0) { + Load load = vl.newLoad() + .setId(id) + .setName(name) + .setNode(node) + .setP0(p0) + .setQ0(q0) + .add(); + load.addExtension(ConnectablePosition.class, new ConnectablePosition<>(load, new ConnectablePosition + .Feeder(feederName, feederOrder, direction), null, null, null)); + } +}