[JENKINS-76086] Fails to process Bitbucket webhook events with "No processor found" (#1109)

Make the copy of headers a case insensitive on Map

Author: nfalco79

src/main/java/com/cloudbees/jenkins/plugins/bitbucket/hooks/BitbucketSCMSourcePushHookReceiver.java

@@ -39,7 +39,6 @@
 import java.nio.charset.StandardCharsets;
 import java.util.Arrays;
 import java.util.Collections;
-import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.Map.Entry;
@@ -49,6 +48,7 @@
 import org.apache.commons.collections4.EnumerationUtils;
 import org.apache.commons.collections4.MultiMapUtils;
 import org.apache.commons.collections4.MultiValuedMap;
+import org.apache.commons.collections4.map.CaseInsensitiveMap;
 import org.apache.commons.collections4.multimap.ArrayListValuedHashMap;
 import org.apache.commons.io.IOUtils;
 import org.apache.commons.lang3.StringUtils;
@@ -163,7 +163,8 @@ private MultiValuedMap<String, String> getParameters(StaplerRequest2 req) {
     }
 
     private Map<String, String> getHeaders(StaplerRequest2 req) {
-        Map<String, String> reqHeaders = new HashMap<>();
+        // HTTP headers are case insensitive
+        Map<String, String> reqHeaders = new CaseInsensitiveMap<>();
         for (String headerName : EnumerationUtils.asIterable(req.getHeaderNames())) {
             reqHeaders.put(headerName, req.getHeader(headerName));
         }

src/test/java/com/cloudbees/jenkins/plugins/bitbucket/hooks/BitbucketSCMSourcePushHookReceiverTest.java

@@ -31,10 +31,11 @@
 import com.cloudbees.jenkins.plugins.bitbucket.test.util.MockRequest;
 import java.util.Collections;
 import java.util.Enumeration;
-import java.util.HashMap;
 import java.util.Map;
+import java.util.concurrent.atomic.AtomicReference;
 import java.util.stream.Stream;
 import org.apache.commons.collections4.MultiValuedMap;
+import org.apache.commons.collections4.map.CaseInsensitiveMap;
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -48,6 +49,7 @@
 
 import static org.assertj.core.api.Assertions.assertThat;
 import static org.mockito.ArgumentMatchers.any;
+import static org.mockito.ArgumentMatchers.anyMap;
 import static org.mockito.ArgumentMatchers.anyString;
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.mock;
@@ -58,11 +60,12 @@
 @WithJenkins
 class BitbucketSCMSourcePushHookReceiverTest {
 
-    private static JenkinsRule j;
+    @SuppressWarnings("unused")
+    private static JenkinsRule rule;
 
     @BeforeAll
     static void init(JenkinsRule rule) {
-        j = rule;
+        BitbucketSCMSourcePushHookReceiverTest.rule = rule;
     }
 
     private StaplerRequest2 req;
@@ -72,7 +75,7 @@ static void init(JenkinsRule rule) {
     @BeforeEach
     void setup() throws Exception {
         req = mock(StaplerRequest2.class);
-        headers = new HashMap<>();
+        headers = new CaseInsensitiveMap<>();
         when(req.getHeader(anyString())).thenAnswer(new Answer<String>() {
             @Override
             public String answer(InvocationOnMock invocation) throws Throwable {
@@ -119,7 +122,9 @@ Stream<BitbucketWebhookProcessor> getHookProcessors() {
             when(hookProcessor.getEventType(any(), any())).thenReturn("event:X");
 
             sut.doNotify(req);
+            @SuppressWarnings("unchecked")
             ArgumentCaptor<Map<String, String>> headersCaptor = ArgumentCaptor.forClass(Map.class);
+            @SuppressWarnings("unchecked")
             ArgumentCaptor<MultiValuedMap<String, String>> parametersCaptor = ArgumentCaptor.forClass(MultiValuedMap.class);
 
             verify(hookProcessor).canHandle(headersCaptor.capture(),  parametersCaptor.capture());
@@ -176,4 +181,30 @@ Stream<BitbucketWebhookProcessor> getHookProcessors() {
         }
     }
 
+    @Test
+    void request_headers_must_be_case_insensitive() throws Exception {
+        AtomicReference<Map<String, String>> requestHeaders = new AtomicReference<>();
+
+        BitbucketWebhookProcessor hookProcessor = mock(BitbucketWebhookProcessor.class);
+        when(hookProcessor.canHandle(anyMap(), any())).thenAnswer(new Answer<Boolean>() {
+            @Override
+            public Boolean answer(InvocationOnMock invocation) throws Throwable {
+                requestHeaders.set(invocation.getArgument(0));
+                // stop to process the request
+                return false;
+            }
+        });
+        sut = new BitbucketSCMSourcePushHookReceiver() {
+            @Override
+            Stream<BitbucketWebhookProcessor> getHookProcessors() {
+                return Stream.of(hookProcessor);
+            }
+        };
+        mockRequest();
+        headers.putAll(HookProcessorTestUtil.getCloudHeaders());
+
+        sut.doNotify(req);
+        assertThat(requestHeaders.get()).containsKeys("X-Request-UUID", "X-Request-UUID".toLowerCase());
+    }
+
 }

src/test/java/com/cloudbees/jenkins/plugins/bitbucket/hooks/WebhookAutoRegisterListenerTest.java

@@ -66,8 +66,8 @@ class WebhookAutoRegisterListenerTest {
     private static JenkinsRule rule;
 
     @BeforeAll
-    static void init(JenkinsRule r) {
-        rule = r;
+    static void init(JenkinsRule rule) {
+        WebhookAutoRegisterListenerTest.rule = rule;
     }
 
     private WebhookAutoRegisterListener sut;
@@ -108,6 +108,7 @@ void test_register() throws Exception {
             });
     }
 
+    @SuppressWarnings("deprecation")
     @Test
     void test_do_not_update_plugin_hook_if_no_changes() throws Exception {
         String serverURL = "http://localhost:7990/bitbucket";
@@ -127,6 +128,7 @@ void test_do_not_update_plugin_hook_if_no_changes() throws Exception {
             .isNotInstanceOf(HttpPut.class);
     }
 
+    @SuppressWarnings("deprecation")
     @Test
     void test_update_plugin_hook_when_serverURL_is_changed() throws Exception {
         String serverURL = "http://myserver:7990";

src/test/java/com/cloudbees/jenkins/plugins/bitbucket/impl/webhook/cloud/CloudPullRequestWebhookProcessorTest.java

@@ -43,6 +43,7 @@
 import jenkins.scm.api.SCMNavigator;
 import jenkins.scm.api.SCMSource;
 import org.apache.commons.collections4.MultiValuedMap;
+import org.apache.commons.collections4.map.CaseInsensitiveMap;
 import org.apache.commons.collections4.multimap.ArrayListValuedHashMap;
 import org.apache.commons.io.IOUtils;
 import org.junit.jupiter.api.BeforeEach;
@@ -70,7 +71,7 @@ public void notifyEvent(SCMHeadEvent<?> event, int delaySeconds) {
 
     @Test
     void test_getServerURL_return_always_cloud_URL() throws Exception {
-        Map<String, String> headers = new HashMap<>();
+        Map<String, String> headers = new CaseInsensitiveMap<>();
         MultiValuedMap<String, String> parameters = new ArrayListValuedHashMap<>();
         parameters.put("server_url", "https://localhost:8080");
 

src/test/java/com/cloudbees/jenkins/plugins/bitbucket/impl/webhook/cloud/CloudPushWebhookProcessorTest.java

@@ -43,6 +43,7 @@
 import jenkins.scm.api.SCMHeadEvent;
 import jenkins.scm.api.SCMRevision;
 import org.apache.commons.collections4.MultiValuedMap;
+import org.apache.commons.collections4.map.CaseInsensitiveMap;
 import org.apache.commons.collections4.multimap.ArrayListValuedHashMap;
 import org.apache.commons.io.IOUtils;
 import org.junit.jupiter.api.BeforeEach;
@@ -68,7 +69,7 @@ public void notifyEvent(SCMHeadEvent<?> event, int delaySeconds) {
 
     @Test
     void test_getServerURL_return_always_cloud_URL() throws Exception {
-        Map<String, String> headers = new HashMap<>();
+        Map<String, String> headers = new CaseInsensitiveMap<>();
         MultiValuedMap<String, String> parameters = new ArrayListValuedHashMap<>();
         parameters.put("server_url", "https://localhost:8080");
 

src/test/java/com/cloudbees/jenkins/plugins/bitbucket/impl/webhook/plugin/PluginPullRequestWebhookProcessorTest.java

@@ -41,6 +41,7 @@
 import jenkins.scm.api.SCMNavigator;
 import jenkins.scm.api.SCMSource;
 import org.apache.commons.collections4.MultiValuedMap;
+import org.apache.commons.collections4.map.CaseInsensitiveMap;
 import org.apache.commons.collections4.multimap.ArrayListValuedHashMap;
 import org.apache.commons.io.IOUtils;
 import org.junit.jupiter.api.BeforeEach;
@@ -70,7 +71,7 @@ public void notifyEvent(SCMHeadEvent<?> event, int delaySeconds) {
 
     @Test
     void test_getServerURL_return_always_cloud_URL() throws Exception {
-        Map<String, String> headers = new HashMap<>();
+        Map<String, String> headers = new CaseInsensitiveMap<>();
         MultiValuedMap<String, String> parameters = new ArrayListValuedHashMap<>();
         parameters.put("server_url", SERVER_URL);
 

src/test/java/com/cloudbees/jenkins/plugins/bitbucket/impl/webhook/plugin/PluginPushWebhookProcessorTest.java

@@ -44,6 +44,7 @@
 import jenkins.scm.api.SCMRevision;
 import jenkins.scm.api.SCMSource;
 import org.apache.commons.collections4.MultiValuedMap;
+import org.apache.commons.collections4.map.CaseInsensitiveMap;
 import org.apache.commons.collections4.multimap.ArrayListValuedHashMap;
 import org.apache.commons.io.IOUtils;
 import org.junit.jupiter.api.BeforeEach;
@@ -74,7 +75,7 @@ public void notifyEvent(SCMHeadEvent<?> event, int delaySeconds) {
 
     @Test
     void test_getServerURL_return_always_cloud_URL() throws Exception {
-        Map<String, String> headers = new HashMap<>();
+        Map<String, String> headers = new CaseInsensitiveMap<>();
         MultiValuedMap<String, String> parameters = new ArrayListValuedHashMap<>();
         parameters.put("server_url", SERVER_URL);
 

src/test/java/com/cloudbees/jenkins/plugins/bitbucket/impl/webhook/server/ServerPushWebhookProcessorTest.java

@@ -66,11 +66,12 @@ class ServerPushWebhookProcessorTest {
     private SCMHeadEvent<?> scmEvent;
     private BitbucketEndpoint endpoint;
 
+    @SuppressWarnings("unused")
     private static JenkinsRule rule;
 
     @BeforeAll
-    static void init(JenkinsRule r) {
-        rule = r;
+    static void init(JenkinsRule rule) {
+        ServerPushWebhookProcessorTest.rule = rule;
     }
 
     @BeforeEach

src/test/java/com/cloudbees/jenkins/plugins/bitbucket/test/util/HookProcessorTestUtil.java

@@ -23,17 +23,17 @@
  */
 package com.cloudbees.jenkins.plugins.bitbucket.test.util;
 
-import java.util.HashMap;
 import java.util.Map;
 import java.util.UUID;
+import org.apache.commons.collections4.map.CaseInsensitiveMap;
 
 public final class HookProcessorTestUtil {
 
     private HookProcessorTestUtil() {
     }
 
     public static Map<String, String> getCloudHeaders() {
-        Map<String, String> headers = new HashMap<>();
+        Map<String, String> headers = new CaseInsensitiveMap<>();
         headers.put("User-Agent", "Bitbucket-Webhooks/2.0");
         headers.put("X-Attempt-Number", "1");
         headers.put("Content-Type", "application/json");
@@ -45,15 +45,15 @@ public static Map<String, String> getCloudHeaders() {
     }
 
     public static Map<String, String> getNativeHeaders() {
-        Map<String, String> headers = new HashMap<>();
+        Map<String, String> headers = new CaseInsensitiveMap<>();
         headers.put("Content-Type", "application/json; charset=utf-8");
         headers.put("X-Request-Id", UUID.randomUUID().toString());
         headers.put("User-Agent", "Atlassian HttpClient 4.2.0 / Bitbucket-9.5.2 (9005002) / Default");
         return headers;
     }
 
     public static Map<String, String> getPluginHeaders() {
-        Map<String, String> headers = new HashMap<>();
+        Map<String, String> headers = new CaseInsensitiveMap<>();
         headers.put("Content-Type", "application/json; charset=utf-8");
         headers.put("X-Bitbucket-Type", "server");
         headers.put("User-Agent", "Bitbucket version: 8.18.0, Post webhook plugin version: 7.13.41-SNAPSHOT");