Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vitalijr2/mock-jdk-platform-logging
JDK Platform Logging Service with mock loggers backed by Mockito.
https://github.com/vitalijr2/mock-jdk-platform-logging
java-logging jdk-logging junit-extension logger-mock logging-library mock-library mocks
Last synced: 26 days ago
JSON representation
JDK Platform Logging Service with mock loggers backed by Mockito.
- Host: GitHub
- URL: https://github.com/vitalijr2/mock-jdk-platform-logging
- Owner: vitalijr2
- License: apache-2.0
- Created: 2024-07-15T15:29:24.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-09-04T19:30:56.000Z (2 months ago)
- Last Synced: 2024-09-06T03:36:36.090Z (2 months ago)
- Topics: java-logging, jdk-logging, junit-extension, logger-mock, logging-library, mock-library, mocks
- Language: Java
- Homepage:
- Size: 96.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- Changelog: changelog.md
- Contributing: contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# Mock of JDK Platform Logging
JDK Platform Logging Service with mock loggers backed by [Mockito][].
[![Codacy Badge][codacy-badge]][codacy-badge-link]
[![Codacy Coverage][codacy-coverage]][codacy-coverage-link]
[![Libraries.io dependency status for GitHub repo][dependency-status]][dependencies]
[![Java Version][java-version]][jdk-download]
[](https://search.maven.org/artifact/io.github.vitalijr2.logging/mock-jdk-platform-logging)
[](https://javadoc.io/doc/io.github.vitalijr2.logging/mock-jdk-platform-logging)
## How to use
Just put a test dependency to your POM:
```xml
mock-jdk-platform-logging
io.github.vitalijr2.logging
test
1.1.1
```
The most basic usage example looks like this:
```java
@Test
void helloWorld() {
var helloService = new HelloService();
assertDoesNotThrow(helloService::sayHelloWorld);
verify(System.getLogger("HelloService")).log(Level.INFO, "Hello World!");
}
```
See more details at [HelloServiceBasicTest.java](src/it/hello-world/src/test/java/example/hello/HelloServiceBasicTest.java)
It should be taken into account that all loggers are initialized only once during the run of tests.
Therefore, a more complex example cleans the loggers before (or after) each test:
```java
// the static logger instance
private static Logger logger;
// initialize the mock logger once
@BeforeAll
static void setUpClass() {
logger = System.getLogger("HelloService");
}
// clean the mock logger after each test
@AfterEach
void tearDown() {
clearInvocations(logger);
}
// use the mock logger in a test
@DisplayName("Names")
@ParameterizedTest(name = "<{0}>")
@ValueSource(strings = {"John", "Jane"})
void names(String name) {
var helloService = new HelloService();
assertDoesNotThrow(() -> helloService.sayHello(name));
var logger = System.getLogger("HelloService");
verify(logger).log(Level.INFO, "Hello " + name + "!");
verifyNoMoreInteractions(logger);
}
```
See more details at [HelloServiceFullTest.java](src/it/hello-world/src/test/java/example/hello/HelloServiceFullTest.java)
Since the version **1.1.0** you can use the jUnit extension for automation.
```java
@ExtendWith(MockLoggerExtension.class)
class HelloServiceExtensionTest {
private static Logger logger;
@BeforeAll
static void setUpClass() {
logger = System.getLogger("HelloService");
}
@DisplayName("Names")
@ParameterizedTest(name = "<{0}>")
@ValueSource(strings = {"John", "Jane"})
void names(String name) {
var helloService = new HelloService();
assertDoesNotThrow(() -> helloService.sayHello(name));
var logger = System.getLogger("HelloService");
verify(logger).log(Level.INFO, "Hello " + name + "!");
verifyNoMoreInteractions(logger);
}
}
```
See more details at [HelloServiceExtensionTest.java](src/it/hello-world/src/test/java/example/hello/HelloServiceExtensionTest.java)
## Credits
There are two projects which inspired me to make this library:
- [s4u/slf4j-mock][slf4j-mock]
- [ocarlsen/mock-slf4j-impl][mock-slf4j-impl]
## Contributing
Please read [Contributing](contributing.md).
## History
See [Changelog](changelog.md)
## License
Copyright 2024 Vitalij Berdinskih
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
[Apache License v2.0](LICENSE)
[](https://www.apache.org/licenses/LICENSE-2.0.html)
[Mockito]: https://site.mockito.org
[codacy-badge]: https://app.codacy.com/project/badge/Grade/9be380deaf3e40138ad306a40532289c
[codacy-badge-link]: https://app.codacy.com/gh/vitalijr2/mock-jdk-platform-logging/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade
[codacy-coverage]: https://app.codacy.com/project/badge/Coverage/9be380deaf3e40138ad306a40532289c
[codacy-coverage-link]: https://app.codacy.com/gh/vitalijr2/mock-jdk-platform-logging/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_coverage
[dependency-status]: https://img.shields.io/librariesio/github/vitalijr2/mock-jdk-platform-logging
[dependencies]: https://libraries.io/github/vitalijr2/mock-jdk-platform-logging
[java-version]: https://img.shields.io/static/v1?label=java&message=11&color=blue&logo=java&logoColor=E23D28
[jdk-download]: https://www.oracle.com/java/technologies/downloads/#java11
[slf4j-mock]: https://github.com/s4u/slf4j-mock
[mock-slf4j-impl]: https://github.com/ocarlsen/mock-slf4j-impl