utils

package

Go to main page

Versions in this module

v3

v3.5.0

Aug 17, 2026

Changes in this version

+ const GitHubActionsEnv

+ const GitHubWorkflowRefEnv

type ScanDetails

+ func (sc *ScanDetails) SetRiskyTechEnvironmentGuard(guard func(detectedTechnologies []techutils.Technology) error) *ScanDetails

v3.4.2

Aug 14, 2026

v3.4.1

Aug 12, 2026

Changes in this version

+ func CreateSyntheticHeadCommit(repoPath string) error

v3.4.0

Aug 6, 2026

Changes in this version

+ const GitWorkspaceEnv

+ const UploadPrSecurityResultsToVcsEnv

+ func UploadPrSarifToGithubSecurityTab(scanResults *results.SecurityCommandResults, repo *Repository, prId int64, ...) error

+ func UploadRepoSarifResultsToGithubSecurityTab(scanResults *results.SecurityCommandResults, repo *Repository, branch string, ...) error

type Git

+ UploadPrSecurityResultsToVcs bool

+ Workspace string

v3.3.2

Jul 22, 2026

v3.3.1

Jul 9, 2026

v3.3.0

Jul 6, 2026

Changes in this version

+ func PrintScanResultsTable(scanResults *results.SecurityCommandResults)

v3.2.2

Jun 21, 2026

v3.2.1

Jun 4, 2026

v3.2.0

May 28, 2026

Changes in this version

+ const AggregatePullRequestTitleDefaultTemplate

+ const AggregatedBranchNameTemplate

+ const AzureRepos

+ const BitbucketCloud

+ const BitbucketServer

+ const BranchHashPlaceHolder

+ const BranchNameTemplate

+ const CommitMessageTemplate

+ const FixVersionPlaceHolder

+ const GitApiEndpointEnv

+ const GitAzureProjectEnv

+ const GitBaseBranchEnv

+ const GitBitBucketUsernameEnv

+ const GitDependencyGraphSubmissionEnv

+ const GitHub

+ const GitLab

+ const GitProvider

+ const GitPullRequestIDEnv

+ const GitRepoEnv

+ const GitRepoOwnerEnv

+ const GitTokenEnv

+ const GitlabScanResultsOutputDirEnv

+ const InvalidModulesConfigProfile

+ const InvalidPathConfigProfile

+ const JFrogPasswordEnv

+ const JFrogTokenEnv

+ const JFrogUrlEnv

+ const JFrogUserEnv

+ const JfrogHomeDirEnv

+ const MaxConcurrentScanners

+ const NonExistingProfile

+ const PackagePlaceHolder

+ const PullRequestTitleTemplate

+ const RootDir

+ const ScanPullRequest

+ const ScanRepository

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

+ var FrogbotVersion = "0.0.0"

+ 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 *issues.ScansIssuesCollection, workingDirs ...string)

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

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

+ func CreateErrorIfFailUponScannerErrorEnabled(fail bool, messageForLog string, err error) error

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

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

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

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

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

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

+ func DeletePullRequestComments(repo *Repository, client vcsclient.VcsClient, pullRequestID int) (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, ...) (description string, extraComments []string)

+ func GenerateFrogbotSarifReport(extendedResults *results.SecurityCommandResults) (string, bool, error)

+ func GetFullBranchName(branchName string) plumbing.ReferenceName

+ 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 *issues.ScansIssuesCollection, resultContext results.ResultContext, ...) (err error)

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

+ func IsFileTrackedByGit(filePath, repoRootDir string) (bool, error)

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

+ 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 *results.SecurityCommandResults, repo *Repository, branch string, ...) error

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

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

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

+ func WriteScanResultsToGitlabDir(outputDir string, scanResults *results.SecurityCommandResults, ...) error

+ type CustomTemplates struct

+ func LoadCustomTemplates(commitMessageTemplate, branchNameTemplate, pullRequestTitleTemplate string) (customTemplates CustomTemplates, err error)

+ type ErrMissingEnv struct

+ VariableName string

+ func (e *ErrMissingEnv) Error() string

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

+ type ErrNothingToCommit struct

+ PackageName string

+ func (err *ErrNothingToCommit) Error() string

+ type ErrUnsupportedFix struct

+ ErrorType UnsupportedErrorType

+ FixedVersion string

+ PackageName string

+ func (err *ErrUnsupportedFix) Error() string

+ type FrogbotDetails struct

+ GitClient vcsclient.VcsClient

+ ReleasesRepo string

+ Repository Repository

+ ServerDetails *coreconfig.ServerDetails

+ XrayVersion string

+ XscVersion string

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

+ type Git struct

+ Branches []string

+ GitProvider vcsutils.VcsProvider

+ GitlabScanResultsOutputDir string

+ PullRequestDetails vcsclient.PullRequestInfo

+ RepoName string

+ RepoOwner string

+ RepositoryCloneUrl string

+ UploadSbomToVcs *bool

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

+ type GitManager struct

+ SkipClone bool

+ func NewGitManager() *GitManager

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

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

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

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

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

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

+ func (gm *GitManager) Fetch() error

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

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

+ func (gm *GitManager) GenerateAggregatedPullRequestTitle(tech []techutils.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) GetAuth() *githttp.BasicAuth

+ func (gm *GitManager) GetRemoteGitUrl() string

+ func (gm *GitManager) GetRemoteName() 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) SetCurrentWdAsLocalGitRepository() error

+ func (gm *GitManager) SetCustomTemplates(customTemplates CustomTemplates) *GitManager

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

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

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

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

+ type JFrogPlatform struct

+ JFrogProjectKey string

+ XrayVersion string

+ XscVersion string

+ type Params struct

+ type Repository struct

+ OutputWriter outputwriter.OutputWriter

+ Server coreconfig.ServerDetails

+ func BuildRepositoryFromEnv(xrayVersion, xscVersion string, gitClient vcsclient.VcsClient, ...) (repository Repository, err error)

+ type ReviewComment struct

+ CommentInfo vcsclient.PullRequestComment

+ Location formats.Location

+ Type ReviewCommentType

+ type ReviewCommentType string

+ const ApplicableComment

+ const IacComment

+ const SastComment

+ const SecretComment

+ const SnippetComment

+ type ScanDetails struct

+ ConfigProfile *xscservices.ConfigProfile

+ MultiScanId string

+ ResultsToCompare *results.SecurityCommandResults

+ StartTime time.Time

+ XrayVersion string

+ XscVersion string

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

+ func (sc *ScanDetails) Audit(baseDir string) (auditResults *results.SecurityCommandResults)

+ func (sc *ScanDetails) BaseBranch() string

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

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

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

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

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

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

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

+ func (sc *ScanDetails) SetResultsContext(httpCloneUrl string, jfrogProjectKey string, includeVulnerabilities bool) *ScanDetails

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

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

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

+ type UnsupportedErrorType string

+ const BuildToolsDependencyFixNotSupported

+ const IndirectDependencyFixNotSupported

+ const UnsupportedForFixVulnerableVersion

+ type UrlAccessChecker struct

+ func CheckConnection(url string) *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)

Other modules containing this package

github.com/jfrog/frogbot/v2

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