Add confugurable cachePath

Author: movit

README.md

@@ -42,6 +42,7 @@ This library aims to require as little configuration as possible, favouring over
 | Password            | postgres                                        |
 | Database            | postgres                                        |
 | Version             | 12.1.0                                          |
+| CachePath           | $USER_HOME/.embedded-postgres-go/               |
 | RuntimePath         | $USER_HOME/.embedded-postgres-go/extracted      |
 | DataPath            | $USER_HOME/.embedded-postgres-go/extracted/data |
 | BinariesPath        | $USER_HOME/.embedded-postgres-go/extracted      |

cache_locator.go

@@ -8,13 +8,15 @@ import (
 
 // CacheLocator retrieves the location of the Postgres binary cache returning it to location.
 // The result of whether this cache is present will be returned to exists.
-type CacheLocator func() (location string, exists bool)
+type CacheLocator func(cachePath string) (location string, exists bool)
 
 func defaultCacheLocator(versionStrategy VersionStrategy) CacheLocator {
-	return func() (string, bool) {
-		cacheDirectory := ".embedded-postgres-go"
-		if userHome, err := os.UserHomeDir(); err == nil {
-			cacheDirectory = filepath.Join(userHome, ".embedded-postgres-go")
+	return func(cacheDirectory string) (string, bool) {
+		if cacheDirectory == "" {
+			cacheDirectory = ".embedded-postgres-go"
+			if userHome, err := os.UserHomeDir(); err == nil {
+				cacheDirectory = filepath.Join(userHome, ".embedded-postgres-go")
+			}
 		}
 
 		operatingSystem, architecture, version := versionStrategy()

cache_locator_test.go

@@ -11,8 +11,19 @@ func Test_defaultCacheLocator_NotExists(t *testing.T) {
 		return "a", "b", "1.2.3"
 	})
 
-	cacheLocation, exists := locator()
+	cacheLocation, exists := locator("")
 
 	assert.Contains(t, cacheLocation, ".embedded-postgres-go/embedded-postgres-binaries-a-b-1.2.3.txz")
 	assert.False(t, exists)
 }
+
+func Test_defaultCacheLocator_CustomPath(t *testing.T) {
+	locator := defaultCacheLocator(func() (string, string, PostgresVersion) {
+		return "a", "b", "1.2.3"
+	})
+
+	cacheLocation, exists := locator("/custom/path")
+
+	assert.Equal(t, cacheLocation, "/custom/path/embedded-postgres-binaries-a-b-1.2.3.txz")
+	assert.False(t, exists)
+}

config.go

@@ -14,6 +14,7 @@ type Config struct {
 	database            string
 	username            string
 	password            string
+	cachePath           string
 	runtimePath         string
 	dataPath            string
 	binariesPath        string
@@ -82,6 +83,13 @@ func (c Config) RuntimePath(path string) Config {
 	return c
 }
 
+// CachePath sets the path that will be used for storing Postgres binaries archive.
+// If this option is not set, ~/.go-embedded-postgres will be used.
+func (c Config) CachePath(path string) Config {
+	c.cachePath = path
+	return c
+}
+
 // DataPath sets the path that will be used for the Postgres data directory.
 // If this option is set, a previously initialized data directory will be reused if possible.
 func (c Config) DataPath(path string) Config {

embedded_postgres.go

@@ -77,7 +77,7 @@ func (ep *EmbeddedPostgres) Start() error {
 
 	ep.syncedLogger = logger
 
-	cacheLocation, cacheExists := ep.cacheLocator()
+	cacheLocation, cacheExists := ep.cacheLocator(ep.config.cachePath)
 
 	if ep.config.runtimePath == "" {
 		ep.config.runtimePath = filepath.Join(filepath.Dir(cacheLocation), "extracted")

embedded_postgres_test.go

@@ -66,7 +66,7 @@ func Test_ErrorWhenPortAlreadyTaken(t *testing.T) {
 
 func Test_ErrorWhenRemoteFetchError(t *testing.T) {
 	database := NewDatabase()
-	database.cacheLocator = func() (string, bool) {
+	database.cacheLocator = func(string) (string, bool) {
 		return "", false
 	}
 	database.remoteFetchStrategy = func() error {
@@ -88,7 +88,7 @@ func Test_ErrorWhenUnableToUnArchiveFile_WrongFormat(t *testing.T) {
 		Database("beer").
 		StartTimeout(10 * time.Second))
 
-	database.cacheLocator = func() (string, bool) {
+	database.cacheLocator = func(string) (string, bool) {
 		return jarFile, true
 	}
 
@@ -119,7 +119,7 @@ func Test_ErrorWhenUnableToInitDatabase(t *testing.T) {
 		RuntimePath(extractPath).
 		StartTimeout(10 * time.Second))
 
-	database.cacheLocator = func() (string, bool) {
+	database.cacheLocator = func(string) (string, bool) {
 		return jarFile, true
 	}
 
@@ -222,7 +222,7 @@ func Test_ErrorWhenCannotStartPostgresProcess(t *testing.T) {
 	database := NewDatabase(DefaultConfig().
 		RuntimePath(extractPath))
 
-	database.cacheLocator = func() (string, bool) {
+	database.cacheLocator = func(string) (string, bool) {
 		return jarFile, true
 	}
 
@@ -360,7 +360,7 @@ func Test_ConcurrentStart(t *testing.T) {
 	var wg sync.WaitGroup
 
 	database := NewDatabase()
-	cacheLocation, _ := database.cacheLocator()
+	cacheLocation, _ := database.cacheLocator("")
 	err := os.RemoveAll(cacheLocation)
 	require.NoError(t, err)
 
@@ -644,7 +644,7 @@ func Test_CustomBinariesLocation(t *testing.T) {
 	}
 
 	// Delete cache to make sure unarchive doesn't happen again.
-	cacheLocation, _ := database.cacheLocator()
+	cacheLocation, _ := database.cacheLocator("")
 	if err := os.RemoveAll(cacheLocation); err != nil {
 		panic(err)
 	}
@@ -688,13 +688,13 @@ func Test_PrefetchedBinaries(t *testing.T) {
 		panic(err)
 	}
 
-	cacheLocation, _ := database.cacheLocator()
+	cacheLocation, _ := database.cacheLocator("")
 	if err := decompressTarXz(defaultTarReader, cacheLocation, binTempDir); err != nil {
 		panic(err)
 	}
 
 	// Expect everything to work without cacheLocator and/or remoteFetch abilities.
-	database.cacheLocator = func() (string, bool) {
+	database.cacheLocator = func(string) (string, bool) {
 		return "", false
 	}
 	database.remoteFetchStrategy = func() error {

remote_fetch.go

@@ -80,7 +80,7 @@ func decompressResponse(bodyBytes []byte, contentLength int64, cacheLocator Cach
 		return errorFetchingPostgres(err)
 	}
 
-	cacheLocation, _ := cacheLocator()
+	cacheLocation, _ := cacheLocator("")
 
 	if err := os.MkdirAll(filepath.Dir(cacheLocation), 0755); err != nil {
 		return errorExtractingPostgres(err)

remote_fetch_test.go

@@ -141,7 +141,7 @@ func Test_defaultRemoteFetchStrategy_ErrorWhenCannotExtractSubArchive(t *testing
 
 	remoteFetchStrategy := defaultRemoteFetchStrategy(server.URL+"/maven2",
 		testVersionStrategy(),
-		func() (s string, b bool) {
+		func(string) (s string, b bool) {
 			return filepath.FromSlash("/invalid"), false
 		})
 
@@ -181,7 +181,7 @@ func Test_defaultRemoteFetchStrategy_ErrorWhenCannotCreateCacheDirectory(t *test
 
 	remoteFetchStrategy := defaultRemoteFetchStrategy(server.URL+"/maven2",
 		testVersionStrategy(),
-		func() (s string, b bool) {
+		func(string) (s string, b bool) {
 			return cacheLocation, false
 		})
 
@@ -218,7 +218,7 @@ func Test_defaultRemoteFetchStrategy_ErrorWhenCannotCreateSubArchiveFile(t *test
 
 	remoteFetchStrategy := defaultRemoteFetchStrategy(server.URL+"/maven2",
 		testVersionStrategy(),
-		func() (s string, b bool) {
+		func(string) (s string, b bool) {
 			return "/\\000", false
 		})
 
@@ -256,7 +256,7 @@ func Test_defaultRemoteFetchStrategy_ErrorWhenSHA256NotMatch(t *testing.T) {
 
 	remoteFetchStrategy := defaultRemoteFetchStrategy(server.URL+"/maven2",
 		testVersionStrategy(),
-		func() (s string, b bool) {
+		func(string) (s string, b bool) {
 			return cacheLocation, false
 		})
 
@@ -295,7 +295,7 @@ func Test_defaultRemoteFetchStrategy(t *testing.T) {
 
 	remoteFetchStrategy := defaultRemoteFetchStrategy(server.URL+"/maven2",
 		testVersionStrategy(),
-		func() (s string, b bool) {
+		func(string) (s string, b bool) {
 			return cacheLocation, false
 		})
 
@@ -347,7 +347,7 @@ func Test_defaultRemoteFetchStrategyWithExistingDownload(t *testing.T) {
 
 	remoteFetchStrategy := defaultRemoteFetchStrategy(server.URL+"/maven2",
 		testVersionStrategy(),
-		func() (s string, b bool) {
+		func(string) (s string, b bool) {
 			return cacheLocation, false
 		})
 

test_util_test.go

@@ -55,7 +55,7 @@ func testVersionStrategy() VersionStrategy {
 }
 
 func testCacheLocator() CacheLocator {
-	return func() (s string, b bool) {
+	return func(string) (s string, b bool) {
 		return "", false
 	}
 }