e2e: add logfile for e2e tests #1775
Conversation
Good to link the issue, but we should start a PR with a commit message describing the change. We can describe what was done and what will be done later. This helps people to review the change. |
e2e/main_test.go
Outdated
| } | ||
|
|
||
| log := logger.Sugar() | ||
| executableName := "ramen-e2e" |
There was a problem hiding this comment.
Removed this. Using private constant called logFilePath in test/log
e2e/main_test.go
Outdated
| log := logger.Sugar() | ||
| executableName := "ramen-e2e" | ||
| logger := util.CreateLogger(executableName, false) | ||
| defer logger.Sync() |
There was a problem hiding this comment.
See kubectl-gather for how to handle the return value.
There was a problem hiding this comment.
Still facing lint issues wrt to defer, will fix it.
e2e/util/logger.go
Outdated
| "go.uber.org/zap/zapcore" | ||
| ) | ||
|
|
||
| func CreateLogger(executableName string, verbose bool) *zap.SugaredLogger { |
There was a problem hiding this comment.
We don't need the executable name or verbose flag.
The executable name is available in os.Args[0], but it may be "go" when we run the tests as go test ..., and "ramen-e2e" when we run from the executable. It will be best to support both use cases. If using os.Args[0] does not work, it is fine to hard code the default log name using private constant in this file.
We can add later a --logfile argument and use it here, but lets defer this work so we can have the default log file available sooner. Using custom logfile is nice to have and we can add it when after we finished with more important stuff.
There was a problem hiding this comment.
wrt using os.Args[0]:
// Determine the log file name, fallback to "ramen-e2e.log" if running via go test
logFileName := "ramen-e2e.log" // Default log file name
if len(os.Args) > 0 {
if os.Args[0] == "go" {
// If we are running with `go test`, use the default log file name
logFileName = "ramen-e2e.log"
} else {
// If we are running the executable directly, use the base name of the executable
logFileName = filepath.Base(os.Args[0]) + ".log"
}
}
Currently i have hardcoded logfile name to ramen-e2e.log. What do you think about above code suggestion for os.Args[0]?
There was a problem hiding this comment.
Lets use constant log name. Add a private constant in the log.go.
When we add a --logfile option the option will use a default value anyway.
This commit introduces a dedicated log file for e2e tests: * Creates a log file (ramen-e2e.log) in the current directory by default. * Log DEBUG level messages to the file and INFO level messages to the console. * Remove caller (file:lineno) from console logs for cleaner output. Signed-off-by: Parikshith <[email protected]>
parikshithb
force-pushed
the
e2e_logger
branch
from
7b81bbb to
13a1f0c
Compare
This reverts commit 2cd063a. The original commit redirected e2e test logs to ramen-e2e.log using tee. The new logger writes to ramen-e2e.log by default Signed-off-by: Parikshith <[email protected]>
parikshithb
force-pushed
the
e2e_logger
branch
from
13a1f0c to
f242964
Compare
Fixes: #1722