Modify and Merge protocol test request unit tests codegen logic #445
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,46 @@ | ||
| package http | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "github.com/aws/smithy-go/middleware" | ||
| "net/http" | ||
| "strconv" | ||
| ) | ||
|
|
||
| const captureRequestID = "CaptureProtocolTestRequest" | ||
|
|
||
| // AddCaptureRequestMiddleware captures serialized http request during protocol test for check | ||
| func AddCaptureRequestMiddleware(stack *middleware.Stack, req *http.Request) error { | ||
|
There was a problem hiding this comment. Question: Do we have to expose this in the public API? If I understand correctly, the generated protocol tests in the SDK repo will have to see it to use it, but I think I'd rather we just generate it as unexported code in the protocol test instead of having it be exported in smithy-go just to be used for testing. There was a problem hiding this comment. Note that if/when we go that route you can just drop the unit test. The protocol tests needing to pass based on it are assertion enough imo. There was a problem hiding this comment. Alternatively we can put it somewhere under There was a problem hiding this comment. I prefer alternative method cause the it prevent smithy go codegen using some sdk dependency of middleware. I will create a new |
||
| return stack.Build.Add(&captureRequestMiddleware{ | ||
| req: req, | ||
| }, middleware.After) | ||
| } | ||
|
|
||
| type captureRequestMiddleware struct { | ||
| req *http.Request | ||
| } | ||
|
|
||
| func (*captureRequestMiddleware) ID() string { | ||
| return captureRequestID | ||
| } | ||
|
|
||
| func (m *captureRequestMiddleware) HandleBuild(ctx context.Context, input middleware.BuildInput, next middleware.BuildHandler, | ||
| ) ( | ||
| output middleware.BuildOutput, metadata middleware.Metadata, err error, | ||
| ) { | ||
| request, ok := input.Request.(*Request) | ||
| if !ok { | ||
| return output, metadata, fmt.Errorf("error while retrieving http request") | ||
| } | ||
|
|
||
| *m.req = *request.Build(ctx) | ||
| if len(m.req.URL.RawPath) == 0 { | ||
| m.req.URL.RawPath = m.req.URL.Path | ||
| } | ||
| if v := m.req.ContentLength; v != 0 { | ||
| m.req.Header.Set("Content-Length", strconv.FormatInt(v, 10)) | ||
| } | ||
|
|
||
| return next.HandleBuild(ctx, input) | ||
| } | ||
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,109 @@ | ||
| package http | ||
|
|
||
| import ( | ||
| "context" | ||
| "github.com/aws/smithy-go/middleware" | ||
| smithytesting "github.com/aws/smithy-go/testing" | ||
| "io" | ||
| "io/ioutil" | ||
| "net/http" | ||
| "net/url" | ||
| "strings" | ||
| "testing" | ||
| ) | ||
|
|
||
| // TestAddCaptureRequestMiddleware tests AddCaptureRequestMiddleware | ||
| func TestAddCaptureRequestMiddleware(t *testing.T) { | ||
| cases := map[string]struct { | ||
| Request *http.Request | ||
| ExpectRequest *http.Request | ||
| ExpectQuery []smithytesting.QueryItem | ||
| Stream io.Reader | ||
| }{ | ||
| "normal request": { | ||
| Request: &http.Request{ | ||
| Method: "PUT", | ||
| Header: map[string][]string{ | ||
| "Foo": {"bar", "too"}, | ||
| "Checksum": {"SHA256"}, | ||
| }, | ||
| URL: &url.URL{ | ||
| Path: "test/path", | ||
| RawQuery: "language=us®ion=us-west+east", | ||
| }, | ||
| ContentLength: 100, | ||
| }, | ||
| ExpectRequest: &http.Request{ | ||
| Method: "PUT", | ||
| Header: map[string][]string{ | ||
| "Foo": {"bar", "too"}, | ||
| "Checksum": {"SHA256"}, | ||
| "Content-Length": {"100"}, | ||
| }, | ||
| URL: &url.URL{ | ||
| Path: "test/path", | ||
| RawPath: "test/path", | ||
| }, | ||
| Body: ioutil.NopCloser(strings.NewReader("hello world.")), | ||
| }, | ||
| ExpectQuery: []smithytesting.QueryItem{ | ||
| { | ||
| Key: "language", | ||
| Value: "us", | ||
| }, | ||
| { | ||
| Key: "region", | ||
| Value: "us-west%20east", | ||
| }, | ||
| }, | ||
| Stream: strings.NewReader("hello world."), | ||
| }, | ||
| } | ||
|
|
||
| for name, c := range cases { | ||
| t.Run(name, func(t *testing.T) { | ||
| var err error | ||
| req := &Request{ | ||
| Request: c.Request, | ||
| stream: c.Stream, | ||
| } | ||
| capturedRequest := &http.Request{} | ||
| m := captureRequestMiddleware{ | ||
| req: capturedRequest, | ||
| } | ||
| _, _, err = m.HandleBuild(context.Background(), | ||
| middleware.BuildInput{Request: req}, | ||
| middleware.BuildHandlerFunc(func(ctx context.Context, input middleware.BuildInput) ( | ||
| out middleware.BuildOutput, metadata middleware.Metadata, err error) { | ||
| return out, metadata, nil | ||
| }), | ||
| ) | ||
| if err != nil { | ||
| t.Fatalf("expect no error, got %v", err) | ||
| } | ||
|
|
||
| if e, a := c.ExpectRequest.Method, capturedRequest.Method; e != a { | ||
| t.Errorf("expect request method %v found, got %v", e, a) | ||
| } | ||
| if e, a := c.ExpectRequest.URL.Path, capturedRequest.URL.RawPath; e != a { | ||
| t.Errorf("expect %v path, got %v", e, a) | ||
| } | ||
| if c.ExpectRequest.Body != nil { | ||
| expect, err := ioutil.ReadAll(c.ExpectRequest.Body) | ||
| if capturedRequest.Body == nil { | ||
| t.Errorf("Expect request stream %v captured, get nil", string(expect)) | ||
| } | ||
| actual, err := ioutil.ReadAll(capturedRequest.Body) | ||
| if err != nil { | ||
| t.Errorf("unable to read captured request body, %v", err) | ||
| } | ||
| if e, a := string(expect), string(actual); e != a { | ||
| t.Errorf("expect request body to be %s, got %s", e, a) | ||
| } | ||
| } | ||
| queryItems := smithytesting.ParseRawQuery(capturedRequest.URL.RawQuery) | ||
| smithytesting.AssertHasQuery(t, c.ExpectQuery, queryItems) | ||
| smithytesting.AssertHasHeader(t, c.ExpectRequest.Header, capturedRequest.Header) | ||
| }) | ||
| } | ||
| } |
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.
This is totally fine but you might have been able to get away with less changes by just connecting your new middleware to the originally declared
actualReqrequest.