Skip to content
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

Use single http client for cli #441

Merged
merged 1 commit into from
Sep 15, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@
* Support PATCH HTTP method for Proxy update(`PATCH /proxies/{proxy}`) and
Toxic update(`PATCH /proxies/{proxy}/toxics/{toxic}`) endpoints.
Deprecat POST HTTP method for those endpoints. (@miry)
* Client does not parse response body in case of errors for Populate.
Requires to get current proxies with new command. (#441, @miry)
* Client specifies `User-Agent` HTTP header for all requests as
"toxiproxy-cli/<version> <os>/<runtime>".
Specifies client request content type as `application/json`. (#441, @miry)

# [2.5.0] - 2022-09-10

Expand Down
14 changes: 9 additions & 5 deletions api.go
Original file line number Diff line number Diff line change
Expand Up @@ -243,10 +243,13 @@ func (server *ApiServer) ProxyCreate(response http.ResponseWriter, request *http

func (server *ApiServer) Populate(response http.ResponseWriter, request *http.Request) {
proxies, err := server.Collection.PopulateJson(server, request.Body)
log := zerolog.Ctx(request.Context())
if err != nil {
log.Warn().Err(err).Msg("Populate errors")
}

apiErr, ok := err.(*ApiError)
if !ok && err != nil {
log := zerolog.Ctx(request.Context())
log.Warn().Err(err).Msg("Error did not include status code")
apiErr = &ApiError{err.Error(), http.StatusInternalServerError}
}
Expand All @@ -268,7 +271,6 @@ func (server *ApiServer) Populate(response http.ResponseWriter, request *http.Re
response.WriteHeader(responseCode)
_, err = response.Write(data)
if err != nil {
log := zerolog.Ctx(request.Context())
log.Warn().Err(err).Msg("Populate: Failed to write response to client")
}
}
Expand Down Expand Up @@ -474,10 +476,12 @@ func (server *ApiServer) ToxicDelete(response http.ResponseWriter, request *http
}

func (server *ApiServer) Version(response http.ResponseWriter, request *http.Request) {
response.Header().Set("Content-Type", "text/plain;charset=utf-8")
_, err := response.Write([]byte(Version))
log := zerolog.Ctx(request.Context())

response.Header().Set("Content-Type", "application/json;charset=utf-8")
version := fmt.Sprintf(`{"version": "%s"}\n`, Version)
_, err := response.Write([]byte(version))
if err != nil {
log := zerolog.Ctx(request.Context())
log.Warn().Err(err).Msg("Version: Failed to write response to client")
}
}
Expand Down
61 changes: 35 additions & 26 deletions api_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -128,10 +128,12 @@ func TestIndexWithNoProxies(t *testing.T) {
func TestCreateProxyBlankName(t *testing.T) {
WithServer(t, func(addr string) {
_, err := client.CreateProxy("", "", "")

expected := "Create: HTTP 400: missing required field: name"
if err == nil {
t.Fatal("Expected error creating proxy, got nil")
} else if err.Error() != "Create: HTTP 400: missing required field: name" {
t.Fatal("Expected different error creating proxy:", err)
t.Error("Expected error creating proxy, got nil")
} else if err.Error() != expected {
t.Errorf("Expected error `%s',\n\tgot: `%s'", expected, err)
}
})
}
Expand All @@ -140,9 +142,9 @@ func TestCreateProxyBlankUpstream(t *testing.T) {
WithServer(t, func(addr string) {
_, err := client.CreateProxy("test", "", "")
if err == nil {
t.Fatal("Expected error creating proxy, got nil")
t.Error("Expected error creating proxy, got nil")
} else if err.Error() != "Create: HTTP 400: missing required field: upstream" {
t.Fatal("Expected different error creating proxy:", err)
t.Error("Expected different error creating proxy:", err)
}
})
}
Expand Down Expand Up @@ -333,8 +335,9 @@ func TestPopulateWithBadName(t *testing.T) {
t.Fatal("Expected Populate to fail.")
}

if err.Error() != "Populate: HTTP 400: missing required field: name at proxy 2" {
t.Fatal("Expected different error during populate:", err)
expected := "Populate: HTTP 400: missing required field: name at proxy 2"
if err.Error() != expected {
t.Fatalf("Expected error `%s',\n\tgot: `%s'", expected, err)
}

if len(testProxies) != 0 {
Expand Down Expand Up @@ -377,21 +380,25 @@ func TestPopulateProxyWithBadDataShouldReturnError(t *testing.T) {
t.Fatal("Expected Populate to fail.")
}

if len(testProxies) != 1 {
t.Fatalf("Wrong number of proxies returned: %d != %d", len(testProxies), 1)
if len(testProxies) != 0 {
t.Fatalf("Expected Proxies to be empty, got %v", testProxies)
}

if testProxies[0].Name != "one" {
t.Fatalf("Wrong proxy name returned: %s != one", testProxies[0].Name)
proxies, err := client.Proxies()
if err != nil {
t.Fatalf("Expected no error, got: %v", err)
}

for _, p := range testProxies {
AssertProxyUp(t, p.Listen, true)
if len(proxies) != 1 {
t.Fatalf("Wrong number of proxies returned: %d != %d", len(proxies), 1)
}

proxies, err := client.Proxies()
if err != nil {
t.Fatal(err)
if _, ok := proxies["one"]; !ok {
t.Fatal("Proxy `one' was not created!")
}

for _, p := range testProxies {
AssertProxyUp(t, p.Listen, true)
}

for _, p := range proxies {
Expand Down Expand Up @@ -642,11 +649,12 @@ func TestDeleteProxy(t *testing.T) {
t.Fatal("Expected proxy to be deleted from list")
}

expected := "Delete: HTTP 404: proxy not found"
err = testProxy.Delete()
if err == nil {
t.Fatal("Proxy did not result in not found.")
} else if err.Error() != "Delete: HTTP 404: proxy not found" {
t.Fatal("Incorrect error removing proxy:", err)
t.Error("Proxy did not result in not found.")
} else if err.Error() != expected {
t.Errorf("Expected error `%s',\n\tgot: `%s'", expected, err)
}
})
}
Expand All @@ -658,12 +666,12 @@ func TestCreateProxyPortConflict(t *testing.T) {
t.Fatal("Unable to create proxy:", err)
}

expected := "Create: HTTP 500: listen tcp 127.0.0.1:3310: bind: address already in use"
_, err = client.CreateProxy("test", "localhost:3310", "localhost:20001")
if err == nil {
t.Fatal("Proxy did not result in conflict.")
} else if err.Error() !=
"Create: HTTP 500: listen tcp 127.0.0.1:3310: bind: address already in use" {
t.Fatal("Incorrect error adding proxy:", err)
t.Error("Proxy did not result in conflict.")
} else if err.Error() != expected {
t.Errorf("Expected error `%s',\n\tgot: `%s'", expected, err)
}

err = testProxy.Delete()
Expand All @@ -684,11 +692,12 @@ func TestCreateProxyNameConflict(t *testing.T) {
t.Fatal("Unable to create proxy:", err)
}

expected := "Create: HTTP 409: proxy already exists"
_, err = client.CreateProxy("mysql_master", "localhost:3311", "localhost:20001")
if err == nil {
t.Fatal("Proxy did not result in conflict.")
} else if err.Error() != "Create: HTTP 409: proxy already exists" {
t.Fatal("Incorrect error adding proxy:", err)
} else if err.Error() != expected {
t.Fatalf("Expected error `%s',\n\tgot: `%s'", expected, err)
}

err = testProxy.Delete()
Expand Down Expand Up @@ -1094,7 +1103,7 @@ func TestVersionEndpointReturnsVersion(t *testing.T) {
t.Fatal("Unable to read body from response")
}

if string(body) != toxiproxy.Version {
if string(body) != `{"version": "git"}\n` {
t.Fatal("Expected to return Version from /version, got:", string(body))
}
})
Expand Down
15 changes: 0 additions & 15 deletions client/api_error.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,7 @@
package toxiproxy

import (
"encoding/json"
"fmt"
"net/http"
)

type ApiError struct {
Expand All @@ -19,16 +17,3 @@ type ApiError struct {
func (err *ApiError) Error() string {
return fmt.Sprintf("HTTP %d: %s", err.Status, err.Message)
}

func checkError(resp *http.Response, expectedCode int, caller string) error {
if resp.StatusCode != expectedCode {
apiError := new(ApiError)
err := json.NewDecoder(resp.Body).Decode(apiError)
if err != nil {
apiError.Message = fmt.Sprintf("Unexpected response code, expected %d", expectedCode)
apiError.Status = resp.StatusCode
}
return fmt.Errorf("%s: %v", caller, apiError)
}
return nil
}
Loading