utils

Dec 17, 2025

Changes in this version

type VulnerabilityDetails

+ func (vd *VulnerabilityDetails) AddMissingCves(cves []formats.CveRow)

Nov 20, 2025

Changes in this version

+ const MaxConcurrentScanners

Aug 7, 2025

Changes in this version

+ const GitDependencyGraphSubmissionEnv

+ func CreateMockServerForDependencySubmission(t *testing.T, owner, repo string) *httptest.Server

+ func CreateMockServerForDependencySubmissionError(t *testing.T, owner, repo string) *httptest.Server

+ func UploadSbomSnapshotToGithubDependencyGraph(owner, repo string, scanResults *results.SecurityCommandResults, ...) error

type Git

+ UploadSbomToVcs *bool

May 28, 2025

Changes in this version

type ScanDetails

+ ResultsToCompare *results.SecurityCommandResults

+ func (sc *ScanDetails) SetDiffScan(diffScan bool) *ScanDetails

+ func (sc *ScanDetails) SetResultsToCompare(results *results.SecurityCommandResults) *ScanDetails

+ func (sc *ScanDetails) SetXscPRGitInfoContext(gitProject string, client vcsclient.VcsClient, ...) *ScanDetails

Jan 7, 2025

Changes in this version

+ const AddPrCommentOnSuccessEnv

+ const IncludeVulnerabilitiesEnv

+ const MaxPnpmTreeDepthEnv

type Git

+ func (g *Git) GetRepositoryHttpsCloneUrl(gitClient vcsclient.VcsClient) (string, error)

type JFrogPlatform

+ IncludeVulnerabilities bool

type Project

+ MaxPnpmTreeDepth string

type Scan

+ AddPrCommentOnSuccess bool

type ScanDetails

+ MultiScanId string

+ XrayVersion string

+ XscVersion string

+ func (sc *ScanDetails) SetJfrogVersions(xrayVersion, xscVersion string) *ScanDetails

+ func (sc *ScanDetails) SetResultsContext(httpCloneUrl string, watches []string, jfrogProjectKey string, ...) *ScanDetails

Dec 22, 2024

Changes in this version

+ const JfrogUseConfigProfileEnv

+ const NonExistingProfile

Dec 22, 2024

Changes in this version

+ const PullRequestSecretCommentsEnv

type Git

+ PullRequestSecretComments bool

type ReviewCommentType

+ const SecretComment

Nov 27, 2024

Changes in this version

+ func CreateScanEvent(serviceDetails *config.ServerDetails, gitInfo *services.XscGitInfoContext, ...) *xscservices.XscAnalyticsGeneralEvent

type FrogbotDetails

+ XrayVersion string

+ XscVersion string

type JFrogPlatform

+ XrayVersion string

+ XscVersion string

type ScanDetails

+ StartTime time.Time

Oct 31, 2024

Changes in this version

+ const UseMostCommonAncestorAsTargetEnv

type Git

+ UseMostCommonAncestorAsTarget bool

type GitManager

+ func (gm *GitManager) CheckoutToHash(hash, targetBranchWd string) error

+ func (gm *GitManager) Fetch() error

+ func (gm *GitManager) GetMostCommonAncestorHash(baseBranch, targetBranch string) (string, error)

Oct 29, 2024

Changes in this version

+ const DisableJasEnv

type Scan

+ DisableJas bool

type ScanDetails

+ func (sc *ScanDetails) DisableJas() bool

+ func (sc *ScanDetails) SetDisableJas(disable bool) *ScanDetails

Oct 21, 2024

Changes in this version

+ const GitUseLocalRepositoryEnv

type Git

+ UseLocalRepository bool

type GitManager

+ func (gm *GitManager) GetAuth() *githttp.BasicAuth

+ func (gm *GitManager) GetRemoteGitUrl() string

+ func (gm *GitManager) GetRemoteName() string

+ func (gm *GitManager) SetLocalRepositoryAndRemoteName() (*GitManager, error)

type ScanDetails

+ func (sc *ScanDetails) HasViolationContext() bool

Oct 13, 2024

Changes in this version

+ const AllowPartialResultsEnv

+ const SkipAutoInstallEnv

+ func CreateErrorIfPartialResultsDisabled(allowPartial bool, messageForLog string, err error) error

type Scan

+ AllowPartialResults bool

+ SkipAutoInstall bool

type ScanDetails

+ func (sc *ScanDetails) AllowPartialResults() bool

+ func (sc *ScanDetails) SetAllowPartialResults(allowPartialResults bool) *ScanDetails

+ func (sc *ScanDetails) SetSkipAutoInstall(skipAutoInstall bool) *ScanDetails

Sep 16, 2024

Changes in this version

+ const DetectionOnlyEnv

type Project

+ func (p *Project) GetTechFromInstallCmdIfExists() []string

type Scan

+ DetectionOnly bool

Sep 5, 2024

Changes in this version

+ const InvalidModulesConfigProfile

+ const InvalidPathConfigProfile

+ const JfrogConfigProfileEnv

+ const ValidConfigProfile

+ func CreateXscMockServerForConfigProfile(t *testing.T) (mockServer *httptest.Server, serverDetails *config.ServerDetails)

type Scan

+ ConfigProfile *services.ConfigProfile

type ScanDetails

+ func (sc *ScanDetails) SetConfigProfile(configProfile *clientservices.ConfigProfile) *ScanDetails

Jun 25, 2024

Changes in this version

+ func CreateTempJfrogHomeWithCallback(t *testing.T) (string, func())

type ScanDetails

+ func (sc *ScanDetails) CreateCommonGraphScanParams() *scangraph.CommonGraphScanParams

Apr 18, 2024

Changes in this version

+ func AddAnalyticsGeneralEvent(gitInfoContext *services.XscGitInfoContext, ...) *utils.AnalyticsMetricsService

type IssuesCollection

+ func (ic *IssuesCollection) CountIssuesCollectionFindings() int

Mar 28, 2024

Changes in this version

+ func DeletePullRequestComments(repo *Repository, client vcsclient.VcsClient, pullRequestID int) (err error)

Feb 21, 2024

Changes in this version

+ type ErrNothingToCommit struct

+ PackageName string

+ func (err *ErrNothingToCommit) Error() string

type ScanDetails

+ func (sc *ScanDetails) CreateMultiScanIdForScans() error

Jan 25, 2024

Changes in this version

+ const AggregatePullRequestTitleDefaultTemplate

+ const AggregatedBranchNameTemplate

+ const AllowedLicensesEnv

+ const AvoidExtraMessages

+ const AvoidPreviousPrCommentsDeletionEnv

+ const AzureRepos

+ const BitbucketServer

+ const BranchHashPlaceHolder

+ const BranchNameTemplate

+ const BranchNameTemplateEnv

+ const CommitMessageTemplate

+ const CommitMessageTemplateEnv

+ const DepsRepoEnv

+ const EmailReceiversEnv

+ const FailOnSecurityIssuesEnv

+ const FixVersionPlaceHolder

+ const FixableOnlyEnv

+ const FrogbotConfigFile

+ const GitAggregateFixesEnv

+ const GitApiEndpointEnv

+ const GitBaseBranchEnv

+ const GitEmailAuthorEnv

+ const GitHub

+ const GitHubActionsEnv

+ const GitLab

+ const GitProjectEnv

+ const GitProvider

+ const GitPullRequestIDEnv

+ const GitRepoEnv

+ const GitRepoOwnerEnv

+ const GitTokenEnv

+ const GitUsernameEnv

+ const IncludeAllVulnerabilitiesEnv

+ const InstallCommandEnv

+ const JFrogPasswordEnv

+ const JFrogTokenEnv

+ const JFrogUrlEnv

+ const JFrogUserEnv

+ const JfrogHomeDirEnv

+ const MinSeverityEnv

+ const PackagePlaceHolder

+ const PathExclusionsEnv

+ const PullRequestCommentTitleEnv

+ const PullRequestTitleTemplate

+ const PullRequestTitleTemplateEnv

+ const RequirementsFileEnv

+ const RootDir

+ const ScanAllPullRequests

+ const ScanMultipleRepositories

+ const ScanPullRequest

+ const ScanRepository

+ const SmtpPasswordEnv

+ const SmtpServerEnv

+ const SmtpUserEnv

+ const UseWrapperEnv

+ const WatchesDelimiter

+ const WorkingDirectoryEnv

+ var BuildToolsDependenciesMap = map[coreutils.Technology][]string

+ var FrogbotVersion = "0.0.0"

+ var TrueVal = true

+ func AlertSecretsExposed(secretsDetails *SecretsEmailDetails) (err error)

+ func AssertSanitizedEnv(t *testing.T)

+ func BuildServerConfigFile(server *config.ServerDetails) (previousJFrogHomeDir, currentJFrogHomeDir string, err error)

+ func ChangeToTempDirWithCallback(t *testing.T) (string, func() error)

+ func Chdir(dir string) (cbk func() error, err error)

+ func ConvertSarifPathsToRelative(issues *IssuesCollection, workingDirs ...string)

+ func CopyCurrentDirFilesToTempDir() (tempDirPath string, err error)

+ func CopyMissingFilesToCurrentWorkingDir(sourceDirPath string) (err error)

+ func CopyTestdataProjectsToTemp(t *testing.T, testDir string) (tmpDir string, restoreFunc func())

+ func CreateDotGitWithCommit(t *testing.T, wd, port string, repositoriesPath ...string)

+ func DeleteExistingPullRequestComments(repository *Repository, client vcsclient.VcsClient) error

+ func DeleteExistingPullRequestReviewComments(repo *Repository, pullRequestID int, client vcsclient.VcsClient) (err error)

+ func DownloadRepoToTempDir(client vcsclient.VcsClient, repoOwner, repoName, branch string) (wd string, cleanup func() error, err error)

+ func ExtractVulnerabilitiesDetailsToRows(vulnDetails []*VulnerabilityDetails) []formats.VulnerabilityOrViolationRow

+ func GenerateFixPullRequestDetails(vulnerabilities []formats.VulnerabilityOrViolationRow, ...) string

+ func GenerateFrogbotSarifReport(extendedResults *xrayutils.Results, isMultipleRoots bool, ...) (string, error)

+ func GetFullBranchName(branchName string) plumbing.ReferenceName

+ func GetFullPathWorkingDirs(workingDirs []string, baseWd string) []string

+ func GetRelativeWd(fullPathWd, baseWd string) string

+ func GetSortedPullRequestComments(client vcsclient.VcsClient, repoOwner, repoName string, prID int) ([]vcsclient.CommentInfo, error)

+ func GetVulnerabiltiesUniqueID(vulnerability formats.VulnerabilityOrViolationRow) string

+ func HandlePullRequestCommentsAfterScan(issues *IssuesCollection, repo *Repository, client vcsclient.VcsClient, ...) (err error)

+ func IsDirectDependency(impactPath [][]formats.ComponentRow) (bool, error)

+ func IsFrogbotRescanComment(comment string) bool

+ func Md5Hash(values ...string) (string, error)

+ func ReadConfigFromFileSystem(configRelativePath string) (configFileContent []byte, err error)

+ func ReportUsageOnCommand(commandName string, serverDetails *config.ServerDetails, ...) func()

+ func SanitizeEnv() error

+ func SetEnvAndAssert(t *testing.T, env map[string]string)

+ func SetEnvsAndAssertWithCallback(t *testing.T, envs map[string]string) func()

+ func UploadSarifResultsToGithubSecurityTab(scanResults *xrayutils.Results, repo *Repository, branch string, ...) error

+ func ValidateSingleRepoConfiguration(configAggregator *RepoAggregator) error

+ func VerifyEnv(t *testing.T) (server config.ServerDetails, restoreFunc func())

+ func VulnerabilityDetailsToMD5Hash(vulnerabilities ...formats.VulnerabilityOrViolationRow) (string, error)

+ type CustomTemplates struct

+ type EmailDetails struct

+ EmailReceivers []string

+ SmtpPassword string

+ SmtpPort string

+ SmtpServer string

+ SmtpUser string

+ type ErrMissingConfig struct

+ func (e *ErrMissingConfig) Error() string

+ type ErrMissingEnv struct

+ VariableName string

+ func (e *ErrMissingEnv) Error() string

+ func (e *ErrMissingEnv) IsMissingEnvErr(err error) bool

+ type ErrUnsupportedFix struct

+ ErrorType UnsupportedErrorType

+ FixedVersion string

+ PackageName string

+ func (err *ErrUnsupportedFix) Error() string

+ type FrogbotDetails struct

+ GitClient vcsclient.VcsClient

+ ReleasesRepo string

+ Repositories RepoAggregator

+ ServerDetails *coreconfig.ServerDetails

+ func GetFrogbotDetails(commandName string) (frogbotDetails *FrogbotDetails, err error)

+ type Git struct

+ AggregateFixes bool

+ AvoidExtraMessages bool

+ BranchNameTemplate string

+ Branches []string

+ CommitMessageTemplate string

+ EmailAuthor string

+ GitProvider vcsutils.VcsProvider

+ PullRequestCommentTitle string

+ PullRequestDetails vcsclient.PullRequestInfo

+ PullRequestTitleTemplate string

+ RepoName string

+ RepoOwner string

+ RepositoryCloneUrl string

+ type GitManager struct

+ SkipClone bool

+ func NewGitManager() *GitManager

+ func (gm *GitManager) AddAllAndCommit(commitMessage string) error

+ func (gm *GitManager) BranchExistsInRemote(branchName string) (bool, error)

+ func (gm *GitManager) Checkout(branchName string) error

+ func (gm *GitManager) Clone(destinationPath, branchName string) error

+ func (gm *GitManager) CreateBranchAndCheckout(branchName string) error

+ func (gm *GitManager) CreateBranchAndCheckoutWithCopyingFilesDiff(branchName string) (error, func() error)

+ func (gm *GitManager) GenerateAggregatedCommitMessage(tech []coreutils.Technology) string

+ func (gm *GitManager) GenerateAggregatedFixBranchName(baseBranch string, tech []coreutils.Technology) (fixBranchName string)

+ func (gm *GitManager) GenerateAggregatedPullRequestTitle(tech []coreutils.Technology) string

+ func (gm *GitManager) GenerateCommitMessage(impactedPackage string, fixVersion string) string

+ func (gm *GitManager) GenerateFixBranchName(branch string, impactedPackage string, fixVersion string) (string, error)

+ func (gm *GitManager) GeneratePullRequestTitle(impactedPackage string, version string) string

+ func (gm *GitManager) IsClean() (bool, error)

+ func (gm *GitManager) Push(force bool, branchName string) error

+ func (gm *GitManager) RemoveRemoteBranch(branchName string) error

+ func (gm *GitManager) SetAuth(username, token string) *GitManager

+ func (gm *GitManager) SetDryRun(dryRun bool, dryRunRepoPath string) *GitManager

+ func (gm *GitManager) SetEmailAuthor(emailAuthor string) *GitManager

+ func (gm *GitManager) SetGitParams(gitParams *Git) (*GitManager, error)

+ func (gm *GitManager) SetLocalRepository() (*GitManager, error)

+ func (gm *GitManager) SetRemoteGitUrl(remoteHttpsGitUrl string) (*GitManager, error)

+ type IssuesCollection struct

+ Iacs []formats.SourceCodeRow

+ Licenses []formats.LicenseRow

+ Sast []formats.SourceCodeRow

+ Secrets []formats.SourceCodeRow

+ Vulnerabilities []formats.VulnerabilityOrViolationRow

+ func (ic *IssuesCollection) Append(issues *IssuesCollection)

+ func (ic *IssuesCollection) IacExists() bool

+ func (ic *IssuesCollection) IssuesExists() bool

+ func (ic *IssuesCollection) LicensesExists() bool

+ func (ic *IssuesCollection) SastExists() bool

+ func (ic *IssuesCollection) SecretsExists() bool

+ func (ic *IssuesCollection) VulnerabilitiesExists() bool

+ type JFrogPlatform struct

+ JFrogProjectKey string

+ Watches []string

+ type Params struct

+ type Project struct

+ DepsRepo string

+ InstallCommand string

+ InstallCommandArgs []string

+ InstallCommandName string

+ IsRecursiveScan bool

+ PathExclusions []string

+ PipRequirementsFile string

+ UseWrapper *bool

+ WorkingDirs []string

+ type RepoAggregator []Repository

+ func BuildRepoAggregator(configFileContent []byte, gitParamsFromEnv *Git, ...) (resultAggregator RepoAggregator, err error)

+ type Repository struct

+ OutputWriter outputwriter.OutputWriter

+ Server coreconfig.ServerDetails

+ type ReviewComment struct

+ CommentInfo vcsclient.PullRequestComment

+ Location formats.Location

+ Type ReviewCommentType

+ type ReviewCommentType string

+ const ApplicableComment

+ const IacComment

+ const RescanRequestComment

+ const SastComment

+ type Scan struct

+ AllowedLicenses []string

+ AvoidPreviousPrCommentsDeletion bool

+ FailOnSecurityIssues *bool

+ FixableOnly bool

+ IncludeAllVulnerabilities bool

+ MinSeverity string

+ Projects []Project

+ func (s *Scan) SetEmailDetails() error

+ type ScanDetails struct

+ func NewScanDetails(client vcsclient.VcsClient, server *config.ServerDetails, git *Git) *ScanDetails

+ func (sc *ScanDetails) BaseBranch() string

+ func (sc *ScanDetails) Client() vcsclient.VcsClient

+ func (sc *ScanDetails) FailOnInstallationErrors() bool

+ func (sc *ScanDetails) FixableOnly() bool

+ func (sc *ScanDetails) MinSeverityFilter() string

+ func (sc *ScanDetails) RunInstallAndAudit(workDirs ...string) (auditResults *xrayutils.Results, err error)

+ func (sc *ScanDetails) SetBaseBranch(branch string) *ScanDetails

+ func (sc *ScanDetails) SetFailOnInstallationErrors(toFail bool) *ScanDetails

+ func (sc *ScanDetails) SetFixableOnly(fixable bool) *ScanDetails

+ func (sc *ScanDetails) SetMinSeverity(minSeverity string) *ScanDetails

+ func (sc *ScanDetails) SetProject(project *Project) *ScanDetails

+ func (sc *ScanDetails) SetRepoName(repoName string) *ScanDetails

+ func (sc *ScanDetails) SetRepoOwner(owner string) *ScanDetails

+ func (sc *ScanDetails) SetXrayGraphScanParams(watches []string, jfrogProjectKey string, includeLicenses bool) *ScanDetails

+ func (sc *ScanDetails) SetXscGitInfoContext(scannedBranch, gitProject string, client vcsclient.VcsClient) *ScanDetails

+ type SecretsEmailDetails struct

+ func NewSecretsEmailDetails(gitClient vcsclient.VcsClient, repoConfig *Repository, ...) *SecretsEmailDetails

+ type UnsupportedErrorType string

+ const BuildToolsDependencyFixNotSupported

+ const IndirectDependencyFixNotSupported

+ const UnsupportedForFixVulnerableVersion

+ type UrlAccessChecker struct

+ func CheckConnection(url string) *UrlAccessChecker

+ func MockHasConnection() *UrlAccessChecker

+ func (ic *UrlAccessChecker) IsConnected() bool

+ type VulnerabilityDetails struct

+ Cves []string

+ IsDirectDependency bool

+ SuggestedFixedVersion string

+ func NewVulnerabilityDetails(vulnerability formats.VulnerabilityOrViolationRow, fixVersion string) *VulnerabilityDetails

+ func (vd *VulnerabilityDetails) SetCves(cves []formats.CveRow)

+ func (vd *VulnerabilityDetails) SetIsDirectDependency(isDirectDependency bool)

+ func (vd *VulnerabilityDetails) UpdateFixVersionIfMax(fixVersion string)