Skip to content

Commit

Permalink
git: add a cache based on bundles
Browse files Browse the repository at this point in the history
Signed-off-by: Christophe de Vienne <[email protected]>
  • Loading branch information
cdevienne committed May 10, 2024
1 parent 9e6fdb7 commit ea8bcde
Show file tree
Hide file tree
Showing 3 changed files with 59 additions and 6 deletions.
2 changes: 1 addition & 1 deletion pkg/vendir/directory/directory.go
Original file line number Diff line number Diff line change
Expand Up @@ -112,7 +112,7 @@ func (d *Directory) Sync(syncOpts SyncOpts) (ctlconf.LockDirectory, error) {

d.ui.PrintLinef("Fetching: %s + %s (git from %s)", d.opts.Path, contents.Path, gitSync.Desc())

lock, err := gitSync.Sync(stagingDstPath, stagingDir.TempArea())
lock, err := gitSync.Sync(stagingDstPath, stagingDir.TempArea(), syncOpts.Cache)
if err != nil {
return lockConfig, fmt.Errorf("Syncing directory '%s' with git contents: %s", contents.Path, err)
}
Expand Down
10 changes: 7 additions & 3 deletions pkg/vendir/fetch/git/git.go
Original file line number Diff line number Diff line change
Expand Up @@ -47,12 +47,12 @@ type GitInfo struct {
CommitTitle string
}

func (t *Git) Retrieve(dstPath string, tempArea ctlfetch.TempArea) (GitInfo, error) {
func (t *Git) Retrieve(dstPath string, tempArea ctlfetch.TempArea, bundle string) (GitInfo, error) {
if len(t.opts.URL) == 0 {
return GitInfo{}, fmt.Errorf("Expected non-empty URL")
}

err := t.fetch(dstPath, tempArea)
err := t.fetch(dstPath, tempArea, bundle)
if err != nil {
return GitInfo{}, err
}
Expand Down Expand Up @@ -81,7 +81,7 @@ func (t *Git) Retrieve(dstPath string, tempArea ctlfetch.TempArea) (GitInfo, err
return info, nil
}

func (t *Git) fetch(dstPath string, tempArea ctlfetch.TempArea) error {
func (t *Git) fetch(dstPath string, tempArea ctlfetch.TempArea, bundle string) error {
authOpts, err := t.getAuthOpts()
if err != nil {
return err
Expand Down Expand Up @@ -168,6 +168,10 @@ func (t *Git) fetch(dstPath string, tempArea ctlfetch.TempArea) error {

argss = append(argss, []string{"config", "remote.origin.tagOpt", "--tags"})

if bundle != "" {
argss = append(argss, []string{"bundle", "unbundle", bundle})
}

{
fetchArgs := []string{"fetch", "origin"}
if strings.HasPrefix(t.opts.Ref, "origin/") {
Expand Down
53 changes: 51 additions & 2 deletions pkg/vendir/fetch/git/sync.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,20 @@
package git

import (
"crypto/sha256"
"fmt"
"io"
"os"
"path/filepath"
"strings"

ctlconf "carvel.dev/vendir/pkg/vendir/config"
ctlfetch "carvel.dev/vendir/pkg/vendir/fetch"
ctlcache "carvel.dev/vendir/pkg/vendir/fetch/cache"
)

const gitCacheType = "git-bundle"

type Sync struct {
opts ctlconf.DirectoryContentsGit
log io.Writer
Expand All @@ -36,7 +41,7 @@ func (d Sync) Desc() string {
return fmt.Sprintf("%s@%s", d.opts.URL, ref)
}

func (d Sync) Sync(dstPath string, tempArea ctlfetch.TempArea) (ctlconf.LockDirectoryContentsGit, error) {
func (d Sync) Sync(dstPath string, tempArea ctlfetch.TempArea, cache ctlcache.Cache) (ctlconf.LockDirectoryContentsGit, error) {
gitLockConf := ctlconf.LockDirectoryContentsGit{}

incomingTmpPath, err := tempArea.NewTempDir("git")
Expand All @@ -46,9 +51,24 @@ func (d Sync) Sync(dstPath string, tempArea ctlfetch.TempArea) (ctlconf.LockDire

defer os.RemoveAll(incomingTmpPath)

sum := sha256.New()
if _, err := sum.Write([]byte(d.opts.URL)); err != nil {
if err != nil {
return gitLockConf, err
}
}

cacheID := string(sum.Sum(nil))

git := NewGit(d.opts, d.log, d.refFetcher)

info, err := git.Retrieve(incomingTmpPath, tempArea)
var bundle string
if cacheEntry, hasCache := cache.Has(gitCacheType, cacheID); hasCache {
bundle = filepath.Join(cacheEntry, "bundle")
}
fmt.Println("We got cache?", cacheID, bundle)

info, err := git.Retrieve(incomingTmpPath, tempArea, bundle)
if err != nil {
return gitLockConf, fmt.Errorf("Fetching git repository: %s", err)
}
Expand All @@ -57,6 +77,35 @@ func (d Sync) Sync(dstPath string, tempArea ctlfetch.TempArea) (ctlconf.LockDire
gitLockConf.Tags = info.Tags
gitLockConf.CommitTitle = d.singleLineCommitTitle(info.CommitTitle)

if os.Getenv("VENDIR_CACHE_DIR") != "" {
// attempt to save a bundle to the cache
bundleDir, err := tempArea.NewTempDir("bundleCache")
if err != nil {
return gitLockConf, err
}
defer os.RemoveAll(bundleDir)
bundle := filepath.Join(bundleDir, "bundle")
// get all refs

out, _, err := git.cmdRunner.Run([]string{"for-each-ref", "--format=%(refname)"}, nil, incomingTmpPath)
if err != nil {
return gitLockConf, err
}
var refs []string
for _, ref := range strings.Split(string(out), "\n") {
ref = strings.TrimSpace(ref)
if ref != "" {
refs = append(refs, ref)
}
}
if _, _, err := git.cmdRunner.Run(append([]string{"bundle", "create", bundle}, refs...), nil, incomingTmpPath); err != nil {
return gitLockConf, err
}
if err := cache.Save(gitCacheType, cacheID, bundleDir); err != nil {
return gitLockConf, err
}
}

err = os.RemoveAll(dstPath)
if err != nil {
return gitLockConf, fmt.Errorf("Deleting dir %s: %s", dstPath, err)
Expand Down

0 comments on commit ea8bcde

Please sign in to comment.