Merge pull request #715 from sviscaino/add-keep-worktrees-option
Add --stale-worktree-timeout option
This commit is contained in:
Kubernetes Prow Robot
GitHub
commit
e1c7c63987
|
|
@ -21,8 +21,10 @@ package main // import "k8s.io/git-sync/cmd/git-sync"
|
|||
import (
|
||||
"context"
|
||||
"crypto/md5"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
"io/fs"
|
||||
"net"
|
||||
"net/http"
|
||||
"net/http/pprof"
|
||||
|
|
@ -166,6 +168,9 @@ var flAskPassURL = pflag.String("askpass-url",
|
|||
envString("", "GITSYNC_ASKPASS_URL", "GIT_SYNC_ASKPASS_URL", "GIT_ASKPASS_URL"),
|
||||
"a URL to query for git credentials (username=<value> and password=<value>)")
|
||||
|
||||
var flStaleWorktreeTimeout = pflag.Duration("stale-worktree-timeout", envDuration(0, "GITSYNC_STALE_WORKTREE_TIMEOUT"),
|
||||
"how long to retain non-current worktrees")
|
||||
|
||||
var flGitCmd = pflag.String("git",
|
||||
envString("git", "GITSYNC_GIT", "GIT_SYNC_GIT"),
|
||||
"the git command to run (subject to PATH search, mostly for testing)")
|
||||
|
|
@ -488,6 +493,7 @@ type repoSync struct {
|
|||
syncCount int // how many times have we synced?
|
||||
log *logging.Logger
|
||||
run cmd.Runner
|
||||
staleTimeout time.Duration // time for worktrees to be cleaned up
|
||||
}
|
||||
|
||||
func main() {
|
||||
|
|
@ -803,6 +809,7 @@ func main() {
|
|||
sparseFile: *flSparseCheckoutFile,
|
||||
log: log,
|
||||
run: cmdRunner,
|
||||
staleTimeout: *flStaleWorktreeTimeout,
|
||||
}
|
||||
|
||||
// This context is used only for git credentials initialization. There are
|
||||
|
|
@ -963,6 +970,12 @@ func main() {
|
|||
start := time.Now()
|
||||
ctx, cancel := context.WithTimeout(context.Background(), *flSyncTimeout)
|
||||
|
||||
if git.staleTimeout > 0 {
|
||||
if err := git.cleanupStaleWorktrees(); err != nil {
|
||||
log.Error(err, "failed to clean up stale worktrees")
|
||||
}
|
||||
}
|
||||
|
||||
if changed, hash, err := git.SyncRepo(ctx, refreshCreds); err != nil {
|
||||
failCount++
|
||||
updateSyncMetrics(metricKeyError, start)
|
||||
|
|
@ -1068,11 +1081,15 @@ func touch(path absPath) error {
|
|||
if err := os.MkdirAll(dir, defaultDirMode); err != nil {
|
||||
return err
|
||||
}
|
||||
file, err := os.Create(path.String())
|
||||
if err != nil {
|
||||
return err
|
||||
if err := os.Chtimes(path.String(), time.Now(), time.Now()); errors.Is(err, fs.ErrNotExist) {
|
||||
file, createErr := os.Create(path.String())
|
||||
if createErr != nil {
|
||||
return createErr
|
||||
}
|
||||
return file.Close()
|
||||
} else {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
const redactedString = "REDACTED"
|
||||
|
|
@ -1272,6 +1289,21 @@ func (git *repoSync) initRepo(ctx context.Context) error {
|
|||
return nil
|
||||
}
|
||||
|
||||
func (git *repoSync) cleanupStaleWorktrees() error {
|
||||
currentWorktree, err := git.currentWorktree()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
err = removeDirContentsIf(git.worktreeFor("").Path(), git.log, func(fi os.FileInfo) (bool, error) {
|
||||
// delete files that are over the stale time out, and make sure to never delete the current worktree
|
||||
return fi.Name() != currentWorktree.Hash() && time.Since(fi.ModTime()) > git.staleTimeout, nil
|
||||
})
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
// sanityCheckRepo tries to make sure that the repo dir is a valid git repository.
|
||||
func (git *repoSync) sanityCheckRepo(ctx context.Context) bool {
|
||||
git.log.V(3).Info("sanity-checking git repo", "repo", git.root)
|
||||
|
|
@ -1340,27 +1372,36 @@ func dirIsEmpty(dir absPath) (bool, error) {
|
|||
return len(dirents) == 0, nil
|
||||
}
|
||||
|
||||
// removeDirContents iterated the specified dir and removes all contents,
|
||||
// except entries which are specifically excepted.
|
||||
func removeDirContents(dir absPath, log *logging.Logger, except ...string) error {
|
||||
// removeDirContents iterated the specified dir and removes all contents
|
||||
func removeDirContents(dir absPath, log *logging.Logger) error {
|
||||
return removeDirContentsIf(dir, log, func(fi os.FileInfo) (bool, error) {
|
||||
return true, nil
|
||||
})
|
||||
}
|
||||
|
||||
func removeDirContentsIf(dir absPath, log *logging.Logger, fn func(fi os.FileInfo) (bool, error)) error {
|
||||
dirents, err := os.ReadDir(dir.String())
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
exceptMap := map[string]bool{}
|
||||
for _, x := range except {
|
||||
exceptMap[x] = true
|
||||
}
|
||||
|
||||
// Save errors until the end.
|
||||
var errs multiError
|
||||
for _, fi := range dirents {
|
||||
name := fi.Name()
|
||||
if exceptMap[name] {
|
||||
p := filepath.Join(dir.String(), name)
|
||||
stat, err := os.Stat(p)
|
||||
if err != nil {
|
||||
log.Error(err, "failed to stat path, skipping", "path", p)
|
||||
continue
|
||||
}
|
||||
if shouldDelete, err := fn(stat); err != nil {
|
||||
log.Error(err, "failed to evaluate shouldDelete function, skipping", "path", p)
|
||||
continue
|
||||
} else if !shouldDelete {
|
||||
log.V(3).Info("skipping path that should not be removed", "path", p)
|
||||
continue
|
||||
}
|
||||
p := filepath.Join(dir.String(), name)
|
||||
if log != nil {
|
||||
log.V(3).Info("removing path recursively", "path", p, "isDir", fi.IsDir())
|
||||
}
|
||||
|
|
@ -1539,12 +1580,12 @@ func (git *repoSync) configureWorktree(ctx context.Context, worktree worktree) e
|
|||
|
||||
// cleanup removes old worktrees and runs git's garbage collection. The
|
||||
// specified worktree is preserved.
|
||||
func (git *repoSync) cleanup(ctx context.Context, worktree worktree) error {
|
||||
func (git *repoSync) cleanup(ctx context.Context) error {
|
||||
// Save errors until the end.
|
||||
var cleanupErrs multiError
|
||||
|
||||
// Clean up previous worktree(s).
|
||||
if err := removeDirContents(git.worktreeFor("").Path(), git.log, worktree.Hash()); err != nil {
|
||||
if err := git.cleanupStaleWorktrees(); err != nil {
|
||||
cleanupErrs = append(cleanupErrs, err)
|
||||
}
|
||||
|
||||
|
|
@ -1639,7 +1680,7 @@ func (git *repoSync) IsKnownHash(ctx context.Context, ref string) (bool, error)
|
|||
return strings.HasPrefix(line, ref), nil
|
||||
}
|
||||
|
||||
// worktree represents a git worktree (which may or may not exisat on disk).
|
||||
// worktree represents a git worktree (which may or may not exist on disk).
|
||||
type worktree absPath
|
||||
|
||||
// Hash returns the intended commit hash for this worktree.
|
||||
|
|
@ -1781,6 +1822,14 @@ func (git *repoSync) SyncRepo(ctx context.Context, refreshCreds func(context.Con
|
|||
if err != nil {
|
||||
return false, "", err
|
||||
}
|
||||
if currentWorktree != "" {
|
||||
// Touch the old worktree -- which will make cleanupStaleWorktrees delete it in the future,
|
||||
// if the stale timeout option is enabled
|
||||
err = touch(currentWorktree.Path())
|
||||
if err != nil {
|
||||
git.log.Error(err, "Couldn't change stale worktree mtime", "path", currentWorktree.Path())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// Mark ourselves as "ready".
|
||||
|
|
@ -1793,7 +1842,7 @@ func (git *repoSync) SyncRepo(ctx context.Context, refreshCreds func(context.Con
|
|||
// not get caught by the normal cleanup.
|
||||
os.RemoveAll(currentWorktree.Path().String())
|
||||
}
|
||||
if err := git.cleanup(ctx, newWorktree); err != nil {
|
||||
if err := git.cleanup(ctx); err != nil {
|
||||
git.log.Error(err, "git cleanup failed", "newWorktree", newWorktree)
|
||||
}
|
||||
}
|
||||
|
|
@ -2412,6 +2461,13 @@ OPTIONS
|
|||
The known_hosts file to use when --ssh-known-hosts is specified.
|
||||
If not specified, this defaults to "/etc/git-secret/known_hosts".
|
||||
|
||||
--stale-worktree-timeout <duration>, $GITSYNC_STALE_WORKTREE_TIMEOUT
|
||||
The length of time to retain stale (not the current link target)
|
||||
worktrees before being removed. Once this duration has elapsed,
|
||||
a stale worktree will be removed during the next sync attempt
|
||||
(as determined by --sync-timeout). If not specified, this defaults
|
||||
to 0, meaning that stale worktrees will be removed immediately.
|
||||
|
||||
--submodules <string>, $GITSYNC_SUBMODULES
|
||||
The git submodule behavior: one of "recursive", "shallow", or
|
||||
"off". If not specified, this defaults to "recursive".
|
||||
|
|
|
|||
229
test_e2e.sh
229
test_e2e.sh
|
|
@ -591,6 +591,235 @@ function e2e::worktree_cleanup() {
|
|||
assert_file_absent "$ROOT/.worktrees/not_a_directory"
|
||||
}
|
||||
|
||||
##############################################
|
||||
# Test stale-worktree-timeout
|
||||
##############################################
|
||||
function e2e::stale_worktree_timeout() {
|
||||
echo "$FUNCNAME 1" > "$REPO"/file
|
||||
git -C "$REPO" commit -qam "$FUNCNAME"
|
||||
WT1=$(git -C "$REPO" rev-list -n1 HEAD)
|
||||
GIT_SYNC \
|
||||
--period=100ms \
|
||||
--repo="file://$REPO" \
|
||||
--root="$ROOT" \
|
||||
--link="link" \
|
||||
--stale-worktree-timeout="5s" \
|
||||
&
|
||||
|
||||
# wait for first sync
|
||||
wait_for_sync "${MAXWAIT}"
|
||||
assert_link_exists "$ROOT"/link
|
||||
assert_file_exists "$ROOT"/link/file
|
||||
assert_file_eq "$ROOT"/link/file "$FUNCNAME 1"
|
||||
|
||||
# wait 2 seconds and make another commit
|
||||
sleep 2
|
||||
echo "$FUNCNAME 2" > "$REPO"/file2
|
||||
git -C "$REPO" add file2
|
||||
git -C "$REPO" commit -qam "$FUNCNAME new file"
|
||||
WT2=$(git -C "$REPO" rev-list -n1 HEAD)
|
||||
|
||||
# wait for second sync
|
||||
wait_for_sync "${MAXWAIT}"
|
||||
# at this point both WT1 and WT2 should exist, with
|
||||
# link pointing to the new WT2
|
||||
assert_link_exists "$ROOT"/link
|
||||
assert_file_exists "$ROOT"/link/file
|
||||
assert_file_exists "$ROOT"/link/file2
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT1/file
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT1/file2
|
||||
|
||||
# wait 2 seconds and make a third commit
|
||||
sleep 2
|
||||
echo "$FUNCNAME 3" > "$REPO"/file3
|
||||
git -C "$REPO" add file3
|
||||
git -C "$REPO" commit -qam "$FUNCNAME new file"
|
||||
WT3=$(git -C "$REPO" rev-list -n1 HEAD)
|
||||
|
||||
wait_for_sync "${MAXWAIT}"
|
||||
|
||||
# at this point WT1, WT2, WT3 should exist, with
|
||||
# link pointing to WT3
|
||||
assert_link_exists "$ROOT"/link
|
||||
assert_file_exists "$ROOT"/link/file
|
||||
assert_file_exists "$ROOT"/link/file2
|
||||
assert_file_exists "$ROOT"/link/file3
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT1/file
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT1/file2
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT1/file3
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT2/file
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT2/file2
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT2/file3
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT3/file
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT3/file2
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT3/file3
|
||||
|
||||
# wait for WT1 to go stale
|
||||
sleep 4
|
||||
|
||||
# now WT1 should be stale and deleted,
|
||||
# WT2 and WT3 should still exist
|
||||
assert_link_exists "$ROOT"/link
|
||||
assert_file_exists "$ROOT"/link/file
|
||||
assert_file_exists "$ROOT"/link/file2
|
||||
assert_file_exists "$ROOT"/link/file3
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT1/file
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT1/file2
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT1/file3
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT2/file
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT2/file2
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT2/file3
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT3/file
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT3/file2
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT3/file3
|
||||
|
||||
# wait for WT2 to go stale
|
||||
sleep 2
|
||||
|
||||
# now both WT1 and WT2 are stale, WT3 should be the only
|
||||
# worktree left
|
||||
assert_link_exists "$ROOT"/link
|
||||
assert_file_exists "$ROOT"/link/file
|
||||
assert_file_exists "$ROOT"/link/file2
|
||||
assert_file_exists "$ROOT"/link/file3
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT1/file
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT1/file2
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT1/file3
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT2/file
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT2/file2
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT2/file3
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT3/file
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT3/file2
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT3/file3
|
||||
}
|
||||
|
||||
##############################################
|
||||
# Test stale-worktree-timeout with restarts
|
||||
##############################################
|
||||
function e2e::stale_worktree_timeout_restart() {
|
||||
echo "$FUNCNAME 1" > "$REPO"/file
|
||||
git -C "$REPO" commit -qam "$FUNCNAME"
|
||||
WT1=$(git -C "$REPO" rev-list -n1 HEAD)
|
||||
GIT_SYNC \
|
||||
--period=100ms \
|
||||
--repo="file://$REPO" \
|
||||
--root="$ROOT" \
|
||||
--link="link" \
|
||||
--one-time
|
||||
|
||||
assert_link_exists "$ROOT"/link
|
||||
assert_file_exists "$ROOT"/link/file
|
||||
assert_file_eq "$ROOT"/link/file "$FUNCNAME 1"
|
||||
|
||||
# wait 2 seconds and make another commit
|
||||
sleep 2
|
||||
echo "$FUNCNAME 2" > "$REPO"/file2
|
||||
git -C "$REPO" add file2
|
||||
git -C "$REPO" commit -qam "$FUNCNAME new file"
|
||||
WT2=$(git -C "$REPO" rev-list -n1 HEAD)
|
||||
|
||||
# restart git-sync
|
||||
GIT_SYNC \
|
||||
--period=100ms \
|
||||
--repo="file://$REPO" \
|
||||
--root="$ROOT" \
|
||||
--link="link" \
|
||||
--stale-worktree-timeout="10s" \
|
||||
--one-time
|
||||
|
||||
# at this point both WT1 and WT2 should exist, with
|
||||
# link pointing to the new WT2
|
||||
assert_link_exists "$ROOT"/link
|
||||
assert_file_exists "$ROOT"/link/file
|
||||
assert_file_exists "$ROOT"/link/file2
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT1/file
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT1/file2
|
||||
|
||||
# wait 2 seconds and make a third commit
|
||||
sleep 4
|
||||
echo "$FUNCNAME 3" > "$REPO"/file3
|
||||
git -C "$REPO" add file3
|
||||
git -C "$REPO" commit -qam "$FUNCNAME new file"
|
||||
WT3=$(git -C "$REPO" rev-list -n1 HEAD)
|
||||
|
||||
# restart git-sync
|
||||
GIT_SYNC \
|
||||
--period=100ms \
|
||||
--repo="file://$REPO" \
|
||||
--root="$ROOT" \
|
||||
--link="link" \
|
||||
--stale-worktree-timeout="10s" \
|
||||
--one-time
|
||||
|
||||
# at this point WT1, WT2, WT3 should exist, with
|
||||
# link pointing to WT3
|
||||
assert_link_exists "$ROOT"/link
|
||||
assert_file_exists "$ROOT"/link/file
|
||||
assert_file_exists "$ROOT"/link/file2
|
||||
assert_file_exists "$ROOT"/link/file3
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT1/file
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT1/file2
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT1/file3
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT2/file
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT2/file2
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT2/file3
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT3/file
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT3/file2
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT3/file3
|
||||
|
||||
# wait for WT1 to go stale and restart git-sync
|
||||
sleep 8
|
||||
GIT_SYNC \
|
||||
--period=100ms \
|
||||
--repo="file://$REPO" \
|
||||
--root="$ROOT" \
|
||||
--link="link" \
|
||||
--stale-worktree-timeout="10s" \
|
||||
--one-time
|
||||
|
||||
# now WT1 should be stale and deleted,
|
||||
# WT2 and WT3 should still exist
|
||||
assert_link_exists "$ROOT"/link
|
||||
assert_file_exists "$ROOT"/link/file
|
||||
assert_file_exists "$ROOT"/link/file2
|
||||
assert_file_exists "$ROOT"/link/file3
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT1/file
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT1/file2
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT1/file3
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT2/file
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT2/file2
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT2/file3
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT3/file
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT3/file2
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT3/file3
|
||||
|
||||
# wait for WT2 to go stale and restart git-sync
|
||||
sleep 4
|
||||
GIT_SYNC \
|
||||
--period=100ms \
|
||||
--repo="file://$REPO" \
|
||||
--root="$ROOT" \
|
||||
--link="link" \
|
||||
--stale-worktree-timeout="10s" \
|
||||
--one-time
|
||||
|
||||
# now both WT1 and WT2 are stale, WT3 should be the only
|
||||
# worktree left
|
||||
assert_link_exists "$ROOT"/link
|
||||
assert_file_exists "$ROOT"/link/file
|
||||
assert_file_exists "$ROOT"/link/file2
|
||||
assert_file_exists "$ROOT"/link/file3
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT1/file
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT1/file2
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT1/file3
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT2/file
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT2/file2
|
||||
assert_file_absent "$ROOT"/.worktrees/$WT2/file3
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT3/file
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT3/file2
|
||||
assert_file_exists "$ROOT"/.worktrees/$WT3/file3
|
||||
}
|
||||
|
||||
##############################################
|
||||
# Test v3->v4 upgrade
|
||||
##############################################
|
||||
|
|
|
|||
Loading…
Reference in New Issue