checks

package
v0.27.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 14, 2025 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

Package checks provides a framework for validating resources against a set of checks.

Index

Constants

This section is empty.

Variables

View Source
var CheckAllArchitectures = checker.NewValidatorCheck(
	"All architectures are deployable",
	checkAllArchitectures,
)

CheckAllArchitectures is a validator check that ensures all architectures in the ALZ library are deployable.

View Source
var CheckAllDefinitionsAreReferenced = checker.NewValidatorCheck(
	"All definitions are referenced",
	checkAllDefinitionsAreReferenced,
)

CheckAllDefinitionsAreReferenced is a validator check that ensures all policy definitions, policy set definitions, and role definitions in the ALZ library are referenced by at least one archetype.

View Source
var CheckDefaults = checker.NewValidatorCheck("All defaults are valid", checkDefaults)

CheckDefaults is a validator check that ensures all policy default values are valid.

View Source
var CheckLibraryMemberPath = checker.NewValidatorCheck(
	"Library member path",
	checkLibraryMemberPath,
)

CheckLibraryMemberPath is a validator check that ensures the library member path matches the expected path from the environment variable.

View Source
var CheckResourceTypeIsCorrect = checker.NewValidatorCheck(
	"Resource type is correct",
	checkResourceTypeIsCorrect,
)

CheckResourceTypeIsCorrect is a validator check that ensures the resource type is correct for policy definitions and set definitions.

View Source
var ErrIncorrectType = errors.New("incorrect type supplied to checker")

ErrIncorrectType is returned when the type supplied to the checker is not correct.

View Source
var ErrLibraryMemberPathMismatch = fmt.Errorf("library member path mismatch")

ErrLibraryMemberPathMismatch is returned when the library member path does not match the expected path.

View Source
var ErrResourceTypeIsIncorrect = errors.New("resource type is incorrect")

ErrResourceTypeIsIncorrect is returned when the resource type is incorrect.

Functions

func NewErrResourceTypeIsIncorrect added in v0.27.0

func NewErrResourceTypeIsIncorrect(resourceType string) error

NewErrResourceTypeIsIncorrect creates a new error indicating that the resource type is incorrect.

Types

This section is empty.

Jump to

Keyboard shortcuts

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