implement PUT /hooks/outgoing/{hook_id} - update outgoing hook (#5793)

Этот коммит содержится в:
Carlos Tadeu Panato Junior
2017-03-21 12:56:42 +01:00
коммит произвёл George Goldberg
родитель 32c658b1ce
Коммит 4968ef0759
3 изменённых файлов: 221 добавлений и 0 удалений

Просмотреть файл

@@ -23,6 +23,7 @@ func InitWebhook() {
BaseRoutes.OutgoingHooks.Handle("", ApiSessionRequired(createOutgoingHook)).Methods("POST")
BaseRoutes.OutgoingHooks.Handle("", ApiSessionRequired(getOutgoingHooks)).Methods("GET")
BaseRoutes.OutgoingHook.Handle("", ApiSessionRequired(updateOutcomingHook)).Methods("PUT")
BaseRoutes.OutgoingHook.Handle("/regen_token", ApiSessionRequired(regenOutgoingHookToken)).Methods("POST")
}
@@ -224,6 +225,49 @@ func deleteIncomingHook(c *Context, w http.ResponseWriter, r *http.Request) {
}
}
func updateOutcomingHook(c *Context, w http.ResponseWriter, r *http.Request) {
c.RequireHookId()
if c.Err != nil {
return
}
toUpdateHook := model.OutgoingWebhookFromJson(r.Body)
if toUpdateHook == nil {
c.SetInvalidParam("outgoing_webhook")
return
}
c.LogAudit("attempt")
toUpdateHook.CreatorId = c.Session.UserId
if !app.SessionHasPermissionToTeam(c.Session, toUpdateHook.TeamId, model.PERMISSION_MANAGE_WEBHOOKS) {
c.SetPermissionError(model.PERMISSION_MANAGE_WEBHOOKS)
return
}
oldHook, err := app.GetOutgoingWebhook(toUpdateHook.Id)
if err != nil {
c.Err = err
return
}
if c.Session.UserId != oldHook.CreatorId && !app.SessionHasPermissionToTeam(c.Session, oldHook.TeamId, model.PERMISSION_MANAGE_OTHERS_WEBHOOKS) {
c.LogAudit("fail - inappropriate permissions")
c.SetPermissionError(model.PERMISSION_MANAGE_OTHERS_WEBHOOKS)
return
}
rhook, err := app.UpdateOutgoingWebhook(oldHook, toUpdateHook)
if err != nil {
c.Err = err
return
}
c.LogAudit("success")
w.Write([]byte(rhook.ToJson()))
}
func createOutgoingHook(c *Context, w http.ResponseWriter, r *http.Request) {
hook := model.OutgoingWebhookFromJson(r.Body)
if hook == nil {

Просмотреть файл

@@ -625,3 +625,170 @@ func TestRegenOutgoingHookToken(t *testing.T) {
_, resp = th.SystemAdminClient.RegenOutgoingHookToken(rhook.Id)
CheckNotImplementedStatus(t, resp)
}
func TestUpdateOutgoingHook(t *testing.T) {
th := Setup().InitBasic().InitSystemAdmin()
defer TearDown()
Client := th.Client
enableOutgoingHooks := utils.Cfg.ServiceSettings.EnableOutgoingWebhooks
enableAdminOnlyHooks := utils.Cfg.ServiceSettings.EnableOnlyAdminIntegrations
defer func() {
utils.Cfg.ServiceSettings.EnableOutgoingWebhooks = enableOutgoingHooks
utils.Cfg.ServiceSettings.EnableOnlyAdminIntegrations = enableAdminOnlyHooks
utils.SetDefaultRolesBasedOnConfig()
}()
utils.Cfg.ServiceSettings.EnableOutgoingWebhooks = true
*utils.Cfg.ServiceSettings.EnableOnlyAdminIntegrations = true
utils.SetDefaultRolesBasedOnConfig()
createdHook := &model.OutgoingWebhook{ChannelId: th.BasicChannel.Id, TeamId: th.BasicChannel.TeamId,
CallbackURLs: []string{"http://nowhere.com"}, TriggerWords: []string{"cats"}}
createdHook, resp := th.SystemAdminClient.CreateOutgoingWebhook(createdHook)
CheckNoError(t, resp)
t.Run("UpdateOutgoingWebhook", func(t *testing.T) {
createdHook.DisplayName = "Cats"
createdHook.Description = "Get me some cats"
updatedHook, resp := th.SystemAdminClient.UpdateOutgoingWebhook(createdHook)
CheckNoError(t, resp)
if updatedHook.DisplayName != "Cats" {
t.Fatal("did not update")
}
if updatedHook.Description != "Get me some cats" {
t.Fatal("did not update")
}
})
t.Run("OutgoingHooksDisabled", func(t *testing.T) {
utils.Cfg.ServiceSettings.EnableOutgoingWebhooks = false
_, resp := th.SystemAdminClient.UpdateOutgoingWebhook(createdHook)
CheckNotImplementedStatus(t, resp)
})
utils.Cfg.ServiceSettings.EnableOutgoingWebhooks = true
t.Run("RetainCreateAt", func(t *testing.T) {
hook2 := &model.OutgoingWebhook{ChannelId: th.BasicChannel.Id, TeamId: th.BasicChannel.TeamId,
CallbackURLs: []string{"http://nowhere.com"}, TriggerWords: []string{"rats"}}
createdHook2, resp := th.SystemAdminClient.CreateOutgoingWebhook(hook2)
CheckNoError(t, resp)
createdHook2.DisplayName = "Name2"
updatedHook2, resp := th.SystemAdminClient.UpdateOutgoingWebhook(createdHook2)
CheckNoError(t, resp)
if updatedHook2.CreateAt != createdHook2.CreateAt {
t.Fatal("failed - hook create at should not be changed")
}
})
t.Run("ModifyUpdateAt", func(t *testing.T) {
createdHook.DisplayName = "Name3"
updatedHook2, resp := th.SystemAdminClient.UpdateOutgoingWebhook(createdHook)
CheckNoError(t, resp)
if updatedHook2.UpdateAt == createdHook.UpdateAt {
t.Fatal("failed - hook updateAt is not updated")
}
})
t.Run("UpdateNonExistentHook", func(t *testing.T) {
nonExistentHook := &model.OutgoingWebhook{ChannelId: th.BasicChannel.Id, TeamId: th.BasicChannel.TeamId,
CallbackURLs: []string{"http://nowhere.com"}, TriggerWords: []string{"rats"}}
_, resp := th.SystemAdminClient.UpdateOutgoingWebhook(nonExistentHook)
CheckNotFoundStatus(t, resp)
nonExistentHook.Id = model.NewId()
_, resp = th.SystemAdminClient.UpdateOutgoingWebhook(nonExistentHook)
CheckInternalErrorStatus(t, resp)
})
t.Run("UserIsNotAdminOfTeam", func(t *testing.T) {
_, resp := Client.UpdateOutgoingWebhook(createdHook)
CheckForbiddenStatus(t, resp)
})
*utils.Cfg.ServiceSettings.EnableOnlyAdminIntegrations = false
utils.SetDefaultRolesBasedOnConfig()
hook2 := &model.OutgoingWebhook{ChannelId: th.BasicChannel.Id, TeamId: th.BasicChannel.TeamId,
CallbackURLs: []string{"http://nowhere.com"}, TriggerWords: []string{"rats2"}}
createdHook2, resp := th.SystemAdminClient.CreateOutgoingWebhook(hook2)
CheckNoError(t, resp)
_, resp = Client.UpdateOutgoingWebhook(createdHook2)
CheckForbiddenStatus(t, resp)
*utils.Cfg.ServiceSettings.EnableOnlyAdminIntegrations = true
utils.SetDefaultRolesBasedOnConfig()
Client.Logout()
UpdateUserToTeamAdmin(th.BasicUser2, th.BasicTeam)
th.LoginBasic2()
t.Run("RetainHookCreator", func(t *testing.T) {
createdHook.DisplayName = "Basic user 2"
updatedHook, resp := Client.UpdateOutgoingWebhook(createdHook)
CheckNoError(t, resp)
if updatedHook.DisplayName != "Basic user 2" {
t.Fatal("should apply the change")
}
if updatedHook.CreatorId != th.SystemAdminUser.Id {
t.Fatal("hook creator should not be changed")
}
})
t.Run("UpdateToExistingTriggerWordAndCallback", func(t *testing.T) {
t.Run("OnSameChannel", func(t *testing.T) {
createdHook.TriggerWords = []string{"rats"}
_, resp := th.SystemAdminClient.UpdateOutgoingWebhook(createdHook)
CheckBadRequestStatus(t, resp)
})
t.Run("OnDifferentChannel", func(t *testing.T) {
createdHook.TriggerWords = []string{"cats"}
createdHook.ChannelId = th.BasicChannel2.Id
_, resp := th.SystemAdminClient.UpdateOutgoingWebhook(createdHook)
CheckNoError(t, resp)
})
})
t.Run("UpdateToNonExistentChannel", func(t *testing.T) {
createdHook.ChannelId = "junk"
_, resp := th.SystemAdminClient.UpdateOutgoingWebhook(createdHook)
CheckNotFoundStatus(t, resp)
})
t.Run("UpdateToPrivateChannel", func(t *testing.T) {
privateChannel := th.CreatePrivateChannel()
createdHook.ChannelId = privateChannel.Id
_, resp := th.SystemAdminClient.UpdateOutgoingWebhook(createdHook)
CheckForbiddenStatus(t, resp)
})
t.Run("UpdateToBlankTriggerWordAndChannel", func(t *testing.T) {
createdHook.ChannelId = ""
createdHook.TriggerWords = nil
_, resp := th.SystemAdminClient.UpdateOutgoingWebhook(createdHook)
CheckInternalErrorStatus(t, resp)
})
team := th.CreateTeamWithClient(Client)
user := th.CreateUserWithClient(Client)
LinkUserToTeam(user, team)
Client.Logout()
Client.Login(user.Id, user.Password)
t.Run("UpdateToADifferentTeam", func(t *testing.T) {
_, resp := Client.UpdateOutgoingWebhook(createdHook)
CheckUnauthorizedStatus(t, resp)
})
}

Просмотреть файл

@@ -1300,6 +1300,16 @@ func (c *Client4) CreateOutgoingWebhook(hook *OutgoingWebhook) (*OutgoingWebhook
}
}
// UpdateOutgoingWebhook creates an outgoing webhook for a team or channel.
func (c *Client4) UpdateOutgoingWebhook(hook *OutgoingWebhook) (*OutgoingWebhook, *Response) {
if r, err := c.DoApiPut(c.GetOutgoingWebhookRoute(hook.Id), hook.ToJson()); err != nil {
return nil, &Response{StatusCode: r.StatusCode, Error: err}
} else {
defer closeBody(r)
return OutgoingWebhookFromJson(r.Body), BuildResponse(r)
}
}
// GetOutgoingWebhooks returns a page of outgoing webhooks on the system. Page counting starts at 0.
func (c *Client4) GetOutgoingWebhooks(page int, perPage int, etag string) ([]*OutgoingWebhook, *Response) {
query := fmt.Sprintf("?page=%v&per_page=%v", page, perPage)