jojo/services/actions/commit_status_test.go
Mathieu Fenniak babc109b26 [v11.0/forgejo] fix: don't duplicate commit status records on workflows with empty name (#10681)
**Backport:** #10678

(cherry picked from commit 8f63ee9a94)

Fixes #10671.

Cleanup for the inflated number of records in this table will come in a near future change.

## 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.
  - [ ] 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.

Reviewed-on: https://codeberg.org/forgejo/forgejo/pulls/10681
Reviewed-by: Gusted <gusted@noreply.codeberg.org>
Co-authored-by: Mathieu Fenniak <mathieu@fenniak.net>
Co-committed-by: Mathieu Fenniak <mathieu@fenniak.net>
2026-01-05 15:03:46 +01:00

79 lines
3.5 KiB
Go

// Copyright 2025 The Forgejo Authors. All rights reserved.
// SPDX-License-Identifier: GPL-3.0-or-later
package actions
import (
"testing"
actions_model "forgejo.org/models/actions"
git_model "forgejo.org/models/git"
"forgejo.org/models/unittest"
"forgejo.org/modules/cache"
"forgejo.org/modules/structs"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
"xorm.io/builder"
)
func TestCreateCommitStatus_AvoidsDuplicates(t *testing.T) {
defer unittest.OverrideFixtures("services/actions/TestCreateCommitStatus")()
require.NoError(t, unittest.PrepareTestDatabase())
cache.Init()
job := unittest.AssertExistsAndLoadBean(t, &actions_model.ActionRunJob{ID: 400})
targetCommitStatusFilter := builder.Eq{"repo_id": 4, "sha": job.CommitSHA}
// Begin with 0 commit statuses
assert.Equal(t, 0, unittest.GetCount(t, &git_model.CommitStatus{}, targetCommitStatusFilter))
err := createCommitStatus(t.Context(), job)
require.NoError(t, err)
// Should have 1 commit status now with one createCommitStatus call
assert.Equal(t, 1, unittest.GetCount(t, &git_model.CommitStatus{}, targetCommitStatusFilter))
status := unittest.AssertExistsAndLoadBean(t, &git_model.CommitStatus{}, targetCommitStatusFilter)
assert.EqualValues(t, 4, status.RepoID)
assert.Equal(t, structs.CommitStatusState("pending"), status.State)
assert.Equal(t, "c7cd3cd144e6d23c9d6f3d07e52b2c1a956e0338", status.SHA)
assert.Equal(t, "/user5/repo4/actions/runs/200/jobs/0", status.TargetURL)
assert.Equal(t, "Blocked by required conditions", status.Description)
assert.Equal(t, "39c46bc9f0f68e0dcfbb59118e12778fa095b066", status.ContextHash)
assert.Equal(t, "/ job_2 (push)", status.Context) // This test is intended to cover the runName = "" case, which trims whitespace in this context string -- don't change it in the future
assert.EqualValues(t, 1, status.Index)
// No status change, but createCommitStatus invoked again
err = createCommitStatus(t.Context(), job)
require.NoError(t, err)
// Should have just the same 1 commit status since the context & state was unchanged.
assert.Equal(t, 1, unittest.GetCount(t, &git_model.CommitStatus{}, targetCommitStatusFilter))
// Change status, but still pending -- should add new commit status just for the Description change
job.Status = actions_model.StatusWaiting // Blocked -> Waiting
err = createCommitStatus(t.Context(), job)
require.NoError(t, err)
// New commit status added
assert.Equal(t, 2, unittest.GetCount(t, &git_model.CommitStatus{}, targetCommitStatusFilter))
status = unittest.AssertExistsAndLoadBean(t, &git_model.CommitStatus{Index: 2}, targetCommitStatusFilter)
assert.Equal(t, structs.CommitStatusState("pending"), status.State)
assert.Equal(t, "Waiting to run", status.Description)
// Invoke createCommitStatus again, check no new record created again
err = createCommitStatus(t.Context(), job)
require.NoError(t, err)
assert.Equal(t, 2, unittest.GetCount(t, &git_model.CommitStatus{}, targetCommitStatusFilter))
// Update job status & create new commit status
job.Status = actions_model.StatusSuccess
err = createCommitStatus(t.Context(), job)
require.NoError(t, err)
// New commit status added w/ updated state & description
assert.Equal(t, 3, unittest.GetCount(t, &git_model.CommitStatus{}, targetCommitStatusFilter))
status = unittest.AssertExistsAndLoadBean(t, &git_model.CommitStatus{Index: 3}, targetCommitStatusFilter)
assert.Equal(t, structs.CommitStatusState("success"), status.State)
assert.Equal(t, "Successful in 1m38s", status.Description)
}