Add templating function to check journal key

Author: tommysitu

core/templating/template_helpers.go

@@ -180,6 +180,13 @@ func (t templateHelpers) parseJournalBasedOnIndex(indexName, keyValue, dataSourc
 	return getEvaluationString("journal", options)
 }
 
+func (t templateHelpers) hasJournalKey(indexName, keyValue string, options *raymond.Options) bool {
+	journalDetails := options.Value("Journal").(Journal)
+	journalEntry, _ := getIndexEntry(journalDetails, indexName, keyValue)
+
+	return journalEntry != nil
+}
+
 func (t templateHelpers) setStatusCode(statusCode int, options *raymond.Options) string {
 	internalVars := options.ValueFromAllCtx("InternalVars").(map[string]interface{})
 	internalVars["statusCode"] = statusCode

core/templating/templating.go

@@ -91,6 +91,7 @@ func NewTemplator() *Templator {
 	helperMethodMap["requestBody"] = t.requestBody
 	helperMethodMap["csv"] = t.parseCsv
 	helperMethodMap["journal"] = t.parseJournalBasedOnIndex
+	helperMethodMap["hasJournalKey"] = t.hasJournalKey
 	helperMethodMap["setStatusCode"] = t.setStatusCode
 	helperMethodMap["sum"] = t.sum
 	helperMethodMap["add"] = t.add

functional-tests/core/ft_journal_indexing_test.go

@@ -6,6 +6,7 @@ import (
 	"github.com/dghubble/sling"
 	. "github.com/onsi/ginkgo"
 	. "github.com/onsi/gomega"
+	"io"
 	"io/ioutil"
 	"net/http"
 	"net/http/httptest"
@@ -57,6 +58,15 @@ var _ = Describe("Manage journal indexing in hoverfly", func() {
 
 				Expect(string(body)).To(Equal("Application Testing"))
 
+				// hasJournalKey function should return true
+				simulationResponse = hoverfly.Proxy(sling.New().Get("http://test-server.com/checkJournalKey"))
+				Expect(simulationResponse.StatusCode).To(Equal(200))
+
+				body, err = io.ReadAll(simulationResponse.Body)
+				Expect(err).To(BeNil())
+
+				Expect(string(body)).To(Equal("123: true 345: false"))
+
 			})
 		})
 

functional-tests/testdata/templating_enabled.go

@@ -60,31 +60,56 @@ var V3TemplatingEnabled = `{
 }`
 
 var JournalTemplatingWithQueryParamIndexEnabled = `{
-    "data": {
-        "pairs": [
-            {
-                "response": {
-                    "status": 200,
-                    "body": "{{ journal 'Request.QueryParam.id' '123' 'Response' 'jsonpath' '$.name' }}",
-                    "encodedBody": false,
-                    "templated" : true
-                },
-                "request": {
-                    "method": {
-						"exactMatch": "GET"
-                    }
-                }
-            }
-        ],
-        "globalActions": {
-            "delays": []
-        }
-    },
-    "meta": {
-        "schemaVersion": "v3",
-        "hoverflyVersion": "v0.10.2",
-        "timeExported": "2017-02-23T12:43:48Z"
-    }
+	"data": {
+		"pairs": [
+			{
+				"request": {
+					"method": [
+						{
+							"matcher": "exact",
+							"value": "GET"
+						}
+					]
+				},
+				"response": {
+					"status": 200,
+					"body": "{{ journal 'Request.QueryParam.id' '123' 'Response' 'jsonpath' '$.name' }}",
+					"encodedBody": false,
+					"templated": true
+				}
+			},
+			{
+				"request": {
+					"method": [
+						{
+							"matcher": "exact",
+							"value": "GET"
+						}
+					],
+					"path": [
+						{
+							"matcher": "exact",
+							"value": "/checkJournalKey"
+						}
+					]
+				},
+				"response": {
+					"status": 200,
+					"body": "123: {{ hasJournalKey 'Request.QueryParam.id' '123' }} 345: {{ hasJournalKey 'Request.QueryParam.id' '345' }}",
+					"encodedBody": false,
+					"templated": true
+				}
+			}
+		],
+		"globalActions": {
+			"delays": [],
+			"delaysLogNormal": []
+		}
+	},
+	"meta": {
+		"schemaVersion": "v5.2",
+		"hoverflyVersion": "v1.9.3"
+	}
 }`
 
 var JournalTemplatingWithBodyIndexEnabled = `{