7632a205d3
Add support and tests for the `--verbose` and `--object-map` flags to the `migrate export` command
316 lines
9.9 KiB
Go
316 lines
9.9 KiB
Go
package commands
|
|
|
|
import (
|
|
"fmt"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"github.com/git-lfs/git-lfs/errors"
|
|
"github.com/git-lfs/git-lfs/git"
|
|
"github.com/git-lfs/git-lfs/git/githistory"
|
|
"github.com/git-lfs/git-lfs/git/odb"
|
|
"github.com/git-lfs/git-lfs/tasklog"
|
|
"github.com/spf13/cobra"
|
|
)
|
|
|
|
var (
|
|
// migrateIncludeRefs is a set of Git references to explicitly include
|
|
// in the migration.
|
|
migrateIncludeRefs []string
|
|
// migrateExcludeRefs is a set of Git references to explicitly exclude
|
|
// in the migration.
|
|
migrateExcludeRefs []string
|
|
|
|
// migrateSkipFetch assumes that the client has the latest copy of
|
|
// remote references, and thus should not contact the remote for a set
|
|
// of updated references.
|
|
migrateSkipFetch bool
|
|
|
|
// migrateEverything indicates the presence of the --everything flag,
|
|
// and instructs 'git lfs migrate' to migrate all local references.
|
|
migrateEverything bool
|
|
|
|
// migrateVerbose enables verbose logging
|
|
migrateVerbose bool
|
|
|
|
// objectMapFile is the path to the map of old sha1 to new sha1
|
|
// commits
|
|
objectMapFilePath string
|
|
|
|
// migrateNoRewrite is the flag indicating whether or not the
|
|
// command should rewrite git history
|
|
migrateNoRewrite bool
|
|
// migrateCommitMessage is the message to use with the commit generated
|
|
// by the migrate command
|
|
migrateCommitMessage string
|
|
)
|
|
|
|
// migrate takes the given command and arguments, *odb.ObjectDatabase, as well
|
|
// as a BlobRewriteFn to apply, and performs a migration.
|
|
func migrate(args []string, r *githistory.Rewriter, l *tasklog.Logger, opts *githistory.RewriteOptions) {
|
|
requireInRepo()
|
|
|
|
opts, err := rewriteOptions(args, opts, l)
|
|
if err != nil {
|
|
ExitWithError(err)
|
|
}
|
|
|
|
_, err = r.Rewrite(opts)
|
|
if err != nil {
|
|
ExitWithError(err)
|
|
}
|
|
}
|
|
|
|
// getObjectDatabase creates a *git.ObjectDatabase from the filesystem pointed
|
|
// at the .git directory of the currently checked-out repository.
|
|
func getObjectDatabase() (*odb.ObjectDatabase, error) {
|
|
dir, err := git.GitDir()
|
|
if err != nil {
|
|
return nil, errors.Wrap(err, "cannot open root")
|
|
}
|
|
return odb.FromFilesystem(filepath.Join(dir, "objects"), cfg.TempDir())
|
|
}
|
|
|
|
// rewriteOptions returns *githistory.RewriteOptions able to be passed to a
|
|
// *githistory.Rewriter that reflect the current arguments and flags passed to
|
|
// an invocation of git-lfs-migrate(1).
|
|
//
|
|
// It is merged with the given "opts". In other words, an identical "opts" is
|
|
// returned, where the Include and Exclude fields have been filled based on the
|
|
// following rules:
|
|
//
|
|
// The included and excluded references are determined based on the output of
|
|
// includeExcludeRefs (see below for documentation and detail).
|
|
//
|
|
// If any of the above could not be determined without error, that error will be
|
|
// returned immediately.
|
|
func rewriteOptions(args []string, opts *githistory.RewriteOptions, l *tasklog.Logger) (*githistory.RewriteOptions, error) {
|
|
include, exclude, err := includeExcludeRefs(l, args)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return &githistory.RewriteOptions{
|
|
Include: include,
|
|
Exclude: exclude,
|
|
|
|
UpdateRefs: opts.UpdateRefs,
|
|
Verbose: opts.Verbose,
|
|
ObjectMapFilePath: opts.ObjectMapFilePath,
|
|
|
|
BlobFn: opts.BlobFn,
|
|
TreeCallbackFn: opts.TreeCallbackFn,
|
|
}, nil
|
|
}
|
|
|
|
// includeExcludeRefs returns fully-qualified sets of references to include, and
|
|
// exclude, or an error if those could not be determined.
|
|
//
|
|
// They are determined based on the following rules:
|
|
//
|
|
// - Include all local refs/heads/<branch> references for each branch
|
|
// specified as an argument.
|
|
// - Include the currently checked out branch if no branches are given as
|
|
// arguments and the --include-ref= or --exclude-ref= flag(s) aren't given.
|
|
// - Include all references given in --include-ref=<ref>.
|
|
// - Exclude all references given in --exclude-ref=<ref>.
|
|
func includeExcludeRefs(l *tasklog.Logger, args []string) (include, exclude []string, err error) {
|
|
hardcore := len(migrateIncludeRefs) > 0 || len(migrateExcludeRefs) > 0
|
|
|
|
if len(args) == 0 && !hardcore && !migrateEverything {
|
|
// If no branches were given explicitly AND neither
|
|
// --include-ref or --exclude-ref flags were given, then add the
|
|
// currently checked out reference.
|
|
current, err := currentRefToMigrate()
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
args = append(args, current.Name)
|
|
}
|
|
|
|
if migrateEverything && len(args) > 0 {
|
|
return nil, nil, errors.New("fatal: cannot use --everything with explicit reference arguments")
|
|
}
|
|
|
|
for _, name := range args {
|
|
var excluded bool
|
|
if strings.HasPrefix("^", name) {
|
|
name = name[1:]
|
|
excluded = true
|
|
}
|
|
|
|
// Then, loop through each branch given, resolve that reference,
|
|
// and include it.
|
|
ref, err := git.ResolveRef(name)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
|
|
if excluded {
|
|
exclude = append(exclude, ref.Refspec())
|
|
} else {
|
|
include = append(include, ref.Refspec())
|
|
}
|
|
}
|
|
|
|
if hardcore {
|
|
if migrateEverything {
|
|
return nil, nil, errors.New("fatal: cannot use --everything with --include-ref or --exclude-ref")
|
|
}
|
|
|
|
// If either --include-ref=<ref> or --exclude-ref=<ref> were
|
|
// given, append those to the include and excluded reference
|
|
// set, respectively.
|
|
include = append(include, migrateIncludeRefs...)
|
|
exclude = append(exclude, migrateExcludeRefs...)
|
|
} else if migrateEverything {
|
|
localRefs, err := git.LocalRefs()
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
|
|
for _, ref := range localRefs {
|
|
include = append(include, ref.Refspec())
|
|
}
|
|
} else {
|
|
bare, err := git.IsBare()
|
|
if err != nil {
|
|
return nil, nil, errors.Wrap(err, "fatal: unable to determine bareness")
|
|
}
|
|
|
|
if !bare {
|
|
// Otherwise, if neither --include-ref=<ref> or
|
|
// --exclude-ref=<ref> were given, include no additional
|
|
// references, and exclude all remote references that
|
|
// are remote branches or remote tags.
|
|
remoteRefs, err := getRemoteRefs(l)
|
|
if err != nil {
|
|
return nil, nil, err
|
|
}
|
|
|
|
for _, rr := range remoteRefs {
|
|
exclude = append(exclude, rr.Refspec())
|
|
}
|
|
}
|
|
}
|
|
|
|
return include, exclude, nil
|
|
}
|
|
|
|
// getRemoteRefs returns a fully qualified set of references belonging to all
|
|
// remotes known by the currently checked-out repository, or an error if those
|
|
// references could not be determined.
|
|
func getRemoteRefs(l *tasklog.Logger) ([]*git.Ref, error) {
|
|
var refs []*git.Ref
|
|
|
|
remotes, err := git.RemoteList()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
if !migrateSkipFetch {
|
|
w := l.Waiter("migrate: Fetching remote refs")
|
|
if err := git.Fetch(remotes...); err != nil {
|
|
return nil, err
|
|
}
|
|
w.Complete()
|
|
}
|
|
|
|
for _, remote := range remotes {
|
|
var refsForRemote []*git.Ref
|
|
if migrateSkipFetch {
|
|
refsForRemote, err = git.CachedRemoteRefs(remote)
|
|
} else {
|
|
refsForRemote, err = git.RemoteRefs(remote)
|
|
}
|
|
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
for _, rr := range refsForRemote {
|
|
// HACK(@ttaylorr): add remote name to fully-qualify
|
|
// references:
|
|
rr.Name = fmt.Sprintf("%s/%s", remote, rr.Name)
|
|
|
|
refs = append(refs, rr)
|
|
}
|
|
}
|
|
|
|
return refs, nil
|
|
}
|
|
|
|
// formatRefName returns the fully-qualified name for the given Git reference
|
|
// "ref".
|
|
func formatRefName(ref *git.Ref, remote string) string {
|
|
var name []string
|
|
|
|
switch ref.Type {
|
|
case git.RefTypeRemoteBranch:
|
|
name = []string{"refs", "remotes", remote, ref.Name}
|
|
case git.RefTypeRemoteTag:
|
|
name = []string{"refs", "tags", ref.Name}
|
|
default:
|
|
return ref.Name
|
|
}
|
|
return strings.Join(name, "/")
|
|
|
|
}
|
|
|
|
// currentRefToMigrate returns the fully-qualified name of the currently
|
|
// checked-out reference, or an error if the reference's type was not a local
|
|
// branch.
|
|
func currentRefToMigrate() (*git.Ref, error) {
|
|
current, err := git.CurrentRef()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
if current.Type == git.RefTypeOther ||
|
|
current.Type == git.RefTypeRemoteBranch ||
|
|
current.Type == git.RefTypeRemoteTag {
|
|
|
|
return nil, errors.Errorf("fatal: cannot migrate non-local ref: %s", current.Name)
|
|
}
|
|
return current, nil
|
|
}
|
|
|
|
// getHistoryRewriter returns a history rewriter that includes the filepath
|
|
// filter given by the --include and --exclude arguments.
|
|
func getHistoryRewriter(cmd *cobra.Command, db *odb.ObjectDatabase, l *tasklog.Logger) *githistory.Rewriter {
|
|
include, exclude := getIncludeExcludeArgs(cmd)
|
|
filter := buildFilepathFilter(cfg, include, exclude)
|
|
|
|
return githistory.NewRewriter(db,
|
|
githistory.WithFilter(filter), githistory.WithLogger(l))
|
|
}
|
|
|
|
func init() {
|
|
info := NewCommand("info", migrateInfoCommand)
|
|
info.Flags().IntVar(&migrateInfoTopN, "top", 5, "--top=<n>")
|
|
info.Flags().StringVar(&migrateInfoAboveFmt, "above", "", "--above=<n>")
|
|
info.Flags().StringVar(&migrateInfoUnitFmt, "unit", "", "--unit=<unit>")
|
|
|
|
importCmd := NewCommand("import", migrateImportCommand)
|
|
importCmd.Flags().BoolVar(&migrateVerbose, "verbose", false, "Verbose logging")
|
|
importCmd.Flags().StringVar(&objectMapFilePath, "object-map", "", "Object map file")
|
|
importCmd.Flags().BoolVar(&migrateNoRewrite, "no-rewrite", false, "Add new history without rewriting previous")
|
|
importCmd.Flags().StringVarP(&migrateCommitMessage, "message", "m", "", "With --no-rewrite, an optional commit message")
|
|
|
|
exportCmd := NewCommand("export", migrateExportCommand)
|
|
exportCmd.Flags().BoolVar(&migrateVerbose, "verbose", false, "Verbose logging")
|
|
exportCmd.Flags().StringVar(&objectMapFilePath, "object-map", "", "Object map file")
|
|
|
|
RegisterCommand("migrate", nil, func(cmd *cobra.Command) {
|
|
cmd.PersistentFlags().StringVarP(&includeArg, "include", "I", "", "Include a list of paths")
|
|
cmd.PersistentFlags().StringVarP(&excludeArg, "exclude", "X", "", "Exclude a list of paths")
|
|
|
|
cmd.PersistentFlags().StringSliceVar(&migrateIncludeRefs, "include-ref", nil, "An explicit list of refs to include")
|
|
cmd.PersistentFlags().StringSliceVar(&migrateExcludeRefs, "exclude-ref", nil, "An explicit list of refs to exclude")
|
|
cmd.PersistentFlags().BoolVar(&migrateEverything, "everything", false, "Migrate all local references")
|
|
cmd.PersistentFlags().BoolVar(&migrateSkipFetch, "skip-fetch", false, "Assume up-to-date remote references.")
|
|
|
|
cmd.AddCommand(exportCmd, importCmd, info)
|
|
})
|
|
}
|