httptesting

package module
v0.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 15, 2018 License: MIT Imports: 23 Imported by: 0

README

httptesting

CircleCI

Golang HTTP testing client for human.

Installation

$ go get github.com/dolab/httptesting

Getting Started

package httptesting

import (
	"net/http"
	"testing"

	"github.com/dolab/httptesting"
)

// Serial mode
func Test_Client(t *testing.T) {
	host := "https://example.com"
	client := httptesting.New(host, true)

	client.Get(t, "/")
	defer client.Close()

	// verify http response status
	client.AssertOK()

	// verify http response header
	client.AssertExistHeader("Content-Length")

	// verify http response body
	client.AssertNotEmpty()
}

// Concurrency mode
func Test_Request(t *testing.T) {
	host := "https://example.com"
	client := httptesting.New(host, true)

	request := client.New(t)
	request.Get("/")

	// verify http response status
	request.AssertOK()

	// verify http response header
	request.AssertExistHeader("Content-Length")

	// verify http response body
	request.AssertNotEmpty()
}
Connected with httptest.Server
package httptesting

import (
	"net/http"
	"testing"

	"github.com/dolab/httptesting"
)

type mockServer struct {
	method	string
	path	  string
	assertion func(w http.ResponseWriter, r *http.Request)
}

func (mock *mockServer) ServeHTTP(w http.ResponseWriter, r *http.Request) {
	mock.assertion(w, r)
}

func Test_Server_Client(t *testing.T) {
	method := "GET"
	uri := "/server/https"
	server := &mockServer{
		method: method,
		path: uri,
		assertion: func(w http.ResponseWriter, r *http.Request) {
			w.Header().Set("x-request-method", r.Method)
			w.WriteHeader(http.StatusOK)
			w.Write([]byte("TLS"))
		},
	}

	// return default client connected with httptest.Server
	ts := httptesting.NewServer(server, true)
	defer ts.Close()

	request := ts.New(t)
	request.Get("/server/https")

	// verify http response status
	request.AssertOK()

	// verify http response header
	request.AssertExistHeader("Content-Length")

	// verify http response body
	request.AssertContains("TLS")
}
Advantage Usage
package main

import (
	"testing"
)

func Test_Request(t *testing.T) {
	host := "https://example.com"
	client := httptesting.New(host, true)

	t.Run("GET /api/json", func(t *testing.T) {
		request := client.New(t)
		request.WithHeader("X-Mock-Client", "httptesting")

		// assume server response with following json data:
		// {"user":{"name":"httptesting","age":3},"addresses":[{"name":"china"},{"name":"USA"}]}
		request.GetJSON("/api/json", nil)

		// verify http response status
		request.AssertOK()

		// verify http response header
		request.AssertHeader("X-Mock-Client", "httptesting")

		// verify http response body with json format
		request.AssertContainsJSON("user.name", "httptesting")

		// for array
		request.AssertContainsJSON("addresses.1.name", "USA")
		request.AssertNotContainsJSON("addresses.2.name")

		// use regexp for custom matcher
		request.AssertMatch("user.*")
	})

	t.Run("POST /api/json", func(t *testing.T) {
		request := client.New(t)
		request.WithHeader("X-Mock-Client", "httptesting")

		payload := struct {
			Name string `json:"name"`
			Age  int	`json:"age"`
		}{"httptesting", 3}

		// assume server response with following json data:
		// {"data":{"name":"httptesting","age":3},"success":true}
		request.PostJSON("/api/json", payload)

		// verify http response status
		request.AssertOK()

		// verify http response header
		request.AssertHeader("X-Mock-Client", "httptesting")

		// verify http response body with json format
		request.AssertContainsJSON("data.name", "httptesting")
		request.AssertContainsJSON("data.age", 3)
		request.AssertContainsJSON("success", true)

		// use regexp for custom matcher
		request.AssertNotMatch("user.*")
	})
}

Author

Spring MC

LICENSE

The MIT License (MIT)

Copyright (c) 2016

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

type Client struct {
	Response     *http.Response
	ResponseBody []byte
	// contains filtered or unexported fields
}

Client defines request component of httptesting NOTE: Client is not safe for concurrency, please use client.New(t) after initialized.

func New 

func New(host string, isTLS bool) *Client

New returns an initialized *Client ready for testing

func NewServer 

func NewServer(handler http.Handler, isTLS bool) *Client

NewServer returns an initialized *Client along with mocked server for testing NOTE: You MUST call client.Close() for cleanup after testing.

func NewServerWithTLS 

func NewServerWithTLS(handler http.Handler, cert tls.Certificate) *Client

NewServerWithTLS returns an initialized *Client along with mocked server for testing NOTE: You MUST call client.Close() for cleanup after testing.

func NewWithTLS 

func NewWithTLS(host string, cert *x509.Certificate) *Client

NewWithTLS returns an initialized *Client with custom certificate.

func (*Client) AssertContains 

func (c *Client) AssertContains(s string)

AssertContains asserts that the response body contains the string.

func (*Client) AssertContainsJSON 

func (c *Client) AssertContainsJSON(key string, value interface{})

AssertContainsJSON asserts that the response body contains JSON value of the key.

func (*Client) AssertContentType 

func (c *Client) AssertContentType(contentType string)

AssertContentType asserts that the response includes Content-Type header with value.

func (*Client) AssertEmpty 

func (c *Client) AssertEmpty()

AssertEmpty asserts that the response body is empty.

func (*Client) AssertExistHeader 

func (c *Client) AssertExistHeader(name string)

AssertExistHeader asserts that the response includes named header.

func (*Client) AssertForbidden 

func (c *Client) AssertForbidden()

AssertForbidden asserts that the response status code is 403.

func (*Client) AssertHeader 

func (c *Client) AssertHeader(name, value string)

AssertHeader asserts that the response includes named header with value.

func (*Client) AssertMatch 

func (c *Client) AssertMatch(re string)

AssertMatch asserts that the response body matches the regular expression.

func (*Client) AssertNotContains 

func (c *Client) AssertNotContains(s string)

AssertNotContains asserts that the response body does not contain the string.

func (*Client) AssertNotContainsJSON 

func (c *Client) AssertNotContainsJSON(key string)

AssertNotContainsJSON asserts that the response body dose not contain JSON value of the key.

func (*Client) AssertNotEmpty 

func (c *Client) AssertNotEmpty()

AssertNotEmpty asserts that the response body is not empty.

func (*Client) AssertNotExistHeader 

func (c *Client) AssertNotExistHeader(name string)

AssertNotExistHeader asserts that the response does not include named header.

func (*Client) AssertNotFound 

func (c *Client) AssertNotFound()

AssertNotFound asserts that the response status code is 404.

func (*Client) AssertNotMatch 

func (c *Client) AssertNotMatch(re string)

AssertNotMatch asserts that the response body does not match the regular expression.

func (*Client) AssertOK 

func (c *Client) AssertOK()

AssertOK asserts that the response status code is 200.

func (*Client) AssertStatus 

func (c *Client) AssertStatus(status int)

AssertStatus asserts that the response status code is equal to value.

func (*Client) Build 

func (c *Client) Build(method, urlpath, contentType string, data ...interface{}) (request *http.Request, err error)

func (*Client) Close 

func (c *Client) Close()

Close tries to

  • close *httptest.Server created by NewServer()
  • release lock of previous request if existed

func (*Client) Cookies 

func (c *Client) Cookies() []*http.Cookie

Cookies returns cookies related to the host

func (*Client) Delete 

func (c *Client) Delete(t *testing.T, path, contentType string, data ...interface{})

Delete issues a DELETE request to the given path, sending request with specified Content-Type header, and stores the result in Response and ResponseBody if success.

func (*Client) DeleteForm 

func (c *Client) DeleteForm(t *testing.T, path string, data interface{})

DeleteForm issues a DELETE request to the given path with Content-Type: application/x-www-form-urlencoded header, and stores the result in Response and ResponseBody if success.

func (*Client) DeleteJSON 

func (c *Client) DeleteJSON(t *testing.T, path string, data interface{})

DeleteJSON issues a DELETE request to the given path with Content-Type: application/json header, and stores the result in Response and ResponseBody if success. NOTE: It will encode data by json.Marshal before making request.

func (*Client) DeleteXML 

func (c *Client) DeleteXML(t *testing.T, path string, data interface{})

DeleteXML issues a DELETE request to the given path with Content-Type: text/xml header, and stores the result in Response and ResponseBody if success. NOTE: It will encode data by xml.Marshal before making request.

func (*Client) Get 

func (c *Client) Get(t *testing.T, path string, params ...url.Values)

Get issues a GET request to the given path with Content-Type: text/html header, and stores the result in Response and ResponseBody if success.

func (*Client) GetJSON 

func (c *Client) GetJSON(t *testing.T, path string, params ...url.Values)

GetJSON issues a GET request to the given path with Content-Type: application/json header, and stores the result in Response and ResponseBody if success.

func (*Client) GetXML 

func (c *Client) GetXML(t *testing.T, path string, params ...url.Values)

GetXML issues a GET request to the given path with Content-Type: text/xml header, and stores the result in Response and ResponseBody if success.

func (*Client) Head 

func (c *Client) Head(t *testing.T, path string, params ...url.Values)

Head issues a HEAD request to the given path with Content-Type: text/html header, and stores the result in Response if success.

func (*Client) Host 

func (c *Client) Host() string

Host returns the host and port of the server, e.g. "127.0.0.1:9090"

func (*Client) New 

func (c *Client) New(t *testing.T) *Request

New returns a Request with copied *Client, which has more customlization!

func (*Client) NewFilterRequest 

func (c *Client) NewFilterRequest(t *testing.T, request *http.Request, filter TransportFilter)

NewFilterRequest issues any request with TransportFilter and read the response. If successful, the caller may examine the Response and ResponseBody properties. NOTE: It returns error without apply HTTP request when transport filter returned an error.

func (*Client) NewMultipartRequest 

func (c *Client) NewMultipartRequest(t *testing.T, method, path, filename string, file interface{}, fields ...map[string]string)

NewMultipartRequest issues a multipart request for the method & fields given and read the response. If successful, the caller may examine the Response and ResponseBody properties.

func (*Client) NewRequest 

func (c *Client) NewRequest(t *testing.T, request *http.Request)

NewRequest issues any request and read the response. If successful, the caller may examine the Response and ResponseBody properties. NOTE: You have to manage session / cookie data manually.

func (*Client) NewSessionRequest 

func (c *Client) NewSessionRequest(t *testing.T, request *http.Request)

NewSessionRequest issues any request with session/cookie and read the response. If successful, the caller may examine the Response and ResponseBody properties. NOTE: Session data will be added to the request cookies for you.

func (*Client) NewWebsocket 

func (c *Client) NewWebsocket(t *testing.T, path string) *websocket.Conn

NewWebsocket creates a websocket connection to the given path and returns the connection

func (*Client) Options 

func (c *Client) Options(t *testing.T, path string, params ...url.Values)

Options issues an OPTIONS request to the given path Content-Type: text/html header, and stores the result in Response if success.

func (*Client) Patch 

func (c *Client) Patch(t *testing.T, path, contentType string, data ...interface{})

Patch issues a PATCH request to the given path with specified Content-Type header, and stores the result in Response and ResponseBody if success.

func (*Client) PatchForm 

func (c *Client) PatchForm(t *testing.T, path string, data interface{})

PatchForm issues a PATCH request to the given path with Content-Type: application/x-www-form-urlencoded header, and stores the result in Response and ResponseBody if success.

func (*Client) PatchJSON 

func (c *Client) PatchJSON(t *testing.T, path string, data interface{})

PatchJSON issues a PATCH request to the given path with with Content-Type: application/json header, and stores the result in Response and ResponseBody if success. It will encode data by json.Marshal before making request.

func (*Client) PatchXML 

func (c *Client) PatchXML(t *testing.T, path string, data interface{})

PatchXML issues a PATCH request to the given path with Content-Type: text/xml header, and stores the result in Response and ResponseBody if success. NOTE: It will encode data by xml.Marshal before making request.

func (*Client) Post 

func (c *Client) Post(t *testing.T, path, contentType string, data ...interface{})

Post issues a POST request to the given path with specified Content-Type header, and stores the result in Response and ResponseBody if success.

func (*Client) PostForm 

func (c *Client) PostForm(t *testing.T, path string, data interface{})

PostForm issues a POST request to the given path with Content-Type: application/x-www-form-urlencoded header, and stores the result in Response and ResponseBody if success.

func (*Client) PostJSON 

func (c *Client) PostJSON(t *testing.T, path string, data interface{})

PostJSON issues a POST request to the given path with Content-Type: application/json header, and stores the result in Response and ResponseBody if success. NOTE: It will encode data by json.Marshal before making request.

func (*Client) PostXML 

func (c *Client) PostXML(t *testing.T, path string, data interface{})

PostXML issues a POST request to the given path with Content-Type: text/xml header, and stores the result in Response and ResponseBody if success. NOTE: It will encode data by xml.Marshal before making request.

func (*Client) Put 

func (c *Client) Put(t *testing.T, path, contentType string, data ...interface{})

Put issues a PUT request to the given path with specified Content-Type header, and stores the result in Response and ResponseBody if success.

func (*Client) PutForm 

func (c *Client) PutForm(t *testing.T, path string, data interface{})

PutForm issues a PUT request to the given path with Content-Type: application/x-www-form-urlencoded header, and stores the result in Response and ResponseBody if success.

func (*Client) PutJSON 

func (c *Client) PutJSON(t *testing.T, path string, data interface{})

PutJSON issues a PUT request to the given path with Content-Type: application/json header, and stores the result in Response and ResponseBody if success. NOTE: It will encode data by json.Marshal before making request.

func (*Client) PutXML 

func (c *Client) PutXML(t *testing.T, path string, data interface{})

PutXML issues a PUT request to the given path with Content-Type: text/xml header, and stores the result in Response and ResponseBody if success. NOTE: It will encode data by xml.Marshal before making request.

func (*Client) Send 

func (c *Client) Send(t *testing.T, method, path, contentType string, data ...interface{})

Send issues a HTTP request to the given path with specified method and content type header, and stores the result in Response and ResponseBody if success. NOTE: It will encode data with json.Marshal for unspported types and reset content type to application/json for the request.

func (*Client) SetCookies 

func (c *Client) SetCookies(cookies []*http.Cookie)

SetCookies sets cookies for the host

func (*Client) Url 

func (c *Client) Url(urlpath string) string

Url returns the abs http/https URL of the resource, e.g. "http://127.0.0.1:9090/status". The scheme is set to https if http.ssl is set to true in the configuration.

func (*Client) WebsocketUrl 

func (c *Client) WebsocketUrl(urlpath string) string

WebsocketUrl returns the abs websocket URL of the resource, e.g. "ws://127.0.0.1:9090/status"

type Request 

type Request struct {
	*Client
	// contains filtered or unexported fields
}

Request defines http client for human

func NewRequest 

func NewRequest(client *Client) *Request

NewRequest returns a new *Request with *Client

func (*Request) Delete 

func (r *Request) Delete(path, contentType string, data ...interface{})

Delete issues a DELETE request to the given path, sending request with specified Content-Type header, and stores the result in Response and ResponseBody if success.

func (*Request) DeleteForm 

func (r *Request) DeleteForm(path string, data interface{})

DeleteForm issues a DELETE request to the given path with Content-Type: application/x-www-form-urlencoded header, and stores the result in Response and ResponseBody if success.

func (*Request) DeleteJSON 

func (r *Request) DeleteJSON(path string, data interface{})

DeleteJSON issues a DELETE request to the given path with Content-Type: application/json header, and stores the result in Response and ResponseBody if success. NOTE: It will encode data by json.Marshal before making request.

func (*Request) DeleteXML 

func (r *Request) DeleteXML(path string, data interface{})

DeleteXML issues a DELETE request to the given path with Content-Type: text/xml header, and stores the result in Response and ResponseBody if success. NOTE: It will encode data by xml.Marshal before making request.

func (*Request) Get 

func (r *Request) Get(path string, params ...url.Values)

Get issues a GET request to the given path with Content-Type: text/html header, and stores the result in Response and ResponseBody if success.

func (*Request) GetJSON 

func (r *Request) GetJSON(path string, params ...url.Values)

GetJSON issues a GET request to the given path with Content-Type: application/json header, and stores the result in Response and ResponseBody if success.

func (*Request) GetXML 

func (r *Request) GetXML(path string, params ...url.Values)

GetXML issues a GET request to the given path with Content-Type: text/xml header, and stores the result in Response and ResponseBody if success.

func (*Request) Head 

func (r *Request) Head(path string, params ...url.Values)

Head issues a HEAD request to the given path with Content-Type: text/html header, and stores the result in Response if success.

func (*Request) NewFilterRequest 

func (r *Request) NewFilterRequest(request *http.Request, filter TransportFilter)

NewFilterRequest issues any request with TransportFiler and read the response. If successful, the caller may examine the Response and ResponseBody properties. NOTE: It returns error without apply HTTP request when transport filter returned an error.

func (*Request) NewMultipartRequest 

func (r *Request) NewMultipartRequest(method, path, filename string, file interface{}, fields ...map[string]string)

NewMultipartRequest issues a multipart request for the method & fields given and read the response. If successful, the caller may examine the Response and ResponseBody properties.

func (*Request) NewRequest 

func (r *Request) NewRequest(request *http.Request)

NewRequest issues any request and read the response. If successful, the caller may examine the Response and ResponseBody properties. NOTE: You have to manage session / cookie data manually.

func (*Request) NewSessionRequest 

func (r *Request) NewSessionRequest(request *http.Request)

NewSessionRequest issues any request with session / cookie and read the response. If successful, the caller may examine the Response and ResponseBody properties. NOTE: Session data will be added to the request cookies for requested host.

func (*Request) NewWebsocket 

func (r *Request) NewWebsocket(t *testing.T, path string) *websocket.Conn

NewWebsocket creates a websocket connection to the given path and returns the connection

func (*Request) Options 

func (r *Request) Options(path string, params ...url.Values)

Options issues an OPTIONS request to the given path Content-Type: text/html header, and stores the result in Response if success.

func (*Request) Patch 

func (r *Request) Patch(path, contentType string, data ...interface{})

Patch issues a PATCH request to the given path with specified Content-Type header, and stores the result in Response and ResponseBody if success.

func (*Request) PatchForm 

func (r *Request) PatchForm(path string, data interface{})

PatchForm issues a PATCH request to the given path with Content-Type: application/x-www-form-urlencoded header, and stores the result in Response and ResponseBody if success.

func (*Request) PatchJSON 

func (r *Request) PatchJSON(path string, data interface{})

PatchJSON issues a PATCH request to the given path with with Content-Type: application/json header, and stores the result in Response and ResponseBody if success. It will encode data by json.Marshal before making request.

func (*Request) PatchXML 

func (r *Request) PatchXML(path string, data interface{})

PatchXML issues a PATCH request to the given path with Content-Type: text/xml header, and stores the result in Response and ResponseBody if success. NOTE: It will encode data by xml.Marshal before making request.

func (*Request) Post 

func (r *Request) Post(path, contentType string, data ...interface{})

Post issues a POST request to the given path with specified Content-Type header, and stores the result in Response and ResponseBody if success.

func (*Request) PostForm 

func (r *Request) PostForm(path string, data interface{})

PostForm issues a POST request to the given path with Content-Type: application/x-www-form-urlencoded header, and stores the result in Response and ResponseBody if success.

func (*Request) PostJSON 

func (r *Request) PostJSON(path string, data interface{})

PostJSON issues a POST request to the given path with Content-Type: application/json header, and stores the result in Response and ResponseBody if success. NOTE: It will encode data by json.Marshal before making request.

func (*Request) PostXML 

func (r *Request) PostXML(path string, data interface{})

PostXML issues a POST request to the given path with Content-Type: text/xml header, and stores the result in Response and ResponseBody if success. NOTE: It will encode data by xml.Marshal before making request.

func (*Request) Put 

func (r *Request) Put(path, contentType string, data ...interface{})

Put issues a PUT request to the given path with specified Content-Type header, and stores the result in Response and ResponseBody if success.

func (*Request) PutForm 

func (r *Request) PutForm(path string, data interface{})

PutForm issues a PUT request to the given path with Content-Type: application/x-www-form-urlencoded header, and stores the result in Response and ResponseBody if success.

func (*Request) PutJSON 

func (r *Request) PutJSON(path string, data interface{})

PutJSON issues a PUT request to the given path with Content-Type: application/json header, and stores the result in Response and ResponseBody if success. NOTE: It will encode data by json.Marshal before making request.

func (*Request) PutXML 

func (r *Request) PutXML(path string, data interface{})

PutXML issues a PUT request to the given path with Content-Type: text/xml header, and stores the result in Response and ResponseBody if success. NOTE: It will encode data by xml.Marshal before making request.

func (*Request) Send 

func (r *Request) Send(method, path, contentType string, data ...interface{})

Send issues a HTTP request to the given path with specified method and content type header, and stores the result in Response and ResponseBody if success. NOTE: It will encode data with json.Marshal for unspported types and reset content type to application/json for the request.

func (*Request) WithHeader 

func (r *Request) WithHeader(key, value string) *Request

WithHeader sets http.Request header by replace

func (*Request) WithHttpHeader 

func (r *Request) WithHttpHeader(header http.Header) *Request

WithHttpHeader adds http.Request header

type TransportFilter 

type TransportFilter func(r *http.Request) error

TransportFilter is a callback for http request injection.

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.