Merge pull request #50 from nao1215/export-pkg-info-at-stdout

nao1215 · web-flow · commit ea41886bbd4e · 2022-09-24T00:18:25.000+09:00
Added output option to Export subcommand
diff --git a/cmd/export.go b/cmd/export.go
@@ -27,6 +27,7 @@ according to the contents of gup.conf.`,
 }
 
 func init() {
+	exportCmd.Flags().BoolP("output", "o", false, "print command path information at STDOUT")
 	rootCmd.AddCommand(exportCmd)
 }
 
@@ -36,8 +37,9 @@ func export(cmd *cobra.Command, args []string) int {
 		return 1
 	}
 
-	if err := os.MkdirAll(config.DirPath(), 0775); err != nil {
-		print.Err(fmt.Errorf("%s: %w", "can not make config directory", err))
+	output, err := cmd.Flags().GetBool("output")
+	if err != nil {
+		print.Err(fmt.Errorf("%s: %w", "can not parse command line argument", err))
 		return 1
 	}
 
@@ -53,14 +55,40 @@ func export(cmd *cobra.Command, args []string) int {
 		return 1
 	}
 
-	if err := config.WriteConfFile(pkgs); err != nil {
+	if output {
+		err = outputConfig(pkgs)
+	} else {
+		err = writeConfigFile(pkgs)
+	}
+	if err != nil {
 		print.Err(err)
 		return 1
 	}
-	print.Info("Export " + config.FilePath())
 	return 0
 }
 
+func writeConfigFile(pkgs []goutil.Package) error {
+	if err := os.MkdirAll(config.DirPath(), 0775); err != nil {
+		return fmt.Errorf("%s: %w", "can not make config directory", err)
+	}
+
+	file, err := os.Create(config.FilePath())
+	if err != nil {
+		return fmt.Errorf("%s %s: %w", "can't update", config.FilePath(), err)
+	}
+	defer file.Close()
+
+	if err := config.WriteConfFile(file, pkgs); err != nil {
+		return err
+	}
+	print.Info("Export " + config.FilePath())
+	return nil
+}
+
+func outputConfig(pkgs []goutil.Package) error {
+	return config.WriteConfFile(os.Stdout, pkgs)
+}
+
 func validPkgInfo(pkgs []goutil.Package) []goutil.Package {
 	result := []goutil.Package{}
 	for _, v := range pkgs {
diff --git a/cmd/export_test.go b/cmd/export_test.go
@@ -11,6 +11,7 @@ import (
 	"testing"
 
 	"github.com/google/go-cmp/cmp"
+	"github.com/nao1215/gup/internal/config"
 	"github.com/nao1215/gup/internal/file"
 	"github.com/nao1215/gup/internal/goutil"
 	"github.com/nao1215/gup/internal/print"
@@ -175,7 +176,7 @@ func Test_export(t *testing.T) {
 			gobin: filepath.Join("testdata", "dummy"),
 			want:  1,
 			stderr: []string{
-				"gup:ERROR: can't get binary-paths installed by 'go install': open " + filepath.Join("testdata", "dummy") + ": no such file or directory",
+				"gup:ERROR: can't get binary-paths installed by 'go install': open testdata/dummy: no such file or directory",
 				"",
 			},
 		})
@@ -214,6 +215,7 @@ func Test_export(t *testing.T) {
 			print.Stdout = pw
 			print.Stderr = pw
 
+			tt.args.cmd.Flags().BoolP("output", "o", false, "print command path information at STDOUT")
 			if got := export(tt.args.cmd, tt.args.args); got != tt.want {
 				t.Errorf("export() = %v, want %v", got, tt.want)
 			}
@@ -241,3 +243,68 @@ func Test_export(t *testing.T) {
 		})
 	}
 }
+
+func Test_export_parse_error(t *testing.T) {
+	t.Run("parse argument error", func(t *testing.T) {
+		orgStdout := print.Stdout
+		orgStderr := print.Stderr
+		pr, pw, err := os.Pipe()
+		if err != nil {
+			t.Fatal(err)
+		}
+		print.Stdout = pw
+		print.Stderr = pw
+
+		if got := export(&cobra.Command{}, []string{}); got != 1 {
+			t.Errorf("export() = %v, want %v", got, 1)
+		}
+		pw.Close()
+		print.Stdout = orgStdout
+		print.Stderr = orgStderr
+
+		buf := bytes.Buffer{}
+		_, err = io.Copy(&buf, pr)
+		if err != nil {
+			t.Error(err)
+		}
+		defer pr.Close()
+		got := strings.Split(buf.String(), "\n")
+
+		want := []string{
+			"gup:ERROR: can not parse command line argument: flag accessed but not defined: output",
+			"",
+		}
+		if diff := cmp.Diff(want, got); diff != "" {
+			t.Errorf("value is mismatch (-want +got):\n%s", diff)
+		}
+	})
+}
+
+func Test_writeConfigFile(t *testing.T) {
+	type args struct {
+		pkgs []goutil.Package
+	}
+	tests := []struct {
+		name    string
+		args    args
+		wantErr bool
+	}{
+		{
+			name: "failed to open config file",
+			args: args{
+				pkgs: []goutil.Package{},
+			},
+			wantErr: true,
+		},
+	}
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			config.ConfigFileName = ""
+			defer func() { config.ConfigFileName = "gup.conf" }()
+
+			if err := writeConfigFile(tt.args.pkgs); (err != nil) != tt.wantErr {
+				t.Errorf("writeConfigFile() error = %v, wantErr %v", err, tt.wantErr)
+			}
+		})
+	}
+}
diff --git a/cmd/root_test.go b/cmd/root_test.go
@@ -410,6 +410,85 @@ subaru = github.com/nao1215/subaru
 	}
 }
 
+func TestExecute_Export_WithOutputOption(t *testing.T) {
+	type test struct {
+		name  string
+		gobin string
+		args  []string
+		want  []string
+	}
+
+	tests := []test{}
+	if runtime.GOOS == "windows" {
+		tests = append(tests, test{
+			name:  "success",
+			gobin: filepath.Join("testdata", "check_success_for_windows"),
+			args:  []string{"gup", "export", "--output"},
+			want: []string{
+				"gal.exe = github.com/nao1215/gal/cmd/gal",
+				"posixer.exe = github.com/nao1215/posixer",
+				""},
+		})
+	} else {
+		tests = append(tests, test{
+			name:  "success",
+			gobin: filepath.Join("testdata", "check_success"),
+			args:  []string{"gup", "export", "--output"},
+			want: []string{
+				"gal = github.com/nao1215/gal/cmd/gal",
+				"posixer = github.com/nao1215/posixer",
+				"subaru = github.com/nao1215/subaru",
+				""},
+		})
+	}
+
+	for _, tt := range tests {
+		oldGoBin := os.Getenv("GOBIN")
+		if err := os.Setenv("GOBIN", tt.gobin); err != nil {
+			t.Fatal(err)
+		}
+		defer func() {
+			if err := os.Setenv("GOBIN", oldGoBin); err != nil {
+				t.Fatal(err)
+			}
+		}()
+
+		OsExit = func(code int) {}
+		defer func() {
+			OsExit = os.Exit
+		}()
+
+		orgStdout := os.Stdout
+		orgStderr := os.Stderr
+		pr, pw, err := os.Pipe()
+		if err != nil {
+			t.Fatal(err)
+		}
+		os.Stdout = pw
+		os.Stderr = pw
+
+		os.Args = tt.args
+		t.Run(tt.name, func(t *testing.T) {
+			Execute()
+		})
+		pw.Close()
+		os.Stdout = orgStdout
+		os.Stderr = orgStderr
+
+		buf := bytes.Buffer{}
+		_, err = io.Copy(&buf, pr)
+		if err != nil {
+			t.Error(err)
+		}
+		defer pr.Close()
+		got := strings.Split(buf.String(), "\n")
+
+		if diff := cmp.Diff(tt.want, got); diff != "" {
+			t.Errorf("value is mismatch (-want +got):\n%s", diff)
+		}
+	}
+}
+
 func TestExecute_Import(t *testing.T) {
 	OsExit = func(code int) {}
 	defer func() {
diff --git a/internal/config/config.go b/internal/config/config.go
@@ -13,9 +13,12 @@ import (
 	"github.com/nao1215/gup/internal/goutil"
 )
 
+// ConfigFileName is gup command configuration file
+var ConfigFileName = "gup.conf"
+
 // FilePath return configuration-file path.
 func FilePath() string {
-	return filepath.Join(DirPath(), "gup.conf")
+	return filepath.Join(DirPath(), ConfigFileName)
 }
 
 // DirPath return directory path that store configuration-file.
@@ -58,20 +61,14 @@ func ReadConfFile() ([]goutil.Package, error) {
 }
 
 // WriteConfFile write package information at configuration-file.
-func WriteConfFile(pkgs []goutil.Package) error {
-	file, err := os.Create(FilePath())
-	if err != nil {
-		return fmt.Errorf("%s %s: %w", "can't update", FilePath(), err)
-	}
-	defer file.Close()
-
+func WriteConfFile(file *os.File, pkgs []goutil.Package) error {
 	text := ""
 	for _, v := range pkgs {
 		// lost version information
 		text = text + fmt.Sprintf("%s = %s\n", v.Name, v.ImportPath)
 	}
 
-	_, err = file.Write(([]byte)(text))
+	_, err := file.Write(([]byte)(text))
 	if err != nil {
 		return fmt.Errorf("%s %s: %w", "can't update", FilePath(), err)
 	}
