forked from go-gitea/gitea
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Fix halfCommitter and WithTx (go-gitea#22366)
Related to go-gitea#22362. I overlooked that there's always `committer.Close()`, like: ```go ctx, committer, err := db.TxContext(db.DefaultContext) if err != nil { return nil } defer committer.Close() // ... if err != nil { return nil } // ... return committer.Commit() ``` So the `Close` of `halfCommitter` should ignore `commit and close`, it's not a rollback. See: [Why `halfCommitter` and `WithTx` should rollback IMMEDIATELY or commit LATER](go-gitea#22366 (comment)). Co-authored-by: techknowlogick <techknowlogick@gitea.io>
- Loading branch information
1 parent
99a675f
commit a357143
Showing
2 changed files
with
124 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,102 @@ | ||
// Copyright 2022 The Gitea Authors. All rights reserved. | ||
// SPDX-License-Identifier: MIT | ||
|
||
package db // it's not db_test, because this file is for testing the private type halfCommitter | ||
|
||
import ( | ||
"fmt" | ||
"testing" | ||
|
||
"github.com/stretchr/testify/assert" | ||
) | ||
|
||
type MockCommitter struct { | ||
wants []string | ||
gots []string | ||
} | ||
|
||
func NewMockCommitter(wants ...string) *MockCommitter { | ||
return &MockCommitter{ | ||
wants: wants, | ||
} | ||
} | ||
|
||
func (c *MockCommitter) Commit() error { | ||
c.gots = append(c.gots, "commit") | ||
return nil | ||
} | ||
|
||
func (c *MockCommitter) Close() error { | ||
c.gots = append(c.gots, "close") | ||
return nil | ||
} | ||
|
||
func (c *MockCommitter) Assert(t *testing.T) { | ||
assert.Equal(t, c.wants, c.gots, "want operations %v, but got %v", c.wants, c.gots) | ||
} | ||
|
||
func Test_halfCommitter(t *testing.T) { | ||
/* | ||
Do something like: | ||
ctx, committer, err := db.TxContext(db.DefaultContext) | ||
if err != nil { | ||
return nil | ||
} | ||
defer committer.Close() | ||
// ... | ||
if err != nil { | ||
return nil | ||
} | ||
// ... | ||
return committer.Commit() | ||
*/ | ||
|
||
testWithCommitter := func(committer Committer, f func(committer Committer) error) { | ||
if err := f(&halfCommitter{committer: committer}); err == nil { | ||
committer.Commit() | ||
} | ||
committer.Close() | ||
} | ||
|
||
t.Run("commit and close", func(t *testing.T) { | ||
mockCommitter := NewMockCommitter("commit", "close") | ||
|
||
testWithCommitter(mockCommitter, func(committer Committer) error { | ||
defer committer.Close() | ||
return committer.Commit() | ||
}) | ||
|
||
mockCommitter.Assert(t) | ||
}) | ||
|
||
t.Run("rollback and close", func(t *testing.T) { | ||
mockCommitter := NewMockCommitter("close", "close") | ||
|
||
testWithCommitter(mockCommitter, func(committer Committer) error { | ||
defer committer.Close() | ||
if true { | ||
return fmt.Errorf("error") | ||
} | ||
return committer.Commit() | ||
}) | ||
|
||
mockCommitter.Assert(t) | ||
}) | ||
|
||
t.Run("close and commit", func(t *testing.T) { | ||
mockCommitter := NewMockCommitter("close", "close") | ||
|
||
testWithCommitter(mockCommitter, func(committer Committer) error { | ||
committer.Close() | ||
committer.Commit() | ||
return fmt.Errorf("error") | ||
}) | ||
|
||
mockCommitter.Assert(t) | ||
}) | ||
} |