This is an automated email from the ASF dual-hosted git repository. btellier pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/james-project.git
commit d436db32bf159c338ad7a8c614166616090bf1a3 Author: Benoit Tellier <[email protected]> AuthorDate: Wed Dec 18 09:22:19 2019 +0700 JAMES-2993 Do not expose endpoints when no associated tasks --- .../webadmin/tasks/TaskFromRequestRegistry.java | 23 ++++-- .../james/webadmin/routes/UserMailboxesRoutes.java | 8 +- .../UserMailboxesRoutesNoIndexationTest.java | 92 ++++++++++++++++++++++ 3 files changed, 114 insertions(+), 9 deletions(-) diff --git a/server/protocols/webadmin/webadmin-core/src/main/java/org/apache/james/webadmin/tasks/TaskFromRequestRegistry.java b/server/protocols/webadmin/webadmin-core/src/main/java/org/apache/james/webadmin/tasks/TaskFromRequestRegistry.java index e823aba..0f01e8a 100644 --- a/server/protocols/webadmin/webadmin-core/src/main/java/org/apache/james/webadmin/tasks/TaskFromRequestRegistry.java +++ b/server/protocols/webadmin/webadmin-core/src/main/java/org/apache/james/webadmin/tasks/TaskFromRequestRegistry.java @@ -31,7 +31,6 @@ import org.apache.james.task.TaskManager; import com.github.fge.lambdas.Throwing; import com.github.steveash.guavate.Guavate; import com.google.common.base.Joiner; -import com.google.common.base.Preconditions; import com.google.common.collect.ImmutableList; import com.google.common.collect.ImmutableMap; import com.google.common.collect.ImmutableSet; @@ -74,16 +73,28 @@ public class TaskFromRequestRegistry implements TaskFromRequest { } public TaskFromRequestRegistry build() { - ImmutableMap<TaskRegistrationKey, TaskFromRequest> registrations = tasks.build(); - Preconditions.checkState(!registrations.isEmpty()); - return new TaskFromRequestRegistry( - taskParameterName.orElse(DEFAULT_PARAMETER), - registrations); + return buildAsOptional() + .orElseThrow(() -> new IllegalStateException("Expecting some registered tasks but got none")); } public Route buildAsRoute(TaskManager taskManager) { return build().asRoute(taskManager); } + + public Optional<Route> buildAsRouteOptional(TaskManager taskManager) { + return buildAsOptional() + .map(registry -> registry.asRoute(taskManager)); + } + + Optional<TaskFromRequestRegistry> buildAsOptional() { + ImmutableMap<TaskRegistrationKey, TaskFromRequest> registrations = tasks.build(); + if (registrations.isEmpty()) { + return Optional.empty(); + } + return Optional.of(new TaskFromRequestRegistry( + taskParameterName.orElse(DEFAULT_PARAMETER), + registrations)); + } } public static class TaskRegistration implements TaskFromRequest { diff --git a/server/protocols/webadmin/webadmin-mailbox/src/main/java/org/apache/james/webadmin/routes/UserMailboxesRoutes.java b/server/protocols/webadmin/webadmin-mailbox/src/main/java/org/apache/james/webadmin/routes/UserMailboxesRoutes.java index 3281ffc..ddaef99 100644 --- a/server/protocols/webadmin/webadmin-mailbox/src/main/java/org/apache/james/webadmin/routes/UserMailboxesRoutes.java +++ b/server/protocols/webadmin/webadmin-mailbox/src/main/java/org/apache/james/webadmin/routes/UserMailboxesRoutes.java @@ -22,6 +22,7 @@ package org.apache.james.webadmin.routes; import static org.apache.james.webadmin.routes.MailboxesRoutes.RE_INDEX; import static org.apache.james.webadmin.routes.MailboxesRoutes.TASK_PARAMETER; +import java.util.Optional; import java.util.Set; import javax.inject.Inject; @@ -124,7 +125,8 @@ public class UserMailboxesRoutes implements Routes { defineDeleteUserMailboxes(); - service.post(USER_MAILBOXES_BASE, defineReIndexMailboxes(), jsonTransformer); + reIndexMailboxesRoute() + .ifPresent(route -> service.post(USER_MAILBOXES_BASE, route, jsonTransformer)); } @GET @@ -173,11 +175,11 @@ public class UserMailboxesRoutes implements Routes { @ApiResponse(code = HttpStatus.INTERNAL_SERVER_ERROR_500, message = "Internal server error - Something went bad on the server side."), @ApiResponse(code = HttpStatus.BAD_REQUEST_400, message = "Bad request - details in the returned error message") }) - public Route defineReIndexMailboxes() { + public Optional<Route> reIndexMailboxesRoute() { return TaskFromRequestRegistry.builder() .parameterName(TASK_PARAMETER) .registrations(usersMailboxesTaskRegistration) - .buildAsRoute(taskManager); + .buildAsRouteOptional(taskManager); } @DELETE diff --git a/server/protocols/webadmin/webadmin-mailbox/src/test/java/org/apache/james/webadmin/routes/UserMailboxesRoutesNoIndexationTest.java b/server/protocols/webadmin/webadmin-mailbox/src/test/java/org/apache/james/webadmin/routes/UserMailboxesRoutesNoIndexationTest.java new file mode 100644 index 0000000..bd8b402 --- /dev/null +++ b/server/protocols/webadmin/webadmin-mailbox/src/test/java/org/apache/james/webadmin/routes/UserMailboxesRoutesNoIndexationTest.java @@ -0,0 +1,92 @@ +/**************************************************************** + * Licensed to the Apache Software Foundation (ASF) under one * + * or more contributor license agreements. See the NOTICE file * + * distributed with this work for additional information * + * regarding copyright ownership. The ASF licenses this file * + * to you under the Apache License, Version 2.0 (the * + * "License"); you may not use this file except in compliance * + * with the License. You may obtain a copy of the License at * + * * + * http://www.apache.org/licenses/LICENSE-2.0 * + * * + * Unless required by applicable law or agreed to in writing, * + * software distributed under the License is distributed on an * + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY * + * KIND, either express or implied. See the License for the * + * specific language governing permissions and limitations * + * under the License. * + ****************************************************************/ + +package org.apache.james.webadmin.routes; + +import static io.restassured.RestAssured.when; +import static org.apache.james.webadmin.Constants.SEPARATOR; +import static org.apache.james.webadmin.routes.UserMailboxesRoutes.USERS_BASE; +import static org.mockito.Mockito.mock; +import static org.mockito.Mockito.when; + +import org.apache.james.core.Username; +import org.apache.james.mailbox.inmemory.InMemoryMailboxManager; +import org.apache.james.mailbox.inmemory.manager.InMemoryIntegrationResources; +import org.apache.james.task.Hostname; +import org.apache.james.task.MemoryTaskManager; +import org.apache.james.user.api.UsersRepository; +import org.apache.james.webadmin.WebAdminServer; +import org.apache.james.webadmin.WebAdminUtils; +import org.apache.james.webadmin.service.UserMailboxesService; +import org.apache.james.webadmin.utils.ErrorResponder; +import org.apache.james.webadmin.utils.JsonTransformer; +import org.eclipse.jetty.http.HttpStatus; +import org.hamcrest.Matchers; +import org.junit.jupiter.api.AfterEach; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; + +import com.google.common.collect.ImmutableSet; + +import io.restassured.RestAssured; + +class UserMailboxesRoutesNoIndexationTest { + private static final Username USERNAME = Username.of("username"); + + private WebAdminServer webAdminServer; + private MemoryTaskManager taskManager; + + + @BeforeEach + void setUp() throws Exception { + InMemoryMailboxManager mailboxManager = InMemoryIntegrationResources.defaultResources().getMailboxManager(); + UsersRepository usersRepository = mock(UsersRepository.class); + when(usersRepository.contains(USERNAME)).thenReturn(true); + + taskManager = new MemoryTaskManager(new Hostname("foo")); + + webAdminServer = WebAdminUtils.createWebAdminServer( + new UserMailboxesRoutes(new UserMailboxesService(mailboxManager, usersRepository), new JsonTransformer(), + taskManager, + ImmutableSet.of()), + new TasksRoutes(taskManager, new JsonTransformer())) + .start(); + + RestAssured.requestSpecification = WebAdminUtils.buildRequestSpecification(webAdminServer) + .setBasePath(USERS_BASE + SEPARATOR + USERNAME.asString() + SEPARATOR + UserMailboxesRoutes.MAILBOXES) + .build(); + } + + @AfterEach + void tearDown() { + webAdminServer.destroy(); + taskManager.stop(); + } + + @Test + void postShouldNotBeExposedWhenNoTasks() { + when() + .post() + .then() + .statusCode(HttpStatus.NOT_FOUND_404) + .body("statusCode", Matchers.is(404)) + .body("type", Matchers.is(ErrorResponder.ErrorType.NOT_FOUND.getType())) + .body("message", Matchers.is("POST /users/username/mailboxes can not be found")); + } +} --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
