testabilities

Documentation

Index

• func New(t testing.TB) (given SPVWalletApplicationFixture, then SPVWalletApplicationAssertions)
• func NewOf(givenSource SPVWalletApplicationFixture, t testing.TB) (given SPVWalletApplicationFixture, then SPVWalletApplicationAssertions)
• type ARCFixture
• type BlockHeadersServiceFixture
• type JsonValueGetter
• type SPVWalletApplicationAssertions
  • func Then(t testing.TB) SPVWalletApplicationAssertions
• type SPVWalletApplicationFixture
  • func Given(t testing.TB) SPVWalletApplicationFixture
• type SPVWalletHttpClientFixture
• type SPVWalletResponseAssertions

Functions

func New

func New(t testing.TB) (given SPVWalletApplicationFixture, then SPVWalletApplicationAssertions)

func NewOf

func NewOf(givenSource SPVWalletApplicationFixture, t testing.TB) (given SPVWalletApplicationFixture, then SPVWalletApplicationAssertions)

Types

type ARCFixture

type ARCFixture interface {
	// WillRespondForBroadcast returns a http response for a broadcast request.
	WillRespondForBroadcast(httpCode int, info *chainmodels.TXInfo)
}

type BlockHeadersServiceFixture

type BlockHeadersServiceFixture interface {
	// WillRespondForMerkleRoots returns a http response for get merkleroots endpoint with
	// provided httpCode and response
	WillRespondForMerkleRoots(httpCode int, response string)

	// WillRespondForMerkleRootsVerify returns a MerkleRootsConfirmations response for get merkleroot/verify endpoint with
	// provided httpCode
	WillRespondForMerkleRootsVerify(httpCode int, response *chainmodels.MerkleRootsConfirmations)
}

type JsonValueGetter

type JsonValueGetter interface {
	GetString(xpath string) string
}

type SPVWalletApplicationAssertions

type SPVWalletApplicationAssertions interface {
	Response(response *resty.Response) SPVWalletResponseAssertions
}

func Then

func Then(t testing.TB) SPVWalletApplicationAssertions

type SPVWalletApplicationFixture

type SPVWalletApplicationFixture interface {
	StartedSPVWallet() (cleanup func())
	StartedSPVWalletWithConfiguration(opts ...testengine.ConfigOpts) (cleanup func())

	// HttpClient returns a new http client that can be used to make requests to the spv-wallet server.
	// It is also failing tests if there are network or invalid request configuration errors,
	// so the tests can focus on the server response.
	HttpClient() SPVWalletHttpClientFixture

	// NewTest creates a new test fixture based on the current one and the provided testing.TB
	// This is useful if you want to start spv-wallet once and then run multiple t.Run with some calls against this one instance.
	NewTest(t testing.TB) SPVWalletApplicationFixture

	// BHS creates a new test fixture for Block Header Service (BHS)
	BHS() BlockHeadersServiceFixture

	// ARC creates a new test fixture for ARC
	ARC() ARCFixture
}

func Given

func Given(t testing.TB) SPVWalletApplicationFixture

type SPVWalletHttpClientFixture

type SPVWalletHttpClientFixture interface {
	// ForAnonymous returns a new http client that is configured without any authentication.
	ForAnonymous() *resty.Client
	// ForAdmin returns a new http client that is configured with the authentication with default admin xpub.
	ForAdmin() *resty.Client
	// ForUser returns a new http client that is configured with the authentication with the xpub of the sender user.
	ForUser() *resty.Client
	// ForGivenUser returns a new http client that is configured with the authentication with the xpub of the given user.
	ForGivenUser(user fixtures.User) *resty.Client
}

type SPVWalletResponseAssertions

type SPVWalletResponseAssertions interface {
	IsOK() SPVWalletResponseAssertions
	HasStatus(status int) SPVWalletResponseAssertions
	WithJSONf(expectedFormat string, args ...any)
	WithJSONMatching(expectedTemplateFormat string, params map[string]any)
	JSONValue() JsonValueGetter
	// IsUnauthorized asserts that the response status code is 401 and the error is about lack of authorization.
	IsUnauthorized()
	// IsUnauthorizedForAdmin asserts that the response status code is 401 and the error is that admin is not authorized to use the endpoint.
	IsUnauthorizedForAdmin()
	// IsUnauthorizedForUser asserts that the response status code is 401 and the error is that only admin is authorized to use this endpoint.
	IsUnauthorizedForUser()
	IsBadRequest() SPVWalletResponseAssertions
}