deps

Documentation

Overview

Package deps provides the deps rule data ingest engine

Index

• Constants
• type Config
• type Deps
  • func NewDepsIngester(cfg *pb.DepsType, gitprov provifv1.Git) (*Deps, error)
  • func (gi *Deps) GetConfig() protoreflect.ProtoMessage
  • func (*Deps) GetType() string
  • func (gi *Deps) Ingest(ctx context.Context, ent protoreflect.ProtoMessage, params map[string]any) (*interfaces.Result, error)

Constants

const (
	// DepsRuleDataIngestType is the type of the deps rule data ingest engine
	DepsRuleDataIngestType = "deps"
)

Types

type Config

type Config struct {
	Branch string `json:"branch" yaml:"branch" mapstructure:"branch"`
}

Config is the set of parameters to the deps rule data ingest engine

type Deps

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

Deps is the engine for a rule type that uses deps data ingest

func NewDepsIngester

func NewDepsIngester(cfg *pb.DepsType, gitprov provifv1.Git) (*Deps, error)

NewDepsIngester creates a new deps rule data ingest engine

func (*Deps) GetConfig

func (gi *Deps) GetConfig() protoreflect.ProtoMessage

GetConfig returns the config for the git rule data ingest engine

func (*Deps) GetType

func (*Deps) GetType() string

GetType returns the type of the git rule data ingest engine

func (*Deps) Ingest

func (gi *Deps) Ingest(ctx context.Context, ent protoreflect.ProtoMessage, params map[string]any) (*interfaces.Result, error)

Ingest does the actual data ingestion for a rule type by cloning a git repo, and scanning it for dependencies with a dependency extractor