-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* initial client * changed parameters * incorporate response parameter * changed copyright, error on response, and used decoder instead of unmarshalling * added testing file but no tests * linter * added unit tests * added unit test coverage * added unit test coverage * unit test mock_test * cleaned mockHTTPClient for unit tests * fixed merge conflicts * unit tests * removed encode failure unit test * changed client check to New and added URL check * changed New() parameter * changed client fields to be unexported * Update wrpclient/wrpclient.go Co-authored-by: Kristina Pathak <kmspring57@gmail.com> * fixed parameter names Co-authored-by: Kristina Pathak <kmspring57@gmail.com>
- Loading branch information
1 parent
808176b
commit 5acbd90
Showing
35 changed files
with
872 additions
and
10 deletions.
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
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
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
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
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
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,38 @@ | ||
| /** | ||
| * Copyright 2022 Comcast Cable Communications Management, LLC | ||
| * | ||
| * 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 wrpclient | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "io/ioutil" | ||
| "net/http" | ||
|
|
||
| "github.com/stretchr/testify/mock" | ||
| ) | ||
|
|
||
| type mockHTTPClient struct { | ||
| mock.Mock | ||
| } | ||
|
|
||
| func (m *mockHTTPClient) Do(req *http.Request) (*http.Response, error) { | ||
| args := m.Called(req) | ||
| return &http.Response{ | ||
| StatusCode: args.Int(0), | ||
| Body: ioutil.NopCloser(bytes.NewBuffer(args.Get(1).([]byte))), | ||
| }, nil | ||
| } |
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,118 @@ | ||
| /** | ||
| * Copyright 2022 Comcast Cable Communications Management, LLC | ||
| * | ||
| * 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 wrpclient | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "context" | ||
| "errors" | ||
| "fmt" | ||
| "net/http" | ||
| "net/url" | ||
|
|
||
| "github.com/xmidt-org/httpaux/erraux" | ||
| "github.com/xmidt-org/wrp-go/v3" | ||
| ) | ||
|
|
||
| var ( | ||
| errEncoding = errors.New("encoding error") | ||
| errCreateRequest = errors.New("http request creation error") | ||
| errHTTPTransaction = errors.New("http transaction error") | ||
| errDecoding = errors.New("decoding response error") | ||
| errNonSuccessfulResponse = errors.New("non-200 response") | ||
| errInvalidRequestFormat = errors.New("invalid client RequestFormat") | ||
| errInvalidURL = errors.New("invalid client URL") | ||
| ) | ||
|
|
||
| type HTTPClient interface { | ||
| Do(*http.Request) (*http.Response, error) | ||
| } | ||
|
|
||
| type Client struct { | ||
|
|
||
| // URL is the full location for the serverside wrp endpoint. | ||
| // If unset, use talaria's URI at localhost, which is the port used in talaria's docker image | ||
| url string | ||
|
|
||
| // RequestFormat is the wrp Format to use for all requests, which specifies the wrp.Encoder. | ||
| // If unset, defaults to JSON, which is what the wrp package defaults to. | ||
| requestFormat wrp.Format | ||
|
|
||
| // If unset, defaults to net/http.DefaultClient | ||
| httpClient HTTPClient | ||
| } | ||
|
|
||
| func New(reqURL string, reqFormat wrp.Format, httpClient HTTPClient) (*Client, error) { | ||
| c := Client{ | ||
| url: reqURL, | ||
| requestFormat: reqFormat, | ||
| httpClient: httpClient, | ||
| } | ||
| if c.url == "" { | ||
| c.url = "http://localhost:6200" | ||
| } | ||
| _, err := url.ParseRequestURI(c.url) | ||
| if err != nil { | ||
| return nil, fmt.Errorf("%w: %v", errInvalidURL, err) | ||
| } | ||
| if c.httpClient == nil { | ||
| c.httpClient = &http.Client{} | ||
| } | ||
| if c.requestFormat == 0 { | ||
| c.requestFormat = wrp.JSON | ||
| } else if c.requestFormat > 2 || c.requestFormat < 0 { | ||
| return nil, errInvalidRequestFormat | ||
| } | ||
| return &c, nil | ||
| } | ||
|
|
||
| func (c *Client) SendWRP(ctx context.Context, response, request interface{}) error { | ||
| // Create an *http.Request, using c.RequestFormat to marshal the body and the client URL | ||
| var payload []byte | ||
| err := wrp.NewEncoderBytes(&payload, c.requestFormat).Encode(request) | ||
| if err != nil { | ||
| return fmt.Errorf("%w: %v", errEncoding, err) | ||
| } | ||
| r, err := http.NewRequestWithContext(ctx, http.MethodPost, c.url, bytes.NewBuffer(payload)) | ||
| if err != nil { | ||
| return fmt.Errorf("%w: %v", errCreateRequest, err) | ||
| } | ||
|
|
||
| // Use c.HTTPClient or http.DefaultClient to execute the HTTP transaction | ||
| resp, err := c.httpClient.Do(r.WithContext(ctx)) | ||
| if err != nil { | ||
| return fmt.Errorf("%w: %v", errHTTPTransaction, err) | ||
| } else if resp.StatusCode >= 300 || resp.StatusCode < 200 { | ||
| err := &erraux.Error{ | ||
| Err: err, | ||
| Code: resp.StatusCode, | ||
| Message: resp.Status, | ||
| Header: resp.Header, | ||
| } | ||
| return fmt.Errorf("%w: %v", errNonSuccessfulResponse, err) | ||
| } | ||
|
|
||
| // Translate the response using the wrp package and the response as the target of unmarshaling | ||
| defer resp.Body.Close() | ||
| err = wrp.NewDecoder(resp.Body, c.requestFormat).Decode(response) | ||
| if err != nil { | ||
| return fmt.Errorf("%w: %v", errDecoding, err) | ||
| } | ||
|
|
||
| return nil | ||
| } |
Oops, something went wrong.