feat: copy libraries and global files from container output to repo in release init command (#1790)

Updates #1008

Author: JoeWang1127

internal/librarian/command.go

@@ -19,6 +19,7 @@ import (
 	"errors"
 	"fmt"
 	"log/slog"
+	"os"
 	"path"
 	"path/filepath"
 	"strings"
@@ -191,6 +192,26 @@ func formatTimestamp(t time.Time) string {
 	return t.Format(yyyyMMddHHmmss)
 }
 
+// cleanAndCopyLibrary cleans the files of the given library in repoDir and copies
+// the new files from outputDir.
+func cleanAndCopyLibrary(state *config.LibrarianState, repoDir, libraryID, outputDir string) error {
+	library := findLibraryByID(state, libraryID)
+	if library == nil {
+		return fmt.Errorf("library %q not found during clean and copy, despite being found in earlier steps", libraryID)
+	}
+	slog.Info("Clean destinations and copy generated results for library", "id", libraryID)
+	if err := clean(repoDir, library.RemoveRegex, library.PreserveRegex); err != nil {
+		return err
+	}
+	// os.CopyFS in Go1.24 returns error when copying from a symbolic link
+	// https://github.com/golang/go/blob/9d828e80fa1f3cc52de60428cae446b35b576de8/src/os/dir.go#L143-L144
+	if err := os.CopyFS(repoDir, os.DirFS(outputDir)); err != nil {
+		return err
+	}
+	slog.Info("Library updated", "id", libraryID)
+	return nil
+}
+
 // commitAndPush creates a commit and push request to GitHub for the generated
 // changes.
 // It uses the GitHub client to create a PR with the specified branch, title, and

internal/librarian/command_test.go

@@ -275,6 +275,84 @@ func TestCloneOrOpenLanguageRepo(t *testing.T) {
 	}
 }
 
+func TestCleanAndCopyLibrary(t *testing.T) {
+	t.Parallel()
+	for _, test := range []struct {
+		name        string
+		libraryID   string
+		state       *config.LibrarianState
+		repo        gitrepo.Repository
+		outputDir   string
+		setup       func(t *testing.T, outputDir string)
+		wantErr     bool
+		errContains string
+	}{
+		{
+			name:      "library not found",
+			libraryID: "non-existent-library",
+			state: &config.LibrarianState{
+				Libraries: []*config.LibraryState{
+					{
+						ID: "some-library",
+					},
+				},
+			},
+			repo:    newTestGitRepo(t),
+			wantErr: true,
+		},
+		{
+			name:      "clean fails",
+			libraryID: "some-library",
+			state: &config.LibrarianState{
+				Libraries: []*config.LibraryState{
+					{
+						ID:          "some-library",
+						RemoveRegex: []string{"["}, // Invalid regex
+					},
+				},
+			},
+			repo:    newTestGitRepo(t),
+			wantErr: true,
+		},
+		{
+			name:      "copy fails on symlink",
+			libraryID: "some-library",
+			state: &config.LibrarianState{
+				Libraries: []*config.LibraryState{
+					{
+						ID: "some-library",
+					},
+				},
+			},
+			repo: newTestGitRepo(t),
+			setup: func(t *testing.T, outputDir string) {
+				// Create a symlink in the output directory to trigger an error.
+				if err := os.Symlink("target", filepath.Join(outputDir, "symlink")); err != nil {
+					t.Fatalf("os.Symlink() = %v", err)
+				}
+			},
+			wantErr: true,
+		},
+	} {
+		t.Run(test.name, func(t *testing.T) {
+			outputDir := t.TempDir()
+			if test.setup != nil {
+				test.setup(t, outputDir)
+			}
+			err := cleanAndCopyLibrary(test.state, test.repo.GetDir(), test.libraryID, outputDir)
+			if test.wantErr {
+				if err == nil {
+					t.Errorf("%s should return error", test.name)
+				}
+				return
+			}
+			if err != nil {
+				t.Fatal(err)
+			}
+		})
+	}
+}
+
 func TestCommitAndPush(t *testing.T) {
 	for _, test := range []struct {
 		name             string

internal/librarian/generate.go

@@ -236,31 +236,13 @@ func (r *generateRunner) runGenerateCommand(ctx context.Context, libraryID, outp
 		return "", err
 	}
 
-	if err := r.cleanAndCopyLibrary(libraryID, outputDir); err != nil {
+	if err := cleanAndCopyLibrary(r.state, r.repo.GetDir(), libraryID, outputDir); err != nil {
 		return "", err
 	}
 
 	return libraryID, nil
 }
 
-func (r *generateRunner) cleanAndCopyLibrary(libraryID, outputDir string) error {
-	library := findLibraryByID(r.state, libraryID)
-	if library == nil {
-		return fmt.Errorf("library %q not found during clean and copy, despite being found in earlier steps", libraryID)
-	}
-	slog.Info("Clean destinations and copy generated results for library", "id", libraryID)
-	if err := clean(r.repo.GetDir(), library.RemoveRegex, library.PreserveRegex); err != nil {
-		return err
-	}
-	// os.CopyFS in Go1.24 returns error when copying from a symbolic link
-	// https://github.com/golang/go/blob/9d828e80fa1f3cc52de60428cae446b35b576de8/src/os/dir.go#L143-L144
-	if err := os.CopyFS(r.repo.GetDir(), os.DirFS(outputDir)); err != nil {
-		return err
-	}
-	slog.Info("Library updated", "id", libraryID)
-	return nil
-}
-
 // runBuildCommand orchestrates the building of an API library using a containerized
 // environment.
 //

internal/librarian/generate_test.go

@@ -1541,86 +1541,3 @@ func TestCompileRegexps(t *testing.T) {
 		})
 	}
 }
-
-func TestCleanAndCopyLibrary(t *testing.T) {
-	t.Parallel()
-	for _, test := range []struct {
-		name        string
-		libraryID   string
-		state       *config.LibrarianState
-		repo        gitrepo.Repository
-		outputDir   string
-		setup       func(t *testing.T, r *generateRunner, outputDir string)
-		wantErr     bool
-		errContains string
-	}{
-		{
-			name:      "library not found",
-			libraryID: "non-existent-library",
-			state: &config.LibrarianState{
-				Libraries: []*config.LibraryState{
-					{
-						ID: "some-library",
-					},
-				},
-			},
-			repo:    newTestGitRepo(t),
-			wantErr: true,
-		},
-		{
-			name:      "clean fails",
-			libraryID: "some-library",
-			state: &config.LibrarianState{
-				Libraries: []*config.LibraryState{
-					{
-						ID:          "some-library",
-						RemoveRegex: []string{"["}, // Invalid regex
-					},
-				},
-			},
-			repo:    newTestGitRepo(t),
-			wantErr: true,
-		},
-		{
-			name:      "copy fails on symlink",
-			libraryID: "some-library",
-			state: &config.LibrarianState{
-				Libraries: []*config.LibraryState{
-					{
-						ID: "some-library",
-					},
-				},
-			},
-			repo: newTestGitRepo(t),
-			setup: func(t *testing.T, r *generateRunner, outputDir string) {
-				// Create a symlink in the output directory to trigger an error.
-				if err := os.Symlink("target", filepath.Join(outputDir, "symlink")); err != nil {
-					t.Fatalf("os.Symlink() = %v", err)
-				}
-			},
-			wantErr: true,
-		},
-	} {
-		t.Run(test.name, func(t *testing.T) {
-			t.Parallel()
-			r := &generateRunner{
-				state: test.state,
-				repo:  test.repo,
-			}
-			outputDir := t.TempDir()
-			if test.setup != nil {
-				test.setup(t, r, outputDir)
-			}
-			err := r.cleanAndCopyLibrary(test.libraryID, outputDir)
-			if test.wantErr {
-				if err == nil {
-					t.Errorf("%s should return error", test.name)
-				}
-				return
-			}
-			if err != nil {
-				t.Fatal(err)
-			}
-		})
-	}
-}

internal/librarian/release_init.go

@@ -126,7 +126,31 @@ func (r *initRunner) runInitCommand(ctx context.Context, outputDir string) error
 		LibraryVersion: r.cfg.LibraryVersion,
 		Output:         outputDir,
 	}
-	return r.containerClient.ReleaseInit(ctx, initRequest)
+
+	if err := r.containerClient.ReleaseInit(ctx, initRequest); err != nil {
+		return err
+	}
+
+	for _, library := range r.state.Libraries {
+		if r.cfg.Library != "" {
+			if r.cfg.Library != library.ID {
+				continue
+			}
+			// Only copy one library to repository.
+			if err := cleanAndCopyLibrary(r.state, r.repo.GetDir(), r.cfg.Library, outputDir); err != nil {
+				return err
+			}
+
+			break
+		}
+
+		// Copy all libraries to repository.
+		if err := cleanAndCopyLibrary(r.state, r.repo.GetDir(), library.ID, outputDir); err != nil {
+			return err
+		}
+	}
+
+	return cleanAndCopyGlobalAllowlist(r.librarianConfig, r.repo.GetDir(), outputDir)
 }
 
 // updateLibrary updates the library which is the index-th library in the given
@@ -192,3 +216,25 @@ func getChangeType(commit *conventionalcommits.ConventionalCommit) string {
 
 	return changeType
 }
+
+// cleanAndCopyGlobalAllowlist cleans the files listed in global allowlist in
+// repoDir, excluding read-only files and copies global files from outputDir.
+func cleanAndCopyGlobalAllowlist(cfg *config.LibrarianConfig, repoDir, outputDir string) error {
+	for _, globalFile := range cfg.GlobalFilesAllowlist {
+		if globalFile.Permissions == config.PermissionReadOnly {
+			continue
+		}
+
+		dst := filepath.Join(repoDir, globalFile.Path)
+		if err := os.Remove(dst); err != nil {
+			return fmt.Errorf("failed to remove global file, %s: %w", dst, err)
+		}
+
+		src := filepath.Join(outputDir, globalFile.Path)
+		if err := os.CopyFS(filepath.Dir(dst), os.DirFS(filepath.Dir(src))); err != nil {
+			return fmt.Errorf("failed to copy global file %s to %s: %w", src, dst, err)
+		}
+	}
+
+	return nil
+}