rulesConfig

Documentation

Index

• Variables
• type OutputSummary
• type RuleResult
• type RulesConfig
  • func New(deps *RulesConfigDependencies) *RulesConfig
  • func (rc *RulesConfig) GetAllRuleNames(scmPlatform string) []string
  • func (rc *RulesConfig) GetRule(ruleName string, scmPlatform string) (*defaultRules.Rule, error)
  • func (rc *RulesConfig) GetRulesFiles(folderName string, rulesList embed.FS) (map[string][]byte, error)
  • func (rc *RulesConfig) GetSelectedRuleIds() (map[int]bool, error)
  • func (rc *RulesConfig) GetSummary(localValidation bool) OutputSummary
  • func (rc *RulesConfig) InCodeValidate(rule *defaultRules.Rule, githubData map[string]*githubConnector.GithubOwner, ...) ([]*defaultRules.SchemaError, error)
  • func (rc *RulesConfig) Initialize() error
  • func (rc *RulesConfig) JSONSchemaValidate(ruleName string, rule *defaultRules.Rule, scmPlatform string) ([]*defaultRules.SchemaError, error)
  • func (rc *RulesConfig) ReadLocalData() error
  • func (rc *RulesConfig) Validate(ruleName string, rule *defaultRules.Rule, scmPlatform string) ([]*defaultRules.SchemaError, error)
• type RulesConfigDependencies

Variables

var ErrNoFetchedData = errors.New("missing repository data. Use PATH option to validate local directory or fetch data from remote first. Run 'allero fetch -h' for more information about remote data")

Types

type OutputSummary

type OutputSummary struct {
	TotalOwners         int    `mapstructure:"Total Owners"`
	TotalRepositories   int    `mapstructure:"Total Repositories"`
	TotalPipelines      int    `mapstructure:"Total Pipelines"`
	TotalRulesEvaluated int    `mapstructure:"Total Rules Evaluated"`
	TotalFailedRules    int    `mapstructure:"Total Failed Rules"`
	URL                 string `mapstructure:"URL"`
}

type RuleResult

type RuleResult struct {
	RuleName       string
	Valid          bool
	SchemaErrors   []*defaultRules.SchemaError
	FailureMessage string
}

type RulesConfig

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

func New

func New(deps *RulesConfigDependencies) *RulesConfig

func (*RulesConfig) GetAllRuleNames

func (rc *RulesConfig) GetAllRuleNames(scmPlatform string) []string

func (*RulesConfig) GetRule

func (rc *RulesConfig) GetRule(ruleName string, scmPlatform string) (*defaultRules.Rule, error)

func (*RulesConfig) GetRulesFiles

func (rc *RulesConfig) GetRulesFiles(folderName string, rulesList embed.FS) (map[string][]byte, error)

func (*RulesConfig) GetSelectedRuleIds

func (rc *RulesConfig) GetSelectedRuleIds() (map[int]bool, error)

func (*RulesConfig) GetSummary

func (rc *RulesConfig) GetSummary(localValidation bool) OutputSummary

func (*RulesConfig) InCodeValidate

func (rc *RulesConfig) InCodeValidate(rule *defaultRules.Rule, githubData map[string]*githubConnector.GithubOwner, gitlabData map[string]*gitlabConnector.GitlabGroup) ([]*defaultRules.SchemaError, error)

func (*RulesConfig) Initialize

func (rc *RulesConfig) Initialize() error

func (*RulesConfig) JSONSchemaValidate

func (rc *RulesConfig) JSONSchemaValidate(ruleName string, rule *defaultRules.Rule, scmPlatform string) ([]*defaultRules.SchemaError, error)

func (*RulesConfig) ReadLocalData

func (rc *RulesConfig) ReadLocalData() error

func (*RulesConfig) Validate

func (rc *RulesConfig) Validate(ruleName string, rule *defaultRules.Rule, scmPlatform string) ([]*defaultRules.SchemaError, error)

type RulesConfigDependencies

type RulesConfigDependencies struct {
	ConfigurationManager *configurationManager.ConfigurationManager
}