github.com/wmuizelaar/kpt@v0.0.0-20221018115725-bd564717b2ed/internal/util/update/update.go

// Copyright 2019 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//      http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

// Package update contains libraries for updating packages.
package update

import (
	"context"
	"fmt"
	"os"
	"path"
	"path/filepath"
	"strings"

	"github.com/GoogleContainerTools/kpt/internal/errors"
	"github.com/GoogleContainerTools/kpt/internal/gitutil"
	"github.com/GoogleContainerTools/kpt/internal/pkg"
	"github.com/GoogleContainerTools/kpt/internal/printer"
	"github.com/GoogleContainerTools/kpt/internal/types"
	"github.com/GoogleContainerTools/kpt/internal/util/addmergecomment"
	"github.com/GoogleContainerTools/kpt/internal/util/fetch"
	"github.com/GoogleContainerTools/kpt/internal/util/git"
	"github.com/GoogleContainerTools/kpt/internal/util/pkgutil"
	"github.com/GoogleContainerTools/kpt/internal/util/stack"
	kptfilev1 "github.com/GoogleContainerTools/kpt/pkg/api/kptfile/v1"
	"github.com/GoogleContainerTools/kpt/pkg/kptfile/kptfileutil"
	"sigs.k8s.io/kustomize/kyaml/copyutil"
	"sigs.k8s.io/kustomize/kyaml/filesys"
)

// PkgNotGitRepoError is the error type returned if the package being updated is not inside
// a git repository.
type PkgNotGitRepoError struct {
	Path types.UniquePath
}

func (p *PkgNotGitRepoError) Error() string {
	return fmt.Sprintf("package %q is not a git repository", p.Path.String())
}

// PkgRepoDirtyError is the error type returned if the package being updated contains
// uncommitted changes.
type PkgRepoDirtyError struct {
	Path types.UniquePath
}

func (p *PkgRepoDirtyError) Error() string {
	return fmt.Sprintf("package %q contains uncommitted changes", p.Path.String())
}

type Options struct {
	// RelPackagePath is the relative path of a subpackage to the root. If the
	// package is root, the value here will be ".".
	RelPackagePath string

	// LocalPath is the absolute path to the package on the local fork.
	LocalPath string

	// OriginPath is the absolute path to the package in the on-disk clone
	// of the origin ref of the repo.
	OriginPath string

	// UpdatedPath is the absolute path to the package in the on-disk clone
	// of the updated ref of the repo.
	UpdatedPath string

	// IsRoot is true if the package is the root, i.e. the clones of
	// updated and origin were fetched based on the information in the
	// Kptfile from this package.
	IsRoot bool
}

// Updater updates a local package
type Updater interface {
	Update(options Options) error
}

var strategies = map[kptfilev1.UpdateStrategyType]func() Updater{
	kptfilev1.FastForward:        func() Updater { return FastForwardUpdater{} },
	kptfilev1.ForceDeleteReplace: func() Updater { return ReplaceUpdater{} },
	kptfilev1.ResourceMerge:      func() Updater { return ResourceMergeUpdater{} },
}

// Command updates the contents of a local package to a different version.
type Command struct {
	// Pkg captures information about the package that should be updated.
	Pkg *pkg.Pkg

	// Ref is the ref to update to
	Ref string

	// Strategy is the update strategy to use
	Strategy kptfilev1.UpdateStrategyType

	// cachedUpstreamRepos is an upstream repo already fetched for a given repoSpec CloneRef
	cachedUpstreamRepos map[string]*gitutil.GitUpstreamRepo
}

// Run runs the Command.
func (u *Command) Run(ctx context.Context) error {
	const op errors.Op = "update.Run"
	pr := printer.FromContextOrDie(ctx)

	if u.Pkg == nil {
		return errors.E(op, errors.MissingParam, "pkg must be provided")
	}

	rootKf, err := u.Pkg.Kptfile()
	if err != nil {
		return errors.E(op, u.Pkg.UniquePath, err)
	}

	if rootKf.Upstream == nil || rootKf.Upstream.Git == nil {
		return errors.E(op, u.Pkg.UniquePath,
			fmt.Errorf("package must have an upstream reference"))
	}
	originalRootKfRef := rootKf.Upstream.Git.Ref
	if u.Ref != "" {
		rootKf.Upstream.Git.Ref = u.Ref
	}
	if u.Strategy != "" {
		rootKf.Upstream.UpdateStrategy = u.Strategy
	}
	err = kptfileutil.WriteFile(u.Pkg.UniquePath.String(), rootKf)
	if err != nil {
		return errors.E(op, u.Pkg.UniquePath, err)
	}
	if u.cachedUpstreamRepos == nil {
		u.cachedUpstreamRepos = make(map[string]*gitutil.GitUpstreamRepo)
	}
	packageCount := 0

	// Use stack to keep track of paths with a Kptfile that might contain
	// information about remote subpackages.
	s := stack.NewPkgStack()
	s.Push(u.Pkg)

	for s.Len() > 0 {
		p := s.Pop()
		packageCount++

		if err := u.updateRootPackage(ctx, p); err != nil {
			return errors.E(op, p.UniquePath, err)
		}

		subPkgs, err := p.DirectSubpackages()
		if err != nil {
			return errors.E(op, p.UniquePath, err)
		}
		for _, subPkg := range subPkgs {
			subKf, err := subPkg.Kptfile()
			if err != nil {
				return errors.E(op, p.UniquePath, err)
			}

			if subKf.Upstream != nil && subKf.Upstream.Git != nil {
				// update subpackage kf ref/strategy if current pkg is a subpkg of root pkg or is root pkg
				// and if original root pkg ref matches the subpkg ref
				if shouldUpdateSubPkgRef(subKf, rootKf, originalRootKfRef) {
					updateSubKf(subKf, u.Ref, u.Strategy)
					err = kptfileutil.WriteFile(subPkg.UniquePath.String(), subKf)
					if err != nil {
						return errors.E(op, subPkg.UniquePath, err)
					}
				}
				s.Push(subPkg)
			}
		}
	}
	pr.Printf("\nUpdated %d package(s).\n", packageCount)

	// finally, make sure that the merge comments are added to all resources in the updated package
	if err := addmergecomment.Process(string(u.Pkg.UniquePath)); err != nil {
		return errors.E(op, u.Pkg.UniquePath, err)
	}
	return nil
}

// GetCachedUpstreamRepos returns repos cached during update
func (u Command) GetCachedUpstreamRepos() map[string]*gitutil.GitUpstreamRepo {
	return u.cachedUpstreamRepos
}

// updateSubKf updates subpackage with given ref and update strategy
func updateSubKf(subKf *kptfilev1.KptFile, ref string, strategy kptfilev1.UpdateStrategyType) {
	// check if explicit ref provided
	if ref != "" {
		subKf.Upstream.Git.Ref = ref
	}
	if strategy != "" {
		subKf.Upstream.UpdateStrategy = strategy
	}
}

// shouldUpdateSubPkgRef checks if subpkg ref should be updated.
// This is true if pkg has the same upstream repo, upstream directory is within or equal to root pkg directory and original root pkg ref matches the subpkg ref.
func shouldUpdateSubPkgRef(subKf, rootKf *kptfilev1.KptFile, originalRootKfRef string) bool {
	return subKf.Upstream.Git.Repo == rootKf.Upstream.Git.Repo &&
		subKf.Upstream.Git.Ref == originalRootKfRef &&
		strings.HasPrefix(path.Clean(subKf.Upstream.Git.Directory), path.Clean(rootKf.Upstream.Git.Directory))
}

// repoClone is an interface that represents a clone of a repo on the local
// disk.
type repoClone interface {
	AbsPath() string
}

// newNilRepoClone creates a new nilRepoClone that implements the repoClone
// interface
func newNilRepoClone() (*nilRepoClone, error) {
	const op errors.Op = "update.newNilRepoClone"
	dir, err := os.MkdirTemp("", "kpt-empty-")
	if err != nil {
		return nil, errors.E(op, errors.IO, fmt.Errorf("errors creating a temporary directory: %w", err))
	}
	return &nilRepoClone{
		dir: dir,
	}, nil
}

// nilRepoClone is an implementation of the repoClone interface, but that
// just represents an empty directory. This simplifies the logic for update
// since we don't have to special case situations where we don't have
// upstream and/or origin.
type nilRepoClone struct {
	dir string
}

// AbsPath returns the absolute path to the local directory for the repo. For
// the nilRepoClone, this will always be an empty directory.
func (nrc *nilRepoClone) AbsPath() string {
	return nrc.dir
}

// updateRootPackage updates a local package. It will use the information
// about upstream in the Kptfile to fetch upstream and origin, and then
// recursively traverse the hierarchy to add/update/delete packages.
func (u Command) updateRootPackage(ctx context.Context, p *pkg.Pkg) error {
	const op errors.Op = "update.updateRootPackage"
	kf, err := p.Kptfile()
	if err != nil {
		return errors.E(op, p.UniquePath, err)
	}

	pr := printer.FromContextOrDie(ctx)
	pr.PrintPackage(p, !(p == u.Pkg))

	g := kf.Upstream.Git
	updated := &git.RepoSpec{OrgRepo: g.Repo, Path: g.Directory, Ref: g.Ref}
	pr.Printf("Fetching upstream from %s@%s\n", kf.Upstream.Git.Repo, kf.Upstream.Git.Ref)
	cloner := fetch.NewCloner(updated, fetch.WithCachedRepo(u.cachedUpstreamRepos))
	if err := cloner.ClonerUsingGitExec(ctx); err != nil {
		return errors.E(op, p.UniquePath, err)
	}
	defer os.RemoveAll(updated.AbsPath())

	var origin repoClone
	if kf.UpstreamLock != nil {
		gLock := kf.UpstreamLock.Git
		originRepoSpec := &git.RepoSpec{OrgRepo: gLock.Repo, Path: gLock.Directory, Ref: gLock.Commit}
		pr.Printf("Fetching origin from %s@%s\n", kf.Upstream.Git.Repo, kf.Upstream.Git.Ref)
		if err := fetch.NewCloner(originRepoSpec, fetch.WithCachedRepo(u.cachedUpstreamRepos)).ClonerUsingGitExec(ctx); err != nil {
			return errors.E(op, p.UniquePath, err)
		}
		origin = originRepoSpec
	} else {
		origin, err = newNilRepoClone()
		if err != nil {
			return errors.E(op, p.UniquePath, err)
		}
	}
	defer os.RemoveAll(origin.AbsPath())

	s := stack.New()
	s.Push(".")

	for s.Len() > 0 {
		relPath := s.Pop()
		localPath := filepath.Join(p.UniquePath.String(), relPath)
		updatedPath := filepath.Join(updated.AbsPath(), relPath)
		originPath := filepath.Join(origin.AbsPath(), relPath)

		isRoot := false
		if relPath == "." {
			isRoot = true
		}

		if err := u.updatePackage(ctx, relPath, localPath, updatedPath, originPath, isRoot); err != nil {
			return errors.E(op, p.UniquePath, err)
		}

		paths, err := pkgutil.FindSubpackagesForPaths(pkg.Remote, false,
			localPath, updatedPath, originPath)
		if err != nil {
			return errors.E(op, p.UniquePath, err)
		}
		for _, path := range paths {
			s.Push(filepath.Join(relPath, path))
		}
	}

	if err := kptfileutil.UpdateUpstreamLockFromGit(p.UniquePath.String(), updated); err != nil {
		return errors.E(op, p.UniquePath, err)
	}
	return nil
}

// updatePackage takes care of updating a single package. The absolute paths to
// the local, updated and origin packages are provided, as well as the path to the
// package relative to the root.
// The last parameter tells if this package is the root, i.e. the package
// from which we got the information about upstream and origin.
//
//nolint:gocyclo
func (u Command) updatePackage(ctx context.Context, subPkgPath, localPath, updatedPath, originPath string, isRootPkg bool) error {
	const op errors.Op = "update.updatePackage"
	pr := printer.FromContextOrDie(ctx)

	localExists, err := pkg.IsPackageDir(filesys.FileSystemOrOnDisk{}, localPath)
	if err != nil {
		return errors.E(op, types.UniquePath(localPath), err)
	}

	// We need to handle the root package special here, since the copies
	// from updated and origin might not have a Kptfile at the root.
	updatedExists := isRootPkg
	if !isRootPkg {
		updatedExists, err = pkg.IsPackageDir(filesys.FileSystemOrOnDisk{}, updatedPath)
		if err != nil {
			return errors.E(op, types.UniquePath(localPath), err)
		}
	}

	originExists := isRootPkg
	if !isRootPkg {
		originExists, err = pkg.IsPackageDir(filesys.FileSystemOrOnDisk{}, originPath)
		if err != nil {
			return errors.E(op, types.UniquePath(localPath), err)
		}
	}

	switch {
	case !originExists && !localExists && !updatedExists:
		break
	// Check if subpackage has been added both in upstream and in local. We
	// can't make a sane merge here, so we treat it as an error.
	case !originExists && localExists && updatedExists:
		pr.Printf("Package %q added in both local and upstream.\n", packageName(localPath))
		return errors.E(op, types.UniquePath(localPath),
			fmt.Errorf("subpackage %q added in both upstream and local", subPkgPath))

	// Package added in upstream. We just copy the package. If the package
	// contains any unfetched subpackages, those will be handled when we traverse
	// the package hierarchy and that package is the root.
	case !originExists && !localExists && updatedExists:
		pr.Printf("Adding package %q from upstream.\n", packageName(localPath))
		if err := pkgutil.CopyPackage(updatedPath, localPath, !isRootPkg, pkg.None); err != nil {
			return errors.E(op, types.UniquePath(localPath), err)
		}

	// Package added locally, so no action needed.
	case !originExists && localExists && !updatedExists:
		break

	// Package deleted from both upstream and local, so no action needed.
	case originExists && !localExists && !updatedExists:
		break

	// Package deleted from local
	// In this case we assume the user knows what they are doing, so
	// we don't re-add the updated package from upstream.
	case originExists && !localExists && updatedExists:
		pr.Printf("Ignoring package %q in upstream since it is deleted from local.\n", packageName(localPath))

	// Package deleted from upstream
	case originExists && localExists && !updatedExists:
		// Check the diff. If there are local changes, we keep the subpackage.
		diff, err := copyutil.Diff(originPath, localPath)
		if err != nil {
			return errors.E(op, types.UniquePath(localPath), err)
		}
		if diff.Len() == 0 {
			pr.Printf("Deleting package %q from local since it is removed in upstream.\n", packageName(localPath))
			if err := os.RemoveAll(localPath); err != nil {
				return errors.E(op, types.UniquePath(localPath), err)
			}
		} else {
			pr.Printf("Package %q deleted from upstream, but keeping local since it has changes.\n", packageName(localPath))
		}
	default:
		if err := u.mergePackage(ctx, localPath, updatedPath, originPath, subPkgPath, isRootPkg); err != nil {
			return errors.E(op, types.UniquePath(localPath), err)
		}
	}
	return nil
}

func (u Command) mergePackage(ctx context.Context, localPath, updatedPath, originPath, relPath string, isRootPkg bool) error {
	const op errors.Op = "update.mergePackage"
	pr := printer.FromContextOrDie(ctx)
	// at this point, the localPath, updatedPath and originPath exists and are about to be merged
	// make sure that the merge comments are added to all of them so that they are merged accurately
	if err := addmergecomment.Process(localPath, updatedPath, originPath); err != nil {
		return errors.E(op, types.UniquePath(localPath),
			fmt.Errorf("failed to add merge comments %q", err.Error()))
	}
	updatedUnfetched, err := pkg.IsPackageUnfetched(updatedPath)
	if err != nil {
		if !errors.Is(err, os.ErrNotExist) || !isRootPkg {
			return errors.E(op, types.UniquePath(localPath), err)
		}
		// For root packages, there might not be a Kptfile in the upstream repo.
		updatedUnfetched = false
	}

	originUnfetched, err := pkg.IsPackageUnfetched(originPath)
	if err != nil {
		if !errors.Is(err, os.ErrNotExist) || !isRootPkg {
			return errors.E(op, types.UniquePath(localPath), err)
		}
		// For root packages, there might not be a Kptfile in origin.
		originUnfetched = false
	}

	switch {
	case updatedUnfetched && originUnfetched:
		fallthrough
	case updatedUnfetched && !originUnfetched:
		// updated is unfetched, so can't have changes except for Kptfile.
		// we can just merge that one.
		return kptfileutil.UpdateKptfile(localPath, updatedPath, originPath, true)
	case !updatedUnfetched && originUnfetched:
		// This means that the package was unfetched when local forked from upstream,
		// so the local fork and upstream might have fetched different versions of
		// the package. We just return an error here.
		// We might be able to compare the commit SHAs from local and updated
		// to determine if they share the common upstream and then fetch origin
		// using the common commit SHA. But this is a very advanced scenario,
		// so we just return the error for now.
		return errors.E(op, types.UniquePath(localPath), fmt.Errorf("no origin available for package"))
	default:
		// Both exists, so just go ahead as normal.
	}

	pkgKf, err := pkg.ReadKptfile(filesys.FileSystemOrOnDisk{}, localPath)
	if err != nil {
		return errors.E(op, types.UniquePath(localPath), err)
	}
	updater, found := strategies[pkgKf.Upstream.UpdateStrategy]
	if !found {
		return errors.E(op, types.UniquePath(localPath),
			fmt.Errorf("unrecognized update strategy %s", u.Strategy))
	}
	pr.Printf("Updating package %q with strategy %q.\n", packageName(localPath), pkgKf.Upstream.UpdateStrategy)
	if err := updater().Update(Options{
		RelPackagePath: relPath,
		LocalPath:      localPath,
		UpdatedPath:    updatedPath,
		OriginPath:     originPath,
		IsRoot:         isRootPkg,
	}); err != nil {
		return errors.E(op, types.UniquePath(localPath), err)
	}

	return nil
}

func packageName(path string) string {
	return filepath.Base(path)
}