Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions server/instance.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ package main

import (
"net/http"
"strings"

"github.com/mattermost/mattermost-plugin-jira/server/utils/types"
)
Expand Down Expand Up @@ -72,3 +73,7 @@ func (ic *InstanceCommon) Common() *InstanceCommon {
func (ic InstanceCommon) IsCloudInstance() bool {
return ic.Type == CloudInstanceType || ic.Type == CloudOAuthInstanceType
}

func normalizeJiraBaseURL(baseURL string) string {
return strings.TrimRight(baseURL, "/")
}
Comment thread
coderabbitai[bot] marked this conversation as resolved.
6 changes: 3 additions & 3 deletions server/instance_cloud.go
Original file line number Diff line number Diff line change
Expand Up @@ -192,15 +192,15 @@ func (ci *cloudInstance) GetURL() string {
}

func (ci *cloudInstance) GetJiraBaseURL() string {
return ci.GetURL()
return normalizeJiraBaseURL(ci.GetURL())
}

func (ci *cloudInstance) GetManageAppsURL() string {
return fmt.Sprintf("%s/plugins/servlet/upm", ci.GetURL())
return fmt.Sprintf("%s/plugins/servlet/upm", ci.GetJiraBaseURL())
}

func (ci *cloudInstance) GetManageWebhooksURL() string {
return cloudManageWebhooksURL(ci.GetURL())
return cloudManageWebhooksURL(ci.GetJiraBaseURL())
}

func cloudManageWebhooksURL(jiraURL string) string {
Expand Down
4 changes: 2 additions & 2 deletions server/instance_cloud_oauth.go
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ func (p *Plugin) installCloudOAuthInstance(rawURL string) (string, *cloudOAuthIn
newInstance := &cloudOAuthInstance{
InstanceCommon: newInstanceCommon(p, CloudOAuthInstanceType, types.ID(jiraURL)),
MattermostKey: p.GetPluginKey(),
JiraBaseURL: rawURL,
JiraBaseURL: jiraURL,
CodeVerifier: params.CodeVerifier,
CodeChallenge: params.CodeChallenge,
}
Expand Down Expand Up @@ -226,7 +226,7 @@ func (ci *cloudOAuthInstance) GetURL() string {
}

func (ci *cloudOAuthInstance) GetJiraBaseURL() string {
return ci.JiraBaseURL
return normalizeJiraBaseURL(ci.JiraBaseURL)
}

func (ci *cloudOAuthInstance) GetManageAppsURL() string {
Expand Down
6 changes: 3 additions & 3 deletions server/instance_server.go
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,15 @@ func (si *serverInstance) GetURL() string {
}

func (si *serverInstance) GetJiraBaseURL() string {
return si.GetURL()
return normalizeJiraBaseURL(si.GetURL())
}

func (si *serverInstance) GetManageAppsURL() string {
return fmt.Sprintf("%s/plugins/servlet/applinks/listApplicationLinks", si.GetURL())
return fmt.Sprintf("%s/plugins/servlet/applinks/listApplicationLinks", si.GetJiraBaseURL())
}

func (si *serverInstance) GetManageWebhooksURL() string {
return fmt.Sprintf("%s/plugins/servlet/webhooks", si.GetURL())
return fmt.Sprintf("%s/plugins/servlet/webhooks", si.GetJiraBaseURL())
}

func (si *serverInstance) GetMattermostKey() string {
Expand Down
54 changes: 54 additions & 0 deletions server/instance_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
// Copyright (c) 2017-present Mattermost, Inc. All Rights Reserved.
// See LICENSE.txt for license information.

package main

import (
"testing"

"github.com/stretchr/testify/assert"

"github.com/mattermost/mattermost-plugin-jira/server/utils/types"
)

func TestGetJiraBaseURLTrimsTrailingSlash(t *testing.T) {
for name, tc := range map[string]struct {
instance Instance
expected string
}{
"cloud-oauth, no trailing slash": {
instance: &cloudOAuthInstance{JiraBaseURL: "https://mmtest.atlassian.net"},
expected: "https://mmtest.atlassian.net",
},
"cloud-oauth, trailing slash": {
instance: &cloudOAuthInstance{JiraBaseURL: "https://mmtest.atlassian.net/"},
expected: "https://mmtest.atlassian.net",
},
"cloud-oauth, repeated trailing slashes": {
instance: &cloudOAuthInstance{JiraBaseURL: "https://mmtest.atlassian.net///"},
expected: "https://mmtest.atlassian.net",
},
"cloud, trailing slash": {
instance: &cloudInstance{
AtlassianSecurityContext: &AtlassianSecurityContext{BaseURL: "https://mmtest.atlassian.net/"},
},
expected: "https://mmtest.atlassian.net",
},
"server, trailing slash": {
instance: &serverInstance{
InstanceCommon: &InstanceCommon{InstanceID: types.ID("https://jira.example.com/")},
},
expected: "https://jira.example.com",
},
"server, no trailing slash": {
instance: &serverInstance{
InstanceCommon: &InstanceCommon{InstanceID: types.ID("https://jira.example.com")},
},
expected: "https://jira.example.com",
},
} {
t.Run(name, func(t *testing.T) {
assert.Equal(t, tc.expected, tc.instance.GetJiraBaseURL())
})
}
}
4 changes: 2 additions & 2 deletions server/plugin.go
Original file line number Diff line number Diff line change
Expand Up @@ -509,7 +509,7 @@ func (p *Plugin) AddAutolinksForCloudInstance(ci *cloudInstance) error {
return fmt.Errorf("unable to get project keys: %w", err)
}

return p.AddAutoLinkForProjects(plist, ci.BaseURL)
return p.AddAutoLinkForProjects(plist, ci.GetJiraBaseURL())
}

func (p *Plugin) AddAutolinksForCloudOAuthInstance(coi *cloudOAuthInstance) error {
Expand All @@ -518,7 +518,7 @@ func (p *Plugin) AddAutolinksForCloudOAuthInstance(coi *cloudOAuthInstance) erro
return fmt.Errorf("error getting project list: %w", err)
}

return p.AddAutoLinkForProjects(*plist, coi.JiraBaseURL)
return p.AddAutoLinkForProjects(*plist, coi.GetJiraBaseURL())
Comment thread
coderabbitai[bot] marked this conversation as resolved.
}

func (p *Plugin) AddAutoLinkForProjects(plist jira.ProjectList, baseURL string) error {
Expand Down
46 changes: 46 additions & 0 deletions server/plugin_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,22 @@ package main

import (
"bytes"
"encoding/json"
"io"
"net/http"
"net/http/httptest"
"os"
"testing"

jira "github.com/andygrunwald/go-jira"
"github.com/mattermost-community/mattermost-plugin-autolink/server/autolink"
"github.com/mattermost/mattermost/server/public/model"
"github.com/mattermost/mattermost/server/public/plugin"
"github.com/mattermost/mattermost/server/public/plugin/plugintest"
"github.com/mattermost/mattermost/server/public/plugin/plugintest/mock"
"github.com/mattermost/mattermost/server/public/pluginapi"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
)

const (
Expand Down Expand Up @@ -269,6 +273,48 @@ func TestSetupAutolink(t *testing.T) {
}
}

func TestAddAutoLinkForProjectsNormalizesBaseURL(t *testing.T) {
rawURL := "https://mmtest.atlassian.net///"
accessorURL := (&cloudInstance{
AtlassianSecurityContext: &AtlassianSecurityContext{BaseURL: rawURL},
}).GetJiraBaseURL()

for name, baseURL := range map[string]string{
"no trailing slash": "https://mmtest.atlassian.net",
"trailing slash": "https://mmtest.atlassian.net/",
"repeated trailing slashes": rawURL,
"normalized by accessor": accessorURL,
} {
t.Run(name, func(t *testing.T) {
mockAPI := &plugintest.API{}
var installed []autolink.Autolink
mockAPI.On("PluginHTTP", mock.AnythingOfType("*http.Request")).Return(
&http.Response{StatusCode: http.StatusOK, Body: http.NoBody},
).Run(func(args mock.Arguments) {
req := args.Get(0).(*http.Request)
body, err := io.ReadAll(req.Body)
require.NoError(t, err)

var link autolink.Autolink
require.NoError(t, json.Unmarshal(body, &link))
installed = append(installed, link)
})

p := &Plugin{}
p.SetAPI(mockAPI)

require.NoError(t, p.AddAutoLinkForProjects(jira.ProjectList{{Key: "TES"}}, baseURL))

require.Len(t, installed, 2)
for _, link := range installed {
assert.NotContains(t, link.Template, "net//browse/")
assert.Contains(t, link.Template, "https://mmtest.atlassian.net/browse/TES-${jira_id}")
}
assert.Contains(t, installed[1].Pattern, `https://mmtest\.atlassian\.net/browse/`)
})
}
}

func GetConfigSetterFunction() func(*config) {
return func(c *config) {
c.AdminAPIToken = MockAPIToken
Expand Down
Loading