mirror of
https://github.com/go-gitea/gitea
synced 2024-12-27 02:54:20 +01:00
6bc3079c00
This PR follows #21535 (and replace #22592) ## Review without space diff https://github.com/go-gitea/gitea/pull/22678/files?diff=split&w=1 ## Purpose of this PR 1. Make git module command completely safe (risky user inputs won't be passed as argument option anymore) 2. Avoid low-level mistakes like https://github.com/go-gitea/gitea/pull/22098#discussion_r1045234918 3. Remove deprecated and dirty `CmdArgCheck` function, hide the `CmdArg` type 4. Simplify code when using git command ## The main idea of this PR * Move the `git.CmdArg` to the `internal` package, then no other package except `git` could use it. Then developers could never do `AddArguments(git.CmdArg(userInput))` any more. * Introduce `git.ToTrustedCmdArgs`, it's for user-provided and already trusted arguments. It's only used in a few cases, for example: use git arguments from config file, help unit test with some arguments. * Introduce `AddOptionValues` and `AddOptionFormat`, they make code more clear and simple: * Before: `AddArguments("-m").AddDynamicArguments(message)` * After: `AddOptionValues("-m", message)` * - * Before: `AddArguments(git.CmdArg(fmt.Sprintf("--author='%s <%s>'", sig.Name, sig.Email)))` * After: `AddOptionFormat("--author='%s <%s>'", sig.Name, sig.Email)` ## FAQ ### Why these changes were not done in #21535 ? #21535 is mainly a search&replace, it did its best to not change too much logic. Making the framework better needs a lot of changes, so this separate PR is needed as the second step. ### The naming of `AddOptionXxx` According to git's manual, the `--xxx` part is called `option`. ### How can it guarantee that `internal.CmdArg` won't be not misused? Go's specification guarantees that. Trying to access other package's internal package causes compilation error. And, `golangci-lint` also denies the git/internal package. Only the `git/command.go` can use it carefully. ### There is still a `ToTrustedCmdArgs`, will it still allow developers to make mistakes and pass untrusted arguments? Generally speaking, no. Because when using `ToTrustedCmdArgs`, the code will be very complex (see the changes for examples). Then developers and reviewers can know that something might be unreasonable. ### Why there was a `CmdArgCheck` and why it's removed? At the moment of #21535, to reduce unnecessary changes, `CmdArgCheck` was introduced as a hacky patch. Now, almost all code could be written as `cmd := NewCommand(); cmd.AddXxx(...)`, then there is no need for `CmdArgCheck` anymore. ### Why many codes for `signArg == ""` is deleted? Because in the old code, `signArg` could never be empty string, it's either `-S[key-id]` or `--no-gpg-sign`. So the `signArg == ""` is just dead code. --------- Co-authored-by: Lunny Xiao <xiaolunwen@gmail.com>
54 lines
1.6 KiB
Go
54 lines
1.6 KiB
Go
// Copyright 2022 The Gitea Authors. All rights reserved.
|
|
// SPDX-License-Identifier: MIT
|
|
|
|
package git
|
|
|
|
import (
|
|
"context"
|
|
"testing"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
)
|
|
|
|
func TestRunWithContextStd(t *testing.T) {
|
|
cmd := NewCommand(context.Background(), "--version")
|
|
stdout, stderr, err := cmd.RunStdString(&RunOpts{})
|
|
assert.NoError(t, err)
|
|
assert.Empty(t, stderr)
|
|
assert.Contains(t, stdout, "git version")
|
|
|
|
cmd = NewCommand(context.Background(), "--no-such-arg")
|
|
stdout, stderr, err = cmd.RunStdString(&RunOpts{})
|
|
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)
|
|
}
|
|
|
|
cmd = NewCommand(context.Background())
|
|
cmd.AddDynamicArguments("-test")
|
|
assert.ErrorIs(t, cmd.Run(&RunOpts{}), ErrBrokenCommand)
|
|
|
|
cmd = NewCommand(context.Background())
|
|
cmd.AddDynamicArguments("--test")
|
|
assert.ErrorIs(t, cmd.Run(&RunOpts{}), ErrBrokenCommand)
|
|
|
|
subCmd := "version"
|
|
cmd = NewCommand(context.Background()).AddDynamicArguments(subCmd) // for test purpose only, the sub-command should never be dynamic for production
|
|
stdout, stderr, err = cmd.RunStdString(&RunOpts{})
|
|
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"))
|
|
}
|