feat: add package for finding JIRA issue references

pkg/jira/build_regex.go

@@ -0,0 +1,28 @@
+package jira
+
+import "strings"
+
+func buildRegex(keys []string) string {
+	// This is the default regex for JIRA tickets. Please see https://community.atlassian.com/t5/Bitbucket-questions/Regex-pattern-to-match-JIRA-issue-key/qaq-p/233319 for reference
+	if len(keys) == 0 {
+		return `([A-Z]+-[\d]+)`
+	}
+
+	result := strings.Builder{}
+
+	result.WriteString("(")
+
+	for index, key := range keys {
+		result.WriteString(key)
+
+		if (index + 1) != len(keys) {
+			result.WriteString("|")
+		}
+	}
+
+	result.WriteString(")")
+
+	result.WriteString("-[0-9]+")
+
+	return result.String()
+}

pkg/jira/build_regex_test.go

@@ -0,0 +1,18 @@
+package jira
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestBuildRegex(t *testing.T) {
+	tests := map[string][]string{
+		`([A-Z]+-[\d]+)`:          {},
+		`(TEST|PROJ|FEOP)-[0-9]+`: {"TEST", "PROJ", "FEOP"},
+	}
+
+	for expected, test := range tests {
+		assert.Equal(t, expected, buildRegex(test))
+	}
+}

pkg/jira/find_references.go

@@ -0,0 +1,18 @@
+package jira
+
+import (
+	"regexp"
+)
+
+// FindReferences scans a given message looking for all issues that match the keys. Default to the JIRA default regex if no keys are provided.
+func FindReferences(keys []string, message string) ([]string, error) {
+	regex, err := regexp.Compile(buildRegex(keys))
+
+	if err != nil {
+		return nil, err
+	}
+
+	matches := regex.FindAllString(message, -1)
+
+	return matches, nil
+}

pkg/jira/find_references_test.go

@@ -0,0 +1,53 @@
+package jira
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestFindReferences(t *testing.T) {
+	tests := []struct {
+		expected []string
+		keys     []string
+		message  string
+	}{
+		{
+			expected: []string{"TES-1"},
+			keys:     nil,
+			message:  "TES-1: added a tes feature",
+		},
+		{
+			expected: []string{"TES-1"},
+			keys:     []string{"TES"},
+			message:  "TES-1: added a tes feature",
+		},
+		{
+			expected: nil,
+			keys:     []string{"TES"},
+			message:  "REST-1: added a tes feature",
+		},
+		{
+			expected: []string{"REST-1", "TEST-2"},
+			keys:     []string{"TEST", "REST"},
+			message:  "REST-1: added a tes feature TEST-2",
+		},
+		{
+			expected: []string{"TEST-2"},
+			keys:     []string{"TEST"},
+			message:  "REST-1: added a tes feature TEST-2",
+		},
+		{
+			expected: []string{"REST-1", "TEST-2"},
+			keys:     nil,
+			message:  "REST-1: added a tes feature TEST-2",
+		},
+	}
+
+	for _, test := range tests {
+		references, err := FindReferences(test.keys, test.message)
+
+		assert.NoError(t, err)
+		assert.Equal(t, test.expected, references)
+	}
+}