utils

package

v0.28.0 Latest Latest Go to latest Published: Oct 30, 2025 License: MIT Imports: 10 Imported by: 6

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ONSdigital/dp-component-test

Links

Open Source Insights

Documentation ¶

Overview ¶

revive:disable:var-naming

Index ¶

func RandomDatabase() string
type AccessibilityConfig
- func (cfg *AccessibilityConfig) JSON() (string, error)
type Rule
type RunOnly
type Violation
- func RunTest(ctx context.Context) ([]Violation, string, error)
- func RunTestWithConfig(ctx context.Context, cfg AccessibilityConfig) ([]Violation, string, error)
type ViolationNode

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func RandomDatabase ¶

func RandomDatabase() string

RandomDatabase returns a random valid mongo database name. You can use to to pick a new database name for each test to isolate tests from each other without having to tear down the whole server.

This function will panic if it cannot generate a random number.

Types ¶

type AccessibilityConfig ¶ added in v0.13.0

type AccessibilityConfig struct {
	Rules   map[string]Rule `json:"rules,omitempty"`
	RunOnly RunOnly         `json:"runOnly,omitempty"`
}

func (*AccessibilityConfig) JSON ¶ added in v0.13.0

func (cfg *AccessibilityConfig) JSON() (string, error)

Exports the Accessibility config as a JSON string to supply to axe-core

type Rule ¶ added in v0.13.0

type Rule struct {
	Enabled bool `json:"enabled"`
}

type RunOnly ¶ added in v0.13.0

type RunOnly struct {
	Type   string   `json:"type,omitempty"`
	Values []string `json:"values,omitempty"`
}

type Violation ¶ added in v0.13.0

type Violation struct {
	ID          string          `json:"id"`
	Impact      string          `json:"impact"`
	Tags        []string        `json:"tags"`
	Description string          `json:"description"`
	Help        string          `json:"help"`
	HelpURL     string          `json:"helpUrl"`
	Nodes       []ViolationNode `json:"nodes"`
}

func RunTest ¶ added in v0.13.0

func RunTest(ctx context.Context) ([]Violation, string, error)

func RunTestWithConfig ¶ added in v0.13.0

func RunTestWithConfig(ctx context.Context, cfg AccessibilityConfig) ([]Violation, string, error)

type ViolationNode ¶ added in v0.13.0

type ViolationNode struct {
	Impact string `json:"impact"`
	HTML   string `json:"html"`
}

Source Files ¶

View all Source files

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