fake

Documentation

Overview

Package fake provides a fake weather client for testing

Index

• type Client
  • func NewClient(options map[string]any) (*Client, error)
  • func (c *Client) GetAverageHighTemperature(_ context.Context, _ time.Duration) (float32, error)
  • func (c *Client) GetTotalRain(_ context.Context, since time.Duration) (float32, error)
• type Config

Types

type Client

type Client struct {
	*Config
}

Client ...

func NewClient

func NewClient(options map[string]any) (*Client, error)

NewClient creates a new client that will return fake data based on configuration. This is intended for testing purposes only and should be used in a staging environment or integration tests, not as a mock in unit tests

func (*Client) GetAverageHighTemperature

func (c *Client) GetAverageHighTemperature(_ context.Context, _ time.Duration) (float32, error)

GetAverageHighTemperature returns the configured value

func (*Client) GetTotalRain

func (c *Client) GetTotalRain(_ context.Context, since time.Duration) (float32, error)

GetTotalRain calculates and returns the configured amount of rain for the given period

type Config

type Config struct {
	RainMM       float32 `mapstructure:"rain_mm"`
	RainInterval string  `mapstructure:"rain_interval"`

	AverageHighTemperature float32 `mapstructure:"avg_high_temperature"`

	Error string `mapstructure:"error"`
	// contains filtered or unexported fields
}

Config is specific to the Fake API and holds all of the necessary fields for configuring fake data responses.