Add in --duplex flag to run HTTP and GRPC servers on the same port #931
There are no files selected for viewing
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,112 @@ | ||
| // Copyright 2021 The Sigstore Authors. | ||
| // | ||
| // 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 | ||
| // | ||
| // http://www.apache.org/licenses/LICENSE-2.0 | ||
| // | ||
| // 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. | ||
| // | ||
|
|
||
| package app | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "io" | ||
| "log" | ||
| "net/http" | ||
| "net/url" | ||
| "strings" | ||
| "testing" | ||
|
|
||
| "github.com/google/go-cmp/cmp" | ||
| "github.com/sigstore/fulcio/pkg/api" | ||
| "github.com/sigstore/fulcio/pkg/ca/ephemeralca" | ||
| "github.com/sigstore/fulcio/pkg/config" | ||
| "github.com/sigstore/fulcio/pkg/generated/protobuf" | ||
| "google.golang.org/grpc" | ||
| "google.golang.org/grpc/credentials/insecure" | ||
| ) | ||
|
|
||
| func TestDuplex(t *testing.T) { | ||
| // Start a server with duplex on port 8089 | ||
| ctx := context.Background() | ||
| ca, err := ephemeralca.NewEphemeralCA() | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| port := 8089 | ||
| serverURL, err := url.Parse(fmt.Sprintf("http://localhost:%d", port)) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| metricsPort := 2114 | ||
|
|
||
| go func() { | ||
| if err := StartDuplexServer(ctx, config.DefaultConfig, nil, ca, port, metricsPort); err != nil { | ||
| log.Fatalf("error starting duplex server: %v", err) | ||
| } | ||
| }() | ||
|
|
||
| var rootCert string | ||
| t.Run("http", func(t *testing.T) { | ||
| // Make sure we can grab the rootcert with the v1 endpoint | ||
| legacyClient := api.NewClient(serverURL) | ||
| resp, err := legacyClient.RootCert() | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| rootCert = string(resp.ChainPEM) | ||
| }) | ||
|
|
||
| var grpcRootCert string | ||
| t.Run("grpc", func(t *testing.T) { | ||
| // Grab the rootcert with the v2 endpoint | ||
| conn, err := grpc.Dial(fmt.Sprintf("127.0.0.1:%d", port), grpc.WithTransportCredentials(insecure.NewCredentials())) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| grpcClient := protobuf.NewCAClient(conn) | ||
| tb, err := grpcClient.GetTrustBundle(ctx, &protobuf.GetTrustBundleRequest{}) | ||
| if err != nil { | ||
| t.Fatalf("error getting trust bundle: %v", err) | ||
| } | ||
| if len(tb.Chains) != 1 { | ||
| t.Fatalf("didn't get expected length certificate chain: %v", tb.Chains) | ||
| } | ||
| if len(tb.Chains[0].Certificates) != 1 { | ||
| t.Fatalf("didn't get expected length certs: %v", tb.Chains) | ||
| } | ||
| grpcRootCert = strings.TrimSuffix(tb.Chains[0].Certificates[0], "\n") | ||
| }) | ||
|
|
||
| t.Run("compare root certs", func(t *testing.T) { | ||
| if d := cmp.Diff(rootCert, grpcRootCert); d != "" { | ||
| t.Fatal(d) | ||
| } | ||
| }) | ||
|
|
||
| t.Run("prometheus", func(t *testing.T) { | ||
| // make sure there are metrics on the metrics port | ||
| url := fmt.Sprintf("http://localhost:%d/metrics", metricsPort) | ||
| resp, err := http.Get(url) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| contents, err := io.ReadAll(resp.Body) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
| // make sure there's something about hitting the GetTrustBundle in there | ||
| // this just confirms some metrics are being printed | ||
| if !strings.Contains(string(contents), "GetTrustBundle") { | ||
| t.Fatalf("didn't get expected metrics output: %s", string(contents)) | ||
| } | ||
| }) | ||
| } |
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
Oops, something went wrong.
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.
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.
I would prefer we don't deprecate these flags, because there are no plans to cut a new major release of Fulcio anytime soon, and ideally we don't mark something as deprecated right after we cut 1.0.
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.
If we eventually plan to remove them (which I think makes the most sense) then it's best to deprecate them sooner. IIUC we'll still maintain support for at least a few releases or a few months (whatever the policy comes up with suggests).
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.
I don't think it's a great look to deprecate functionality right after we've introduced it as stable. I know it's a tiny part of the service, but I think we shouldn't begin deprecation of features right after a 1.0 release until we start thinking about a 2.0 release, and right now, I don't see any features in the pipeline to need a 2.0 release.