-
Notifications
You must be signed in to change notification settings - Fork 151
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
16 changed files
with
283 additions
and
24 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
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
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
102 changes: 102 additions & 0 deletions
102
src/main/java/eu/openanalytics/shinyproxy/controllers/DelegateProxyAdminController.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,102 @@ | ||
| /** | ||
| * ShinyProxy | ||
| * | ||
| * Copyright (C) 2016-2024 Open Analytics | ||
| * | ||
| * =========================================================================== | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the Apache License as published by | ||
| * The Apache Software Foundation, either version 2 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * Apache License for more details. | ||
| * | ||
| * You should have received a copy of the Apache License | ||
| * along with this program. If not, see <http://www.apache.org/licenses/> | ||
| */ | ||
| package eu.openanalytics.shinyproxy.controllers; | ||
|
|
||
| import eu.openanalytics.containerproxy.api.dto.ApiResponse; | ||
| import eu.openanalytics.containerproxy.event.RemoveDelegateProxiesEvent; | ||
| import io.swagger.v3.oas.annotations.Operation; | ||
| import io.swagger.v3.oas.annotations.Parameter; | ||
| import io.swagger.v3.oas.annotations.media.Content; | ||
| import io.swagger.v3.oas.annotations.media.ExampleObject; | ||
| import io.swagger.v3.oas.annotations.responses.ApiResponses; | ||
| import org.springframework.context.ApplicationEventPublisher; | ||
| import org.springframework.http.MediaType; | ||
| import org.springframework.http.ResponseEntity; | ||
| import org.springframework.stereotype.Controller; | ||
| import org.springframework.web.bind.annotation.RequestMapping; | ||
| import org.springframework.web.bind.annotation.RequestMethod; | ||
| import org.springframework.web.bind.annotation.RequestParam; | ||
| import org.springframework.web.bind.annotation.ResponseBody; | ||
|
|
||
| import javax.inject.Inject; | ||
|
|
||
| @Controller | ||
| public class DelegateProxyAdminController extends BaseController { | ||
|
|
||
| @Inject | ||
| private ApplicationEventPublisher applicationEventPublisher; | ||
|
|
||
| @Operation(summary = "Stops DelegateProxies. Can only be used by admins. If no parameters are specified, all DelegateProxies (of all specs) are stopped. " + | ||
| "DelegateProxies that have claimed seats will be stopped as soon as all seats are released. " + | ||
| "New DelegateProxies are automatically created to meet the minimum number of seats.", | ||
| tags = "ShinyProxy" | ||
| ) | ||
| @ApiResponses(value = { | ||
| @io.swagger.v3.oas.annotations.responses.ApiResponse( | ||
| responseCode = "200", | ||
| description = "The DelegateProxies are being stopped.", | ||
| content = { | ||
| @Content( | ||
| mediaType = "application/json", | ||
| examples = { | ||
| @ExampleObject(value = "{\"status\":\"success\", \"data\": null}") | ||
| } | ||
| ) | ||
| }), | ||
| @io.swagger.v3.oas.annotations.responses.ApiResponse( | ||
| responseCode = "400", | ||
| description = "Invalid request, no DelegateProxies are being stopped.", | ||
| content = { | ||
| @Content( | ||
| mediaType = "application/json", | ||
| examples = { | ||
| @ExampleObject(name = "Both id and specId are specified, provide only a single parameter.", value = "{\"status\":\"fail\",\"data\":\"Id and specId cannot be specified at the same time\"}"), | ||
| } | ||
| ) | ||
| }), | ||
| @io.swagger.v3.oas.annotations.responses.ApiResponse( | ||
| responseCode = "403", | ||
| description = "Forbidden, you are not an admin user.", | ||
| content = { | ||
| @Content( | ||
| mediaType = "application/json", | ||
| examples = {@ExampleObject(value = "{\"status\": \"fail\", \"data\": \"forbidden\"}")} | ||
| ) | ||
| }), | ||
| }) | ||
|
|
||
| @RequestMapping(value = "/admin/delegate-proxy", produces = MediaType.APPLICATION_JSON_VALUE, method = RequestMethod.DELETE) | ||
| @ResponseBody | ||
| public ResponseEntity<ApiResponse<Object>> stopDelegateProxies( | ||
| @Parameter(description = "If specified stops the DelegateProxy with this id") @RequestParam(required = false) String id, | ||
| @Parameter(description = "If specified stops all DelegateProxies of this specId ") @RequestParam(required = false) String specId | ||
| ) { | ||
|
|
||
| if (id != null && specId != null) { | ||
| return ApiResponse.fail("Id and specId cannot be specified at the same time"); | ||
| } | ||
|
|
||
| applicationEventPublisher.publishEvent(new RemoveDelegateProxiesEvent(id, specId)); | ||
|
|
||
| return ApiResponse.success(); | ||
| } | ||
|
|
||
| } |
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
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
78 changes: 78 additions & 0 deletions
78
src/test/java/eu/openanalytics/shinyproxy/test/api/DelegateProxyAdminControllerTest.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,78 @@ | ||
| /** | ||
| * ShinyProxy | ||
| * | ||
| * Copyright (C) 2016-2024 Open Analytics | ||
| * | ||
| * =========================================================================== | ||
| * | ||
| * This program is free software: you can redistribute it and/or modify | ||
| * it under the terms of the Apache License as published by | ||
| * The Apache Software Foundation, either version 2 of the License, or | ||
| * (at your option) any later version. | ||
| * | ||
| * This program is distributed in the hope that it will be useful, | ||
| * but WITHOUT ANY WARRANTY; without even the implied warranty of | ||
| * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||
| * Apache License for more details. | ||
| * | ||
| * You should have received a copy of the Apache License | ||
| * along with this program. If not, see <http://www.apache.org/licenses/> | ||
| */ | ||
| package eu.openanalytics.shinyproxy.test.api; | ||
|
|
||
| import eu.openanalytics.containerproxy.test.helpers.ShinyProxyInstance; | ||
| import eu.openanalytics.shinyproxy.test.helpers.ApiTestHelper; | ||
| import eu.openanalytics.shinyproxy.test.helpers.Response; | ||
| import org.junit.jupiter.api.AfterAll; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| public class DelegateProxyAdminControllerTest { | ||
|
|
||
| private static final ShinyProxyInstance inst = new ShinyProxyInstance("application-test-delegate.yml"); | ||
| private static final ApiTestHelper apiTestHelper = new ApiTestHelper(inst); | ||
| private static final String RANDOM_UUID = "8402e8c3-eaef-4fc7-9f23-9e843739dd0f"; | ||
|
|
||
| @AfterAll | ||
| public static void afterAll() { | ||
| inst.close(); | ||
| } | ||
|
|
||
| @Test | ||
| public void testWithoutAuth() { | ||
| Response resp = apiTestHelper.callWithoutAuth(apiTestHelper.createDeleteRequest("/admin/delegate-proxy")); | ||
| resp.assertHtmlAuthenticationRequired(); | ||
|
|
||
| resp = apiTestHelper.callWithoutAuth(apiTestHelper.createDeleteRequest("/admin/delegate-proxy?id=" + RANDOM_UUID)); | ||
| resp.assertHtmlAuthenticationRequired(); | ||
|
|
||
| resp = apiTestHelper.callWithoutAuth(apiTestHelper.createDeleteRequest("/admin/delegate-proxy?specId=01_hello")); | ||
| resp.assertHtmlAuthenticationRequired(); | ||
|
|
||
| // get does nothing for now | ||
| resp = apiTestHelper.callWithoutAuth(apiTestHelper.createRequest("/admin/delegate-proxy")); | ||
| resp.assertHtmlAuthenticationRequired(); // TODO | ||
| } | ||
|
|
||
| @Test | ||
| public void testNonAdminUser() { | ||
| Response resp = apiTestHelper.callWithAuthDemo2(apiTestHelper.createDeleteRequest("/admin/delegate-proxy")); | ||
| resp.assertForbidden(); | ||
|
|
||
| resp = apiTestHelper.callWithAuthDemo2(apiTestHelper.createDeleteRequest("/admin/delegate-proxy?id=" + RANDOM_UUID)); | ||
| resp.assertForbidden(); | ||
|
|
||
| resp = apiTestHelper.callWithAuthDemo2(apiTestHelper.createDeleteRequest("/admin/delegate-proxy?specId=01_hello")); | ||
| resp.assertForbidden(); | ||
|
|
||
| // get does nothing for now | ||
| resp = apiTestHelper.callWithAuthDemo2(apiTestHelper.createRequest("/admin/delegate-proxy")); | ||
| resp.assertForbidden(); // TODO | ||
| } | ||
|
|
||
| @Test | ||
| public void testAdminUser() { | ||
| Response resp = apiTestHelper.callWithAuth(apiTestHelper.createDeleteRequest("/admin/delegate-proxy")); | ||
| resp.jsonSuccess(); | ||
| } | ||
|
|
||
| } |
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
Oops, something went wrong.