2022-03-31 11:56:22 +00:00
|
|
|
// Copyright 2022 The Gitea Authors. All rights reserved.
|
2022-11-27 18:20:29 +00:00
|
|
|
// SPDX-License-Identifier: MIT
|
2019-03-27 09:33:00 +00:00
|
|
|
|
|
|
|
package git
|
|
|
|
|
|
|
|
import (
|
|
|
|
"context"
|
|
|
|
"testing"
|
|
|
|
|
2022-03-31 11:56:22 +00:00
|
|
|
"github.com/stretchr/testify/assert"
|
2024-07-30 19:42:06 +00:00
|
|
|
"github.com/stretchr/testify/require"
|
2022-03-31 11:56:22 +00:00
|
|
|
)
|
2019-03-27 09:33:00 +00:00
|
|
|
|
2022-03-31 11:56:22 +00:00
|
|
|
func TestRunWithContextStd(t *testing.T) {
|
2022-02-06 19:01:47 +00:00
|
|
|
cmd := NewCommand(context.Background(), "--version")
|
2022-04-01 02:55:30 +00:00
|
|
|
stdout, stderr, err := cmd.RunStdString(&RunOpts{})
|
2024-07-30 19:42:06 +00:00
|
|
|
require.NoError(t, err)
|
2022-03-31 11:56:22 +00:00
|
|
|
assert.Empty(t, stderr)
|
|
|
|
assert.Contains(t, stdout, "git version")
|
2019-03-27 09:33:00 +00:00
|
|
|
|
2022-03-31 11:56:22 +00:00
|
|
|
cmd = NewCommand(context.Background(), "--no-such-arg")
|
2022-04-01 02:55:30 +00:00
|
|
|
stdout, stderr, err = cmd.RunStdString(&RunOpts{})
|
2024-07-30 19:42:06 +00:00
|
|
|
require.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)
|
2022-10-15 10:49:26 +00:00
|
|
|
|
2022-10-15 12:18:31 +00:00
|
|
|
cmd = NewCommand(context.Background())
|
|
|
|
cmd.AddDynamicArguments("-test")
|
2024-07-30 19:42:06 +00:00
|
|
|
require.ErrorIs(t, cmd.Run(&RunOpts{}), ErrBrokenCommand)
|
2022-10-15 12:18:31 +00:00
|
|
|
|
|
|
|
cmd = NewCommand(context.Background())
|
|
|
|
cmd.AddDynamicArguments("--test")
|
2024-07-30 19:42:06 +00:00
|
|
|
require.ErrorIs(t, cmd.Run(&RunOpts{}), ErrBrokenCommand)
|
2022-10-15 10:49:26 +00:00
|
|
|
|
|
|
|
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{})
|
2024-07-30 19:42:06 +00:00
|
|
|
require.NoError(t, err)
|
2022-10-15 10:49:26 +00:00
|
|
|
assert.Empty(t, stderr)
|
|
|
|
assert.Contains(t, stdout, "git version")
|
2019-03-27 09:33:00 +00:00
|
|
|
}
|
Refactor git command package to improve security and maintainability (#22678)
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>
2023-02-04 02:30:43 +00:00
|
|
|
|
|
|
|
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"))
|
|
|
|
}
|
2023-04-13 23:17:27 +00:00
|
|
|
|
|
|
|
func TestCommandString(t *testing.T) {
|
|
|
|
cmd := NewCommandContextNoGlobals(context.Background(), "a", "-m msg", "it's a test", `say "hello"`)
|
|
|
|
assert.EqualValues(t, cmd.prog+` a "-m msg" "it's a test" "say \"hello\""`, cmd.String())
|
|
|
|
|
|
|
|
cmd = NewCommandContextNoGlobals(context.Background(), "url: https://a:b@c/")
|
|
|
|
assert.EqualValues(t, cmd.prog+` "url: https://sanitized-credential@c/"`, cmd.toString(true))
|
|
|
|
}
|