Merge pull request #4 from NHSDigital/dp-APM-2884

Add splunk HEC healthcheck flow

Author: dominicplatt2-nhs

azure/azure-release-pipeline.yml

@@ -34,6 +34,11 @@ extends:
       - environment: internal-dev
         post_deploy:
           - template: ./templates/run-smoke-tests.yml
+      - environment: prod
+        post_deploy:
+          - template: ./templates/run-smoke-tests.yml
+        depends_on:
+          - internal-dev
     #   - environment: internal-qa
     #     post_deploy:
     #       - template: ./templates/run-smoke-tests.yml

proxies/live/apiproxy/policies/AssignMessage.HandleSplunkHec.xml

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<AssignMessage async="false" continueOnError="false" enabled="true" name="AssignMessage.HandleSplunkHec">
+    <DisplayName>AssignMessage.HandleSplunkHec</DisplayName>
+    <Properties/>
+    <Set>
+        <Payload contentType="application/json" variablePrefix="%" variableSuffix="#">
+            {
+                "status_code": %splunkCalloutResponse.status.code#,
+                "content": %splunkCalloutResponse.content#
+            }
+        </Payload>
+        <StatusCode>200</StatusCode>
+        <IgnoreUnresolvedVariables>true</IgnoreUnresolvedVariables>
+        <AssignTo createNew="false" transport="https" type="request"/>
+    </Set>
+</AssignMessage>

proxies/live/apiproxy/proxies/default.xml

@@ -19,22 +19,22 @@
       </Response>
       <Condition>(proxy.pathsuffix MatchesPath "/_ping") and ((request.verb = "GET") or (request.verb = "HEAD"))</Condition>
     </Flow>
-    <Flow name="StatusEndpoint">
+    <Flow name="SplunkStatusMonitor">
       <Request>
         <Step>
           <Condition>request.header.apikey = null or private.common.status-endpoint-api-key != request.header.apikey</Condition>
           <Name>RaiseFault.401Unauthorized</Name>
         </Step>
         <Step>
-          <Name>ServiceCallout.CallHealthcheckEndpoint</Name>
+          <Name>FlowCallout.LogToSplunk</Name>
         </Step>
       </Request>
       <Response>
         <Step>
-          <Name>javascript.SetStatusResponse</Name>
+          <Name>AssignMessage.HandleSplunkHec</Name>
         </Step>
       </Response>
-      <Condition>(proxy.pathsuffix MatchesPath "/_status") and ((request.verb = "GET") or (request.verb = "HEAD"))
+      <Condition>((proxy.pathsuffix MatchesPath "/status") and (request.verb = "GET")) or ((proxy.pathsuffix MatchesPath "/_status") and ((request.verb = "GET") or (request.verb = "HEAD")))
       </Condition>
     </Flow>
   </Flows>
@@ -59,9 +59,15 @@
   <RouteRule name="NoRouteStatus">
     <Condition>(proxy.pathsuffix MatchesPath "/_status") and ((request.verb = "GET") or (request.verb = "HEAD"))</Condition>
   </RouteRule>
-  <RouteRule name="splunk-monitor-target">
-    <TargetEndpoint>splunk-monitor-target</TargetEndpoint>
-  </RouteRule>
+  <FaultRules>
+    <FaultRule name="SplunkError">
+      <Step>
+        <Name>AssignMessage.HandleSplunkHec</Name>
+      </Step>
+      <Condition>(((proxy.pathsuffix MatchesPath "/status") and (request.verb = "GET")) or ((proxy.pathsuffix MatchesPath "/_status") and ((request.verb = "GET") or (request.verb = "HEAD")))) and (splunkCalloutResponse isNot null)
+      </Condition>
+    </FaultRule>
+  </FaultRules>
   <DefaultFaultRule>
     <Step>
       <Name>AssignMessage.Errors.CatchAllMessage</Name>

tests/api_tests.py

@@ -20,6 +20,10 @@ async def is_401(resp: ClientResponse) -> bool:
     return resp.status == 401
 
 
+async def is_200(resp: ClientResponse) -> bool:
+    return resp.status == 200
+
+
 @pytest.mark.e2e
 @pytest.mark.smoketest
 def test_output_test_config(api_test_config: APITestSessionConfig):
@@ -65,11 +69,8 @@ async def test_wait_for_status(api_client: APISessionClient, api_test_config: AP
         test for _status ..  this uses poll_until to wait until the correct SOURCE_COMMIT_ID ( from env var )
         is available
     """
-
-    is_deployed = partial(_is_deployed, api_test_config=api_test_config)
-
     await poll_until(
         make_request=lambda: api_client.get('_status', headers={'apikey': env.status_endpoint_api_key()}),
-        until=is_deployed,
+        until=is_200,
         timeout=120
     )