Add gRPC testing guide #1846
Merged
Add gRPC testing guide #1846
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
Can't run the example without downloading the protobuf definition :(
heitortsergent
requested review from
mstoykov and
inancgumus
and removed request for
a team
inancgumus
approved these changes
Jan 28, 2025
docs/sources/k6/next/testing-guides/performance-testing-grpc-services.md
Outdated
Show resolved
Hide resolved
Comment on lines
+203
to
+204
| - [k6 gRPC Module API](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-net-grpc/) | ||
| - [k6 QuickPizza: A demo service for gRPC](grpc-quickpizza.grafana.com:443) |
There was a problem hiding this comment.
With dots:
Suggested change
| - [k6 gRPC Module API](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-net-grpc/) | |
| - [k6 QuickPizza: A demo service for gRPC](grpc-quickpizza.grafana.com:443) | |
| - [k6 gRPC Module API](https://grafana.com/docs/k6/<K6_VERSION>/javascript-api/k6-net-grpc/). | |
| - [k6 QuickPizza: A demo service for gRPC](grpc-quickpizza.grafana.com:443). |
|
|
||
| ### Create the test | ||
|
|
||
| The gRPC module is a separate module, available from your test script as `k6/net/grpc`. Before you can use it, you first have to create an instance of the client. Instantiating the client, as well as the `.load` operation, is only available during test initialization, that is, directly in the global scope. |
There was a problem hiding this comment.
Here, we say ".load operation", but below, we say ".load() function". Should we keep them consistent, like .load() function?
I also wonder if using a dot prefix is a common practice in our docs. I'd omit the dot for simplicity (i.e., load() function). Or, it can be Client.load() if we want to keep it verbose and explicit.
There was a problem hiding this comment.
That's a good point, I think we can just refer to it as load() function.
| const client = new grpc.Client(); | ||
| ``` | ||
|
|
||
| Next, load a `.proto` definition applicable for the system under test. For the purpose of this article, you can use [QuickPizza](grpc-quickpizza.grafana.com:443). The `.load()` function takes two arguments, the first one being an array of paths to search for proto files, and the second being the name of the file to load. |
There was a problem hiding this comment.
Clicking on the QuickPizza link won't work for every user. Should we add a notice?
docs/sources/k6/next/testing-guides/performance-testing-grpc-services.md
Outdated
Show resolved
Hide resolved
Co-authored-by: İnanç Gümüş <[email protected]>
heitortsergent
commented
Jan 28, 2025
docs/sources/k6/next/testing-guides/performance-testing-grpc-services.md
Outdated
Show resolved
Hide resolved
docs/sources/k6/next/testing-guides/performance-testing-grpc-services.md
Outdated
Show resolved
Hide resolved
|
|
||
| ### Create the test | ||
|
|
||
| The gRPC module is a separate module, available from your test script as `k6/net/grpc`. Before you can use it, you first have to create an instance of the client. Instantiating the client, as well as the `.load` operation, is only available during test initialization, that is, directly in the global scope. |
There was a problem hiding this comment.
That's a good point, I think we can just refer to it as load() function.
docs/sources/k6/next/testing-guides/performance-testing-grpc-services.md
Outdated
Show resolved
Hide resolved
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?
Migrate the Performance testing gRPC services to the Testing guides section.
Checklist
npm startcommand locally and verified that the changes look good.docs/sources/k6/nextfolder of the documentation.docs/sources/k6/v{most_recent_release}folder of the documentation.Related PR(s)/Issue(s)