steammocks

Documentation

Index

• type APIMock
  • func (mock *APIMock) GetOwnedGames(ctx context.Context, id string) ([]*steam.Game, error)
  • func (mock *APIMock) GetOwnedGamesCalls() []struct{ ... }
  • func (mock *APIMock) GetPlayerSummary(ctx context.Context, id string) (*steam.Summary, error)
  • func (mock *APIMock) GetPlayerSummaryCalls() []struct{ ... }

Types

type APIMock

type APIMock struct {
	// GetOwnedGamesFunc mocks the GetOwnedGames method.
	GetOwnedGamesFunc func(ctx context.Context, id string) ([]*steam.Game, error)

	// GetPlayerSummaryFunc mocks the GetPlayerSummary method.
	GetPlayerSummaryFunc func(ctx context.Context, id string) (*steam.Summary, error)
	// contains filtered or unexported fields
}

APIMock is a mock implementation of steam.API.

func TestSomethingThatUsesAPI(t *testing.T) {

	// make and configure a mocked steam.API
	mockedAPI := &APIMock{
		GetOwnedGamesFunc: func(ctx context.Context, id string) ([]*steam.Game, error) {
			panic("mock out the GetOwnedGames method")
		},
		GetPlayerSummaryFunc: func(ctx context.Context, id string) (*steam.Summary, error) {
			panic("mock out the GetPlayerSummary method")
		},
	}

	// use mockedAPI in code that requires steam.API
	// and then make assertions.

}

func (*APIMock) GetOwnedGames

func (mock *APIMock) GetOwnedGames(ctx context.Context, id string) ([]*steam.Game, error)

GetOwnedGames calls GetOwnedGamesFunc.

func (*APIMock) GetOwnedGamesCalls

func (mock *APIMock) GetOwnedGamesCalls() []struct {
	Ctx context.Context
	ID  string
}

GetOwnedGamesCalls gets all the calls that were made to GetOwnedGames. Check the length with:

len(mockedAPI.GetOwnedGamesCalls())

func (*APIMock) GetPlayerSummary

func (mock *APIMock) GetPlayerSummary(ctx context.Context, id string) (*steam.Summary, error)

GetPlayerSummary calls GetPlayerSummaryFunc.

func (*APIMock) GetPlayerSummaryCalls

func (mock *APIMock) GetPlayerSummaryCalls() []struct {
	Ctx context.Context
	ID  string
}

GetPlayerSummaryCalls gets all the calls that were made to GetPlayerSummary. Check the length with:

len(mockedAPI.GetPlayerSummaryCalls())