From b8149cc6832aa37f78be6a351a092c4ad5d5d0b2 Mon Sep 17 00:00:00 2001 From: Michael Marineau Date: Thu, 18 May 2017 12:33:24 -0700 Subject: [PATCH] client: add extended http client for making omaha api requests Supports encoding/decoding omaha xml and retrying on transient failures. --- omaha/client/http.go | 78 +++++++++++++++++++++++++++++++++++++++ omaha/client/http_test.go | 57 ++++++++++++++++++++++++++++ 2 files changed, 135 insertions(+) create mode 100644 omaha/client/http.go create mode 100644 omaha/client/http_test.go diff --git a/omaha/client/http.go b/omaha/client/http.go new file mode 100644 index 0000000..bde2610 --- /dev/null +++ b/omaha/client/http.go @@ -0,0 +1,78 @@ +// Copyright 2017 CoreOS, Inc. +// +// 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 client + +import ( + "bytes" + "encoding/xml" + "fmt" + "net" + "net/http" + "time" + + "github.com/coreos/go-omaha/omaha" +) + +const ( + defaultTimeout = 90 * time.Second + defaultTries = 7 +) + +// httpClient extends the standard http.Client to support xml encoding +// and decoding as well as automatic retries on transient failures. +type httpClient struct { + http.Client +} + +func newHTTPClient() *httpClient { + return &httpClient{http.Client{ + Timeout: defaultTimeout, + }} +} + +// doPost sends a single HTTP POST, returning a parsed omaha response. +func (hc *httpClient) doPost(url string, reqBody []byte) (*omaha.Response, error) { + resp, err := hc.Post(url, "text/xml; charset=utf-8", bytes.NewReader(reqBody)) + if err != nil { + return nil, err + } + defer resp.Body.Close() + + contentType := resp.Header.Get("Content-Type") + return omaha.ParseResponse(contentType, resp.Body) +} + +// Omaha encodes and sends an omaha request, retrying on any transient errors. +func (hc *httpClient) Omaha(url string, req *omaha.Request) (resp *omaha.Response, err error) { + buf := bytes.NewBufferString(xml.Header) + enc := xml.NewEncoder(buf) + if err := enc.Encode(req); err != nil { + return nil, fmt.Errorf("omaha: failed to encode request: %v", err) + } + + for i := 0; i < defaultTries; i++ { + resp, err = hc.doPost(url, buf.Bytes()) + if neterr, ok := err.(net.Error); ok && neterr.Temporary() { + // TODO(marineam): add exponential backoff + continue + } + break + } + if err != nil { + return nil, fmt.Errorf("omaha: request failed: %v", err) + } + + return resp, nil +} diff --git a/omaha/client/http_test.go b/omaha/client/http_test.go new file mode 100644 index 0000000..fa7eed2 --- /dev/null +++ b/omaha/client/http_test.go @@ -0,0 +1,57 @@ +// Copyright 2017 CoreOS, Inc. +// +// 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 client + +import ( + "testing" + + "github.com/coreos/go-omaha/omaha" +) + +const ( + sampleRequest = ` + + + + + + + + +` +) + +func TestHTTPClientDoPost(t *testing.T) { + s, err := omaha.NewTrivialServer("127.0.0.1:0") + if err != nil { + t.Fatal(err) + } + defer s.Destroy() + go s.Serve() + + c := newHTTPClient() + url := "http://" + s.Addr().String() + "/v1/update/" + + resp, err := c.doPost(url, []byte(sampleRequest)) + if err != nil { + t.Fatal(err) + } + if len(resp.Apps) != 1 { + t.Fatalf("Should be 1 app, not %d", len(resp.Apps)) + } + if resp.Apps[0].Status != omaha.AppOK { + t.Fatalf("Bad apps status: %q", resp.Apps[0].Status) + } +}