mirror of
https://codeberg.org/forgejo/forgejo.git
synced 2025-07-27 17:28:34 +00:00
Actions Failure, Succes, Recover Webhooks (#7508)
Implement Actions Success, Failure and Recover webhooks for Forgejo, Gitea, Gogs, Slack, Discord, DingTalk, Telegram, Microsoft Teams, Feishu / Lark Suite, Matrix, WeCom (Wechat Work), Packagist. Some of these webhooks have not been manually tested. Implement settings for these new webhooks. ## Checklist The [contributor guide](https://forgejo.org/docs/next/contributor/) contains information that will be helpful to first time contributors. There also are a few [conditions for merging Pull Requests in Forgejo repositories](https://codeberg.org/forgejo/governance/src/branch/main/PullRequestsAgreement.md). You are also welcome to join the [Forgejo development chatroom](https://matrix.to/#/#forgejo-development:matrix.org). ### Tests - I added test coverage for Go changes... - [x] in their respective `*_test.go` for unit tests. - [x] in the `tests/integration` directory if it involves interactions with a live Forgejo server. - I added test coverage for JavaScript changes... - [ ] in `web_src/js/*.test.js` if it can be unit tested. - [ ] in `tests/e2e/*.test.e2e.js` if it requires interactions with a live Forgejo server (see also the [developer guide for JavaScript testing](https://codeberg.org/forgejo/forgejo/src/branch/forgejo/tests/e2e/README.md#end-to-end-tests)). ### Documentation - [ ] I created a pull request [to the documentation](https://codeberg.org/forgejo/docs) to explain to Forgejo users how to use this change. - [x] I did not document these changes and I do not expect someone else to do it. ### Release notes - [ ] I do not want this change to show in the release notes. - [x] I want the title to show in the release notes with a link to this pull request. - [ ] I want the content of the `release-notes/<pull request number>.md` to be be used for the release notes instead of the title. <!--start release-notes-assistant--> ## Release notes <!--URL:https://codeberg.org/forgejo/forgejo--> - Features - [PR](https://codeberg.org/forgejo/forgejo/pulls/7508): <!--number 7508 --><!--line 0 --><!--description QWN0aW9ucyBGYWlsdXJlLCBTdWNjZXMsIFJlY292ZXIgV2ViaG9va3M=-->Actions Failure, Succes, Recover Webhooks<!--description--> <!--end release-notes-assistant--> Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/7508 Reviewed-by: Earl Warren <earl-warren@noreply.codeberg.org> Co-authored-by: christopher-besch <mail@chris-besch.com> Co-committed-by: christopher-besch <mail@chris-besch.com>
This commit is contained in:
christopher-besch
Earl Warren
parent
6ce9d764bc
commit
d17aa98262
27 changed files with 683 additions and 12 deletions
|
|
@ -6,6 +6,7 @@ package webhook
|
|||
import (
|
||||
"testing"
|
||||
|
||||
actions_model "forgejo.org/models/actions"
|
||||
"forgejo.org/models/db"
|
||||
repo_model "forgejo.org/models/repo"
|
||||
"forgejo.org/models/unittest"
|
||||
|
|
@ -13,10 +14,12 @@ import (
|
|||
webhook_model "forgejo.org/models/webhook"
|
||||
"forgejo.org/modules/git"
|
||||
"forgejo.org/modules/json"
|
||||
"forgejo.org/modules/log"
|
||||
"forgejo.org/modules/repository"
|
||||
"forgejo.org/modules/setting"
|
||||
"forgejo.org/modules/structs"
|
||||
"forgejo.org/modules/test"
|
||||
webhook_module "forgejo.org/modules/webhook"
|
||||
|
||||
"github.com/stretchr/testify/assert"
|
||||
"github.com/stretchr/testify/require"
|
||||
|
|
@ -119,3 +122,190 @@ func TestPushCommits(t *testing.T) {
|
|||
assert.Equal(t, "2c54faec6c45d31c1abfaecdab471eac6633738a", payloadContent.Commits[0].ID)
|
||||
})
|
||||
}
|
||||
|
||||
func assertActionEqual(t *testing.T, expectedRun *actions_model.ActionRun, actualRun *structs.ActionRun) {
|
||||
assert.NotNil(t, expectedRun)
|
||||
assert.NotNil(t, actualRun)
|
||||
// only test a few things
|
||||
assert.Equal(t, expectedRun.ID, actualRun.ID)
|
||||
assert.Equal(t, expectedRun.Status.String(), actualRun.Status)
|
||||
assert.Equal(t, expectedRun.Index, actualRun.Index)
|
||||
assert.Equal(t, expectedRun.RepoID, actualRun.Repo.ID)
|
||||
// convert to unix because of time zones
|
||||
assert.Equal(t, expectedRun.Stopped.AsTime().Unix(), actualRun.Stopped.Unix())
|
||||
assert.Equal(t, expectedRun.Title, actualRun.Title)
|
||||
assert.Equal(t, expectedRun.WorkflowID, actualRun.WorkflowID)
|
||||
}
|
||||
|
||||
func TestAction(t *testing.T) {
|
||||
defer unittest.OverrideFixtures("services/webhook/TestPushCommits")()
|
||||
require.NoError(t, unittest.PrepareTestDatabase())
|
||||
|
||||
triggerUser := unittest.AssertExistsAndLoadBean(t, &user_model.User{ID: 2})
|
||||
repo := unittest.AssertExistsAndLoadBean(t, &repo_model.Repository{ID: 2, OwnerID: triggerUser.ID})
|
||||
|
||||
oldSuccessRun := &actions_model.ActionRun{
|
||||
ID: 1,
|
||||
Status: actions_model.StatusSuccess,
|
||||
Index: 1,
|
||||
RepoID: repo.ID,
|
||||
Stopped: 1693648027,
|
||||
WorkflowID: "some_workflow",
|
||||
Title: "oldSuccessRun",
|
||||
TriggerUser: triggerUser,
|
||||
TriggerUserID: triggerUser.ID,
|
||||
TriggerEvent: "push",
|
||||
}
|
||||
oldSuccessRun.LoadAttributes(db.DefaultContext)
|
||||
oldFailureRun := &actions_model.ActionRun{
|
||||
ID: 1,
|
||||
Status: actions_model.StatusFailure,
|
||||
Index: 1,
|
||||
RepoID: repo.ID,
|
||||
Stopped: 1693648027,
|
||||
WorkflowID: "some_workflow",
|
||||
Title: "oldFailureRun",
|
||||
TriggerUser: triggerUser,
|
||||
TriggerUserID: triggerUser.ID,
|
||||
TriggerEvent: "push",
|
||||
}
|
||||
oldFailureRun.LoadAttributes(db.DefaultContext)
|
||||
newSuccessRun := &actions_model.ActionRun{
|
||||
ID: 1,
|
||||
Status: actions_model.StatusSuccess,
|
||||
Index: 1,
|
||||
RepoID: repo.ID,
|
||||
Stopped: 1693648327,
|
||||
WorkflowID: "some_workflow",
|
||||
Title: "newSuccessRun",
|
||||
TriggerUser: triggerUser,
|
||||
TriggerUserID: triggerUser.ID,
|
||||
TriggerEvent: "push",
|
||||
}
|
||||
newSuccessRun.LoadAttributes(db.DefaultContext)
|
||||
newFailureRun := &actions_model.ActionRun{
|
||||
ID: 1,
|
||||
Status: actions_model.StatusFailure,
|
||||
Index: 1,
|
||||
RepoID: repo.ID,
|
||||
Stopped: 1693648327,
|
||||
WorkflowID: "some_workflow",
|
||||
Title: "newFailureRun",
|
||||
TriggerUser: triggerUser,
|
||||
TriggerUserID: triggerUser.ID,
|
||||
TriggerEvent: "push",
|
||||
}
|
||||
newFailureRun.LoadAttributes(db.DefaultContext)
|
||||
|
||||
t.Run("Successful Run after Nothing", func(t *testing.T) {
|
||||
defer test.MockVariableValue(&setting.Webhook.PayloadCommitLimit, 10)()
|
||||
|
||||
NewNotifier().ActionRunNowDone(db.DefaultContext, newSuccessRun, actions_model.StatusWaiting, nil)
|
||||
|
||||
// there's only one of these at the time
|
||||
hookTask := unittest.AssertExistsAndLoadBean(t, &webhook_model.HookTask{}, unittest.Cond("event_type == 'action_run_success' AND payload_content LIKE '%success%newSuccessRun%'"))
|
||||
assert.Equal(t, webhook_module.HookEventActionRunSuccess, hookTask.EventType)
|
||||
|
||||
var payloadContent structs.ActionPayload
|
||||
require.NoError(t, json.Unmarshal([]byte(hookTask.PayloadContent), &payloadContent))
|
||||
assert.Equal(t, structs.HookActionSuccess, payloadContent.Action)
|
||||
assert.Equal(t, actions_model.StatusWaiting.String(), payloadContent.PriorStatus)
|
||||
assertActionEqual(t, newSuccessRun, payloadContent.Run)
|
||||
assert.Nil(t, payloadContent.LastRun)
|
||||
})
|
||||
|
||||
t.Run("Successful Run after Failure", func(t *testing.T) {
|
||||
defer test.MockVariableValue(&setting.Webhook.PayloadCommitLimit, 10)()
|
||||
|
||||
NewNotifier().ActionRunNowDone(db.DefaultContext, newSuccessRun, actions_model.StatusWaiting, oldFailureRun)
|
||||
|
||||
{
|
||||
hookTask := unittest.AssertExistsAndLoadBean(t, &webhook_model.HookTask{}, unittest.Cond("event_type == 'action_run_success' AND payload_content LIKE '%success%newSuccessRun%oldFailureRun%'"))
|
||||
assert.Equal(t, webhook_module.HookEventActionRunSuccess, hookTask.EventType)
|
||||
|
||||
var payloadContent structs.ActionPayload
|
||||
require.NoError(t, json.Unmarshal([]byte(hookTask.PayloadContent), &payloadContent))
|
||||
assert.Equal(t, structs.HookActionSuccess, payloadContent.Action)
|
||||
assert.Equal(t, actions_model.StatusWaiting.String(), payloadContent.PriorStatus)
|
||||
assertActionEqual(t, newSuccessRun, payloadContent.Run)
|
||||
assertActionEqual(t, oldFailureRun, payloadContent.LastRun)
|
||||
}
|
||||
{
|
||||
hookTask := unittest.AssertExistsAndLoadBean(t, &webhook_model.HookTask{}, unittest.Cond("event_type == 'action_run_recover' AND payload_content LIKE '%recover%newSuccessRun%oldFailureRun%'"))
|
||||
assert.Equal(t, webhook_module.HookEventActionRunRecover, hookTask.EventType)
|
||||
|
||||
log.Error("something: %s", hookTask.PayloadContent)
|
||||
var payloadContent structs.ActionPayload
|
||||
require.NoError(t, json.Unmarshal([]byte(hookTask.PayloadContent), &payloadContent))
|
||||
assert.Equal(t, structs.HookActionRecover, payloadContent.Action)
|
||||
assert.Equal(t, actions_model.StatusWaiting.String(), payloadContent.PriorStatus)
|
||||
assertActionEqual(t, newSuccessRun, payloadContent.Run)
|
||||
assertActionEqual(t, oldFailureRun, payloadContent.LastRun)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("Successful Run after Success", func(t *testing.T) {
|
||||
defer test.MockVariableValue(&setting.Webhook.PayloadCommitLimit, 10)()
|
||||
|
||||
NewNotifier().ActionRunNowDone(db.DefaultContext, newSuccessRun, actions_model.StatusWaiting, oldSuccessRun)
|
||||
|
||||
hookTask := unittest.AssertExistsAndLoadBean(t, &webhook_model.HookTask{}, unittest.Cond("event_type == 'action_run_success' AND payload_content LIKE '%success%newSuccessRun%oldSuccessRun%'"))
|
||||
assert.Equal(t, webhook_module.HookEventActionRunSuccess, hookTask.EventType)
|
||||
|
||||
var payloadContent structs.ActionPayload
|
||||
require.NoError(t, json.Unmarshal([]byte(hookTask.PayloadContent), &payloadContent))
|
||||
assert.Equal(t, structs.HookActionSuccess, payloadContent.Action)
|
||||
assert.Equal(t, actions_model.StatusWaiting.String(), payloadContent.PriorStatus)
|
||||
assertActionEqual(t, newSuccessRun, payloadContent.Run)
|
||||
assertActionEqual(t, oldSuccessRun, payloadContent.LastRun)
|
||||
})
|
||||
|
||||
t.Run("Failed Run after Nothing", func(t *testing.T) {
|
||||
defer test.MockVariableValue(&setting.Webhook.PayloadCommitLimit, 10)()
|
||||
|
||||
NewNotifier().ActionRunNowDone(db.DefaultContext, newFailureRun, actions_model.StatusWaiting, nil)
|
||||
|
||||
// there should only be this one at the time
|
||||
hookTask := unittest.AssertExistsAndLoadBean(t, &webhook_model.HookTask{}, unittest.Cond("event_type == 'action_run_failure' AND payload_content LIKE '%failure%newFailureRun%'"))
|
||||
assert.Equal(t, webhook_module.HookEventActionRunFailure, hookTask.EventType)
|
||||
|
||||
var payloadContent structs.ActionPayload
|
||||
require.NoError(t, json.Unmarshal([]byte(hookTask.PayloadContent), &payloadContent))
|
||||
assert.Equal(t, structs.HookActionFailure, payloadContent.Action)
|
||||
assert.Equal(t, actions_model.StatusWaiting.String(), payloadContent.PriorStatus)
|
||||
assertActionEqual(t, newFailureRun, payloadContent.Run)
|
||||
assert.Nil(t, payloadContent.LastRun)
|
||||
})
|
||||
|
||||
t.Run("Failed Run after Failure", func(t *testing.T) {
|
||||
defer test.MockVariableValue(&setting.Webhook.PayloadCommitLimit, 10)()
|
||||
|
||||
NewNotifier().ActionRunNowDone(db.DefaultContext, newFailureRun, actions_model.StatusWaiting, oldFailureRun)
|
||||
|
||||
hookTask := unittest.AssertExistsAndLoadBean(t, &webhook_model.HookTask{}, unittest.Cond("event_type == 'action_run_failure' AND payload_content LIKE '%failure%newFailureRun%oldFailureRun%'"))
|
||||
assert.Equal(t, webhook_module.HookEventActionRunFailure, hookTask.EventType)
|
||||
|
||||
var payloadContent structs.ActionPayload
|
||||
require.NoError(t, json.Unmarshal([]byte(hookTask.PayloadContent), &payloadContent))
|
||||
assert.Equal(t, structs.HookActionFailure, payloadContent.Action)
|
||||
assert.Equal(t, actions_model.StatusWaiting.String(), payloadContent.PriorStatus)
|
||||
assertActionEqual(t, newFailureRun, payloadContent.Run)
|
||||
assertActionEqual(t, oldFailureRun, payloadContent.LastRun)
|
||||
})
|
||||
|
||||
t.Run("Failed Run after Success", func(t *testing.T) {
|
||||
defer test.MockVariableValue(&setting.Webhook.PayloadCommitLimit, 10)()
|
||||
|
||||
NewNotifier().ActionRunNowDone(db.DefaultContext, newFailureRun, actions_model.StatusWaiting, oldSuccessRun)
|
||||
|
||||
hookTask := unittest.AssertExistsAndLoadBean(t, &webhook_model.HookTask{}, unittest.Cond("event_type == 'action_run_failure' AND payload_content LIKE '%failure%newFailureRun%oldSuccessRun%'"))
|
||||
assert.Equal(t, webhook_module.HookEventActionRunFailure, hookTask.EventType)
|
||||
|
||||
var payloadContent structs.ActionPayload
|
||||
require.NoError(t, json.Unmarshal([]byte(hookTask.PayloadContent), &payloadContent))
|
||||
assert.Equal(t, structs.HookActionFailure, payloadContent.Action)
|
||||
assert.Equal(t, actions_model.StatusWaiting.String(), payloadContent.PriorStatus)
|
||||
assertActionEqual(t, newFailureRun, payloadContent.Run)
|
||||
assertActionEqual(t, oldSuccessRun, payloadContent.LastRun)
|
||||
})
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue