connvalidate

Documentation

Overview

Copyright (c) 2021, SailPoint Technologies, Inc. All rights reserved.

Index

• Variables
• type Check
• type CheckResult
• type Config
• type Validator
  • func NewValidator(cfg Config, cc *connclient.ConnClient) *Validator
  • func (v *Validator) Run(ctx context.Context) (results []CheckResult, err error)

Variables

var Checks = []Check{}

Types

type Check

type Check struct {
	ID          string
	Description string

	// IsDataModifier determines a checking that will modify connectors data after applying
	IsDataModifier bool
	Run            func(ctx context.Context, spec *connclient.ConnSpec, cc *connclient.ConnClient, res *CheckResult, readLimit int64)
	// RequiredCommands represents a list of commands that use for this check
	RequiredCommands []string
}

Check represents a specific property we want to validate

type CheckResult

type CheckResult struct {
	// ID is a short human readable slug describing the check
	ID string

	// Errors is a list of errors encountered when running the test.
	Errors []string

	// Skipped is a short description why the check was skipped
	Skipped []string

	// Warnings is a list of warnings encountered when running the test.
	Warnings []string
}

CheckResult captures the result of an individual check.

type Config

type Config struct {
	// Check specifies a single check that should be run. If this is empty then
	// all checks are run.
	Check string

	// ReadOnly specifies a type of validation.
	// If ReadOnly set 'true' validator will run all checks that don't make any modifications.
	ReadOnly bool

	// ReadLimit specifies whether to limit the number of account read
	// If ReadLimit set 'true', check for account and entitlement read will only read 8 accounts
	ReadLimit int64
}

Config provides options for how the validator runs

type Validator

type Validator struct {
	// contains filtered or unexported fields
}

Validator runs checks for a specific connector

func NewValidator

func NewValidator(cfg Config, cc *connclient.ConnClient) *Validator

NewValidator creates a new validator with provided config and ConnClient

func (*Validator) Run

func (v *Validator) Run(ctx context.Context) (results []CheckResult, err error)

Run runs the validator suite