GEODE-7485: REST URLs accepts dots in trailing parameters (apache#4379)

By default, when Spring parses a request mapping parameter at the end of
a URL, it treats the last dot in the parmater value to be the start of a
file extension, and discards the 'extension" before passing the
parameter to the handler method.

Several of our configurable items allow dots in their IDs. And several
of our REST request mappings place those IDs at the end of the URL. In
those cases, Spring's default behavior truncates the ID at the last dot,
and passes the truncated ID to the request handler. As a result, the
request fails.

This commit configure all current management REST API request mappings
to allow dots in their final parameters.

Co-authored-by: Dale Emery <[email protected]>
Co-authored-by: Jinmei Liao <[email protected]>
Co-authored-by: Dale Emery <[email protected]>

geode-web-management/src/integrationTest/java/org/apache/geode/management/internal/rest/GatewayManagementControllerSpringTest.java

@@ -0,0 +1,86 @@
+/*
+ * 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.geode.management.internal.rest;
+
+import static org.apache.geode.management.configuration.GatewayReceiver.GATEWAY_RECEIVERS_ENDPOINTS;
+import static org.apache.geode.management.configuration.Links.URI_VERSION;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.ArgumentCaptor;
+import org.mockito.Mockito;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.context.web.WebAppConfiguration;
+import org.springframework.web.context.WebApplicationContext;
+
+import org.apache.geode.management.api.ClusterManagementGetResult;
+import org.apache.geode.management.api.ClusterManagementService;
+import org.apache.geode.management.configuration.GatewayReceiver;
+
+@RunWith(SpringRunner.class)
+@ContextConfiguration(locations = {"classpath*:WEB-INF/management-servlet.xml"},
+    loader = MockLocatorContextLoader.class)
+@WebAppConfiguration
+public class GatewayManagementControllerSpringTest {
+
+  @Autowired
+  private WebApplicationContext webApplicationContext;
+
+  private LocatorWebContext context;
+  private MockLocatorContextLoader mockLocator;
+  private ClusterManagementService cms;
+
+  @Before
+  public void before() {
+    context = new LocatorWebContext(webApplicationContext);
+    mockLocator = (MockLocatorContextLoader) context.getLocator();
+    cms = mockLocator.getClusterManagementService();
+  }
+
+  @After
+  public void clearMocks() {
+    Mockito.clearInvocations(cms);
+  }
+
+  @Test
+  public void getGatewayReceiverMappingRecognizesReceiverIdWithDot() throws Exception {
+    String receiverIdWithDot = "receiver.id";
+    String requestPath = URI_VERSION + GATEWAY_RECEIVERS_ENDPOINTS + "/" + receiverIdWithDot;
+
+    when(cms.get(any())).thenReturn(new ClusterManagementGetResult<>());
+
+    context.perform(get(requestPath))
+        .andExpect(status().is2xxSuccessful());
+
+    ArgumentCaptor<GatewayReceiver> gatewayReceiverCaptor =
+        ArgumentCaptor.forClass(GatewayReceiver.class);
+    verify(cms).get(gatewayReceiverCaptor.capture());
+
+    assertThat(gatewayReceiverCaptor.getValue().getId())
+        .isEqualTo(receiverIdWithDot);
+  }
+}

geode-web-management/src/integrationTest/java/org/apache/geode/management/internal/rest/MemberManagementControllerSpringTest.java

@@ -0,0 +1,86 @@
+/*
+ * 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.geode.management.internal.rest;
+
+import static org.apache.geode.management.configuration.Links.URI_VERSION;
+import static org.apache.geode.management.configuration.Member.MEMBER_ENDPOINT;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.ArgumentCaptor;
+import org.mockito.Mockito;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.context.web.WebAppConfiguration;
+import org.springframework.web.context.WebApplicationContext;
+
+import org.apache.geode.management.api.ClusterManagementGetResult;
+import org.apache.geode.management.api.ClusterManagementService;
+import org.apache.geode.management.configuration.Member;
+
+@RunWith(SpringRunner.class)
+@ContextConfiguration(locations = {"classpath*:WEB-INF/management-servlet.xml"},
+    loader = MockLocatorContextLoader.class)
+@WebAppConfiguration
+public class MemberManagementControllerSpringTest {
+
+  @Autowired
+  private WebApplicationContext webApplicationContext;
+
+  private LocatorWebContext context;
+  private MockLocatorContextLoader mockLocator;
+  private ClusterManagementService cms;
+
+  @Before
+  public void before() {
+    context = new LocatorWebContext(webApplicationContext);
+    mockLocator = (MockLocatorContextLoader) context.getLocator();
+    cms = mockLocator.getClusterManagementService();
+  }
+
+  @After
+  public void clearMocks() {
+    Mockito.clearInvocations(cms);
+  }
+
+  @Test
+  public void getMemberMappingRecognizesMemberIdWithDot() throws Exception {
+    String memberIdWithDot = "member.id";
+    String requestPath = URI_VERSION + MEMBER_ENDPOINT + "/" + memberIdWithDot;
+
+    when(cms.get(any())).thenReturn(new ClusterManagementGetResult<>());
+
+    context.perform(get(requestPath))
+        .andExpect(status().is2xxSuccessful());
+
+    ArgumentCaptor<Member> memberCaptor =
+        ArgumentCaptor.forClass(Member.class);
+    verify(cms).get(memberCaptor.capture());
+
+    assertThat(memberCaptor.getValue().getId())
+        .isEqualTo(memberIdWithDot);
+  }
+}

geode-web-management/src/integrationTest/java/org/apache/geode/management/internal/rest/RebalanceOperationControllerSpringTest.java

@@ -0,0 +1,81 @@
+/*
+ * 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.geode.management.internal.rest;
+
+import static org.apache.geode.management.configuration.Links.URI_VERSION;
+import static org.apache.geode.management.operation.RebalanceOperation.REBALANCE_ENDPOINT;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.Mockito;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.context.web.WebAppConfiguration;
+import org.springframework.web.context.WebApplicationContext;
+
+import org.apache.geode.management.api.ClusterManagementResult;
+import org.apache.geode.management.internal.ClusterManagementOperationStatusResult;
+import org.apache.geode.management.internal.api.LocatorClusterManagementService;
+
+@RunWith(SpringRunner.class)
+@ContextConfiguration(locations = {"classpath*:WEB-INF/management-servlet.xml"},
+    loader = MockLocatorContextLoader.class)
+@WebAppConfiguration
+public class RebalanceOperationControllerSpringTest {
+
+  @Autowired
+  private WebApplicationContext webApplicationContext;
+
+  private LocatorWebContext context;
+  private MockLocatorContextLoader mockLocator;
+  private LocatorClusterManagementService cms;
+
+  @Before
+  public void before() {
+    context = new LocatorWebContext(webApplicationContext);
+    mockLocator = (MockLocatorContextLoader) context.getLocator();
+    cms = (LocatorClusterManagementService) mockLocator.getClusterManagementService();
+  }
+
+  @After
+  public void clearMocks() {
+    Mockito.clearInvocations(cms);
+  }
+
+  @Test
+  public void checkStatusMappingRecognizesRebalanceIdWithDot() throws Exception {
+    String rebalanceIdWithDot = "rebalance.id";
+    String requestPath = URI_VERSION + REBALANCE_ENDPOINT + "/" + rebalanceIdWithDot;
+
+    when(cms.checkStatus(any()))
+        .thenReturn(new ClusterManagementOperationStatusResult<>(
+            new ClusterManagementResult()));
+
+    context.perform(get(requestPath))
+        .andExpect(status().is2xxSuccessful());
+
+    verify(cms).checkStatus(rebalanceIdWithDot);
+  }
+}

geode-web-management/src/integrationTest/java/org/apache/geode/management/internal/rest/RegionManagementControllerSpringTest.java

@@ -0,0 +1,128 @@
+/*
+ * 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.geode.management.internal.rest;
+
+import static org.apache.geode.management.configuration.Links.URI_VERSION;
+import static org.apache.geode.management.configuration.Region.REGION_CONFIG_ENDPOINT;
+import static org.apache.geode.management.internal.rest.controllers.RegionManagementController.INDEXES;
+import static org.assertj.core.api.Assertions.assertThat;
+import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.Mockito.verify;
+import static org.mockito.Mockito.when;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.delete;
+import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
+import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;
+
+import org.junit.After;
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+import org.mockito.ArgumentCaptor;
+import org.mockito.Mockito;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.junit4.SpringRunner;
+import org.springframework.test.context.web.WebAppConfiguration;
+import org.springframework.web.context.WebApplicationContext;
+
+import org.apache.geode.management.api.ClusterManagementGetResult;
+import org.apache.geode.management.api.ClusterManagementRealizationResult;
+import org.apache.geode.management.api.ClusterManagementService;
+import org.apache.geode.management.configuration.Index;
+import org.apache.geode.management.configuration.Region;
+
+@RunWith(SpringRunner.class)
+@ContextConfiguration(locations = {"classpath*:WEB-INF/management-servlet.xml"},
+    loader = MockLocatorContextLoader.class)
+@WebAppConfiguration
+public class RegionManagementControllerSpringTest {
+
+  @Autowired
+  private WebApplicationContext webApplicationContext;
+
+  private LocatorWebContext context;
+  private MockLocatorContextLoader mockLocator;
+  private ClusterManagementService cms;
+
+  @Before
+  public void before() {
+    context = new LocatorWebContext(webApplicationContext);
+    mockLocator = (MockLocatorContextLoader) context.getLocator();
+    cms = mockLocator.getClusterManagementService();
+  }
+
+  @After
+  public void clearMocks() {
+    Mockito.clearInvocations(cms);
+  }
+
+  @Test
+  public void getIndexMappingRecognizesIndexIdWithDot() throws Exception {
+    String regionName = "myregion";
+    String indexNameWithDot = "index.name";
+    String requestPath = URI_VERSION + REGION_CONFIG_ENDPOINT
+        + "/" + regionName + INDEXES + "/" + indexNameWithDot;
+
+    when(cms.get(any())).thenReturn(new ClusterManagementGetResult<>());
+
+    context.perform(get(requestPath))
+        .andExpect(status().is2xxSuccessful());
+
+    ArgumentCaptor<Index> indexCaptor = ArgumentCaptor.forClass(Index.class);
+    verify(cms).get(indexCaptor.capture());
+    Index indexPassedToGet = indexCaptor.getValue();
+
+    assertThat(indexPassedToGet.getId())
+        .isEqualTo(indexNameWithDot);
+  }
+
+  @Test
+  public void getRegionMappingRecognizesRegionNameWithDot() throws Exception {
+    String regionNameWithDot = "region.name";
+    String requestPath = URI_VERSION + REGION_CONFIG_ENDPOINT + "/" + regionNameWithDot;
+
+    when(cms.get(any())).thenReturn(new ClusterManagementGetResult<>());
+
+    context.perform(get(requestPath))
+        .andExpect(status().is2xxSuccessful());
+
+    ArgumentCaptor<Region> regionCaptor = ArgumentCaptor.forClass(Region.class);
+    verify(cms).get(regionCaptor.capture());
+    Region regionPassedToGet = regionCaptor.getValue();
+
+    assertThat(regionPassedToGet.getName())
+        .isEqualTo(regionNameWithDot);
+  }
+
+  @Test
+  public void deleteRegionMappingRecognizesRegionNameWithDot() throws Exception {
+    String regionNameWithDot = "region.name";
+    String requestPath = URI_VERSION + REGION_CONFIG_ENDPOINT + "/" + regionNameWithDot;
+
+    when(cms.delete(any())).thenReturn(new ClusterManagementRealizationResult());
+
+    context.perform(delete(requestPath))
+        .andExpect(status().is2xxSuccessful());
+
+    ArgumentCaptor<Region> regionCaptor = ArgumentCaptor.forClass(Region.class);
+    verify(cms).delete(regionCaptor.capture());
+    Region regionPassedToGet = regionCaptor.getValue();
+
+    assertThat(regionPassedToGet.getName())
+        .isEqualTo(regionNameWithDot);
+  }
+}

geode-web-management/src/main/java/org/apache/geode/management/internal/rest/controllers/GatewayManagementController.java

@@ -57,7 +57,7 @@ public ClusterManagementListResult<GatewayReceiver, GatewayReceiverInfo> listGat
 
   @ApiOperation(value = "get gateway-receiver")
   @PreAuthorize("@securityService.authorize('CLUSTER', 'READ')")
-  @GetMapping(GATEWAY_RECEIVERS_ENDPOINTS + "/{id}")
+  @GetMapping(GATEWAY_RECEIVERS_ENDPOINTS + "/{id:.+}")
   public ClusterManagementGetResult<GatewayReceiver, GatewayReceiverInfo> getGatewayReceiver(
       @PathVariable(name = "id") String id) {
     GatewayReceiver config = new GatewayReceiver();