repo: make method to write all repositories public

Rename the 'core.RepositoryProvider' function 'writeRouteFile()' to
'WriteAllRoutes()' to make it accessible from other packages. The ability to
make "bulk" changes to the repository registry and commit all at once will
be useful in future patches, such as rebuilding the route list based on the
repositories on disk.

Signed-off-by: Victoria Dye <[email protected]>

Author: vdye

internal/core/repo.go

@@ -21,6 +21,7 @@ type Repository struct {
 type RepositoryProvider interface {
 	CreateRepository(ctx context.Context, route string) (*Repository, error)
 	GetRepositories(ctx context.Context) (map[string]Repository, error)
+	WriteAllRoutes(ctx context.Context, repos map[string]Repository) error
 	ReadRepositoryStorage(ctx context.Context) (map[string]Repository, error)
 	RemoveRoute(ctx context.Context, route string) error
 }
@@ -80,7 +81,7 @@ func (r *repoProvider) CreateRepository(ctx context.Context, route string) (*Rep
 
 	repos[route] = repo
 
-	err = r.writeRouteFile(repos)
+	err = r.WriteAllRoutes(ctx, repos)
 	if err != nil {
 		return nil, fmt.Errorf("warning: failed to write route file")
 	}
@@ -104,23 +105,22 @@ func (r *repoProvider) RemoveRoute(ctx context.Context, route string) error {
 
 	delete(repos, route)
 
-	return r.writeRouteFile(repos)
+	return r.WriteAllRoutes(ctx, repos)
 }
 
-func (r *repoProvider) writeRouteFile(repos map[string]Repository) error {
+func (r *repoProvider) WriteAllRoutes(ctx context.Context, repos map[string]Repository) error {
 	user, err := r.user.CurrentUser()
 	if err != nil {
 		return err
 	}
 	routefile := filepath.Join(bundleroot(user), "routes")
 
 	contents := ""
-
 	for routes := range repos {
 		contents = contents + routes + "\n"
 	}
 
-	return os.WriteFile(routefile, []byte(contents), 0o600)
+	return r.fileSystem.WriteFile(routefile, []byte(contents))
 }
 
 func (r *repoProvider) GetRepositories(ctx context.Context) (map[string]Repository, error) {

internal/core/repo_test.go

@@ -5,6 +5,7 @@ import (
 	"errors"
 	"os/user"
 	"path/filepath"
+	"strings"
 	"testing"
 
 	"github.com/github/git-bundle-server/internal/common"
@@ -256,3 +257,83 @@ func TestRepos_ReadRepositoryStorage(t *testing.T) {
 		})
 	}
 }
+
+var writeAllRoutesTests = []struct {
+	title        string
+	repos        map[string]core.Repository
+	expectedFile []string
+}{
+	{
+		"empty repo map",
+		map[string]core.Repository{},
+		[]string{""},
+	},
+	{
+		"single repo",
+		map[string]core.Repository{
+			"test/route": {Route: "test/route"},
+		},
+		[]string{
+			"test/route",
+		},
+	},
+	{
+		"multiple repos",
+		map[string]core.Repository{
+			"test/route":   {Route: "test/route"},
+			"another/repo": {Route: "another/repo"},
+		},
+		[]string{
+			"test/route",
+			"another/repo",
+		},
+	},
+}
+
+func TestRepos_WriteAllRoutes(t *testing.T) {
+	testLogger := &MockTraceLogger{}
+	testFileSystem := &MockFileSystem{}
+	testUser := &user.User{
+		Uid:      "123",
+		Username: "testuser",
+		HomeDir:  "/my/test/dir",
+	}
+	testUserProvider := &MockUserProvider{}
+	testUserProvider.On("CurrentUser").Return(testUser, nil)
+	repoProvider := core.NewRepositoryProvider(testLogger, testUserProvider, testFileSystem, nil)
+
+	for _, tt := range writeAllRoutesTests {
+		t.Run(tt.title, func(t *testing.T) {
+			var actualFilename string
+			var actualFileBytes []byte
+
+			testFileSystem.On("WriteFile",
+				mock.MatchedBy(func(filename string) bool {
+					actualFilename = filename
+					return true
+				}),
+				mock.MatchedBy(func(fileBytes any) bool {
+					// Save off value and always match
+					actualFileBytes = fileBytes.([]byte)
+					return true
+				}),
+			).Return(nil).Once()
+
+			err := repoProvider.WriteAllRoutes(context.Background(), tt.repos)
+			assert.Nil(t, err)
+			mock.AssertExpectationsForObjects(t, testUserProvider, testFileSystem)
+
+			// Check filename
+			expectedFilename := filepath.Clean("/my/test/dir/git-bundle-server/routes")
+			assert.Equal(t, expectedFilename, actualFilename)
+
+			// Check routes file contents
+			fileLines := strings.Split(strings.TrimSpace(string(actualFileBytes)), "\n")
+
+			assert.ElementsMatch(t, tt.expectedFile, fileLines)
+
+			// Reset mocks
+			testFileSystem.Mock = mock.Mock{}
+		})
+	}
+}