Help us shape the future of Go! Take the 2026 Go Developer Survey

scan

package
v0.66.1 Latest Latest
Warning

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

Go to latest
Published: Jul 1, 2026 License: AGPL-3.0 Imports: 22 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type CircleClient

type CircleClient interface {
	ListCollaborations(ctx context.Context) ([]collaborationItem, error)
	ListOrganizationProjects(ctx context.Context, orgSlug, defaultVCS string) ([]string, error)
	ListAccessibleProjectsV1(ctx context.Context, defaultVCS, orgFilter string) ([]string, error)
	ListPipelines(ctx context.Context, projectSlug, branch, pageToken string) ([]pipelineItem, string, error)
	ListPipelineWorkflows(ctx context.Context, pipelineID string) ([]workflowItem, error)
	ListWorkflowJobs(ctx context.Context, workflowID string) ([]workflowJobItem, error)
	GetProjectJob(ctx context.Context, projectSlug string, jobNumber int) (projectJobResponse, error)
	GetProjectJobV1(ctx context.Context, projectSlug string, jobNumber int) (projectJobResponse, error)
	ListJobArtifacts(ctx context.Context, projectSlug string, jobNumber int) ([]jobArtifactItem, error)
	ListJobTests(ctx context.Context, projectSlug string, jobNumber int) ([]jobTestItem, error)
	ListProjectInsightsWorkflows(ctx context.Context, projectSlug, branch string) ([]string, error)
	GetProjectInsightsWorkflow(ctx context.Context, projectSlug, workflowName, branch string) (map[string]interface{}, error)
	DownloadWithAuth(ctx context.Context, rawURL string) ([]byte, error)
}

type InitializeOptionsInput

type InitializeOptionsInput struct {
	Token                  string
	CircleURL              string
	Organization           string
	Projects               []string
	VCS                    string
	Branch                 string
	Statuses               []string
	WorkflowNames          []string
	JobNames               []string
	Since                  string
	Until                  string
	MaxPipelines           int
	IncludeTests           bool
	IncludeInsights        bool
	Artifacts              bool
	MaxArtifactSize        string
	ConfidenceFilter       []string
	MaxScanGoRoutines      int
	TruffleHogVerification bool
	HitTimeout             time.Duration
}

type ScanOptions

type ScanOptions struct {
	Token                  string
	CircleURL              string
	Organization           string
	Projects               []string
	Branch                 string
	Statuses               map[string]struct{}
	WorkflowNames          map[string]struct{}
	JobNames               map[string]struct{}
	Since                  *time.Time
	Until                  *time.Time
	MaxPipelines           int
	IncludeTests           bool
	IncludeInsights        bool
	Artifacts              bool
	MaxArtifactSize        int64
	ConfidenceFilter       []string
	MaxScanGoRoutines      int
	TruffleHogVerification bool
	HitTimeout             time.Duration
	Context                context.Context
	APIClient              CircleClient
	HTTPClient             *http.Client
}

func InitializeOptions

func InitializeOptions(input InitializeOptionsInput) (ScanOptions, error)

type Scanner

type Scanner interface {
	pkgscanner.BaseScanner
	Status() *zerolog.Event
}

func NewScanner

func NewScanner(opts ScanOptions) Scanner

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL