-
Notifications
You must be signed in to change notification settings - Fork 8
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.
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
Update refs to connectrpc #539
Changes from 11 commits
688625a
a44705f
d0dc625
5c01da9
afdd0a3
257a1d2
e910756
e2cfcbf
79faca9
cb87ebb
d4827c4
1421ae9
8b1a3aa
781603c
d0917ea
f456864
9a917fa
710acca
c26a3dc
40025da
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
Contributing | ||
============ | ||
|
||
We'd love your help making `connect-crosstest` more thorough! | ||
We'd love your help making `connect-conformance` more thorough! | ||
|
||
If you'd like to add new tests, please [open an issue][open-issue] describing | ||
your proposal — discussing API changes ahead of time makes pull request | ||
|
@@ -22,9 +22,9 @@ enabled][docker-compose-v2]. | |
``` | ||
mkdir -p $GOPATH/src/github.com/bufbuild | ||
cd $GOPATH/src/github.com/bufbuild | ||
git clone [email protected]:your_github_username/connect-crosstest.git | ||
cd connect-crosstest | ||
git remote add upstream https://github.com/bufbuild/connect-crosstest.git | ||
git clone [email protected]:your_github_username/conformance.git | ||
cd conformance | ||
git remote add upstream https://github.com/connectrpc/conformance.git | ||
git fetch upstream | ||
``` | ||
|
||
|
@@ -40,7 +40,7 @@ make | |
Start by creating a new branch for your changes: | ||
|
||
``` | ||
cd $GOPATH/src/github.com/bufbuild/connect-crosstest | ||
cd $GOPATH/src/github.com/connectrpc/conformance | ||
git checkout main | ||
git fetch upstream | ||
git rebase upstream/main | ||
|
@@ -69,7 +69,7 @@ We're much more likely to approve your changes if you: | |
* Write a [good commit message][commit-message]. | ||
* Maintain backward compatibility. | ||
|
||
[fork]: https://github.com/bufbuild/connect-crosstest/fork | ||
[open-issue]: https://github.com/bufbuild/connect-crosstest/issues/new | ||
[fork]: https://github.com/connectrpc/conformance/fork | ||
[open-issue]: https://github.com/connectrpc/conformance/issues/new | ||
[commit-message]: http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html | ||
[docker-compose-v2]: https://www.docker.com/blog/announcing-compose-v2-general-availability/#still-using-compose-v1 |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,12 @@ | ||
# connect-crosstest | ||
# connect-conformance | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Just There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Should this be lowercase
Kinda sounds weird to me but if you guys are fine with it, works for me. There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The sentence sounds weird to me too, but couldn't you simply use "This repository runs..." to avoid it? |
||
|
||
[![License](https://img.shields.io/github/license/bufbuild/connect-crosstest?color=blue)][license] | ||
[![CI](https://github.com/bufbuild/connect-crosstest/actions/workflows/ci.yaml/badge.svg?branch=main)][ci] | ||
[![crosstest-go](https://github.com/bufbuild/connect-crosstest/actions/workflows/crosstest-go.yaml/badge.svg?branch=main)][github-action-go] | ||
[![crosstest-web](https://github.com/bufbuild/connect-crosstest/actions/workflows/crosstest-web.yaml/badge.svg?branch=main)][github-action-web] | ||
[![License](https://img.shields.io/github/license/connectrpc/conformance?color=blue)][license] | ||
[![CI](https://github.com/connectrpc/conformance/actions/workflows/ci.yaml/badge.svg?branch=main)][ci] | ||
[![conformance-go](https://github.com/connectrpc/conformance/actions/workflows/conformance-go.yaml/badge.svg?branch=main)][github-action-go] | ||
[![conformance-web](https://github.com/connectrpc/conformance/actions/workflows/conformance-web.yaml/badge.svg?branch=main)][github-action-web] | ||
[![conformance-cc](https://github.com/connectrpc/conformance/actions/workflows/conformance-cc.yaml/badge.svg?branch=main)][github-action-cc] | ||
|
||
`connect-crosstest` runs a suite of cross-compatibility tests using every combination of the | ||
`connect-conformance` runs a suite of cross-compatibility tests using every combination of the | ||
following clients and servers: | ||
|
||
### Servers | ||
|
@@ -17,10 +18,10 @@ following clients and servers: | |
|
||
- [connect-go][connect-go] (connect protocol, gRPC protocol and gRPC-web protocol) | ||
- [grpc-go][grpc-go] | ||
- [connect-web][connect-web] (connect protocol and gRPC-web protocol) | ||
- [connect-es][connect-es] (connect protocol and gRPC-web protocol) | ||
- [grpc-web][grpc-web] | ||
|
||
The test suite is run daily against the latest commits of [connect-go][connect-go], [connect-web][connect-web] | ||
The test suite is run daily against the latest commits of [connect-go][connect-go], [connect-es][connect-es] | ||
and [protobuf-es][protobuf-es] to ensure that we are continuously testing for compatibility. | ||
|
||
For more on Connect, see the [announcement blog post][blog], the documentation | ||
|
@@ -33,7 +34,7 @@ The test suite is a superset of [gRPC][grpc-interop] and [grpc-web][grpc-web-int | |
tests. Clients and servers use the [gRPC interop Protobuf definitions][test.proto] and cover | ||
a range of expected behaviours and functionality for gRPC and Connect. | ||
|
||
| Test Case | `connect-go`, `grpc-go` | `connect-web`, `grpc-web` | | ||
| Test Case | `connect-go`, `grpc-go` | `connect-es`, `grpc-web` | | ||
|------------------------------------------|-------------------------|---------------------------| | ||
| `empty_unary` | ✓ | ✓ | | ||
| `cacheable_unary` | ✓ | ✓ | | ||
|
@@ -132,8 +133,8 @@ and a non-ASCII message with error details. | |
RPC: `FailStreamingOutputCall` | ||
|
||
Client calls `FailStreamingOutputCall`, and asks for four response messages. The server | ||
responds with the messages, the status `RESOURCE_EXHAUSTED` and a non-ASCII message, and | ||
error details. The client verifies that four response messages and the error status with | ||
responds with the messages, the status `RESOURCE_EXHAUSTED` and a non-ASCII message, and | ||
error details. The client verifies that four response messages and the error status with | ||
code, message, and details was received. | ||
|
||
#### cancel_after_begin | ||
|
@@ -166,7 +167,7 @@ and expects the same metadata to be attached to the response. Client calls `Stre | |
with a request with a custom header and custom binary trailer and expects the same metadata | ||
to be attached to the response when stream is closed. Client calls `FullDuplexCall` | ||
with a request with a custom header and custom binary trailer and expects the same metadata | ||
to be attached to the response when stream is closed. The `web` flows only test the unary and | ||
to be attached to the response when stream is closed. The `web` flows only test the unary and | ||
server streaming RPC. | ||
|
||
#### duplicated_custom_metadata | ||
|
@@ -230,8 +231,11 @@ Client calls an unresolvable host and expects an error with the status `UNAVAILA | |
|
||
### Github Actions | ||
|
||
There are Github Actions workflows for [go][github-action-go] and [web][github-action-web] configured for running the daily crosstest against | ||
the latest commits of [connect-go][connect-go], [connect-web][connect-web] and [protobuf-es][protobuf-es]. | ||
There are Github Actions workflows for [go][github-action-go] and [web][github-action-web] configured for running the daily conformance suite against | ||
the latest commits of [connect-go][connect-go], [connect-es][connect-es] and [protobuf-es][protobuf-es]. | ||
|
||
In addition, there is a Github Action workflow for [C++][github-action-cc] which runs a gRPC C++ client against the | ||
conformance suite. | ||
|
||
### Locally | ||
|
||
|
@@ -244,30 +248,35 @@ You can run the tests using `make dockercomposetest`. | |
|
||
## Support and Versioning | ||
|
||
`connect-crosstest` works with: | ||
`connect-conformance` works with: | ||
|
||
* The most recent release of Go. | ||
|
||
Unlike Connect's Go implementation, `connect-crosstest` has no exported APIs | ||
Unlike Connect's Go implementation, `connect-conformance` has no exported APIs | ||
and makes no backward compatibility guarantees. We'd like to release it as an | ||
interoperability testing toolkit eventually, but don't have a concrete timeline | ||
in mind. | ||
|
||
## Legal | ||
|
||
Offered under the [Apache 2 license][license]. | ||
|
||
[Getting Started]: https://connect.build/go/getting-started | ||
[blog]: https://buf.build/blog/connect-a-better-grpc | ||
[ci]: https://github.com/bufbuild/connect-crosstest/actions/workflows/ci.yaml | ||
[connect-go]: https://github.com/bufbuild/connect-go | ||
[connect-web]: https://github.com/bufbuild/connect-web | ||
[demo]: https://github.com/bufbuild/connect-demo | ||
[ci]: https://github.com/connectrpc/conformance/actions/workflows/ci.yaml | ||
[connect-go]: https://github.com/connectrpc/connect-go | ||
[connect-es]: https://github.com/connectrpc/connect-es | ||
[demo]: https://github.com/connectrpc/examples-go | ||
[docker-compose-v2]: https://www.docker.com/blog/announcing-compose-v2-general-availability/#still-using-compose-v1 | ||
[docs]: https://connect.build | ||
[github-action-go]: https://github.com/bufbuild/connect-crosstest/actions/workflows/crosstest-go.yaml | ||
[github-action-web]: https://github.com/bufbuild/connect-crosstest/actions/workflows/crosstest-web.yaml | ||
[github-action-go]: https://github.com/connectrpc/conformance/actions/workflows/conformance-go.yaml | ||
[github-action-web]: https://github.com/connectrpc/conformance/actions/workflows/conformance-web.yaml | ||
[github-action-cc]: https://github.com/connectrpc/conformance/actions/workflows/conformance-cc.yaml | ||
[go-support-policy]: https://golang.org/doc/devel/release#policy | ||
[grpc-go]: https://github.com/grpc/grpc-go | ||
[grpc-interop]: https://github.com/grpc/grpc/blob/master/doc/interop-test-descriptions.md | ||
[grpc-web-interop]: https://github.com/grpc/grpc-web/blob/master/doc/interop-test-descriptions.md | ||
[grpc-web]: https://github.com/grpc/grpc-web | ||
[license]: https://github.com/bufbuild/connect-crosstest/blob/main/LICENSE | ||
[license]: https://github.com/connectrpc/conformance/blob/main/LICENSE | ||
[protobuf-es]: https://github.com/bufbuild/protobuf-es | ||
[test.proto]: https://github.com/bufbuild/connect-crosstest/blob/main/internal/proto/grpc/testing/test.proto | ||
[test.proto]: https://github.com/connectrpc/conformance/blob/main/internal/proto/grpc/testing/test.proto |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Think this file needs to be updated more carefully - wherever we're using the import path (for example, when cloning into GOPATH), we should use
connectrpc.com/conformance
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks Akshay. I assume this also goes for the actual module name itself in
go.mod
right? Also, should it apply to the links at the bottom?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It applies to
go.mod
, because that's the import path. The links below are to Github, though, so they should begithub.com/connectrpc/conformance
.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Got it. Updated. Let me know what you think.