Unify logging in tests #5487
Merged
Unify logging in tests #5487
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3vilhamster
requested review from
Shaddoll,
neil-xie,
davidporter-id-au,
Groxx,
shijiesheng,
agautam478,
jakobht,
sankari165,
dkrotx,
taylanisikdemir and
demirkayaender
as code owners
3vilhamster
force-pushed
the
integration-tests-logging
branch
2 times, most recently
from
f71a0a6 to
343227e
Compare
Shaddoll
approved these changes
Dec 18, 2023
3vilhamster
force-pushed
the
integration-tests-logging
branch
from
aa58862 to
ce36015
Compare
taylanisikdemir
approved these changes
Dec 18, 2023
Groxx
reviewed
Dec 18, 2023
| s.Require().NoError(err) | ||
| } | ||
| logger := loggerimpl.NewLogger(zapLogger) | ||
| logger := testlogger.New(s.T()) |
There was a problem hiding this comment.
Unfortunately:
panic: Log in goroutine after TestScavengerTestSuite/TestExpiredTasksFollowedByAlive has completed: 2023-12-18T22:18:12.457Z INFO Tasklist scavenger stopped {"logging-call-at": "scavenger.go:201"}
goroutine 243 [running]:
testing.(*common).logDepth(0xc0009d7860, {0xc0001ea2a0, 0x60}, 0x3)
/usr/local/go/src/testing/testing.go:1003 +0x68c
testing.(*common).log(...)
/usr/local/go/src/testing/testing.go:985
testing.(*common).Logf(0xc0009d7860, {0x15894f4, 0x2}, {0xc000016040, 0x1, 0x1})
/usr/local/go/src/testing/testing.go:1036 +0xa5
go.uber.org/zap/zaptest.testingWriter.Write({{0x25e9a20?, 0xc0009d7860?}, 0xa0?}, {0xc0001cc400, 0x61, 0x400})
/go/pkg/mod/go.uber.org/[email protected]/zaptest/logger.go:130 +0x12d
go.uber.org/zap/zapcore.(*ioCore).Write(0xc0009fa1e0, {0x0, {0xc1584f291b469190, 0x2bd47304, 0x2d30fe0}, {0x0, 0x0}, {0x15a5897, 0x1a}, {0x0, ...}, ...}, ...)
/go/pkg/mod/go.uber.org/[email protected]/zapcore/core.go:90 +0x19a
go.uber.org/zap/zapcore.(*CheckedEntry).Write(0xc00014cdc0, {0xc000c12300, 0x1, 0x1})
/go/pkg/mod/go.uber.org/[email protected]/zapcore/entry.go:216 +0x2ed
go.uber.org/zap.(*Logger).Info(0xc000119dc0?, {0x15a5897, 0x1a}, {0xc000c12300, 0x1, 0x1})
/go/pkg/mod/go.uber.org/[email protected]/logger.go:187 +0x6b
github.com/uber/cadence/common/log/loggerimpl.(*loggerImpl).Info(0xc000119dc0, {0x15a5897, 0x1a}, {0x0, 0x0, 0x0})
/cadence/common/log/loggerimpl/logger.go:132 +0xd7
github.com/uber/cadence/service/worker/scanner/tasklist.(*Scavenger).Stop(0xc0005d0b60)
/cadence/service/worker/scanner/tasklist/scavenger.go:201 +0x19f
created by github.com/uber/cadence/service/worker/scanner/tasklist.(*Scavenger).run.func1
/cadence/service/worker/scanner/tasklist/scavenger.go:213 +0xaf
FAIL github.com/uber/cadence/service/worker/scanner/tasklist 0.748s
iirc that's true for a fair number of these, sadly :|
incrementally undoing them as they cause issues seems worthwhile though, and other changes might have improved these since I last tried.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changed?
I've separate test logger into a dedicated package and centralized verbose testing approach.
Switch to zaptest.New that will print out logs only if test are failing to avoid logging on success.
When required, you can always fallback to Development using -v flag.
Why?
It is better to have common approach to logging in tests.
Simplify debugging issues on CI. Now only in the logs you can find logs related to failed test.
Also, save some space. Unit test run logs from 43 mb to 215kb.
How did you test it?
unit tests/integration tests
Potential risks
None
Release notes
Documentation Changes