Fix for issue 4998 - Web Hook Rules check http headers in case sensitive manner

CHANGELOG.rst

@@ -71,6 +71,12 @@ Added
 
   Contributed by @khushboobhatia01
 
+* Added `trigger.headers_lower` to webhook trigger payload. This allows rules to match webhook triggers
+  without dealing with the case-sensitive nature of `trigger.headers`, as `triggers.headers_lower` providers
+  the same headers, but with the header name lower cased. #5038
+
+  Contributed by @Rand01ph
+
 Fixed
 ~~~~~
 

st2api/st2api/controllers/v1/webhooks.py

@@ -172,6 +172,7 @@ def post(self, hook, webhook_body_api, headers, requester_user):
             payload = {}
 
             payload["headers"] = headers
+            payload["headers_lower"] = {k.lower(): v for k, v in headers.items()}
             payload["body"] = body
 
             # Dispatch trigger instance for each of the trigger found

st2api/tests/unit/controllers/v1/test_webhooks.py

@@ -388,6 +388,33 @@ def test_authentication_headers_should_be_removed(self, dispatch_mock):
         )
         self.assertNotIn("Cookie", dispatch_mock.call_args[1]["payload"]["headers"])
 
+    @mock.patch.object(
+        TriggerInstancePublisher, "publish_trigger", mock.MagicMock(return_value=True)
+    )
+    @mock.patch.object(
+        WebhooksController, "_is_valid_hook", mock.MagicMock(return_value=True)
+    )
+    @mock.patch.object(
+        HooksHolder,
+        "get_triggers_for_hook",
+        mock.MagicMock(return_value=[DUMMY_TRIGGER_DICT]),
+    )
+    @mock.patch("st2common.transport.reactor.TriggerDispatcher.dispatch")
+    def test_st2_webhook_lower_header(self, dispatch_mock):
+        data = WEBHOOK_1
+        post_resp = self.__do_post(
+            "git", data, headers={"X-Github-Token": "customvalue"}
+        )
+        self.assertEqual(post_resp.status_int, http_client.ACCEPTED)
+        self.assertEqual(
+            dispatch_mock.call_args[1]["payload"]["headers"]["X-Github-Token"],
+            "customvalue",
+        )
+        self.assertEqual(
+            dispatch_mock.call_args[1]["payload"]["headers_lower"]["x-github-token"],
+            "customvalue",
+        )
+
     def __do_post(self, hook, webhook, expect_errors=False, headers=None):
         return self.app.post_json(
             "/v1/webhooks/" + hook,