Remove latest_version.txt creation in user curr dir (#3179)

* fix version text in current dir

* empty dir check

* version checker test

* moved init out of version check

* fix comment

---------

Co-authored-by: Gauri Lamunion <[email protected]>

Author: wonwuakpa-msft

cmd/root.go

@@ -76,6 +76,7 @@ var rootCmd = &cobra.Command{
 	Use:     "azcopy",
 	Short:   rootCmdShortDescription,
 	Long:    rootCmdLongDescription,
+	// PersistentPreRunE hook will not run on just `azcopy` without any subcommand
 	PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
 		glcm.RegisterCloseFunc(func() {
 			if debugMemoryProfile != "" {
@@ -262,6 +263,14 @@ func InitializeAndExecute() {
 		glcm.Error(err.Error())
 	} else {
 		if !SkipVersionCheck && !isPipeDownload {
+			// In commands like azcopy --version and azcopy --help, they do not reach Initialize() in the PersistentPreRunE
+			// So we set the log path folder here.
+			// This ensures we sure we don't write to user's current directory
+			if common.LogPathFolder == "" {
+				// With this, latest_version.txt is written to app dir
+				common.InitializeFolders()
+			}
+
 			// our commands all control their own life explicitly with the lifecycle manager
 			// only commands that don't explicitly exit actually reach this point (e.g. help commands)
 			select {
@@ -345,7 +354,6 @@ func beginDetectNewVersion() chan struct{} {
 		if err != nil {
 			return
 		}
-
 		// Step 1: Fetch & validate cached version. If it is up to date, we return without making API calls
 		filePath := filepath.Join(common.LogPathFolder, "latest_version.txt")
 		cachedVersion, err := ValidateCachedVersion(filePath) // same as the remote version

cmd/versionChecker.go

@@ -121,6 +121,7 @@ func (v Version) EqualTo(v2 Version) bool {
 func (v Version) CacheRemoteVersion(remoteVer Version, filePath string) error {
 	if v.OlderThan(remoteVer) || v.EqualTo(remoteVer) {
 		expiry := time.Now().Add(24 * time.Hour).Format(versionFileTimeFormat)
+		// make sure filepath is absolute filepath so WriteFile is not written to customers current directory
 		if err := os.WriteFile(filePath, []byte(remoteVer.original+","+expiry), 0666); err != nil {
 			return err
 		}

e2etest/zt_version_test.go

@@ -20,10 +20,15 @@
 package e2etest
 
 import (
+	cmd2 "github.com/Azure/azure-storage-azcopy/v10/testSuite/cmd"
+	"github.com/stretchr/testify/assert"
+	"os"
 	"os/exec"
+	"path/filepath"
 	"regexp"
 	"strings"
 	"testing"
+	"time"
 
 	"github.com/Azure/azure-storage-azcopy/v10/common"
 )
@@ -68,3 +73,46 @@ func TestVersionCommand(t *testing.T) {
 		t.FailNow()
 	}
 }
+
+// Test that latest_version file is uploaded to correct directory
+func TestLastVersionFileLocation(t *testing.T) {
+	a := assert.New(t)
+
+	// Save original working directory
+	originalWorkDir, err := os.Getwd()
+	a.NoError(err)
+
+	defer func() { // Reset current dir after test
+		os.Chdir(originalWorkDir)
+	}()
+
+	// Create temp dir to use as current working directory
+	tempWorkDir, err := os.MkdirTemp("", "temp")
+	a.NoError(err)
+	defer func() { // Clean up
+		os.RemoveAll(tempWorkDir)
+	}()
+
+	// Run the help command
+	cmd := exec.Command(GlobalInputManager{}.GetExecutablePath(), "--help")
+	output, err := cmd.CombinedOutput()
+	a.NoError(err, "Help command should work")
+	a.NotEmpty(output)
+
+	// Check that latest_version.txt is NOT in current directory
+	currDirFile := filepath.Join(tempWorkDir, "latest_version.txt")
+	_, err = os.Stat(currDirFile)
+	a.True(os.IsNotExist(err), "latest_version.txt should NOT be in current directory")
+
+	// The file should be in the app's log directory
+	appDataFolder := cmd2.GetAzCopyAppPath()
+	if appDataFolder != "" {
+		expectedFile := filepath.Join(appDataFolder, "latest_version.txt")
+		time.Sleep(2 * time.Second) // Wait for version check to complete
+
+		// Check if file exists
+		if _, err := os.Stat(expectedFile); err == nil {
+			a.True(true, "latest_version.txt found in app dir")
+		}
+	}
+}