reportsummary

package
v0.0.82 Latest Latest
Warning

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

 Go to latest Published: Jan 2, 2022 License: Apache-2.0 Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type ControlSummary 

type ControlSummary struct {
	Name             string              `json:"name"`
	Status           apis.ScanningStatus `json:"status"`
	Score            float32             `json:"score"`
	ResourceCounters ResourceCounters    `json:",inline"`
	ResourceIDs      helpersv1.AllLists  `json:"-"`
	Description      string              `json:"-"`
	Remediation      string              `json:"-"`
}

ControlSummary summary of scanning from a single control perspective

func (*ControlSummary) Append added in v0.0.81 

func (controlSummary *ControlSummary) Append(status apis.IStatus, ids ...string)

Append increases the counter based on the status

func (*ControlSummary) CalculateStatus added in v0.0.79 

func (controlSummary *ControlSummary) CalculateStatus()

CalculateStatus set the control status based on the resource counters

func (*ControlSummary) GetID added in v0.0.80 

func (controlSummary *ControlSummary) GetID() string

GetName return control ID

func (*ControlSummary) GetName added in v0.0.80 

func (controlSummary *ControlSummary) GetName() string

GetName return control name

func (*ControlSummary) GetScore 

func (controlSummary *ControlSummary) GetScore() float32

GetScore return control score

func (*ControlSummary) GetStatus added in v0.0.79 

func (controlSummary *ControlSummary) GetStatus() apis.IStatus

GetStatus get the control status. returns an apis.ScanningStatus object

func (*ControlSummary) List added in v0.0.81 

func (controlSummary *ControlSummary) List() *helpersv1.AllLists

List resources IDs

func (*ControlSummary) NumberOf added in v0.0.80 

func (controlSummary *ControlSummary) NumberOf() ICounters

NumberOf get the number of resources

type FrameworkSummary 

type FrameworkSummary struct {
	Name             string                    `json:"name"` // framework name
	Status           apis.ScanningStatus       `json:"status"`
	Score            float32                   `json:"score"`              // framework score
	Version          string                    `json:"version"`            // framework version
	Controls         map[string]ControlSummary `json:"controls,omitempty"` // mapping of control - map[<control ID>]<control summary>
	ResourceCounters ResourceCounters          `json:",inline"`
	// contains filtered or unexported fields
}

FrameworkSummary summary of scanning from a single framework perspective

func (*FrameworkSummary) Append added in v0.0.81 

func (frameworkSummary *FrameworkSummary) Append(status apis.IStatus, ids ...string)

Append increases the counter based on the status

func (*FrameworkSummary) CalculateStatus added in v0.0.79 

func (frameworkSummary *FrameworkSummary) CalculateStatus()

SetStatus set the framework status based on the resource counters

func (*FrameworkSummary) GetName 

func (frameworkSummary *FrameworkSummary) GetName() string

GetName return framework name

func (*FrameworkSummary) GetScore 

func (frameworkSummary *FrameworkSummary) GetScore() float32

GetScore return framework score

func (*FrameworkSummary) GetStatus added in v0.0.79 

func (frameworkSummary *FrameworkSummary) GetStatus() apis.IStatus

Status get the framework status. returns an apis.ScanningStatus object

func (*FrameworkSummary) Increase added in v0.0.79 

func (frameworkSummary *FrameworkSummary) Increase(status apis.IStatus)

Increase increases the counter based on the status

func (*FrameworkSummary) List added in v0.0.81 

func (frameworkSummary *FrameworkSummary) List() *helpersv1.AllLists

List resources IDs

func (*FrameworkSummary) NumberOf added in v0.0.80 

func (frameworkSummary *FrameworkSummary) NumberOf() ICounters

NumberOfExcluded get the number of excluded resources

type ICounters added in v0.0.80 

type ICounters interface {
	Excluded() int
	Passed() int
	Skipped() int
	Failed() int
	All() int

	Increase(status apis.IStatus)
	Set(*helpersv1.AllLists)
}

type IPolicies added in v0.0.80 

type IPolicies interface {
	GetStatus() apis.IStatus
	CalculateStatus()

	// Counters
	NumberOf() ICounters

	// Score
	GetScore() float32

	// Name
	GetName() string
}

type ListPolicies added in v0.0.80 

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

func (*ListPolicies) All added in v0.0.80 

func (all *ListPolicies) All() []IPolicies

func (*ListPolicies) Append added in v0.0.80 

func (all *ListPolicies) Append(status apis.ScanningStatus, policy IPolicies)

Append append single string to matching status list

func (*ListPolicies) Excluded added in v0.0.80 

func (all *ListPolicies) Excluded() []IPolicies

func (*ListPolicies) Failed added in v0.0.80 

func (all *ListPolicies) Failed() []IPolicies

func (*ListPolicies) Other added in v0.0.80 

func (all *ListPolicies) Other() []IPolicies

func (*ListPolicies) Passed added in v0.0.80 

func (all *ListPolicies) Passed() []IPolicies

func (*ListPolicies) Skipped added in v0.0.80 

func (all *ListPolicies) Skipped() []IPolicies

func (*ListPolicies) Update added in v0.0.80 

func (all *ListPolicies) Update(all2 *ListPolicies)

Update AllLists objects with

type ResourceCounters 

type ResourceCounters struct {
	PassedResources   int `json:"passedResources"`
	FailedResources   int `json:"failedResources"`
	ExcludedResources int `json:"excludedResources"`
	SkippedResources  int `json:"skippedResources"`
}

func (*ResourceCounters) All added in v0.0.80 

func (resourceCounters *ResourceCounters) All() int

NumberOfAll get the number of all resources

func (*ResourceCounters) Excluded added in v0.0.80 

func (resourceCounters *ResourceCounters) Excluded() int

NumberOfExcluded get the number of excluded resources

func (*ResourceCounters) Failed added in v0.0.80 

func (resourceCounters *ResourceCounters) Failed() int

NumberOfFailed get the number of failed resources

func (*ResourceCounters) Increase added in v0.0.79 

func (resourceCounters *ResourceCounters) Increase(status apis.IStatus)

Increase increases the counter based on the status

func (*ResourceCounters) Passed added in v0.0.80 

func (resourceCounters *ResourceCounters) Passed() int

NumberOfPassed get the number of passed resources

func (*ResourceCounters) Set added in v0.0.81 

func (resourceCounters *ResourceCounters) Set(allLists *helpersv1.AllLists)

NumberOfExcluded get the number of excluded resources

func (*ResourceCounters) Skipped added in v0.0.80 

func (resourceCounters *ResourceCounters) Skipped() int

NumberOfSkipped get the number of skipped resources

type SummaryDetails 

type SummaryDetails struct {
	Score            float32                   `json:"score"`              // overall score
	Status           apis.ScanningStatus       `json:"status"`             // overall status
	Frameworks       []FrameworkSummary        `json:"frameworks"`         // list of framework summary
	Controls         map[string]ControlSummary `json:"controls,omitempty"` // mapping of control - map[<control ID>]<control summary>
	ResourceCounters ResourceCounters          `json:",inline"`
	// contains filtered or unexported fields
}

SummaryDetails detailed summary of the scanning. will contain versions, counters, etc.

func MockSummaryDetails added in v0.0.79 

func MockSummaryDetails() *SummaryDetails

func (*SummaryDetails) AppendResourceResult added in v0.0.81 

func (summaryDetails *SummaryDetails) AppendResourceResult(resourceResult *resourcesresults.Result)

updateSummaryWithResource get the result of a single resource. If resource not found will return nil

func (*SummaryDetails) CalculateStatus added in v0.0.79 

func (summaryDetails *SummaryDetails) CalculateStatus()

SetStatus set the framework status based on the resource counters

func (*SummaryDetails) ControlName added in v0.0.80 

func (summaryDetails *SummaryDetails) ControlName(controlID string) string

================================================================================

func (*SummaryDetails) GetStatus added in v0.0.79 

func (summaryDetails *SummaryDetails) GetStatus() *helpersv1.Status

Status get the scan status. returns an apis.ScanningStatus object

func (*SummaryDetails) Increase added in v0.0.79 

func (summaryDetails *SummaryDetails) Increase(status apis.IStatus)

Increase increases the counter based on the status

func (*SummaryDetails) InitResourcesSummary added in v0.0.81 

func (summaryDetails *SummaryDetails) InitResourcesSummary()

InitResourcesSummary must run this AFTER initializing the controls

func (*SummaryDetails) ListControls 

func (summaryDetails *SummaryDetails) ListControls() *ListPolicies

ListFrameworks list all frameworks

func (*SummaryDetails) ListControlsIDs added in v0.0.80 

func (summaryDetails *SummaryDetails) ListControlsIDs() *helpersv1.AllLists

func (*SummaryDetails) ListControlsNames added in v0.0.80 

func (summaryDetails *SummaryDetails) ListControlsNames() *helpersv1.AllLists

ListControlsNames list all framework names

func (*SummaryDetails) ListFrameworks 

func (summaryDetails *SummaryDetails) ListFrameworks() *ListPolicies

ListFrameworks list all frameworks

func (*SummaryDetails) ListFrameworksNames added in v0.0.80 

func (summaryDetails *SummaryDetails) ListFrameworksNames() *helpersv1.AllLists

ListFrameworksNames list all framework names

func (*SummaryDetails) ListResourcesIDs added in v0.0.81 

func (summaryDetails *SummaryDetails) ListResourcesIDs() *helpersv1.AllLists

ListResourcesIDs list all resources IDs

func (*SummaryDetails) NumberOf added in v0.0.80 

func (summaryDetails *SummaryDetails) NumberOf() ICounters

NumberOfExcluded get the number of excluded resources

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.