mirror of
				https://github.com/go-gitea/gitea.git
				synced 2025-10-28 03:46:18 +01:00 
			
		
		
		
	Refactor Git command functions to use WithXXX methods instead of exposing RunOpts. This change simplifies reuse across gitrepo and improves consistency, encapsulation, and maintainability of command options. --------- Co-authored-by: wxiaoguang <wxiaoguang@gmail.com>
		
			
				
	
	
		
			100 lines
		
	
	
		
			2.9 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
			
		
		
	
	
			100 lines
		
	
	
		
			2.9 KiB
		
	
	
	
		
			Go
		
	
	
	
	
	
| // Copyright 2022 The Gitea Authors. All rights reserved.
 | |
| // SPDX-License-Identifier: MIT
 | |
| 
 | |
| package gitcmd
 | |
| 
 | |
| import (
 | |
| 	"fmt"
 | |
| 	"os"
 | |
| 	"testing"
 | |
| 
 | |
| 	"code.gitea.io/gitea/modules/setting"
 | |
| 	"code.gitea.io/gitea/modules/tempdir"
 | |
| 
 | |
| 	"github.com/stretchr/testify/assert"
 | |
| )
 | |
| 
 | |
| func TestMain(m *testing.M) {
 | |
| 	gitHomePath, cleanup, err := tempdir.OsTempDir("gitea-test").MkdirTempRandom("git-home")
 | |
| 	if err != nil {
 | |
| 		_, _ = fmt.Fprintf(os.Stderr, "unable to create temp dir: %v", err)
 | |
| 		os.Exit(1)
 | |
| 	}
 | |
| 	defer cleanup()
 | |
| 
 | |
| 	setting.Git.HomePath = gitHomePath
 | |
| 	os.Exit(m.Run())
 | |
| }
 | |
| 
 | |
| func TestRunWithContextStd(t *testing.T) {
 | |
| 	{
 | |
| 		cmd := NewCommand("--version")
 | |
| 		stdout, stderr, err := cmd.RunStdString(t.Context())
 | |
| 		assert.NoError(t, err)
 | |
| 		assert.Empty(t, stderr)
 | |
| 		assert.Contains(t, stdout, "git version")
 | |
| 	}
 | |
| 
 | |
| 	{
 | |
| 		cmd := NewCommand("ls-tree", "no-such")
 | |
| 		stdout, stderr, err := cmd.RunStdString(t.Context())
 | |
| 		if assert.Error(t, err) {
 | |
| 			assert.Equal(t, stderr, err.Stderr())
 | |
| 			assert.Equal(t, "fatal: Not a valid object name no-such\n", err.Stderr())
 | |
| 			// FIXME: GIT-CMD-STDERR: it is a bad design, the stderr should not be put in the error message
 | |
| 			assert.Equal(t, "exit status 128 - fatal: Not a valid object name no-such\n", err.Error())
 | |
| 			assert.Empty(t, stdout)
 | |
| 		}
 | |
| 	}
 | |
| 
 | |
| 	{
 | |
| 		cmd := NewCommand("ls-tree", "no-such")
 | |
| 		stdout, stderr, err := cmd.RunStdBytes(t.Context())
 | |
| 		if assert.Error(t, err) {
 | |
| 			assert.Equal(t, string(stderr), err.Stderr())
 | |
| 			assert.Equal(t, "fatal: Not a valid object name no-such\n", err.Stderr())
 | |
| 			// FIXME: GIT-CMD-STDERR: it is a bad design, the stderr should not be put in the error message
 | |
| 			assert.Equal(t, "exit status 128 - fatal: Not a valid object name no-such\n", err.Error())
 | |
| 			assert.Empty(t, stdout)
 | |
| 		}
 | |
| 	}
 | |
| 
 | |
| 	{
 | |
| 		cmd := NewCommand()
 | |
| 		cmd.AddDynamicArguments("-test")
 | |
| 		assert.ErrorIs(t, cmd.Run(t.Context()), ErrBrokenCommand)
 | |
| 
 | |
| 		cmd = NewCommand()
 | |
| 		cmd.AddDynamicArguments("--test")
 | |
| 		assert.ErrorIs(t, cmd.Run(t.Context()), ErrBrokenCommand)
 | |
| 	}
 | |
| 
 | |
| 	{
 | |
| 		subCmd := "version"
 | |
| 		cmd := NewCommand().AddDynamicArguments(subCmd) // for test purpose only, the sub-command should never be dynamic for production
 | |
| 		stdout, stderr, err := cmd.RunStdString(t.Context())
 | |
| 		assert.NoError(t, err)
 | |
| 		assert.Empty(t, stderr)
 | |
| 		assert.Contains(t, stdout, "git version")
 | |
| 	}
 | |
| }
 | |
| 
 | |
| func TestGitArgument(t *testing.T) {
 | |
| 	assert.True(t, isValidArgumentOption("-x"))
 | |
| 	assert.True(t, isValidArgumentOption("--xx"))
 | |
| 	assert.False(t, isValidArgumentOption(""))
 | |
| 	assert.False(t, isValidArgumentOption("x"))
 | |
| 
 | |
| 	assert.True(t, isSafeArgumentValue(""))
 | |
| 	assert.True(t, isSafeArgumentValue("x"))
 | |
| 	assert.False(t, isSafeArgumentValue("-x"))
 | |
| }
 | |
| 
 | |
| func TestCommandString(t *testing.T) {
 | |
| 	cmd := NewCommand("a", "-m msg", "it's a test", `say "hello"`)
 | |
| 	assert.Equal(t, cmd.prog+` a "-m msg" "it's a test" "say \"hello\""`, cmd.LogString())
 | |
| 
 | |
| 	cmd = NewCommand("url: https://a:b@c/", "/root/dir-a/dir-b")
 | |
| 	assert.Equal(t, cmd.prog+` "url: https://sanitized-credential@c/" .../dir-a/dir-b`, cmd.LogString())
 | |
| }
 |