metadata

Documentation

Index

• type Factory
  • func NewMetadataFactory(astQueryIDProvider interfaces.ASTQueryIDProvider, ...) *Factory
  • func (e *Factory) GetMetadataRecord(scanID string, queries []*Query) (*Record, error)
• type Node
• type Provider
• type Query
  • func GetQueriesFromReport(reportReader *report.CxXMLResults) []*Query
• type Record
• type RecordPath
• type RecordQuery
• type RecordResult
• type Result
• type SimilarityCalculationJob
• type SimilarityCalculationResult

Types

type Factory

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

func NewMetadataFactory

func NewMetadataFactory(
	astQueryIDProvider interfaces.ASTQueryIDProvider,
	similarityIDProvider similarity.IDProvider,
	sourceProvider interfaces.SourceFileRepo,
	methodLineProvider interfaces.MethodLineRepo,
	tmpDir string,
) *Factory

func (*Factory) GetMetadataRecord

func (e *Factory) GetMetadataRecord(scanID string, queries []*Query) (*Record, error)

type Node

type Node struct {
	FileName string
	Name     string
	Line     string
	Column   string
}

type Provider

type Provider interface {
	GetMetadataRecord(scanID string, queries []*Query) (*Record, error)
}

type Query

type Query struct {
	QueryID  string
	Language string
	Name     string
	Group    string
	Results  []*Result
}

func GetQueriesFromReport

func GetQueriesFromReport(reportReader *report.CxXMLResults) []*Query

type Record

type Record struct {
	Queries []*RecordQuery `json:"queries"`
}

type RecordPath

type RecordPath struct {
	PathID           string `json:"pathId"`
	SimilarityID     string `json:"similarityId"`
	ResultID         string `json:"-"`
	SASTSimilarityID string `json:"-"`
}

type RecordQuery

type RecordQuery struct {
	QueryID string          `json:"queryId"`
	Results []*RecordResult `json:"results"`
}

type RecordResult

type RecordResult struct {
	ResultID string        `json:"resultId"`
	Paths    []*RecordPath `json:"paths"`
}

type Result

type Result struct {
	PathID       string
	ResultID     string
	SimilarityID string
	FirstNode    Node
	LastNode     Node
}

type SimilarityCalculationJob

type SimilarityCalculationJob struct {
	ResultID, PathID,
	Filename1, Name1, Line1, Column1, MethodLine1,
	Filename2, Name2, Line2, Column2, MethodLine2,
	QueryID string
}

type SimilarityCalculationResult

type SimilarityCalculationResult struct {
	Err                            error
	ResultID, PathID, SimilarityID string
}