mirror of
https://github.com/argoproj/argo-cd.git
synced 2026-03-25 09:48:47 +01:00
6002c7d8f3
* fix: [#15949] split git revision metadata by newline not pipe symbol pipe symbol '|' could appear in username or commit message body Signed-off-by: Petr Studeny <studenyp@gmail.com> * test: add test Signed-off-by: Blake Pettersson <blake.pettersson@gmail.com> * Update util/git/client_test.go Co-authored-by: Petr Studeny <studenyp@gmail.com> Signed-off-by: Blake Pettersson <blake.pettersson@gmail.com> * test: fix test Signed-off-by: Blake Pettersson <blake.pettersson@gmail.com> --------- Signed-off-by: Petr Studeny <studenyp@gmail.com> Signed-off-by: Blake Pettersson <blake.pettersson@gmail.com> Co-authored-by: Petr Studeny <studenyp@gmail.com>
482 lines
14 KiB
Go
482 lines
14 KiB
Go
package git
|
|
|
|
import (
|
|
"fmt"
|
|
"os"
|
|
"os/exec"
|
|
"path"
|
|
"path/filepath"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/stretchr/testify/assert"
|
|
"github.com/stretchr/testify/require"
|
|
)
|
|
|
|
func runCmd(workingDir string, name string, args ...string) error {
|
|
cmd := exec.Command(name, args...)
|
|
cmd.Dir = workingDir
|
|
cmd.Stdout = os.Stdout
|
|
cmd.Stderr = os.Stderr
|
|
return cmd.Run()
|
|
}
|
|
|
|
func _createEmptyGitRepo() (string, error) {
|
|
tempDir, err := os.MkdirTemp("", "")
|
|
if err != nil {
|
|
return tempDir, err
|
|
}
|
|
|
|
err = runCmd(tempDir, "git", "init")
|
|
if err != nil {
|
|
return tempDir, err
|
|
}
|
|
|
|
err = runCmd(tempDir, "git", "commit", "-m", "Initial commit", "--allow-empty")
|
|
return tempDir, err
|
|
}
|
|
|
|
func Test_nativeGitClient_Fetch(t *testing.T) {
|
|
tempDir, err := _createEmptyGitRepo()
|
|
require.NoError(t, err)
|
|
|
|
client, err := NewClient(fmt.Sprintf("file://%s", tempDir), NopCreds{}, true, false, "", "")
|
|
require.NoError(t, err)
|
|
|
|
err = client.Init()
|
|
require.NoError(t, err)
|
|
|
|
err = client.Fetch("")
|
|
require.NoError(t, err)
|
|
}
|
|
|
|
func Test_nativeGitClient_Fetch_Prune(t *testing.T) {
|
|
tempDir, err := _createEmptyGitRepo()
|
|
require.NoError(t, err)
|
|
|
|
client, err := NewClient(fmt.Sprintf("file://%s", tempDir), NopCreds{}, true, false, "", "")
|
|
require.NoError(t, err)
|
|
|
|
err = client.Init()
|
|
require.NoError(t, err)
|
|
|
|
err = runCmd(tempDir, "git", "branch", "test/foo")
|
|
require.NoError(t, err)
|
|
|
|
err = client.Fetch("")
|
|
require.NoError(t, err)
|
|
|
|
err = runCmd(tempDir, "git", "branch", "-d", "test/foo")
|
|
require.NoError(t, err)
|
|
err = runCmd(tempDir, "git", "branch", "test/foo/bar")
|
|
require.NoError(t, err)
|
|
|
|
err = client.Fetch("")
|
|
require.NoError(t, err)
|
|
}
|
|
|
|
func Test_IsAnnotatedTag(t *testing.T) {
|
|
tempDir := t.TempDir()
|
|
client, err := NewClient(fmt.Sprintf("file://%s", tempDir), NopCreds{}, true, false, "", "")
|
|
require.NoError(t, err)
|
|
|
|
err = client.Init()
|
|
require.NoError(t, err)
|
|
|
|
p := path.Join(client.Root(), "README")
|
|
f, err := os.Create(p)
|
|
require.NoError(t, err)
|
|
_, err = f.WriteString("Hello.")
|
|
require.NoError(t, err)
|
|
err = f.Close()
|
|
require.NoError(t, err)
|
|
|
|
err = runCmd(client.Root(), "git", "add", "README")
|
|
require.NoError(t, err)
|
|
|
|
err = runCmd(client.Root(), "git", "commit", "-m", "Initial commit", "-a")
|
|
require.NoError(t, err)
|
|
|
|
atag := client.IsAnnotatedTag("master")
|
|
assert.False(t, atag)
|
|
|
|
err = runCmd(client.Root(), "git", "tag", "some-tag", "-a", "-m", "Create annotated tag")
|
|
require.NoError(t, err)
|
|
atag = client.IsAnnotatedTag("some-tag")
|
|
assert.True(t, atag)
|
|
|
|
// Tag effectually points to HEAD, so it's considered the same
|
|
atag = client.IsAnnotatedTag("HEAD")
|
|
assert.True(t, atag)
|
|
|
|
err = runCmd(client.Root(), "git", "rm", "README")
|
|
require.NoError(t, err)
|
|
err = runCmd(client.Root(), "git", "commit", "-m", "remove README", "-a")
|
|
require.NoError(t, err)
|
|
|
|
// We moved on, so tag doesn't point to HEAD anymore
|
|
atag = client.IsAnnotatedTag("HEAD")
|
|
assert.False(t, atag)
|
|
}
|
|
|
|
func Test_ChangedFiles(t *testing.T) {
|
|
tempDir := t.TempDir()
|
|
|
|
client, err := NewClientExt(fmt.Sprintf("file://%s", tempDir), tempDir, NopCreds{}, true, false, "", "")
|
|
require.NoError(t, err)
|
|
|
|
err = client.Init()
|
|
require.NoError(t, err)
|
|
|
|
err = runCmd(client.Root(), "git", "commit", "-m", "Initial commit", "--allow-empty")
|
|
require.NoError(t, err)
|
|
|
|
// Create a tag to have a second ref
|
|
err = runCmd(client.Root(), "git", "tag", "some-tag")
|
|
require.NoError(t, err)
|
|
|
|
p := path.Join(client.Root(), "README")
|
|
f, err := os.Create(p)
|
|
require.NoError(t, err)
|
|
_, err = f.WriteString("Hello.")
|
|
require.NoError(t, err)
|
|
err = f.Close()
|
|
require.NoError(t, err)
|
|
|
|
err = runCmd(client.Root(), "git", "add", "README")
|
|
require.NoError(t, err)
|
|
|
|
err = runCmd(client.Root(), "git", "commit", "-m", "Changes", "-a")
|
|
require.NoError(t, err)
|
|
|
|
previousSHA, err := client.LsRemote("some-tag")
|
|
require.NoError(t, err)
|
|
|
|
commitSHA, err := client.LsRemote("HEAD")
|
|
require.NoError(t, err)
|
|
|
|
// Invalid commits, error
|
|
_, err = client.ChangedFiles("0000000000000000000000000000000000000000", "1111111111111111111111111111111111111111")
|
|
require.Error(t, err)
|
|
|
|
// Not SHAs, error
|
|
_, err = client.ChangedFiles(previousSHA, "HEAD")
|
|
require.Error(t, err)
|
|
|
|
// Same commit, no changes
|
|
changedFiles, err := client.ChangedFiles(commitSHA, commitSHA)
|
|
require.NoError(t, err)
|
|
assert.ElementsMatch(t, []string{}, changedFiles)
|
|
|
|
// Different ref, with changes
|
|
changedFiles, err = client.ChangedFiles(previousSHA, commitSHA)
|
|
require.NoError(t, err)
|
|
assert.ElementsMatch(t, []string{"README"}, changedFiles)
|
|
}
|
|
|
|
func Test_SemverTags(t *testing.T) {
|
|
tempDir := t.TempDir()
|
|
|
|
client, err := NewClientExt(fmt.Sprintf("file://%s", tempDir), tempDir, NopCreds{}, true, false, "", "")
|
|
require.NoError(t, err)
|
|
|
|
err = client.Init()
|
|
require.NoError(t, err)
|
|
|
|
mapTagRefs := map[string]string{}
|
|
for _, tag := range []string{
|
|
"v1.0.0-rc1",
|
|
"v1.0.0-rc2",
|
|
"v1.0.0",
|
|
"v1.0",
|
|
"v1.0.1",
|
|
"v1.1.0",
|
|
"2024-apple",
|
|
"2024-banana",
|
|
} {
|
|
err = runCmd(client.Root(), "git", "commit", "-m", tag+" commit", "--allow-empty")
|
|
require.NoError(t, err)
|
|
|
|
// Create an rc semver tag
|
|
err = runCmd(client.Root(), "git", "tag", tag)
|
|
require.NoError(t, err)
|
|
|
|
sha, err := client.LsRemote("HEAD")
|
|
require.NoError(t, err)
|
|
|
|
mapTagRefs[tag] = sha
|
|
}
|
|
|
|
for _, tc := range []struct {
|
|
name string
|
|
ref string
|
|
expected string
|
|
error bool
|
|
}{{
|
|
name: "pinned rc version",
|
|
ref: "v1.0.0-rc1",
|
|
expected: mapTagRefs["v1.0.0-rc1"],
|
|
}, {
|
|
name: "lt rc constraint",
|
|
ref: "< v1.0.0-rc3",
|
|
expected: mapTagRefs["v1.0.0-rc2"],
|
|
}, {
|
|
name: "pinned major version",
|
|
ref: "v1.0.0",
|
|
expected: mapTagRefs["v1.0.0"],
|
|
}, {
|
|
name: "pinned patch version",
|
|
ref: "v1.0.1",
|
|
expected: mapTagRefs["v1.0.1"],
|
|
}, {
|
|
name: "pinned minor version",
|
|
ref: "v1.1.0",
|
|
expected: mapTagRefs["v1.1.0"],
|
|
}, {
|
|
name: "patch wildcard constraint",
|
|
ref: "v1.0.*",
|
|
expected: mapTagRefs["v1.0.1"],
|
|
}, {
|
|
name: "patch tilde constraint",
|
|
ref: "~v1.0.0",
|
|
expected: mapTagRefs["v1.0.1"],
|
|
}, {
|
|
name: "minor wildcard constraint",
|
|
ref: "v1.*",
|
|
expected: mapTagRefs["v1.1.0"],
|
|
}, {
|
|
// The semver library allows for using both * and x as the wildcard modifier.
|
|
name: "alternative minor wildcard constraint",
|
|
ref: "v1.x",
|
|
expected: mapTagRefs["v1.1.0"],
|
|
}, {
|
|
name: "minor gte constraint",
|
|
ref: ">= v1.0.0",
|
|
expected: mapTagRefs["v1.1.0"],
|
|
}, {
|
|
name: "multiple constraints",
|
|
ref: "> v1.0.0 < v1.1.0",
|
|
expected: mapTagRefs["v1.0.1"],
|
|
}, {
|
|
// We treat non-specific semver versions as regular tags, rather than constraints.
|
|
name: "non-specific version",
|
|
ref: "v1.0",
|
|
expected: mapTagRefs["v1.0"],
|
|
}, {
|
|
// Which means a missing tag will raise an error.
|
|
name: "missing non-specific version",
|
|
ref: "v1.1",
|
|
error: true,
|
|
}, {
|
|
// This is NOT a semver constraint, so it should always resolve to itself - because specifying a tag should
|
|
// return the commit for that tag.
|
|
// semver/v3 has the unfortunate semver-ish behaviour where any tag starting with a number is considered to be
|
|
// "semver-ish", where that number is the semver major version, and the rest then gets coerced into a beta
|
|
// version string. This can cause unexpected behaviour with constraints logic.
|
|
// In this case, if the tag is being incorrectly coerced into semver (for being semver-ish), it will incorrectly
|
|
// return the commit for the 2024-banana tag; which we want to avoid.
|
|
name: "apple non-semver tag",
|
|
ref: "2024-apple",
|
|
expected: mapTagRefs["2024-apple"],
|
|
}, {
|
|
name: "banana non-semver tag",
|
|
ref: "2024-banana",
|
|
expected: mapTagRefs["2024-banana"],
|
|
}, {
|
|
// A semver version (without constraints) should ONLY match itself.
|
|
// We do not want "2024-apple" to get "semver-ish'ed" into matching "2024.0.0-apple"; they're different tags.
|
|
name: "no semver tag coercion",
|
|
ref: "2024.0.0-apple",
|
|
error: true,
|
|
}, {
|
|
// No minor versions are specified, so we would expect a major version of 2025 or more.
|
|
// This is because if we specify > 11 in semver, we would not expect 11.1.0 to pass; it should be 12.0.0 or more.
|
|
// Similarly, if we were to specify > 11.0, we would expect 11.1.0 or more.
|
|
name: "semver constraints on non-semver tags",
|
|
ref: "> 2024-apple",
|
|
error: true,
|
|
}, {
|
|
// However, if one specifies the minor/patch versions, semver constraints can be used to match non-semver tags.
|
|
// 2024-banana is considered as "2024.0.0-banana" in semver-ish, and banana > apple, so it's a match.
|
|
// Note: this is more for documentation and future reference than real testing, as it seems like quite odd behaviour.
|
|
name: "semver constraints on non-semver tags",
|
|
ref: "> 2024.0.0-apple",
|
|
expected: mapTagRefs["2024-banana"],
|
|
}} {
|
|
t.Run(tc.name, func(t *testing.T) {
|
|
commitSHA, err := client.LsRemote(tc.ref)
|
|
if tc.error {
|
|
require.Error(t, err)
|
|
return
|
|
}
|
|
require.NoError(t, err)
|
|
assert.True(t, IsCommitSHA(commitSHA))
|
|
assert.Equal(t, tc.expected, commitSHA)
|
|
})
|
|
}
|
|
}
|
|
|
|
func Test_nativeGitClient_Submodule(t *testing.T) {
|
|
tempDir, err := os.MkdirTemp("", "")
|
|
require.NoError(t, err)
|
|
|
|
foo := filepath.Join(tempDir, "foo")
|
|
err = os.Mkdir(foo, 0o755)
|
|
require.NoError(t, err)
|
|
|
|
err = runCmd(foo, "git", "init")
|
|
require.NoError(t, err)
|
|
|
|
bar := filepath.Join(tempDir, "bar")
|
|
err = os.Mkdir(bar, 0o755)
|
|
require.NoError(t, err)
|
|
|
|
err = runCmd(bar, "git", "init")
|
|
require.NoError(t, err)
|
|
|
|
err = runCmd(bar, "git", "commit", "-m", "Initial commit", "--allow-empty")
|
|
require.NoError(t, err)
|
|
|
|
// Embed repository bar into repository foo
|
|
t.Setenv("GIT_ALLOW_PROTOCOL", "file")
|
|
err = runCmd(foo, "git", "submodule", "add", bar)
|
|
require.NoError(t, err)
|
|
|
|
err = runCmd(foo, "git", "commit", "-m", "Initial commit")
|
|
require.NoError(t, err)
|
|
|
|
tempDir, err = os.MkdirTemp("", "")
|
|
require.NoError(t, err)
|
|
|
|
// Clone foo
|
|
err = runCmd(tempDir, "git", "clone", foo)
|
|
require.NoError(t, err)
|
|
|
|
client, err := NewClient(fmt.Sprintf("file://%s", foo), NopCreds{}, true, false, "", "")
|
|
require.NoError(t, err)
|
|
|
|
err = client.Init()
|
|
require.NoError(t, err)
|
|
|
|
err = client.Fetch("")
|
|
require.NoError(t, err)
|
|
|
|
commitSHA, err := client.LsRemote("HEAD")
|
|
require.NoError(t, err)
|
|
|
|
// Call Checkout() with submoduleEnabled=false.
|
|
err = client.Checkout(commitSHA, false)
|
|
require.NoError(t, err)
|
|
|
|
// Check if submodule url does not exist in .git/config
|
|
err = runCmd(client.Root(), "git", "config", "submodule.bar.url")
|
|
require.Error(t, err)
|
|
|
|
// Call Submodule() via Checkout() with submoduleEnabled=true.
|
|
err = client.Checkout(commitSHA, true)
|
|
require.NoError(t, err)
|
|
|
|
// Check if the .gitmodule URL is reflected in .git/config
|
|
cmd := exec.Command("git", "config", "submodule.bar.url")
|
|
cmd.Dir = client.Root()
|
|
result, err := cmd.Output()
|
|
require.NoError(t, err)
|
|
assert.Equal(t, bar+"\n", string(result))
|
|
|
|
// Change URL of submodule bar
|
|
err = runCmd(client.Root(), "git", "config", "--file=.gitmodules", "submodule.bar.url", bar+"baz")
|
|
require.NoError(t, err)
|
|
|
|
// Call Submodule()
|
|
err = client.Submodule()
|
|
require.NoError(t, err)
|
|
|
|
// Check if the URL change in .gitmodule is reflected in .git/config
|
|
cmd = exec.Command("git", "config", "submodule.bar.url")
|
|
cmd.Dir = client.Root()
|
|
result, err = cmd.Output()
|
|
require.NoError(t, err)
|
|
assert.Equal(t, bar+"baz\n", string(result))
|
|
}
|
|
|
|
func TestNewClient_invalidSSHURL(t *testing.T) {
|
|
client, err := NewClient("ssh://bitbucket.org:org/repo", NopCreds{}, false, false, "", "")
|
|
assert.Nil(t, client)
|
|
assert.ErrorIs(t, err, ErrInvalidRepoURL)
|
|
}
|
|
|
|
func Test_IsRevisionPresent(t *testing.T) {
|
|
tempDir := t.TempDir()
|
|
|
|
client, err := NewClientExt(fmt.Sprintf("file://%s", tempDir), tempDir, NopCreds{}, true, false, "", "")
|
|
require.NoError(t, err)
|
|
|
|
err = client.Init()
|
|
require.NoError(t, err)
|
|
|
|
p := path.Join(client.Root(), "README")
|
|
f, err := os.Create(p)
|
|
require.NoError(t, err)
|
|
_, err = f.WriteString("Hello.")
|
|
require.NoError(t, err)
|
|
err = f.Close()
|
|
require.NoError(t, err)
|
|
|
|
err = runCmd(client.Root(), "git", "add", "README")
|
|
require.NoError(t, err)
|
|
|
|
err = runCmd(client.Root(), "git", "commit", "-m", "Initial Commit", "-a")
|
|
require.NoError(t, err)
|
|
|
|
commitSHA, err := client.LsRemote("HEAD")
|
|
require.NoError(t, err)
|
|
|
|
// Ensure revision for HEAD is present locally.
|
|
revisionPresent := client.IsRevisionPresent(commitSHA)
|
|
assert.True(t, revisionPresent)
|
|
|
|
// Ensure invalid revision is not returned.
|
|
revisionPresent = client.IsRevisionPresent("invalid-revision")
|
|
assert.False(t, revisionPresent)
|
|
}
|
|
|
|
func Test_nativeGitClient_RevisionMetadata(t *testing.T) {
|
|
tempDir := t.TempDir()
|
|
client, err := NewClient(fmt.Sprintf("file://%s", tempDir), NopCreds{}, true, false, "", "")
|
|
require.NoError(t, err)
|
|
|
|
err = client.Init()
|
|
require.NoError(t, err)
|
|
|
|
p := path.Join(client.Root(), "README")
|
|
f, err := os.Create(p)
|
|
require.NoError(t, err)
|
|
_, err = f.WriteString("Hello.")
|
|
require.NoError(t, err)
|
|
err = f.Close()
|
|
require.NoError(t, err)
|
|
|
|
err = runCmd(client.Root(), "git", "config", "user.name", "FooBar ||| something\nelse")
|
|
require.NoError(t, err)
|
|
err = runCmd(client.Root(), "git", "config", "user.email", "foo@foo.com")
|
|
require.NoError(t, err)
|
|
|
|
err = runCmd(client.Root(), "git", "add", "README")
|
|
require.NoError(t, err)
|
|
err = runCmd(client.Root(), "git", "commit", "--date=\"Sat Jun 5 20:00:00 2021 +0000 UTC\"", "-m", `| Initial commit |
|
|
|
|
|
|
(╯°□°)╯︵ ┻━┻
|
|
`, "-a")
|
|
require.NoError(t, err)
|
|
|
|
metadata, err := client.RevisionMetadata("HEAD")
|
|
require.NoError(t, err)
|
|
require.Equal(t, &RevisionMetadata{
|
|
Author: `FooBar ||| somethingelse <foo@foo.com>`,
|
|
Date: time.Date(2021, time.June, 5, 20, 0, 0, 0, time.UTC).Local(),
|
|
Tags: []string{},
|
|
Message: "| Initial commit |\n\n(╯°□°)╯︵ ┻━┻",
|
|
}, metadata)
|
|
}
|