mirror of https://github.com/go-gitea/gitea
Fix halfCommitter and WithTx (#22366)
Related to #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](https://github.com/go-gitea/gitea/pull/22366#issuecomment-1374778612). Co-authored-by: techknowlogick <techknowlogick@gitea.io>pull/22374/head^2
parent
99a675f4a1
commit
a35714372d
@ -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) |
||||
}) |
||||
} |
Loading…
Reference in new issue