utils

Documentation

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

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

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

func (*AccessibilityConfig) JSON

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

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

type Rule

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

type RunOnly

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

type Violation

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

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

func RunTestWithConfig

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

type ViolationNode

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