【问题标题】:Mocking HTTPS responses in Go在 Go 中模拟 HTTPS 响应
【发布时间】:2015-03-08 23:25:51
【问题描述】:

我正在尝试为向 Web 服务发出请求的包编写测试。我遇到问题可能是因为我对 TLS 缺乏了解。

目前我的测试看起来像这样:

func TestSimple() {
    server := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
        w.Header().Set("Content-Type", "application/json")
        w.WriteHeader(200)
        fmt.Fprintf(w, `{ "fake" : "json data here" }`)
    }))
    transport := &http.Transport{
        Proxy: func(req *http.Request) (*url.URL, error) {
            return url.Parse(server.URL)
        },
    }
    // Client is the type in my package that makes requests
    client := Client{
        c: http.Client{Transport: transport},
    }

    client.DoRequest() // ...
}

我的包有一个包变量(我希望它是一个常量..),用于查询 Web 服务的基地址。它是一个 https URL。我在上面创建的测试服务器是纯 HTTP,没有 TLS。

默认情况下,我的测试失败并显示错误“tls:第一条记录看起来不像 TLS 握手。”

为了让它工作,我的测试在进行查询之前将包变量更改为纯 http URL 而不是 https。

有没有办法解决这个问题?我可以将包变量设为常量 (https),​​然后设置一个“降级”为未加密 HTTP 的 http.Transport,还是改用 httptest.NewTLSServer()

(当我尝试使用 NewTLSServer() 时,我收到“http: TLS 握手错误来自 127.0.0.1:45678: tls: 收到长度为 20037 的超大记录”)

【问题讨论】:

  • 你真的需要模拟一个 TLS 请求吗? net/http 具有广泛的测试,因此针对本地 HTTPS 托管的测试实现进行测试是相当多余的。直接针对 HTTP 进行测试在语义上是等效的。
  • 没有。事实上,我现在正在嘲笑 HTTP。我只是不喜欢我必须用来强制 HTTP 的解决方法。某些东西会自动尝试使用 TLS,因为请求 URL 以 https 开头。我很乐意仅为我的测试禁用此行为。
  • 好的,在这种情况下,您可以创建一个 http.RoundTripper 的实现,它可以做任何您想做的事情(例如将 https:// 视为 http url)——您甚至可以使用自定义 RoundTripper 直接运行模拟 http.Handler,而无需通过 httptest.Server。你所要做的就是http.DefaultClient.Transport = CustomRoundTripper
  • 自定义 http.RoundTripper 就像一个魅力。您应该将您的评论转换为答案,以便我接受。

标签: testing ssl go


【解决方案1】:

net/http 中的大多数行为都可以被模拟、扩展或更改。虽然http.Client 是实现HTTP 客户端语义的具体类型,但它的所有字段都是导出的并且可以自定义。

Client.Transport 字段尤其可以被替换以使客户端执行任何操作,从使用自定义协议(例如 ftp:// 或 file://)到直接连接到本地处理程序(不生成 HTTP 协议字节或通过网络发送任何内容)。

客户端函数,例如http.Get,都使用导出的http.DefaultClient 包变量(您可以修改),因此使用这些便利函数的代码更改为在自定义客户端变量上调用方法。请注意,虽然在公开可用的库中修改全局行为是不合理的,但在应用程序和测试(包括库测试)中这样做非常有用。

http://play.golang.org/p/afljO086iB 包含一个自定义 http.RoundTripper,它重写了请求 URL,以便将其路由到本地托管的 httptest.Server,另一个示例直接将请求传递给 http.Handler,以及一个自定义http.ResponseWriter 实现,为了创建一个http.Response。第二种方法不像第一种那样勤奋(它不会在 Response 值中填写那么多字段)但效率更高,并且应该足够兼容以与大多数处理程序和客户端调用者一起工作。

上面链接的代码也包含在下面:

package main

import (
    "fmt"
    "io"
    "log"
    "net/http"
    "net/http/httptest"
    "net/url"
    "os"
    "path"
    "strings"
)

func Handler(w http.ResponseWriter, r *http.Request) {
    fmt.Fprintf(w, "hello %s\n", path.Base(r.URL.Path))
}

func main() {
    s := httptest.NewServer(http.HandlerFunc(Handler))
    u, err := url.Parse(s.URL)
    if err != nil {
        log.Fatalln("failed to parse httptest.Server URL:", err)
    }
    http.DefaultClient.Transport = RewriteTransport{URL: u}
    resp, err := http.Get("https://google.com/path-one")
    if err != nil {
        log.Fatalln("failed to send first request:", err)
    }
    fmt.Println("[First Response]")
    resp.Write(os.Stdout)

    fmt.Print("\n", strings.Repeat("-", 80), "\n\n")

    http.DefaultClient.Transport = HandlerTransport{http.HandlerFunc(Handler)}
    resp, err = http.Get("https://google.com/path-two")
    if err != nil {
        log.Fatalln("failed to send second request:", err)
    }
    fmt.Println("[Second Response]")
    resp.Write(os.Stdout)
}

// RewriteTransport is an http.RoundTripper that rewrites requests
// using the provided URL's Scheme and Host, and its Path as a prefix.
// The Opaque field is untouched.
// If Transport is nil, http.DefaultTransport is used
type RewriteTransport struct {
    Transport http.RoundTripper
    URL       *url.URL
}

func (t RewriteTransport) RoundTrip(req *http.Request) (*http.Response, error) {
    // note that url.URL.ResolveReference doesn't work here
    // since t.u is an absolute url
    req.URL.Scheme = t.URL.Scheme
    req.URL.Host = t.URL.Host
    req.URL.Path = path.Join(t.URL.Path, req.URL.Path)
    rt := t.Transport
    if rt == nil {
        rt = http.DefaultTransport
    }
    return rt.RoundTrip(req)
}

type HandlerTransport struct{ h http.Handler }

func (t HandlerTransport) RoundTrip(req *http.Request) (*http.Response, error) {
    r, w := io.Pipe()
    resp := &http.Response{
        Proto:      "HTTP/1.1",
        ProtoMajor: 1,
        ProtoMinor: 1,
        Header:     make(http.Header),
        Body:       r,
        Request:    req,
    }
    ready := make(chan struct{})
    prw := &pipeResponseWriter{r, w, resp, ready}
    go func() {
        defer w.Close()
        t.h.ServeHTTP(prw, req)
    }()
    <-ready
    return resp, nil
}

type pipeResponseWriter struct {
    r     *io.PipeReader
    w     *io.PipeWriter
    resp  *http.Response
    ready chan<- struct{}
}

func (w *pipeResponseWriter) Header() http.Header {
    return w.resp.Header
}

func (w *pipeResponseWriter) Write(p []byte) (int, error) {
    if w.ready != nil {
        w.WriteHeader(http.StatusOK)
    }
    return w.w.Write(p)
}

func (w *pipeResponseWriter) WriteHeader(status int) {
    if w.ready == nil {
        // already called
        return
    }
    w.resp.StatusCode = status
    w.resp.Status = fmt.Sprintf("%d %s", status, http.StatusText(status))
    close(w.ready)
    w.ready = nil
}

【讨论】:

    【解决方案2】:

    您收到错误 http: TLS handshake error from 127.0.0.1:45678: tls: oversized record received with length 20037 的原因是 https 需要域名(而不是 IP 地址)。域名是分配给 SSL 证书的。

    使用自己的证书以 TLS 模式启动 httptest 服务器

    cert, err := tls.LoadX509KeyPair("cert.pem", "key.pem")
    if err != nil {
        log.Panic("bad server certs: ", err)
    }
    certs := []tls.Certificate{cert}
    
    server = httptest.NewUnstartedServer(router)
    server.TLS = &tls.Config{Certificates: certs}
    server.StartTLS()
    serverPort = ":" + strings.Split(server.URL, ":")[2] // it's always https://127.0.0.1:<port>
    server.URL = "https://sub.domain.com" + serverPort
    

    为连接提供有效的 SSL 证书有以下选项:

    1. 不提供证书和密钥
    2. 提供自签名证书和密钥
    3. 提供真正有效的证书和密钥

    没有证书

    如果您不提供自己的证书,则默认加载 example.com 证书。

    自签名证书

    要创建测试证书,可以使用包含的自签名证书生成器$GOROOT/src/crypto/tls/generate_cert.go --host "*.domain.name"

    您会收到x509: certificate signed by unknown authority 警告,因为它是自签名的,因此您需要让您的客户跳过这些警告,方法是将以下内容添加到您的 http.Transport 字段:

     TLSClientConfig: &tls.Config{InsecureSkipVerify: true}
    

    有效的真实证书

    最后,如果您要使用真正的证书,请将有效的证书和密钥保存在可以加载它们的位置。


    这里的关键是使用server.URL = https://sub.domain.com 来提供您自己的域。

    【讨论】:

      猜你喜欢
      • 2015-05-03
      • 1970-01-01
      • 2018-08-11
      • 1970-01-01
      • 1970-01-01
      • 2013-07-28
      • 2010-12-30
      • 1970-01-01
      • 1970-01-01
      相关资源
      最近更新 更多