Add locale config option (fergusstrange#12)

tachiniererin · web-flow · commit 73cda76c9966 · 2020-06-12T11:00:20.000+10:00
diff --git a/config.go b/config.go
@@ -10,6 +10,7 @@ type Config struct {
 	username     string
 	password     string
 	runtimePath  string
+	locale       string
 	startTimeout time.Duration
 }
 
@@ -68,6 +69,12 @@ func (c Config) RuntimePath(path string) Config {
 	return c
 }
 
+// Locale sets the default locale for initdb
+func (c Config) Locale(locale string) Config {
+	c.locale = locale
+	return c
+}
+
 // StartTimeout sets the max timeout that will be used when starting the Postgres process and creating the initial database.
 func (c Config) StartTimeout(timeout time.Duration) Config {
 	c.startTimeout = timeout
diff --git a/embedded_postgres.go b/embedded_postgres.go
@@ -75,7 +75,7 @@ func (ep *EmbeddedPostgres) Start() error {
 		return fmt.Errorf("unable to extract postgres archive %s to %s", cacheLocation, binaryExtractLocation)
 	}
 
-	if err := ep.initDatabase(binaryExtractLocation, ep.config.username, ep.config.password); err != nil {
+	if err := ep.initDatabase(binaryExtractLocation, ep.config.username, ep.config.password, ep.config.locale); err != nil {
 		return err
 	}
 
diff --git a/embedded_postgres_test.go b/embedded_postgres_test.go
@@ -117,7 +117,7 @@ func Test_ErrorWhenUnableToInitDatabase(t *testing.T) {
 		return jarFile, true
 	}
 
-	database.initDatabase = func(binaryExtractLocation, username, password string) error {
+	database.initDatabase = func(binaryExtractLocation, username, password, locale string) error {
 		return errors.New("ah it did not work")
 	}
 
@@ -220,7 +220,7 @@ func Test_ErrorWhenCannotStartPostgresProcess(t *testing.T) {
 		return jarFile, true
 	}
 
-	database.initDatabase = func(binaryExtractLocation, username, password string) error {
+	database.initDatabase = func(binaryExtractLocation, username, password, locale string) error {
 		return nil
 	}
 
@@ -248,7 +248,8 @@ func Test_CustomConfig(t *testing.T) {
 		Version(V12).
 		RuntimePath(tempDir).
 		Port(9876).
-		StartTimeout(10 * time.Second))
+		StartTimeout(10 * time.Second).
+		Locale("C"))
 	if err := database.Start(); err != nil {
 		shutdownDBAndFail(t, err, database)
 	}
@@ -271,6 +272,31 @@ func Test_CustomConfig(t *testing.T) {
 	}
 }
 
+func Test_CustomLocaleConfig(t *testing.T) {
+	// C is the only locale we can guarantee to always work
+	database := NewDatabase(DefaultConfig().Locale("C"))
+	if err := database.Start(); err != nil {
+		shutdownDBAndFail(t, err, database)
+	}
+
+	db, err := sql.Open("postgres", fmt.Sprintf("host=localhost port=5432 user=postgres password=postgres dbname=postgres sslmode=disable"))
+	if err != nil {
+		shutdownDBAndFail(t, err, database)
+	}
+
+	if err = db.Ping(); err != nil {
+		shutdownDBAndFail(t, err, database)
+	}
+
+	if err := db.Close(); err != nil {
+		shutdownDBAndFail(t, err, database)
+	}
+
+	if err := database.Stop(); err != nil {
+		shutdownDBAndFail(t, err, database)
+	}
+}
+
 func Test_CanStartAndStopTwice(t *testing.T) {
 	database := NewDatabase()
 
diff --git a/prepare_database.go b/prepare_database.go
@@ -13,21 +13,28 @@ import (
 	"github.com/lib/pq"
 )
 
-type initDatabase func(binaryExtractLocation, username, password string) error
+type initDatabase func(binaryExtractLocation, username, password, locale string) error
 type createDatabase func(port uint32, username, password, database string) error
 
-func defaultInitDatabase(binaryExtractLocation, username, password string) error {
+func defaultInitDatabase(binaryExtractLocation, username, password, locale string) error {
 	passwordFile, err := createPasswordFile(binaryExtractLocation, password)
 	if err != nil {
 		return err
 	}
 
-	postgresInitDbBinary := filepath.Join(binaryExtractLocation, "bin/initdb")
-	postgresInitDbProcess := exec.Command(postgresInitDbBinary,
+	args := []string{
 		"-A", "password",
 		"-U", username,
 		"-D", filepath.Join(binaryExtractLocation, "data"),
-		fmt.Sprintf("--pwfile=%s", passwordFile))
+		fmt.Sprintf("--pwfile=%s", passwordFile),
+	}
+
+	if locale != "" {
+		args = append(args, fmt.Sprintf("--locale=%s", locale))
+	}
+
+	postgresInitDbBinary := filepath.Join(binaryExtractLocation, "bin/initdb")
+	postgresInitDbProcess := exec.Command(postgresInitDbBinary, args...)
 	postgresInitDbProcess.Stderr = os.Stderr
 	postgresInitDbProcess.Stdout = os.Stdout
 
diff --git a/prepare_database_test.go b/prepare_database_test.go
@@ -11,7 +11,7 @@ import (
 )
 
 func Test_defaultInitDatabase_ErrorWhenCannotCreatePasswordFile(t *testing.T) {
-	err := defaultInitDatabase("path_not_exists", "Tom", "Beer")
+	err := defaultInitDatabase("path_not_exists", "Tom", "Beer", "")
 
 	assert.EqualError(t, err, "unable to write password file to path_not_exists/pwfile")
 }
@@ -28,7 +28,7 @@ func Test_defaultInitDatabase_ErrorWhenCannotStartInitDBProcess(t *testing.T) {
 		}
 	}()
 
-	err = defaultInitDatabase(tempDir, "Tom", "Beer")
+	err = defaultInitDatabase(tempDir, "Tom", "Beer", "")
 
 	assert.EqualError(t, err, fmt.Sprintf("unable to init database using: %s/bin/initdb -A password -U Tom -D %s/data --pwfile=%s/pwfile",
 		tempDir,
@@ -37,6 +37,26 @@ func Test_defaultInitDatabase_ErrorWhenCannotStartInitDBProcess(t *testing.T) {
 	assert.FileExists(t, filepath.Join(tempDir, "pwfile"))
 }
 
+func Test_defaultInitDatabase_ErrorInvalidLocaleSetting(t *testing.T) {
+	tempDir, err := ioutil.TempDir("", "prepare_database_test")
+	if err != nil {
+		panic(err)
+	}
+
+	defer func() {
+		if err := os.RemoveAll(tempDir); err != nil {
+			panic(err)
+		}
+	}()
+
+	err = defaultInitDatabase(tempDir, "postgres", "postgres", "en_XY")
+
+	assert.EqualError(t, err, fmt.Sprintf("unable to init database using: %s/bin/initdb -A password -U postgres -D %s/data --pwfile=%s/pwfile --locale=en_XY",
+		tempDir,
+		tempDir,
+		tempDir))
+}
+
 func Test_defaultCreateDatabase_ErrorWhenSQLOpenError(t *testing.T) {
 	err := defaultCreateDatabase(1234, "user client_encoding=lol", "password", "database")
 

Original file line number	Diff line number	Diff line change
`@@ -75,7 +75,7 @@ func (ep *EmbeddedPostgres) Start() error {`
`75`	`75`	`return fmt.Errorf("unable to extract postgres archive %s to %s", cacheLocation, binaryExtractLocation)`
`76`	`76`	`}`
`77`	`77`
`78`		`- if err := ep.initDatabase(binaryExtractLocation, ep.config.username, ep.config.password); err != nil {`
	`78`	`+ if err := ep.initDatabase(binaryExtractLocation, ep.config.username, ep.config.password, ep.config.locale); err != nil {`
`79`	`79`	`return err`
`80`	`80`	`}`
`81`	`81`