paths: use user.User value to get home dir

Continuing our efforts to make our code unit testable, add a user.User
struct to the parameters for the methods in paths.go. This allows us to
remove the rest of the dependencies on the real system in the
GetRepositories() method. It requires some more work elsewhere in the
codebase for all the places where the path methods are used.

Signed-off-by: Derrick Stolee <[email protected]>

Author: derrickstolee

cmd/git-bundle-server/cron.go

@@ -5,10 +5,16 @@ import (
 	"os"
 	"strings"
 
+	"github.com/github/git-bundle-server/internal/common"
 	"github.com/github/git-bundle-server/internal/core"
 )
 
 func SetCronSchedule() error {
+	user, err := common.NewUserProvider().CurrentUser()
+	if err != nil {
+		return err
+	}
+
 	pathToExec, err := os.Executable()
 	if err != nil {
 		return fmt.Errorf("failed to get executable: %w", err)
@@ -33,7 +39,7 @@ func SetCronSchedule() error {
 	}
 
 	scheduleBytes = append(scheduleBytes, []byte(dailySchedule)...)
-	scheduleFile := core.CrontabFile()
+	scheduleFile := core.CrontabFile(user)
 
 	err = os.WriteFile(scheduleFile, scheduleBytes, 0o600)
 	if err != nil {

cmd/git-bundle-server/update-all.go

@@ -22,6 +22,10 @@ For every configured route, run 'git-bundle-server update <options> <route>'.`
 }
 
 func (UpdateAll) Run(args []string) error {
+	user, err := common.NewUserProvider().CurrentUser()
+	if err != nil {
+		return err
+	}
 	fs := common.NewFileSystem()
 
 	parser := argparse.NewArgParser("git-bundle-server update-all")
@@ -32,7 +36,7 @@ func (UpdateAll) Run(args []string) error {
 		return fmt.Errorf("failed to get path to execuable: %w", err)
 	}
 
-	repos, err := core.GetRepositories(fs)
+	repos, err := core.GetRepositories(user, fs)
 	if err != nil {
 		return err
 	}

cmd/git-bundle-web-server/main.go

@@ -35,6 +35,10 @@ func parseRoute(path string) (string, string, string, error) {
 }
 
 func serve(w http.ResponseWriter, r *http.Request) {
+	user, err := common.NewUserProvider().CurrentUser()
+	if err != nil {
+		return
+	}
 	fs := common.NewFileSystem()
 	path := r.URL.Path
 
@@ -47,7 +51,7 @@ func serve(w http.ResponseWriter, r *http.Request) {
 
 	route := owner + "/" + repo
 
-	repos, err := core.GetRepositories(fs)
+	repos, err := core.GetRepositories(user, fs)
 	if err != nil {
 		w.WriteHeader(http.StatusInternalServerError)
 		fmt.Printf("Failed to load routes\n")

internal/core/paths.go

@@ -1,25 +1,21 @@
 package core
 
-import "os"
+import (
+	"os/user"
+)
 
-func bundleroot() string {
-	dirname, err := os.UserHomeDir()
-	if err != nil {
-		// TODO: respond better. For now, try creating in "/var"
-		dirname = "/var"
-	}
-
-	return dirname + "/git-bundle-server/"
+func bundleroot(user *user.User) string {
+	return user.HomeDir + "/git-bundle-server/"
 }
 
-func webroot() string {
-	return bundleroot() + "www/"
+func webroot(user *user.User) string {
+	return bundleroot(user) + "www/"
 }
 
-func reporoot() string {
-	return bundleroot() + "git/"
+func reporoot(user *user.User) string {
+	return bundleroot(user) + "git/"
 }
 
-func CrontabFile() string {
-	return bundleroot() + "cron-schedule"
+func CrontabFile(user *user.User) string {
+	return bundleroot(user) + "cron-schedule"
 }

internal/core/repo.go

@@ -4,6 +4,7 @@ import (
 	"fmt"
 	"log"
 	"os"
+	"os/user"
 
 	"github.com/github/git-bundle-server/internal/common"
 )
@@ -15,8 +16,12 @@ type Repository struct {
 }
 
 func CreateRepository(route string) (*Repository, error) {
+	user, err := common.NewUserProvider().CurrentUser()
+	if err != nil {
+		return nil, err
+	}
 	fs := common.NewFileSystem()
-	repos, err := GetRepositories(fs)
+	repos, err := GetRepositories(user, fs)
 	if err != nil {
 		return nil, fmt.Errorf("failed to parse routes file")
 	}
@@ -26,8 +31,8 @@ func CreateRepository(route string) (*Repository, error) {
 		return &repo, nil
 	}
 
-	repodir := reporoot() + route
-	web := webroot() + route
+	repodir := reporoot(user) + route
+	web := webroot(user) + route
 
 	mkdirErr := os.MkdirAll(web, os.ModePerm)
 	if mkdirErr != nil {
@@ -51,8 +56,12 @@ func CreateRepository(route string) (*Repository, error) {
 }
 
 func RemoveRoute(route string) error {
+	user, err := common.NewUserProvider().CurrentUser()
+	if err != nil {
+		return err
+	}
 	fs := common.NewFileSystem()
-	repos, err := GetRepositories(fs)
+	repos, err := GetRepositories(user, fs)
 	if err != nil {
 		return fmt.Errorf("failed to parse routes file")
 	}
@@ -68,7 +77,11 @@ func RemoveRoute(route string) error {
 }
 
 func WriteRouteFile(repos map[string]Repository) error {
-	dir := bundleroot()
+	user, err := common.NewUserProvider().CurrentUser()
+	if err != nil {
+		return err
+	}
+	dir := bundleroot(user)
 	routefile := dir + "/routes"
 
 	contents := ""
@@ -80,10 +93,10 @@ func WriteRouteFile(repos map[string]Repository) error {
 	return os.WriteFile(routefile, []byte(contents), 0o600)
 }
 
-func GetRepositories(fs common.FileSystem) (map[string]Repository, error) {
+func GetRepositories(user *user.User, fs common.FileSystem) (map[string]Repository, error) {
 	repos := make(map[string]Repository)
 
-	dir := bundleroot()
+	dir := bundleroot(user)
 	routefile := dir + "/routes"
 
 	lines, err := fs.ReadFileLines(routefile)
@@ -97,8 +110,8 @@ func GetRepositories(fs common.FileSystem) (map[string]Repository, error) {
 
 		repo := Repository{
 			Route:   route,
-			RepoDir: reporoot() + route,
-			WebDir:  webroot() + route,
+			RepoDir: reporoot(user) + route,
+			WebDir:  webroot(user) + route,
 		}
 		repos[route] = repo
 	}

internal/daemon/shared_test.go

@@ -94,3 +94,8 @@ func (m *mockFileSystem) ReadFileLines(filename string) ([]string, error) {
 	fnArgs := m.Called(filename)
 	return fnArgs.Get(0).([]string), fnArgs.Error(1)
 }
+
+func (m *mockFileSystem) UserHomeDir() (string, error) {
+	fnArgs := m.Called()
+	return fnArgs.String(0), fnArgs.Error(1)
+}