Skip to content

Commit

Permalink
agent: Ensure logger set up method is public (#24887)
Browse files Browse the repository at this point in the history
backport of commit 63ea13b

Co-authored-by: James Rasell <[email protected]>
  • Loading branch information
hc-github-team-nomad-core and jrasell authored Jan 17, 2025
1 parent 9038434 commit c4f5dda
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 5 deletions.
9 changes: 6 additions & 3 deletions command/agent/command.go
Original file line number Diff line number Diff line change
Expand Up @@ -547,8 +547,11 @@ func (c *Command) IsValidConfig(config, cmdConfig *Config) bool {
return true
}

// setupLoggers is used to set up the logGate and our logOutput.
func setupLoggers(ui cli.Ui, config *Config) (*gatedwriter.Writer, io.Writer) {
// SetupLoggers is used to set up the logGate and our logOutput.
//
// The function needs to be public due to the way it is used within the Nomad
// Enterprise codebase.
func SetupLoggers(ui cli.Ui, config *Config) (*gatedwriter.Writer, io.Writer) {

// Pull the log level from the configuration, ensure it is titled and then
// perform validation. Do this before the gated writer, as this can
Expand Down Expand Up @@ -798,7 +801,7 @@ func (c *Command) Run(args []string) int {
}

// Set up the log outputs.
logGate, logOutput := setupLoggers(c.Ui, config)
logGate, logOutput := SetupLoggers(c.Ui, config)
if logGate == nil {
return 1
}
Expand Down
4 changes: 2 additions & 2 deletions command/agent/command_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -639,7 +639,7 @@ func Test_setupLoggers_logFile(t *testing.T) {
}

// Generate the loggers and ensure the correct error is generated.
gatedWriter, writer := setupLoggers(mockUI, cfg)
gatedWriter, writer := SetupLoggers(mockUI, cfg)
must.Nil(t, gatedWriter)
must.Nil(t, writer)
must.StrContains(t, mockUI.ErrorWriter.String(), "Invalid log level: WARNING")
Expand All @@ -650,7 +650,7 @@ func Test_setupLoggers_logFile(t *testing.T) {
// Update the log level, so that it is a valid option and set up the
// loggers again.
cfg.LogLevel = "warn"
gatedWriter, writer = setupLoggers(mockUI, cfg)
gatedWriter, writer = SetupLoggers(mockUI, cfg)
must.NotNil(t, gatedWriter)
must.NotNil(t, writer)

Expand Down

0 comments on commit c4f5dda

Please sign in to comment.