feat: add audit file location to viper

Signed-off-by: Manan Gupta <manan@planetscale.com>

go/vt/vtorc/config/config.go

@@ -46,7 +46,7 @@ const (
 
 var (
 	instancePollTime = viperutil.Configure(
-		"InstancePollTime",
+		"instance-pPollTime",
 		viperutil.Options[time.Duration]{
 			FlagName: "instance-poll-time",
 			Default:  5 * time.Second,
@@ -89,10 +89,18 @@ var (
 			Dynamic:  true,
 		},
 	)
+
+	auditFileLocation = viperutil.Configure(
+		"AuditFileLocation",
+		viperutil.Options[string]{
+			FlagName: "audit-file-location",
+			Default:  "",
+			Dynamic:  false,
+		},
+	)
 )
 
 var (
-	auditFileLocation              = ""
 	auditToBackend                 = false
 	auditToSyslog                  = false
 	auditPurgeDuration             = 7 * 24 * time.Hour // Equivalent of 7 days
@@ -114,7 +122,7 @@ func registerFlags(fs *pflag.FlagSet) {
 	fs.Duration("instance-poll-time", instancePollTime.Default(), "Timer duration on which VTOrc refreshes MySQL information")
 	fs.Duration("snapshot-topology-interval", snapshotTopologyInterval.Default(), "Timer duration on which VTOrc takes a snapshot of the current MySQL information it has in the database. Should be in multiple of hours")
 	fs.Duration("reasonable-replication-lag", reasonableReplicationLag.Default(), "Maximum replication lag on replicas which is deemed to be acceptable")
-	fs.StringVar(&auditFileLocation, "audit-file-location", auditFileLocation, "File location where the audit logs are to be stored")
+	fs.String("audit-file-location", auditFileLocation.Default(), "File location where the audit logs are to be stored")
 	fs.BoolVar(&auditToBackend, "audit-to-backend", auditToBackend, "Whether to store the audit log in the VTOrc database")
 	fs.BoolVar(&auditToSyslog, "audit-to-syslog", auditToSyslog, "Whether to store the audit log in the syslog")
 	fs.DurationVar(&auditPurgeDuration, "audit-purge-duration", auditPurgeDuration, "Duration for which audit logs are held before being purged. Should be in multiples of days")
@@ -132,6 +140,7 @@ func registerFlags(fs *pflag.FlagSet) {
 		sqliteDataFile,
 		snapshotTopologyInterval,
 		reasonableReplicationLag,
+		auditFileLocation,
 	)
 }
 
@@ -194,10 +203,19 @@ func GetSnapshotTopologyInterval() time.Duration {
 	return snapshotTopologyInterval.Get()
 }
 
+// GetAuditFileLocation is a getter function.
+func GetAuditFileLocation() string {
+	return auditFileLocation.Get()
+}
+
+// SetAuditFileLocation is a setter function.
+func SetAuditFileLocation(v string) {
+	auditFileLocation.Set(v)
+}
+
 // UpdateConfigValuesFromFlags is used to update the config values from the flags defined.
 // This is done before we read any configuration files from the user. So the config files take precedence.
 func UpdateConfigValuesFromFlags() {
-	Config.AuditLogFile = auditFileLocation
 	Config.AuditToBackendDB = auditToBackend
 	Config.AuditToSyslog = auditToSyslog
 	Config.AuditPurgeDays = uint(auditPurgeDuration / (time.Hour * 24))
@@ -234,7 +252,6 @@ func LogConfigValues() {
 
 func newConfiguration() *Configuration {
 	return &Configuration{
-		AuditLogFile:                  "",
 		AuditToSyslog:                 false,
 		AuditToBackendDB:              false,
 		AuditPurgeDays:                7,

go/vt/vtorc/config/config_test.go

@@ -52,21 +52,6 @@ func TestUpdateConfigValuesFromFlags(t *testing.T) {
 		require.Equal(t, testConfig, Config)
 	})
 
-	t.Run("override auditFileLocation", func(t *testing.T) {
-		oldAuditFileLocation := auditFileLocation
-		auditFileLocation = "newFile"
-		// Restore the changes we make
-		defer func() {
-			Config = newConfiguration()
-			auditFileLocation = oldAuditFileLocation
-		}()
-
-		testConfig := newConfiguration()
-		testConfig.AuditLogFile = "newFile"
-		UpdateConfigValuesFromFlags()
-		require.Equal(t, testConfig, Config)
-	})
-
 	t.Run("override auditToBackend", func(t *testing.T) {
 		oldAuditToBackend := auditToBackend
 		auditToBackend = true

go/vt/vtorc/inst/audit_dao.go

@@ -38,10 +38,10 @@ func AuditOperation(auditType string, tabletAlias string, message string) error
 	}
 
 	auditWrittenToFile := false
-	if config.Config.AuditLogFile != "" {
+	if config.GetAuditFileLocation() != "" {
 		auditWrittenToFile = true
 		go func() {
-			f, err := os.OpenFile(config.Config.AuditLogFile, os.O_RDWR|os.O_CREATE|os.O_APPEND, 0640)
+			f, err := os.OpenFile(config.GetAuditFileLocation(), os.O_RDWR|os.O_CREATE|os.O_APPEND, 0640)
 			if err != nil {
 				log.Error(err)
 				return

go/vt/vtorc/inst/audit_dao_test.go

@@ -36,11 +36,11 @@ import (
 func TestAuditOperation(t *testing.T) {
 	// Restore original configurations
 	originalAuditSysLog := config.Config.AuditToSyslog
-	originalAuditLogFile := config.Config.AuditLogFile
+	originalAuditLogFile := config.GetAuditFileLocation()
 	originalAuditBackend := config.Config.AuditToBackendDB
 	defer func() {
 		config.Config.AuditToSyslog = originalAuditSysLog
-		config.Config.AuditLogFile = originalAuditLogFile
+		config.SetAuditFileLocation(originalAuditLogFile)
 		config.Config.AuditToBackendDB = originalAuditBackend
 	}()
 
@@ -78,7 +78,7 @@ func TestAuditOperation(t *testing.T) {
 	message := "test-message"
 
 	t.Run("audit to backend", func(t *testing.T) {
-		config.Config.AuditLogFile = ""
+		config.SetAuditFileLocation("")
 		config.Config.AuditToSyslog = false
 		config.Config.AuditToBackendDB = true
 
@@ -112,7 +112,7 @@ func TestAuditOperation(t *testing.T) {
 		file, err := os.CreateTemp("", "test-auditing-*")
 		require.NoError(t, err)
 		defer os.Remove(file.Name())
-		config.Config.AuditLogFile = file.Name()
+		config.SetAuditFileLocation(file.Name())
 
 		err = AuditOperation(auditType, tab100Alias, message)
 		require.NoError(t, err)