http_helper

Documentation

Overview

Package http_helper contains helpers to interact with deployed resources through HTTP.

Index

• func ContinuouslyCheckUrl(t testing.TestingT, url string, stopChecking <-chan bool, ...) (*sync.WaitGroup, <-chan GetResponse)
• func HTTPDo(t testing.TestingT, method string, url string, body io.Reader, ...) (int, string)
• func HTTPDoE(t testing.TestingT, method string, url string, body io.Reader, ...) (int, string, error)
• func HTTPDoWithCustomValidation(t testing.TestingT, method string, url string, body io.Reader, ...)
• func HTTPDoWithCustomValidationE(t testing.TestingT, method string, url string, body io.Reader, ...) error
• func HTTPDoWithRetry(t testing.TestingT, method string, url string, body []byte, ...) string
• func HTTPDoWithRetryE(t testing.TestingT, method string, url string, body []byte, ...) (string, error)
• func HTTPDoWithValidation(t testing.TestingT, method string, url string, body io.Reader, ...)
• func HTTPDoWithValidationE(t testing.TestingT, method string, url string, body io.Reader, ...) error
• func HTTPDoWithValidationRetry(t testing.TestingT, method string, url string, body []byte, ...)
• func HTTPDoWithValidationRetryE(t testing.TestingT, method string, url string, body []byte, ...) error
• func HttpGet(t testing.TestingT, url string, tlsConfig *tls.Config) (int, string)
• func HttpGetE(t testing.TestingT, url string, tlsConfig *tls.Config) (int, string, error)
• func HttpGetWithCustomValidation(t testing.TestingT, url string, tlsConfig *tls.Config, ...)
• func HttpGetWithCustomValidationE(t testing.TestingT, url string, tlsConfig *tls.Config, ...) error
• func HttpGetWithRetry(t testing.TestingT, url string, tlsConfig *tls.Config, expectedStatus int, ...)
• func HttpGetWithRetryE(t testing.TestingT, url string, tlsConfig *tls.Config, expectedStatus int, ...) error
• func HttpGetWithRetryWithCustomValidation(t testing.TestingT, url string, tlsConfig *tls.Config, retries int, ...)
• func HttpGetWithRetryWithCustomValidationE(t testing.TestingT, url string, tlsConfig *tls.Config, retries int, ...) error
• func HttpGetWithValidation(t testing.TestingT, url string, tlsConfig *tls.Config, expectedStatusCode int, ...)
• func HttpGetWithValidationE(t testing.TestingT, url string, tlsConfig *tls.Config, expectedStatusCode int, ...) error
• func RunDummyServer(t testing.TestingT, text string) (net.Listener, int)
• func RunDummyServerE(t testing.TestingT, text string) (net.Listener, int, error)
• func RunDummyServerWithHandlers(t testing.TestingT, ...) (net.Listener, int)
• func RunDummyServerWithHandlersE(t testing.TestingT, ...) (net.Listener, int, error)
• type GetResponse
• type ValidationFunctionFailed
  • func (err ValidationFunctionFailed) Error() string

Functions

func ContinuouslyCheckUrl

func ContinuouslyCheckUrl(
	t testing.TestingT,
	url string,
	stopChecking <-chan bool,
	sleepBetweenChecks time.Duration,
) (*sync.WaitGroup, <-chan GetResponse)

Continuously check the given URL every 1 second until the stopChecking channel receives a signal to stop. This function will return a sync.WaitGroup that can be used to wait for the checking to stop, and a read only channel to stream the responses for each check. Note that the channel has a buffer of 1000, after which it will start to drop the send events

func HTTPDo

func HTTPDo(
	t testing.TestingT, method string, url string, body io.Reader,
	headers map[string]string, tlsConfig *tls.Config,
) (int, string)

HTTPDo performs the given HTTP method on the given URL and return the HTTP status code and body. If there's any error, fail the test.

func HTTPDoE

func HTTPDoE(
	t testing.TestingT, method string, url string, body io.Reader,
	headers map[string]string, tlsConfig *tls.Config,
) (int, string, error)

HTTPDoE performs the given HTTP method on the given URL and return the HTTP status code, body, and any error.

func HTTPDoWithCustomValidation

func HTTPDoWithCustomValidation(t testing.TestingT, method string, url string, body io.Reader, headers map[string]string, validateResponse func(int, string) bool, tlsConfig *tls.Config)

HTTPDoWithCustomValidation performs the given HTTP method on the given URL and validate the returned status code and body using the given function.

func HTTPDoWithCustomValidationE

func HTTPDoWithCustomValidationE(t testing.TestingT, method string, url string, body io.Reader, headers map[string]string, validateResponse func(int, string) bool, tlsConfig *tls.Config) error

HTTPDoWithCustomValidationE performs the given HTTP method on the given URL and validate the returned status code and body using the given function.

func HTTPDoWithRetry

func HTTPDoWithRetry(
	t testing.TestingT, method string, url string,
	body []byte, headers map[string]string, expectedStatus int,
	retries int, sleepBetweenRetries time.Duration, tlsConfig *tls.Config,
) string

HTTPDoWithRetry repeatedly performs the given HTTP method on the given URL until the given status code and body are returned or until max retries has been exceeded. The function compares the expected status code against the received one and fails if they don't match.

func HTTPDoWithRetryE

func HTTPDoWithRetryE(
	t testing.TestingT, method string, url string,
	body []byte, headers map[string]string, expectedStatus int,
	retries int, sleepBetweenRetries time.Duration, tlsConfig *tls.Config,
) (string, error)

HTTPDoWithRetryE repeatedly performs the given HTTP method on the given URL until the given status code and body are returned or until max retries has been exceeded. The function compares the expected status code against the received one and fails if they don't match.

func HTTPDoWithValidation

func HTTPDoWithValidation(t testing.TestingT, method string, url string, body io.Reader, headers map[string]string, expectedStatusCode int, expectedBody string, tlsConfig *tls.Config)

HTTPDoWithValidation performs the given HTTP method on the given URL and verify that you get back the expected status code and body. If either doesn't match, fail the test.

func HTTPDoWithValidationE

func HTTPDoWithValidationE(t testing.TestingT, method string, url string, body io.Reader, headers map[string]string, expectedStatusCode int, expectedBody string, tlsConfig *tls.Config) error

HTTPDoWithValidationE performs the given HTTP method on the given URL and verify that you get back the expected status code and body. If either doesn't match, return an error.

func HTTPDoWithValidationRetry

func HTTPDoWithValidationRetry(
	t testing.TestingT, method string, url string,
	body []byte, headers map[string]string, expectedStatus int,
	expectedBody string, retries int, sleepBetweenRetries time.Duration, tlsConfig *tls.Config,
)

HTTPDoWithValidationRetry repeatedly performs the given HTTP method on the given URL until the given status code and body are returned or until max retries has been exceeded.

func HTTPDoWithValidationRetryE

func HTTPDoWithValidationRetryE(
	t testing.TestingT, method string, url string,
	body []byte, headers map[string]string, expectedStatus int,
	expectedBody string, retries int, sleepBetweenRetries time.Duration, tlsConfig *tls.Config,
) error

HTTPDoWithValidationRetryE repeatedly performs the given HTTP method on the given URL until the given status code and body are returned or until max retries has been exceeded.

func HttpGet

func HttpGet(t testing.TestingT, url string, tlsConfig *tls.Config) (int, string)

HttpGet performs an HTTP GET, with an optional pointer to a custom TLS configuration, on the given URL and return the HTTP status code and body. If there's any error, fail the test.

func HttpGetE

func HttpGetE(t testing.TestingT, url string, tlsConfig *tls.Config) (int, string, error)

HttpGetE performs an HTTP GET, with an optional pointer to a custom TLS configuration, on the given URL and return the HTTP status code, body, and any error.

func HttpGetWithCustomValidation

func HttpGetWithCustomValidation(t testing.TestingT, url string, tlsConfig *tls.Config, validateResponse func(int, string) bool)

HttpGetWithCustomValidation performs an HTTP GET on the given URL and validate the returned status code and body using the given function.

func HttpGetWithCustomValidationE

func HttpGetWithCustomValidationE(t testing.TestingT, url string, tlsConfig *tls.Config, validateResponse func(int, string) bool) error

HttpGetWithCustomValidationE performs an HTTP GET on the given URL and validate the returned status code and body using the given function.

func HttpGetWithRetry

func HttpGetWithRetry(t testing.TestingT, url string, tlsConfig *tls.Config, expectedStatus int, expectedBody string, retries int, sleepBetweenRetries time.Duration)

HttpGetWithRetry repeatedly performs an HTTP GET on the given URL until the given status code and body are returned or until max retries has been exceeded.

func HttpGetWithRetryE

func HttpGetWithRetryE(t testing.TestingT, url string, tlsConfig *tls.Config, expectedStatus int, expectedBody string, retries int, sleepBetweenRetries time.Duration) error

HttpGetWithRetryE repeatedly performs an HTTP GET on the given URL until the given status code and body are returned or until max retries has been exceeded.

func HttpGetWithRetryWithCustomValidation

func HttpGetWithRetryWithCustomValidation(t testing.TestingT, url string, tlsConfig *tls.Config, retries int, sleepBetweenRetries time.Duration, validateResponse func(int, string) bool)

HttpGetWithRetryWithCustomValidation repeatedly performs an HTTP GET on the given URL until the given validation function returns true or max retries has been exceeded.

func HttpGetWithRetryWithCustomValidationE

func HttpGetWithRetryWithCustomValidationE(t testing.TestingT, url string, tlsConfig *tls.Config, retries int, sleepBetweenRetries time.Duration, validateResponse func(int, string) bool) error

HttpGetWithRetryWithCustomValidationE repeatedly performs an HTTP GET on the given URL until the given validation function returns true or max retries has been exceeded.

func HttpGetWithValidation

func HttpGetWithValidation(t testing.TestingT, url string, tlsConfig *tls.Config, expectedStatusCode int, expectedBody string)

HttpGetWithValidation performs an HTTP GET on the given URL and verify that you get back the expected status code and body. If either doesn't match, fail the test.

func HttpGetWithValidationE

func HttpGetWithValidationE(t testing.TestingT, url string, tlsConfig *tls.Config, expectedStatusCode int, expectedBody string) error

HttpGetWithValidationE performs an HTTP GET on the given URL and verify that you get back the expected status code and body. If either doesn't match, return an error.

func RunDummyServer

func RunDummyServer(t testing.TestingT, text string) (net.Listener, int)

RunDummyServer runs a dummy HTTP server on a unique port that will return the given text. Returns the Listener for the server, the port it's listening on, or an error if something went wrong while trying to start the listener. Make sure to call the Close() method on the Listener when you're done!

func RunDummyServerE

func RunDummyServerE(t testing.TestingT, text string) (net.Listener, int, error)

RunDummyServerE runs a dummy HTTP server on a unique port that will return the given text. Returns the Listener for the server, the port it's listening on, or an error if something went wrong while trying to start the listener. Make sure to call the Close() method on the Listener when you're done!

func RunDummyServerWithHandlers

func RunDummyServerWithHandlers(t testing.TestingT, handlers map[string]func(http.ResponseWriter, *http.Request)) (net.Listener, int)

RunDummyServerWithHandlers runs a dummy HTTP server on a unique port that will serve given handlers. Returns the Listener for the server, the port it's listening on, or an error if something went wrong while trying to start the listener. Make sure to call the Close() method on the Listener when you're done!

func RunDummyServerWithHandlersE

func RunDummyServerWithHandlersE(t testing.TestingT, handlers map[string]func(http.ResponseWriter, *http.Request)) (net.Listener, int, error)

RunDummyServerWithHandlersE runs a dummy HTTP server on a unique port that will server given handlers. Returns the Listener for the server, the port it's listening on, or an error if something went wrong while trying to start the listener. Make sure to call the Close() method on the Listener when you're done!

Types

type GetResponse

type GetResponse struct {
	StatusCode int
	Body       string
}

type ValidationFunctionFailed

type ValidationFunctionFailed struct {
	Url    string
	Status int
	Body   string
}

ValidationFunctionFailed is an error that occurs if a validation function fails.

func (ValidationFunctionFailed) Error

func (err ValidationFunctionFailed) Error() string