curation

Documentation

Index

• Constants
• Variables
• func DetectNumOfThreads(threadsCount int) (int, error)
• func GetCurationOutputFormat(formatFlagVal string) (format outFormat.OutputFormat, err error)
• type CurationAuditCommand
  • func NewCurationAuditCommand() *CurationAuditCommand
  • func (ca *CurationAuditCommand) CommandName() string
  • func (ca *CurationAuditCommand) Run() (err error)
  • func (ca *CurationAuditCommand) SetParallelRequests(threads int) *CurationAuditCommand
  • func (ca *CurationAuditCommand) SetRepo(tech coreutils.Technology) error
  • func (ca *CurationAuditCommand) SetWorkingDirs(dirs []string) *CurationAuditCommand
• type ErrorResp
• type ErrorsResp
• type PackageStatus
• type PackageStatusTable
• type Policy

Constants

const (
	BlockingReasonPolicy   = "Policy violations"
	BlockingReasonNotFound = "Package pending update"

	BlockMessageKey  = "jfrog packages curation"
	NotBeingFoundKey = "not being found"

	TotalConcurrentRequests = 10

	MinArtiMavenSupport = "7.82.0"
	MinArtiXraySupport  = "3.92.0"
)

Variables

var CurationOutputFormats = []string{string(outFormat.Table), string(outFormat.Json)}

Functions

func DetectNumOfThreads

func DetectNumOfThreads(threadsCount int) (int, error)

func GetCurationOutputFormat

func GetCurationOutputFormat(formatFlagVal string) (format outFormat.OutputFormat, err error)

Types

type CurationAuditCommand

type CurationAuditCommand struct {
	PackageManagerConfig *project.RepositoryConfig

	OriginPath string

	utils.AuditParams
	// contains filtered or unexported fields
}

func NewCurationAuditCommand

func NewCurationAuditCommand() *CurationAuditCommand

func (*CurationAuditCommand) CommandName

func (ca *CurationAuditCommand) CommandName() string

func (*CurationAuditCommand) Run

func (ca *CurationAuditCommand) Run() (err error)

func (*CurationAuditCommand) SetParallelRequests

func (ca *CurationAuditCommand) SetParallelRequests(threads int) *CurationAuditCommand

func (*CurationAuditCommand) SetRepo

func (ca *CurationAuditCommand) SetRepo(tech coreutils.Technology) error

func (*CurationAuditCommand) SetWorkingDirs

func (ca *CurationAuditCommand) SetWorkingDirs(dirs []string) *CurationAuditCommand

type ErrorResp

type ErrorResp struct {
	Status  int    `json:"status"`
	Message string `json:"message"`
}

type ErrorsResp

type ErrorsResp struct {
	Errors []ErrorResp `json:"errors"`
}

type PackageStatus

type PackageStatus struct {
	Action            string   `json:"action"`
	ParentName        string   `json:"direct_dependency_package_name"`
	ParentVersion     string   `json:"direct_dependency_package_version"`
	BlockedPackageUrl string   `json:"blocked_package_url,omitempty"`
	PackageName       string   `json:"blocked_package_name"`
	PackageVersion    string   `json:"blocked_package_version"`
	BlockingReason    string   `json:"blocking_reason"`
	DepRelation       string   `json:"dependency_relation"`
	PkgType           string   `json:"type"`
	Policy            []Policy `json:"policies,omitempty"`
}

type PackageStatusTable

type PackageStatusTable struct {
	ParentName     string `col-name:"Direct\nDependency\nPackage\nName" auto-merge:"true"`
	ParentVersion  string `col-name:"Direct\nDependency\nPackage\nVersion" auto-merge:"true"`
	PackageName    string `col-name:"Blocked\nPackage\nName" auto-merge:"true"`
	PackageVersion string `col-name:"Blocked\nPackage\nVersion" auto-merge:"true"`
	BlockingReason string `col-name:"Blocking Reason" auto-merge:"true"`
	PkgType        string `col-name:"Package\nType" auto-merge:"true"`
	Policy         string `col-name:"Violated\nPolicy\nName"`
	Condition      string `col-name:"Violated Condition\nName"`
	Explanation    string `col-name:"Explanation"`
	Recommendation string `col-name:"Recommendation"`
}

type Policy

type Policy struct {
	Policy         string `json:"policy"`
	Condition      string `json:"condition"`
	Explanation    string `json:"explanation"`
	Recommendation string `json:"recommendation"`
}