README
¶
Mock Provider
The Mock Provider extends the platform-health server to support internal testing.
Configuration
The Mock Provider is configured through the platform-health server's configuration file. Each instance is defined with its name as the YAML key under components.
type(required): Must bemock.spec: Provider-specific configuration:health(default:HEALTHY): The health state of the Mock service.sleep(default:1ns): The delay in returning Mock service status.
Examples
Basic Mock Check
components:
test-service:
type: mock
spec:
health: HEALTHY
sleep: 100ms
Documentation
¶
Index ¶
- Constants
- type Component
- func (c *Component) GetCheckConfig() *checks.CEL
- func (c *Component) GetCheckContext(ctx context.Context) (map[string]any, error)
- func (c *Component) GetHealth(ctx context.Context) *ph.HealthCheckResponse
- func (c *Component) GetType() string
- func (c *Component) SetChecks(exprs []checks.Expression) error
- func (c *Component) Setup() error
- type Option
Constants ¶
View Source
const ProviderType = "mock"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Component ¶ added in v0.6.0
type Component struct {
provider.Base
provider.BaseWithChecks
Health ph.Status `mapstructure:"health" default:"HEALTHY"`
Sleep time.Duration `mapstructure:"sleep" default:"1ns"`
}
func New ¶ added in v0.7.0
New creates a mock component with the given name and options. Defaults to HEALTHY status if not specified via WithHealth.
func Unhealthy ¶ added in v0.6.0
Unhealthy creates an unhealthy mock with the given name and options.
func (*Component) GetCheckConfig ¶ added in v0.6.0
func (*Component) GetCheckContext ¶ added in v0.6.0
func (*Component) GetHealth ¶ added in v0.6.0
func (c *Component) GetHealth(ctx context.Context) *ph.HealthCheckResponse
type Option ¶ added in v0.7.0
type Option func(*Component)
Option configures a mock Component.
func WithAlways ¶ added in v0.8.0
WithAlways marks the mock to always execute even after fail-fast.
func WithHealth ¶ added in v0.7.0
WithHealth sets the health status for the mock.
Source Files
Click to show internal directories.
Click to hide internal directories.