test markdown escaping

CHANGELOG.md

@@ -5,4 +5,5 @@
 - Minor: Moderator commands now also check for server ownership in addition to moderator role
 - Minor: Add ability to configure various uncategorized values using the `$configure value` command. Use `$configure value keys` to see a list of valid keys and their description. (#46)
 - Minor: The \$points command now has a configurable pajbot host instead of pointing at `forsen.tv`. Set it with `$configure value set pajbot_host forsen.tv`. (#46)
-- Minor: Added $8ball command
+- Minor: Added \$8ball command
+- Bugfix: Markdown escaping did not escape \` and handle backslashes properly

go.mod

@@ -8,6 +8,7 @@ require (
 	github.com/davecgh/go-spew v1.1.1 // indirect
 	github.com/dghubble/go-twitter v0.0.0-20190719072343-39e5462e111f
 	github.com/dghubble/oauth1 v0.7.0
+	github.com/frankban/quicktest v1.13.0
 	github.com/gorilla/websocket v1.4.2 // indirect
 	github.com/jessevdk/go-flags v1.5.0
 	github.com/lib/pq v1.10.1

go.sum

@@ -14,6 +14,10 @@ github.com/dghubble/oauth1 v0.7.0 h1:AlpZdbRiJM4XGHIlQ8BuJ/wlpGwFEJNnB4Mc+78tA/w
 github.com/dghubble/oauth1 v0.7.0/go.mod h1:8pFdfPkv/jr8mkChVbNVuJ0suiHe278BtWI4Tk1ujxk=
 github.com/dghubble/sling v1.3.0 h1:pZHjCJq4zJvc6qVQ5wN1jo5oNZlNE0+8T/h0XeXBUKU=
 github.com/dghubble/sling v1.3.0/go.mod h1:XXShWaBWKzNLhu2OxikSNFrlsvowtz4kyRuXUG7oQKY=
+github.com/frankban/quicktest v1.13.0 h1:yNZif1OkDfNoDfb9zZa9aXIpejNR4F23Wely0c+Qdqk=
+github.com/frankban/quicktest v1.13.0/go.mod h1:qLE0fzW0VuyUAJgPU19zByoIr0HtCHN/r/VLSOOIySU=
+github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
+github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
 github.com/google/go-querystring v1.0.0 h1:Xkwi/a1rcvNg1PPYe5vI8GbeBY/jrVuDX5ASuANWTrk=
 github.com/google/go-querystring v1.0.0/go.mod h1:odCYkC5MyYFN7vkCjXpyrEuKhc/BUO6wN/zVPAxq5ck=
 github.com/gorilla/websocket v1.4.0/go.mod h1:E7qHFY5m1UJ88s3WnNqhKjPHQ0heANvMoAMk2YaljkQ=
@@ -22,6 +26,8 @@ github.com/gorilla/websocket v1.4.2/go.mod h1:YR8l580nyteQvAITg2hZ9XVh4b55+EU/ad
 github.com/jessevdk/go-flags v1.5.0 h1:1jKYvbxEjfUl0fmqTCOfonvskHHXMjBySTLW4y9LFvc=
 github.com/jessevdk/go-flags v1.5.0/go.mod h1:Fw0T6WPc1dYxT4mKEZRfG5kJhaTDP9pj1c2EWnYs/m4=
 github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
+github.com/kr/pretty v0.2.1 h1:Fmg33tUaq4/8ym9TJN1x7sLJnHVwhP33CNkpYV/7rwI=
+github.com/kr/pretty v0.2.1/go.mod h1:ipq/a2n7PKx3OHsz4KJII5eveXtPO4qwEXGdVfWzfnI=
 github.com/kr/pty v1.1.1/go.mod h1:pFQYn66WHrOpPYNljwOMqo10TkYh1fy3cYio2l3bCsQ=
 github.com/kr/text v0.1.0 h1:45sCR5RtlFHMR4UwH9sdQ5TC8v0qDQCHnXt+kaKSTVE=
 github.com/kr/text v0.1.0/go.mod h1:4Jbv+DJW3UT/LiOwJeYQe1efqtUx/iVham/4vfdArNI=
@@ -76,6 +82,7 @@ golang.org/x/tools v0.1.0 h1:po9/4sTYwZU9lPhi1tOrb4hCv3qrhiQ77LZfGa2OjwY=
 golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0=
 golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 h1:go1bK/D/BFZV2I8cIQd1NKEZ+0owSTG1fDTci4IqFcE=
 golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=

pkg/utils/fragments.go

@@ -2,16 +2,17 @@ package utils
 
 import (
 	"fmt"
-	"github.com/bwmarrin/discordgo"
 	"regexp"
+
+	"github.com/bwmarrin/discordgo"
 )
 
 var (
-	markdownRegex = regexp.MustCompile(`[_*~|]{1,2}|\\x60{1,3}`)
+	markdownRegex = regexp.MustCompile(`([\\\x60_*~|])`)
 )
 
 func EscapeMarkdown(s string) string {
-	return markdownRegex.ReplaceAllString(s, "\\\\$0")
+	return markdownRegex.ReplaceAllString(s, `\$1`)
 }
 
 func MentionMember(member *discordgo.Member) string {

pkg/utils/fragments_test.go

@@ -0,0 +1,78 @@
+package utils
+
+import (
+	"testing"
+
+	qt "github.com/frankban/quicktest"
+)
+
+func TestEscapeMarkdown(t *testing.T) {
+	c := qt.New(t)
+
+	tests := []struct {
+		input    string
+		expected string
+	}{
+		{
+			input:    "asd",
+			expected: "asd",
+		},
+		{
+			input:    `cool~`,
+			expected: `cool\~`,
+		},
+		{
+			input:    `cool_`,
+			expected: `cool\_`,
+		},
+		{
+			input:    `cool_man_`,
+			expected: `cool\_man\_`,
+		},
+		{
+			input:    `**`,
+			expected: `\*\*`,
+		},
+		{
+			input:    `cool*`,
+			expected: `cool\*`,
+		},
+		{
+			input:    `||spoiler||`,
+			expected: `\|\|spoiler\|\|`,
+		},
+		{
+			input:    `*cool`,
+			expected: `\*cool`,
+		},
+		{
+			input:    `\\*`,
+			expected: `\\\\\*`,
+		},
+		{
+			input:    `cool\*`,
+			expected: `cool\\\*`,
+		},
+		{
+			input:    `cool\**`,
+			expected: `cool\\\*\*`,
+		},
+		{
+			input:    `****`,
+			expected: `\*\*\*\*`,
+		},
+		{
+			input:    `\****`,
+			expected: `\\\*\*\*\*`,
+		},
+		{
+			input:    "cool`",
+			expected: "cool\\`",
+		},
+	}
+
+	for _, test := range tests {
+		actual := EscapeMarkdown(test.input)
+		c.Assert(actual, qt.Equals, test.expected)
+	}
+}