Even more silent Job API #2695
Merged
Even more silent Job API #2695
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
DrJosh9000
reviewed
Mar 20, 2024
| assert.NilError(t, srv.Stop()) | ||
|
|
||
| logs := logBuf.String() | ||
| assert.Check(t, strings.Contains(logs, "~~~ Job API"), "logs: %q", logs) |
There was a problem hiding this comment.
I think the test names need swapping?
There was a problem hiding this comment.
Yep 🤦♂️. It's fixed now.
The Job API should not print anything to the job logs unless in debug mode. This is not currently the case, but it will be fixed in a later commit. The test will succeed once the fix is in place.
Unless if in debug mode
triarius
force-pushed
the
triarius/even-more-silent-job-api
branch
from
0f2416c
to
a7ff25a
Compare
DrJosh9000
approved these changes
Mar 20, 2024
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.
Description
I've made a few PRs to reduce the amount of logging that the job api does. But I kept missing a few places. This PR should fix that, and for good measure I've added a test to make sure that the job api doesn't log anything unless in debug mode. To test that the tests work, the commit that introduces the tests should fail and that failure should be fixed by the next commit.
In particular, it should stop printing the message that the Job API server has shut down. This was difficult to see if log headers (e.g.
+++,~~~, etc) are being used in a job as it's often hidden in the last log group. But it's still an annoyance if log groups are not being used.Context
#2690
#2662
Changes
Testing
go test ./...). Buildkite employees may check this if the pipeline has run automatically.go fmt ./...)