github.com/Benchkram/bob@v0.0.0-20220321080157-7c8f3876e225/bobgit/add.go

package bobgit

import (
	"bufio"
	"bytes"
	"os"
	"path/filepath"
	"strings"

	"github.com/Benchkram/bob/bobgit/pathspec"
	"github.com/Benchkram/bob/pkg/bobutil"
	"github.com/Benchkram/bob/pkg/cmdutil"
	"github.com/Benchkram/bob/pkg/usererror"
	"github.com/Benchkram/errz"
)

// pathspecItem stores a git pathspec with the repository
// path relative to the bob root
type pathspecItem struct {
	pathspec string
	repo     string
}

// Add run git add commands by travsersing all the repositories
// inside the bob workspace.
//
// if target is provided "." it selects all modified files
// in all repos by running `git add . --dry-run`, then run
// `git add {filename}` for all selected files.
//
// else for subdirectory e.g. `subdir/.` it selectes all files
// on that subdir and also all repository under that subtree
// and run `git add --dry-run` followed by `git add {filename}`
//
// else for specific file under any repository on bob workspace
// select the specific repository and run `git add --dry-run` followed
// by `git add {filename}`.
//
// Run all the steps iterativley for multiple targets.
func Add(targets ...string) (err error) {
	pathlist := []pathspecItem{}

	for _, target := range targets {
		defer errz.Recover(&err)

		bobRoot, err := bobutil.FindBobRoot()
		errz.Fatal(err)

		target, err = convertPathRelativeToRoot(bobRoot, target)
		if err != nil {
			return usererror.Wrap(err)
		}

		err = os.Chdir(bobRoot)
		errz.Fatal(err)

		// Assure toplevel is a git repo
		isGit, err := isGitRepo(bobRoot)
		errz.Fatal(err)
		if !isGit {
			return usererror.Wrap(ErrCouldNotFindGitDir)
		}

		ps := pathspec.New(target)

		// search for git repos inside bobRoot/.
		allRepos, err := findRepos(bobRoot)
		errz.Fatal(err)

		filteredRepos := ps.SelectReposByPath(allRepos)

		for _, name := range filteredRepos {
			thistarget, err := ps.GetRelativePathspec(name)
			errz.Fatal(err)

			if name == "." {
				name = strings.TrimSuffix(name, ".")
			}

			output, err := cmdutil.GitAddDry(name, thistarget)
			if err != nil {
				return usererror.Wrapm(err, "Failed to Add files to git.")
			}

			filenames := parseAddDryOutput(output)

			for _, f := range filenames {
				pathspecItem := pathspecItem{
					repo:     name,
					pathspec: f,
				}
				pathlist = append(pathlist, pathspecItem)
			}
		}
	}

	for _, pi := range pathlist {
		err = cmdutil.GitAdd(pi.repo, pi.pathspec)
		if err != nil {
			return usererror.Wrapm(err, "Failed to Add files to git.")
		}
	}

	return nil
}

// parseAddDryOutput parse the output from `git add --dry-run`
// and returns a list of filenames
//
// Example output:
//   $ git add . --dry-run
//   add 'bobgit/add.go'
//   add 'bobgit/bobgit.go'
//   add 'qq'
//
func parseAddDryOutput(buf []byte) (_ []string) {
	fileNames := []string{}

	scanner := bufio.NewScanner(bytes.NewBuffer(buf))
	for scanner.Scan() {
		line := scanner.Text()
		nameStart := strings.Index(line, "'") + 1
		nameEnd := strings.Index(line[nameStart:], "'") + nameStart
		fileName := line[nameStart:nameEnd]
		fileNames = append(fileNames, fileName)
	}

	return fileNames
}

// convertPathRelativeToRoot returns the relative targetpath from
// the provided root.
//
// Example:  `../sample/path` => `bobroot/sample/path`.
//
// also handles git pathspec features like `.`
//
// Example: `sample/.` => `bobroot/sample/.`
func convertPathRelativeToRoot(root string, target string) (string, error) {
	dir, err := filepath.Abs(target)
	errz.Fatal(err)

	if dir == root {
		return ".", nil
	}

	if !strings.HasPrefix(dir, root) {
		return target, ErrOutsideBobWorkspace
	}
	relativepath, err := filepath.Rel(root, dir)
	errz.Fatal(err)

	if target == "." || target == "" || strings.HasSuffix(target, "/.") {
		relativepath = relativepath + "/."
	}

	return relativepath, nil
}