Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Make custom logging façade testable #1047

Closed
1 task done
sbrannen opened this issue Sep 8, 2017 · 3 comments
Closed
1 task done

Make custom logging façade testable #1047

sbrannen opened this issue Sep 8, 2017 · 3 comments
Assignees
@sbrannen
Labels
component: Jupiter component: Platform component: Vintage type: task
Milestone
5.1 M1

Comments

@sbrannen
Copy link
Member

sbrannen commented Sep 8, 2017 •
edited
Loading

Overview

This is a follow-up to #834.

Deliverables

  • Make custom logging façade testable -- for example, by allowing tests to attach some sort of listener in order to verify that particular statements were logged at a specific log level.
    • See org.junit.vintage.engine.RecordCollectingLogger for inspiration.
@sbrannen sbrannen added this to the 5.1 Backlog milestone Sep 8, 2017
@sbrannen sbrannen self-assigned this Sep 8, 2017
@sbrannen sbrannen mentioned this issue Sep 8, 2017
Closed
3 tasks
@sbrannen sbrannen modified the milestones: 5.1 Backlog, 5.1 M1 Sep 20, 2017
@sbrannen
Copy link
Member Author

in progress

sbrannen added a commit that referenced this issue Sep 22, 2017
@sbrannen
Make custom logging façade testable
1b3939d 
This commit introduces a LogRecordListener that can be registered with
JUnit's logging façade for JUL via the LoggerFactory. Such a listener
can be queried for all log records that were submitted since the
listener was registered. This makes it possible for tests to register
a listener for a given scenario that is supposed to log something and
then verify that the expected message got logged at the expected level.

After such a test scenario has completed, the test code should remove
the listener from the LoggerFactory.

To simplify matters, the creation of a listener, registration of a
listener, and removal of a listener are all encapsulated in a JUnit
Jupiter extension that is registered via a new @TrackLogRecords in the
junit-jupiter-engine test source tree.

See MultipleTestableAnnotationsTests for an example of this
functionality in action.

Issue: #1047
sbrannen added a commit that referenced this issue Sep 23, 2017
@sbrannen
Fix @API(since) declaration in LogRecordListener
ec04773 
Issue: #1047
sbrannen added a commit that referenced this issue Sep 23, 2017
@sbrannen
Polish implementation of @TrackLogRecords.Extension
a70b243 
Issue: #1047
sbrannen added a commit that referenced this issue Sep 23, 2017
@sbrannen
Introduce basic filtering support in LogRecordListener
8408183 
Issue: #1047
sbrannen added a commit that referenced this issue Sep 23, 2017
@sbrannen
Publish @TrackLogRecords to other projects as test artifact
7b0076d 
Issue: #1047
sbrannen added a commit that referenced this issue Sep 23, 2017
@sbrannen
Use @TrackLogRecords to test Vintage TestEngine logging
94e5762 
Issue: #1047
sbrannen added a commit that referenced this issue Sep 23, 2017
@sbrannen
Introduce log level filtering support in LogRecordListener
d9ec28d 
Issue: #1047
sbrannen added a commit that referenced this issue Sep 23, 2017
@sbrannen
Return streams from LogRecordListener getLogRecords() variants
8e86ba6 
Issue: #1047
@sbrannen
Copy link
Member Author

Work completed and pushed to master.

See previous commits.

@ghost ghost removed the status: in progress label Sep 23, 2017
@sbrannen
Copy link
Member Author

Note to developers: search for uses of @TrackLogRecords for examples of how to test logging with our logging façade. 😉

Andrei94 pushed a commit to Andrei94/junit5 that referenced this issue Jun 23, 2018
@sbrannen @Andrei94
Make custom logging façade testable
ec78527 
This commit introduces a LogRecordListener that can be registered with
JUnit's logging façade for JUL via the LoggerFactory. Such a listener
can be queried for all log records that were submitted since the
listener was registered. This makes it possible for tests to register
a listener for a given scenario that is supposed to log something and
then verify that the expected message got logged at the expected level.

After such a test scenario has completed, the test code should remove
the listener from the LoggerFactory.

To simplify matters, the creation of a listener, registration of a
listener, and removal of a listener are all encapsulated in a JUnit
Jupiter extension that is registered via a new @TrackLogRecords in the
junit-jupiter-engine test source tree.

See MultipleTestableAnnotationsTests for an example of this
functionality in action.

Issue: junit-team#1047
Andrei94 pushed a commit to Andrei94/junit5 that referenced this issue Jun 23, 2018
@sbrannen @Andrei94
Fix @API(since) declaration in LogRecordListener
7ad0a11 
Issue: junit-team#1047
Andrei94 pushed a commit to Andrei94/junit5 that referenced this issue Jun 23, 2018
@sbrannen @Andrei94
Polish implementation of @TrackLogRecords.Extension
ec81730 
Issue: junit-team#1047
Andrei94 pushed a commit to Andrei94/junit5 that referenced this issue Jun 23, 2018
@sbrannen @Andrei94
Introduce basic filtering support in LogRecordListener
3397cbb 
Issue: junit-team#1047
Andrei94 pushed a commit to Andrei94/junit5 that referenced this issue Jun 23, 2018
@sbrannen @Andrei94
Publish @TrackLogRecords to other projects as test artifact
925453e 
Issue: junit-team#1047
Andrei94 pushed a commit to Andrei94/junit5 that referenced this issue Jun 23, 2018
@sbrannen @Andrei94
Use @TrackLogRecords to test Vintage TestEngine logging
d289537 
Issue: junit-team#1047
Andrei94 pushed a commit to Andrei94/junit5 that referenced this issue Jun 23, 2018
@sbrannen @Andrei94
Introduce log level filtering support in LogRecordListener
14b9722 
Issue: junit-team#1047
Andrei94 pushed a commit to Andrei94/junit5 that referenced this issue Jun 23, 2018
@sbrannen @Andrei94
Return streams from LogRecordListener getLogRecords() variants
bd470d6 
Issue: junit-team#1047
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@sbrannen sbrannen

Labels
component: Jupiter component: Platform component: Vintage type: task
Projects
None yet
Milestone
5.1 M1
Development

No branches or pull requests
1 participant
@sbrannen