Add duplicate multi bar support and enforce .bar filename

Author: IBMJames

internal/configuration/configuration.go

@@ -7,6 +7,7 @@ import (
 	"crypto/x509"
 	"encoding/base64"
 	"errors"
+	"fmt"
 	"io"
 	"io/ioutil"
 	"net/http"
@@ -584,11 +585,14 @@ func downloadBASIC_AUTH(log logger.LoggerInterface, basedir string, barAuthParse
 			return err
 		}
 
-		filename := "/home/aceuser/initial-config/bars/" + path.Base(req.URL.Path)
+		var filename string
 
-		// temporarily override the bar name  with "barfile.bar" if we only have ONE bar file until mq connector is fixed to support any bar name
 		if len(urlArray) == 1 {
+			// Temporarily override the bar name  with "barfile.bar" if we only have ONE bar file until mq connector is fixed to support any bar name
 			filename = "/home/aceuser/initial-config/bars/barfile.bar"
+		} else {
+			// Case where multiple bars. Need to check what file path is available
+			filename = determineAvailableFilename(log, "/home/aceuser/initial-config/bars/"+path.Base(req.URL.Path))
 		}
 
 		file, err := os.Create(filename)
@@ -625,3 +629,29 @@ func downloadBASIC_AUTH(log logger.LoggerInterface, basedir string, barAuthParse
 	}
 	return nil
 }
+
+func determineAvailableFilename(log logger.LoggerInterface, basepath string) string {
+	var filename string
+	filenameBase := basepath
+	// Initially strip off the .bar at the end if present
+	if filenameBase[len(filenameBase)-4:] == ".bar" {
+		filenameBase = filenameBase[:len(filenameBase)-4]
+	}
+	isAvailable := false
+	count := 0
+	for !isAvailable {
+		if count == 0 {
+			filename = filenameBase + ".bar"
+		} else {
+			filename = filenameBase + "-" + fmt.Sprint(count) + ".bar"
+			log.Printf("Previous path already in use. Testing filename: " + filename)
+		}
+
+		if _, err := osStat(filename); os.IsNotExist(err) {
+			log.Printf("No existing file on that path so continuing")
+			isAvailable = true
+		}
+		count++
+	}
+	return filename
+}

internal/configuration/configuration_test.go

@@ -928,3 +928,110 @@ func TestSetupConfigurationsFilesInternal(t *testing.T) {
 	// restore
 	restore()
 }
+
+func TestDetermineAvailableFilename(t *testing.T) {
+
+	var osStatRestore = osStat
+	createdFiles := map[string]bool{}
+
+	var reset = func() {
+		osStat = func(file string) (os.FileInfo, error) {
+			if createdFiles[file] {
+				return nil, os.ErrExist
+			} else {
+				return nil, os.ErrNotExist
+			}
+		}
+	}
+
+	var restore = func() {
+		osStat = osStatRestore
+	}
+
+	reset()
+	defer restore()
+
+	t.Run("No existing files just returns the path.bar when basepath has no .bar", func(t *testing.T) {
+		createdFiles = map[string]bool{}
+		filename := determineAvailableFilename(testLogger, "my_server/my_bar")
+		assert.Equal(t, "my_server/my_bar.bar", filename)
+	})
+
+	t.Run("No existing files just returns the path.bar when basepath already has .bar", func(t *testing.T) {
+		createdFiles = map[string]bool{}
+		filename := determineAvailableFilename(testLogger, "my_server/my_bar.bar")
+		assert.Equal(t, "my_server/my_bar.bar", filename)
+	})
+
+	t.Run("Multiple files with different base paths all save as normal", func(t *testing.T) {
+		createdFiles = map[string]bool{}
+
+		filename1 := determineAvailableFilename(testLogger, "my_server/my_bar1")
+		createdFiles[filename1] = true
+
+		filename2 := determineAvailableFilename(testLogger, "my_server/my_bar2")
+		createdFiles[filename2] = true
+
+		filename3 := determineAvailableFilename(testLogger, "my_server2/my_bar")
+		createdFiles[filename3] = true
+
+		assert.Equal(t, "my_server/my_bar1.bar", filename1)
+		assert.Equal(t, "my_server/my_bar2.bar", filename2)
+		assert.Equal(t, "my_server2/my_bar.bar", filename3)
+	})
+
+	t.Run("Multiple files all the same basepath append an incrementing index with no .bar", func(t *testing.T) {
+		createdFiles = map[string]bool{}
+		basePath := "my_server/my_bar"
+
+		filename1 := determineAvailableFilename(testLogger, basePath)
+		createdFiles[filename1] = true
+
+		filename2 := determineAvailableFilename(testLogger, basePath)
+		createdFiles[filename2] = true
+
+		filename3 := determineAvailableFilename(testLogger, basePath)
+		createdFiles[filename3] = true
+
+		assert.Equal(t, "my_server/my_bar.bar", filename1)
+		assert.Equal(t, "my_server/my_bar-1.bar", filename2)
+		assert.Equal(t, "my_server/my_bar-2.bar", filename3)
+	})
+
+	t.Run("Multiple files all the same basepath append an incrementing index and already have a .bar", func(t *testing.T) {
+		createdFiles = map[string]bool{}
+		basePath := "my_server/my_bar.bar"
+
+		filename1 := determineAvailableFilename(testLogger, basePath)
+		createdFiles[filename1] = true
+
+		filename2 := determineAvailableFilename(testLogger, basePath)
+		createdFiles[filename2] = true
+
+		filename3 := determineAvailableFilename(testLogger, basePath)
+		createdFiles[filename3] = true
+
+		assert.Equal(t, "my_server/my_bar.bar", filename1)
+		assert.Equal(t, "my_server/my_bar-1.bar", filename2)
+		assert.Equal(t, "my_server/my_bar-2.bar", filename3)
+	})
+
+	t.Run("Multiple files all the same basepath append an incrementing index with mixed present and missing .bar", func(t *testing.T) {
+		createdFiles = map[string]bool{}
+		basePath := "my_server/my_bar.bar"
+		basePathBar := "my_server/my_bar"
+
+		filename1 := determineAvailableFilename(testLogger, basePath)
+		createdFiles[filename1] = true
+
+		filename2 := determineAvailableFilename(testLogger, basePathBar)
+		createdFiles[filename2] = true
+
+		filename3 := determineAvailableFilename(testLogger, basePath)
+		createdFiles[filename3] = true
+
+		assert.Equal(t, "my_server/my_bar.bar", filename1)
+		assert.Equal(t, "my_server/my_bar-1.bar", filename2)
+		assert.Equal(t, "my_server/my_bar-2.bar", filename3)
+	})
+}