https://github.com/asarkar/grpc-test

Includes a JUnit 5 Extension that can automatically release gRPC resources at the end of the test
https://github.com/asarkar/grpc-test

grpc grpc-java grpc-test junit junit-extension junit5 junit5-extension protobuf protobuf-java testing

Last synced: 2 days ago
JSON representation

Includes a JUnit 5 Extension that can automatically release gRPC resources at the end of the test

• Host: GitHub
• URL: https://github.com/asarkar/grpc-test
• Owner: asarkar
• License: apache-2.0
• Created: 2020-08-02T23:32:43.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2022-09-12T04:57:50.000Z (about 2 years ago)
• Last Synced: 2024-06-21T20:02:23.835Z (5 months ago)
• Topics: grpc, grpc-java, grpc-test, junit, junit-extension, junit5, junit5-extension, protobuf, protobuf-java, testing
• Language: Kotlin
• Homepage:
• Size: 87.9 KB
• Stars: 26
• Watchers: 5
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# grpc-test

Includes a JUnit

5 [Extension](https://junit.org/junit5/docs/current/api/org.junit.jupiter.api/org/junit/jupiter/api/extension/Extension.html)

that can automatically release gRPC resources at the end of the test.

Like [GrpcCleanupRule](https://grpc.github.io/grpc-java/javadoc/io/grpc/testing/GrpcCleanupRule.html), but built for

JUnit 5 and actively maintained.

If you like it, consider becoming a

[![](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/asarkar).

[![](https://github.com/asarkar/grpc-test/workflows/CI%20Pipeline/badge.svg)](https://github.com/asarkar/grpc-test/actions?query=workflow%3A%22CI+Pipeline%22)

## Installation

You can find the latest version

on [Maven Central](https://search.maven.org/search?q=g:com.asarkar.grpc%20AND%20a:grpc-test).

## Usage

Declare a `Resources` in one of the three following ways, and register `Server` and/or `ManagedChannel` instances with

it.

Get a `Resources` from:

1. A test method parameter injection, or

2. An instance field, or

3. A static field.

The difference is in the lifecycle of the `Resources` object. For `#1`, a new instance is created for every test method.

`#2` is the same as `#1` unless the test class declares `@TestInstance(TestInstance.Lifecycle.PER_CLASS)`, in which case

one instance is shared among all the tests. `#3` is obviously one instance shared among all the tests.

```

@ExtendWith(GrpcCleanupExtension.class)

class ExampleTestCase {

    @Test

    void testSuccessful(Resources resources) {

        resources.register(server); // use default timeout

        resources.register(channel, Duration.ofSeconds(1)); // override default timeout

        resources.timeout(Duration.ofSeconds(3)); // change default timeout to 3 seconds

        resources.register(channel2) // channel2 timeout is 3 seconds; server and channel timeouts didn't change

    }

}

```

:information_source: Note that for `#2` and `#3`, if the variable is already been assigned a value by the user, the

extension will not reinitialize it.

:information_source: If you're writing `@Nested` tests, see [issues/8](https://github.com/asarkar/grpc-test/issues/8).

## Minimum Requirements

- Java 8

## Contributing

This project is a volunteer effort. You are welcome to send pull requests, ask questions, or create issues.

## Code of Conduct

This project adheres to the Contributor Covenant [code of conduct](https://github.com/asarkar/.github/blob/main/CODE_OF_CONDUCT.md).

By participating, you are expected to uphold this code.

## License

Copyright 2022 Abhijit Sarkar - Released under [Apache License v2.0](LICENSE).