Also load config using WithEnvLiteralLoader (#4000)

Co-authored-by: Mike Cohen <[email protected]>
Velocidex · Jan 14, 2025 · c741cf9 · c741cf9
1 parent 786e656
commit c741cf9
Show file tree

Hide file tree

Showing 9 changed files with 23 additions and 7 deletions.
diff --git a/bin/banner.go b/bin/banner.go
@@ -46,7 +46,8 @@ func doBanner() {
 		}
 
 		switch pair[0] {
-		case // Ignore this one as it is the actual configuration "VELOCIRAPTOR_CONFIG",
+		case // Ignore this one as it is the actual configuration
+			"VELOCIRAPTOR_LITERAL_CONFIG",
 			"VELOCIRAPTOR_SLOW_FILESYSTEM",
 			"VELOCIRAPTOR_DISABLE_CSRF", "VELOCIRAPTOR_INJECT_API_SLEEP",
 			"GOGC", "GOTRACEBACK", "GOMAXPROCS", "GODEBUG", "GOMEMLIMIT",

diff --git a/bin/binary_test.go b/bin/binary_test.go
@@ -356,6 +356,16 @@ func TestGenerateConfigWithMerge(t *testing.T) {
 	require.NoError(t, err)
 	require.Contains(t, string(out), "Foo")
 
+	// Specify the literal config in the environment
+	cmd = exec.Command(binary, "config", "show")
+	cmd.Env = append(os.Environ(),
+		"VELOCIRAPTOR_LITERAL_CONFIG="+string(config_file_content),
+		"VELOCIRAPTOR_CONFIG=",
+	)
+	out, err = cmd.Output()
+	require.NoError(t, err)
+	require.Contains(t, string(out), "Foo")
+
 	// Specifying invalid config in the flag is a hard stop - even
 	// if there is a valid environ.
 	cmd = exec.Command(binary, "config", "show", "--config", "XXXX")

diff --git a/bin/gui.go b/bin/gui.go
@@ -160,6 +160,7 @@ func generateGUIConfig(datastore_directory, server_config_path, client_config_pa
 func doGUI() error {
 	// Start from a clean slate
 	os.Setenv("VELOCIRAPTOR_CONFIG", "")
+	os.Setenv("VELOCIRAPTOR_LITERAL_CONFIG", "")
 
 	datastore_directory := *gui_command_datastore
 	if datastore_directory == "" {

diff --git a/bin/main.go b/bin/main.go
@@ -182,6 +182,7 @@ func main() {
 		WithFileLoader(*config_path).
 		WithEmbedded(*embedded_config_path).
 		WithEnvLoader("VELOCIRAPTOR_CONFIG").
+		WithEnvLiteralLoader("VELOCIRAPTOR_LITERAL_CONFIG").
 		WithConfigMutator("Mutator mergeFlagConfig",
 			func(config_obj *config_proto.Config) error {
 				return mergeFlagConfig(config_obj, default_config)
@@ -246,6 +247,7 @@ func makeDefaultConfigLoader() *config.Loader {
 		WithFileLoader(*config_path).
 		WithEmbedded(*embedded_config_path).
 		WithEnvLoader("VELOCIRAPTOR_CONFIG").
+		WithEnvLiteralLoader("VELOCIRAPTOR_LITERAL_CONFIG").
 		WithConfigMutator("Mutator mergeFlagConfig",
 			func(config_obj *config_proto.Config) error {
 				return mergeFlagConfig(config_obj, default_config)

diff --git a/bin/offline.go b/bin/offline.go
@@ -116,6 +116,7 @@ func doCollector() error {
 
 	// Start from a clean slate
 	os.Setenv("VELOCIRAPTOR_CONFIG", "")
+	os.Setenv("VELOCIRAPTOR_LITERAL_CONFIG", "")
 
 	datastore_directory := *collector_command_datastore
 	if datastore_directory == "" {

diff --git a/bin/panic.go b/bin/panic.go
@@ -17,6 +17,7 @@ func writeLogOnPanic() error {
 	config_obj, err := new(config.Loader).
 		WithFileLoader(*config_path).
 		WithEmbedded(*embedded_config_path).
+		WithEnvLiteralLoader("VELOCIRAPTOR_LITERAL_CONFIG").
 		WithEnvLoader("VELOCIRAPTOR_CONFIG").
 		LoadAndValidate()
 	if err != nil {

diff --git a/datastore/remote_test.go b/datastore/remote_test.go
@@ -28,9 +28,9 @@ type RemoteTestSuite struct {
 
 func (self *RemoteTestSuite) SetupTest() {
 	var err error
-	os.Setenv("VELOCIRAPTOR_CONFIG", test_utils.SERVER_CONFIG)
+	os.Setenv("VELOCIRAPTOR_LITERAL_CONFIG", test_utils.SERVER_CONFIG)
 	self.ConfigObj, err = new(config.Loader).
-		WithEnvLiteralLoader("VELOCIRAPTOR_CONFIG").WithRequiredFrontend().
+		WithEnvLiteralLoader("VELOCIRAPTOR_LITERAL_CONFIG").WithRequiredFrontend().
 		WithVerbose(true).LoadAndValidate()
 	require.NoError(self.T(), err)
 

diff --git a/file_store/test_utils/testsuite.go b/file_store/test_utils/testsuite.go
@@ -150,9 +150,9 @@ func (self *TestSuite) CreateFlow(client_id, flow_id string) {
 }
 
 func (self *TestSuite) LoadConfig() *config_proto.Config {
-	os.Setenv("VELOCIRAPTOR_CONFIG", SERVER_CONFIG)
+	os.Setenv("VELOCIRAPTOR_LITERAL_CONFIG", SERVER_CONFIG)
 	config_obj, err := new(config.Loader).
-		WithEnvLiteralLoader("VELOCIRAPTOR_CONFIG").WithRequiredFrontend().
+		WithEnvLiteralLoader("VELOCIRAPTOR_LITERAL_CONFIG").WithRequiredFrontend().
 		WithWriteback().WithVerbose(true).
 		LoadAndValidate()
 	require.NoError(self.T(), err)

diff --git a/services/journal/journal_test.go b/services/journal/journal_test.go
@@ -31,9 +31,9 @@ func (self *JournalTestSuite) SetupTest() {
 
 	file_store.ClearGlobalFilestore()
 
-	os.Setenv("VELOCIRAPTOR_CONFIG", test_utils.SERVER_CONFIG)
+	os.Setenv("VELOCIRAPTOR_LITERAL_CONFIG", test_utils.SERVER_CONFIG)
 	self.ConfigObj, err = new(config.Loader).
-		WithEnvLiteralLoader("VELOCIRAPTOR_CONFIG").WithRequiredFrontend().
+		WithEnvLiteralLoader("VELOCIRAPTOR_LITERAL_CONFIG").WithRequiredFrontend().
 		WithVerbose(true).LoadAndValidate()
 	require.NoError(self.T(), err)