-
-
Notifications
You must be signed in to change notification settings - Fork 5.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Refactor
git.Command.Run*
, introduce RunWithContextString
and `Ru…
…nWithContextBytes` (#19266) This follows * #18553 Introduce `RunWithContextString` and `RunWithContextBytes` to help the refactoring. Add related unit tests. They keep the same behavior to save stderr into err.Error() as `RunInXxx` before. Remove `RunInDirTimeoutPipeline` `RunInDirTimeoutFullPipeline` `RunInDirTimeout` `RunInDirTimeoutEnv` `RunInDirPipeline` `RunInDirFullPipeline` `RunTimeout`, `RunInDirTimeoutEnvPipeline`, `RunInDirTimeoutEnvFullPipeline`, `RunInDirTimeoutEnvFullPipelineFunc`. Then remaining `RunInDir` `RunInDirBytes` `RunInDirWithEnv` can be easily refactored in next PR with a simple search & replace: * before: `stdout, err := RunInDir(path)` * next: `stdout, _, err := RunWithContextString(&git.RunContext{Dir:path})` Other changes: 1. When `timeout <= 0`, use default. Because `timeout==0` is meaningless and could cause bugs. And now many functions becomes more simple, eg: `GitGcRepos` 9 lines to 1 line. `Fsck` 6 lines to 1 line. 2. Only set defaultCommandExecutionTimeout when the option `setting.Git.Timeout.Default > 0`
- Loading branch information
1 parent
d4f84f1
commit b877504
Showing
8 changed files
with
126 additions
and
126 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,40 @@ | ||
// Copyright 2017 The Gitea Authors. All rights reserved. | ||
// Use of this source code is governed by a MIT-style | ||
// license that can be found in the LICENSE file. | ||
|
||
//go:build race | ||
// +build race | ||
|
||
package git | ||
|
||
import ( | ||
"context" | ||
"testing" | ||
"time" | ||
) | ||
|
||
func TestRunWithContextNoTimeout(t *testing.T) { | ||
maxLoops := 10 | ||
|
||
// 'git --version' does not block so it must be finished before the timeout triggered. | ||
cmd := NewCommand(context.Background(), "--version") | ||
for i := 0; i < maxLoops; i++ { | ||
if err := cmd.RunWithContext(&RunContext{}); err != nil { | ||
t.Fatal(err) | ||
} | ||
} | ||
} | ||
|
||
func TestRunWithContextTimeout(t *testing.T) { | ||
maxLoops := 10 | ||
|
||
// 'git hash-object --stdin' blocks on stdin so we can have the timeout triggered. | ||
cmd := NewCommand(context.Background(), "hash-object", "--stdin") | ||
for i := 0; i < maxLoops; i++ { | ||
if err := cmd.RunWithContext(&RunContext{Timeout: 1 * time.Millisecond}); err != nil { | ||
if err != context.DeadlineExceeded { | ||
t.Fatalf("Testing %d/%d: %v", i, maxLoops, err) | ||
} | ||
} | ||
} | ||
} |
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 |
---|---|---|
@@ -1,40 +1,29 @@ | ||
// Copyright 2017 The Gitea Authors. All rights reserved. | ||
// Copyright 2022 The Gitea Authors. All rights reserved. | ||
// Use of this source code is governed by a MIT-style | ||
// license that can be found in the LICENSE file. | ||
|
||
//go:build race | ||
// +build race | ||
|
||
package git | ||
|
||
import ( | ||
"context" | ||
"testing" | ||
"time" | ||
) | ||
|
||
func TestRunInDirTimeoutPipelineNoTimeout(t *testing.T) { | ||
maxLoops := 1000 | ||
"github.com/stretchr/testify/assert" | ||
) | ||
|
||
// 'git --version' does not block so it must be finished before the timeout triggered. | ||
func TestRunWithContextStd(t *testing.T) { | ||
cmd := NewCommand(context.Background(), "--version") | ||
for i := 0; i < maxLoops; i++ { | ||
if err := cmd.RunInDirTimeoutPipeline(-1, "", nil, nil); err != nil { | ||
t.Fatal(err) | ||
} | ||
} | ||
} | ||
|
||
func TestRunInDirTimeoutPipelineAlwaysTimeout(t *testing.T) { | ||
maxLoops := 1000 | ||
stdout, stderr, err := cmd.RunWithContextString(&RunContext{}) | ||
assert.NoError(t, err) | ||
assert.Empty(t, stderr) | ||
assert.Contains(t, stdout, "git version") | ||
|
||
// 'git hash-object --stdin' blocks on stdin so we can have the timeout triggered. | ||
cmd := NewCommand(context.Background(), "hash-object", "--stdin") | ||
for i := 0; i < maxLoops; i++ { | ||
if err := cmd.RunInDirTimeoutPipeline(1*time.Microsecond, "", nil, nil); err != nil { | ||
if err != context.DeadlineExceeded { | ||
t.Fatalf("Testing %d/%d: %v", i, maxLoops, err) | ||
} | ||
} | ||
cmd = NewCommand(context.Background(), "--no-such-arg") | ||
stdout, stderr, err = cmd.RunWithContextString(&RunContext{}) | ||
if assert.Error(t, err) { | ||
assert.Equal(t, stderr, err.Stderr()) | ||
assert.Contains(t, err.Stderr(), "unknown option:") | ||
assert.Contains(t, err.Error(), "exit status 129 - unknown option:") | ||
assert.Empty(t, stdout) | ||
} | ||
} |
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
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
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