assessment

Documentation

Index

• Constants
• type Service
  • func NewService(opts ...ServiceOption) *Service
  • func (s *Service) AssessEvidence(_ context.Context, req *assessment.AssessEvidenceRequest) (res *assessment.AssessEvidenceResponse, err error)
  • func (s *Service) AssessEvidences(stream assessment.Assessment_AssessEvidencesServer) (err error)
  • func (s *Service) ListAssessmentResults(_ context.Context, _ *assessment.ListAssessmentResultsRequest) (res *assessment.ListAssessmentResultsResponse, err error)
  • func (s *Service) RegisterAssessmentResultHook(assessmentResultsHook func(result *assessment.AssessmentResult, err error))
• type ServiceOption
  • func WithEvidenceStoreAddress(address string) ServiceOption
  • func WithOrchestratorAddress(address string) ServiceOption

Constants

const (
	// DefaultEvidenceStoreAddress specifies the default gRPC address of the evidence store.
	DefaultEvidenceStoreAddress = "localhost:9090"

	// DefaultEvidenceStoreAddress specifies the default gRPC address of the orchestrator.
	DefaultOrchestratorAddress = "localhost:9090"
)

Types

type Service

type Service struct {
	// Embedded for FWD compatibility
	assessment.UnimplementedAssessmentServer
	// contains filtered or unexported fields
}

Service is an implementation of the Clouditor Assessment service. It should not be used directly, but rather the NewService constructor should be used. It implements the AssessmentServer interface.

func NewService

func NewService(opts ...ServiceOption) *Service

NewService creates a new assessment service with default values.

func (*Service) AssessEvidence

func (s *Service) AssessEvidence(_ context.Context, req *assessment.AssessEvidenceRequest) (res *assessment.AssessEvidenceResponse, err error)

AssessEvidence is a method implementation of the assessment interface: It assesses a single evidence

func (*Service) AssessEvidences

func (s *Service) AssessEvidences(stream assessment.Assessment_AssessEvidencesServer) (err error)

AssessEvidences is a method implementation of the assessment interface: It assesses multiple evidences (stream)

func (*Service) ListAssessmentResults

func (s *Service) ListAssessmentResults(_ context.Context, _ *assessment.ListAssessmentResultsRequest) (res *assessment.ListAssessmentResultsResponse, err error)

ListAssessmentResults is a method implementation of the assessment interface

func (*Service) RegisterAssessmentResultHook

func (s *Service) RegisterAssessmentResultHook(assessmentResultsHook func(result *assessment.AssessmentResult, err error))

type ServiceOption

type ServiceOption func(*Service)

ServiceOption is a functional option type to configure the assessment service.

func WithEvidenceStoreAddress

func WithEvidenceStoreAddress(address string) ServiceOption

WithEvidenceStoreAddress is an option to configure the evidence store gRPC address.

func WithOrchestratorAddress

func WithOrchestratorAddress(address string) ServiceOption

WithEvidenceStoreAddress is an option to configure the orchestrator gRPC address.