chore: create end-to-end tests for configure command (#1004)

Fixes #862

Author: JoeWang1127

generate_e2e_test.go

@@ -20,19 +20,22 @@ package librarian
 import (
 	"encoding/json"
 	"fmt"
+	"math/rand"
 	"os"
 	"os/exec"
 	"path/filepath"
+	"strings"
 	"testing"
-)
 
-const (
-	repo               = "repo"
-	localRepoBackupDir = "testdata/e2e/generate/repo_backup"
-	localAPISource     = "testdata/e2e/generate/api_root"
+	"github.com/google/go-cmp/cmp"
 )
 
 func TestRunGenerate(t *testing.T) {
+	const (
+		repo                = "repo"
+		initialRepoStateDir = "testdata/e2e/generate/repo_init"
+		localAPISource      = "testdata/e2e/generate/api_root"
+	)
 	t.Parallel()
 	for _, test := range []struct {
 		name    string
@@ -44,15 +47,15 @@ func TestRunGenerate(t *testing.T) {
 			api:  "google/cloud/pubsub/v1",
 		},
 		{
-			name:    "non existant in api source",
-			api:     "google/invalid/path",
+			name:    "non existent in api source",
+			api:     "google/non-existent/path",
 			wantErr: true,
 		},
 	} {
 		t.Run(test.name, func(t *testing.T) {
 			workRoot := filepath.Join(t.TempDir())
 			repo := filepath.Join(workRoot, repo)
-			if err := prepareTest(t, repo, workRoot, localRepoBackupDir); err != nil {
+			if err := prepareTest(t, repo, workRoot, initialRepoStateDir); err != nil {
 				t.Fatalf("prepare test error = %v", err)
 			}
 
@@ -101,6 +104,92 @@ func TestRunGenerate(t *testing.T) {
 	}
 }
 
+func TestRunConfigure(t *testing.T) {
+	const (
+		localRepoDir        = "testdata/e2e/configure/repo"
+		initialRepoStateDir = "testdata/e2e/configure/repo_init"
+		repo                = "repo"
+	)
+	for _, test := range []struct {
+		name         string
+		api          string
+		library      string
+		apiSource    string
+		updatedState string
+		wantErr      bool
+	}{
+		{
+			name:         "runs successfully",
+			api:          "google/cloud/new-library-path/v2",
+			library:      "new-library",
+			apiSource:    "testdata/e2e/configure/api_root",
+			updatedState: "testdata/e2e/configure/updated-state.yaml",
+		},
+		{
+			name:         "failed due to simulated error in configure command",
+			api:          "google/cloud/another-library/v3",
+			library:      "simulate-configure-error-id",
+			apiSource:    "testdata/e2e/configure/api_root",
+			updatedState: "testdata/e2e/configure/updated-state.yaml",
+			wantErr:      true,
+		},
+	} {
+		t.Run(test.name, func(t *testing.T) {
+			t.Parallel()
+			workRoot := filepath.Join(os.TempDir(), fmt.Sprintf("rand-%d", rand.Intn(1000)))
+			repo := filepath.Join(workRoot, repo)
+			if err := prepareTest(t, repo, workRoot, initialRepoStateDir); err != nil {
+				t.Fatalf("prepare test error = %v", err)
+			}
+
+			cmd := exec.Command(
+				"go",
+				"run",
+				"github.com/googleapis/librarian/cmd/librarian",
+				"generate",
+				fmt.Sprintf("--api=%s", test.api),
+				fmt.Sprintf("--output=%s", workRoot),
+				fmt.Sprintf("--repo=%s", repo),
+				fmt.Sprintf("--api-source=%s", test.apiSource),
+				fmt.Sprintf("--library=%s", test.library),
+			)
+			cmd.Stderr = os.Stderr
+			cmd.Stdout = os.Stdout
+			err := cmd.Run()
+			if test.wantErr {
+				if err == nil {
+					t.Fatal("Configure command should fail")
+				}
+
+				// the exact message is not populated here, but we can check it's
+				// indeed an error returned from docker container.
+				if g, w := err.Error(), "exit status 1"; !strings.Contains(g, w) {
+					t.Errorf("got %q, wanted it to contain %q", g, w)
+				}
+				return
+			}
+			if err != nil {
+				t.Fatalf("Failed to run configure: %v", err)
+			}
+
+			// Verify the file content
+			gotBytes, err := os.ReadFile(filepath.Join(repo, ".librarian", "state.yaml"))
+			if err != nil {
+				t.Fatalf("Failed to read configure response file: %v", err)
+			}
+
+			wantBytes, readErr := os.ReadFile(test.updatedState)
+			if readErr != nil {
+				t.Fatalf("Failed to read expected state for comparison: %v", readErr)
+			}
+
+			if diff := cmp.Diff(string(wantBytes), string(gotBytes)); diff != "" {
+				t.Errorf("Generated yaml mismatch (-want +got):\n%s", diff)
+			}
+		})
+	}
+}
+
 func prepareTest(t *testing.T, destRepoDir, workRoot, sourceRepoDir string) error {
 	if err := initTestRepo(t, destRepoDir, sourceRepoDir); err != nil {
 		return err

testdata/e2e/configure/api_root/google/cloud/another-library/v3/another_v3.yaml

@@ -0,0 +1 @@
+type: google.api.Service

testdata/e2e/configure/api_root/google/cloud/new-library-path/v2/library_v2.yaml

@@ -0,0 +1 @@
+type: google.api.Service

testdata/e2e/configure/api_root/google/cloud/pubsub/v1/pubsub_v1.yaml

@@ -0,0 +1 @@
+type: google.api.Service

testdata/e2e/generate/repo_backup/.librarian/state.yaml renamed to testdata/e2e/configure/repo_init/.librarian/state.yaml

@@ -0,0 +1,27 @@
+image: test-image:latest
+libraries:
+  - id: example-library
+    version: ""
+    last_generated_commit: ""
+    apis:
+      - path: google/cloud/pubsub/v1
+        service_config: pubsub_v1.yaml
+    source_roots:
+      - google-cloud-pubsub/v1
+    preserve_regex: []
+    remove_regex: []
+  - id: new-library
+    version: 1.0.0
+    last_generated_commit: ""
+    apis:
+      - path: google/cloud/new-library-path/v2
+        service_config: library_v2.yaml
+    source_roots:
+      - example-source-path
+      - example-source-path-2
+    preserve_regex:
+      - example-preserve-regex
+      - example-preserve-regex-2
+    remove_regex:
+      - example-remove-regex
+      - example-remove-regex-2

testdata/e2e/generate/repo_backup/google-cloud-future/v2/example.txt renamed to testdata/e2e/configure/repo_init/google-cloud-pubsub/v1/example.txt

@@ -0,0 +1,9 @@
+image: test-image:latest
+libraries:
+  - id: example-library
+    version:
+    last_generated_commit:
+    apis:
+      - path: google/cloud/pubsub/v1
+    source_roots:
+      - google-cloud-pubsub/v1