restlib

Documentation

Overview

Package mock contains testing utilities and mocks shared between packages.

Index

• func GetHeaderParam(r *http.Request, key string) string
• func GetQueryParam(r *http.Request, key string) string
• func GetQueryParamForBool(r *http.Request, key string) (bool, error)
• func GetQueryParamForInt(r *http.Request, key string) (int64, error)
• func GetQueryParamForTime(r *http.Request, key string) (convert.JSONTime, error)
• func GetURLParam(r *http.Request, key string) string
• func GetURLParamForInt(r *http.Request, key string) int64
• func OnRestResult(ctx context.Context, result *common.RestResult, err error)
• func OnRestResultHTTPResult(ctx context.Context, result *HTTPResult, err error)
• func ReadCloser() *readCloser
• func ResponseWriter() *responseWriter
• func SendHTTPResponse(w http.ResponseWriter, httpStatus int, responses ...interface{})
• func SetHeaders(w http.ResponseWriter, headerMap http.Header)
• type HTTPResult
  • func DoHTTPRequest(ctx context.Context, client *http.Client, method string, urlString string, ...) (*HTTPResult, error)
  • func (r *HTTPResult) Error() string

Functions

func GetHeaderParam

func GetHeaderParam(r *http.Request, key string) string

func GetQueryParam

func GetQueryParam(r *http.Request, key string) string

func GetQueryParamForBool

func GetQueryParamForBool(r *http.Request, key string) (bool, error)

func GetQueryParamForInt

func GetQueryParamForInt(r *http.Request, key string) (int64, error)

func GetQueryParamForTime

func GetQueryParamForTime(r *http.Request, key string) (convert.JSONTime, error)

func GetURLParam

func GetURLParam(r *http.Request, key string) string

func GetURLParamForInt

func GetURLParamForInt(r *http.Request, key string) int64

func OnRestResult

func OnRestResult(ctx context.Context, result *common.RestResult, err error)

OnRestResult method will be called from tests as we don't expose the HTTPResult itself.

func OnRestResultHTTPResult

func OnRestResultHTTPResult(ctx context.Context, result *HTTPResult, err error)

OnRestResultHTTPResult is called from generated code when an HTTP result is retrieved.

func ReadCloser

func ReadCloser() *readCloser

ReadCloser returns a mock io.ReadCloser that can be set to return an err when Read is called on it and do nothing when Close is called on it.

func ResponseWriter

func ResponseWriter() *responseWriter

ResponseWriter returns a mock ResponseWriter implementing http.ResponseWriter.

func SendHTTPResponse

func SendHTTPResponse(w http.ResponseWriter, httpStatus int, responses ...interface{})

SendHTTPResponse sends the http response to the client.

func SetHeaders

func SetHeaders(w http.ResponseWriter, headerMap http.Header)

SetHeaders sets the headers in response.

Types

type HTTPResult

type HTTPResult struct {
	HTTPResponse *http.Response
	Body         []byte
	Response     interface{}
}

HTTPResult is the result return by the library.

func DoHTTPRequest

func DoHTTPRequest(ctx context.Context, client *http.Client, method string,
	urlString string, body interface{}, required []string,
	okResponse interface{}, errorResponse interface{}) (*HTTPResult, error)

DoHTTPRequest returns HTTPResult.

func (*HTTPResult) Error

func (r *HTTPResult) Error() string