dns

package

v0.3.1 Latest Latest Go to latest Published: Feb 21, 2024 License: Apache-2.0 Imports: 11 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/caas-team/sparrow

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func NewCheck() checks.Check
type Config
- func (c *Config) For() string
- func (c *Config) Validate() error
type DNS
type Resolver
- func NewResolver() Resolver
type ResolverMock

Constants ¶

View Source

const CheckName = "dns"

Variables ¶

This section is empty.

Functions ¶

func NewCheck ¶

func NewCheck() checks.Check

NewCheck creates a new instance of the dns check

Types ¶

type Config ¶

type Config struct {
	Targets  []string           `json:"targets" yaml:"targets"`
	Interval time.Duration      `json:"interval" yaml:"interval"`
	Timeout  time.Duration      `json:"timeout" yaml:"timeout"`
	Retry    helper.RetryConfig `json:"retry" yaml:"retry"`
}

Config defines the configuration parameters for a DNS check

func (*Config) For ¶

func (c *Config) For() string

For returns the name of the check

func (*Config) Validate ¶

func (c *Config) Validate() error

Validate checks if the configuration is valid

type DNS ¶

type DNS struct {
	checks.CheckBase
	// contains filtered or unexported fields
}

DNS is a check that resolves the names and addresses

func (*DNS) GetConfig ¶

func (d *DNS) GetConfig() checks.Runtime

func (*DNS) GetMetricCollectors ¶

func (d *DNS) GetMetricCollectors() []prometheus.Collector

GetMetricCollectors returns all metric collectors of check

func (*DNS) Name ¶

func (d *DNS) Name() string

func (*DNS) Run ¶

func (d *DNS) Run(ctx context.Context, cResult chan checks.ResultDTO) error

Run starts the dns check

func (*DNS) Schema ¶

func (d *DNS) Schema() (*openapi3.SchemaRef, error)

Schema provides the schema of the data that will be provided by the dns check

func (*DNS) SetConfig ¶

func (d *DNS) SetConfig(cfg checks.Runtime) error

func (*DNS) Shutdown ¶

func (d *DNS) Shutdown(_ context.Context) error

type Resolver ¶

type Resolver interface {
	LookupAddr(ctx context.Context, addr string) ([]string, error)
	LookupHost(ctx context.Context, addr string) ([]string, error)
	SetDialer(d *net.Dialer)
}

func NewResolver ¶

func NewResolver() Resolver

type ResolverMock ¶

type ResolverMock struct {
	// LookupAddrFunc mocks the LookupAddr method.
	LookupAddrFunc func(ctx context.Context, addr string) ([]string, error)

	// LookupHostFunc mocks the LookupHost method.
	LookupHostFunc func(ctx context.Context, addr string) ([]string, error)

	// SetDialerFunc mocks the SetDialer method.
	SetDialerFunc func(d *net.Dialer)
	// contains filtered or unexported fields
}

ResolverMock is a mock implementation of Resolver.

func TestSomethingThatUsesResolver(t *testing.T) {

	// make and configure a mocked Resolver
	mockedResolver := &ResolverMock{
		LookupAddrFunc: func(ctx context.Context, addr string) ([]string, error) {
			panic("mock out the LookupAddr method")
		},
		LookupHostFunc: func(ctx context.Context, addr string) ([]string, error) {
			panic("mock out the LookupHost method")
		},
		SetDialerFunc: func(d *net.Dialer)  {
			panic("mock out the SetDialer method")
		},
	}

	// use mockedResolver in code that requires Resolver
	// and then make assertions.

}

func (*ResolverMock) LookupAddr ¶

func (mock *ResolverMock) LookupAddr(ctx context.Context, addr string) ([]string, error)

LookupAddr calls LookupAddrFunc.

func (*ResolverMock) LookupAddrCalls ¶

func (mock *ResolverMock) LookupAddrCalls() []struct {
	Ctx  context.Context
	Addr string
}

LookupAddrCalls gets all the calls that were made to LookupAddr. Check the length with:

len(mockedResolver.LookupAddrCalls())

func (*ResolverMock) LookupHost ¶

func (mock *ResolverMock) LookupHost(ctx context.Context, addr string) ([]string, error)

LookupHost calls LookupHostFunc.

func (*ResolverMock) LookupHostCalls ¶

func (mock *ResolverMock) LookupHostCalls() []struct {
	Ctx  context.Context
	Addr string
}

LookupHostCalls gets all the calls that were made to LookupHost. Check the length with:

len(mockedResolver.LookupHostCalls())

func (*ResolverMock) SetDialer ¶

func (mock *ResolverMock) SetDialer(d *net.Dialer)

SetDialer calls SetDialerFunc.

func (*ResolverMock) SetDialerCalls ¶

func (mock *ResolverMock) SetDialerCalls() []struct {
	D *net.Dialer
}

SetDialerCalls gets all the calls that were made to SetDialer. Check the length with:

len(mockedResolver.SetDialerCalls())

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL