Skip to content

Commit

Permalink
Merge branch 'dev'
Browse files Browse the repository at this point in the history
  • Loading branch information
@eyalb4doc
eyalb4doc committed Dec 25, 2024
2 parents fe9e5dd + 42a4c4d commit 0cfeaaf
Show file tree
Hide file tree
Showing 20 changed files with 347 additions and 135 deletions.
11 changes: 6 additions & 5 deletions artifactory/commands/npm/npmcommand.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,11 @@ import (
"bufio"
"errors"
"fmt"
"os"
"path/filepath"
"strconv"
"strings"

"github.com/jfrog/build-info-go/build"
biUtils "github.com/jfrog/build-info-go/build/utils"
"github.com/jfrog/gofrog/version"
Expand All @@ -18,10 +23,6 @@ import (
"github.com/jfrog/jfrog-client-go/utils/errorutils"
"github.com/jfrog/jfrog-client-go/utils/log"
"github.com/spf13/viper"
"os"
"path/filepath"
"strconv"
"strings"
)

const (
Expand All @@ -31,7 +32,7 @@ const (

// Scoped authentication env var that sets the _auth or _authToken npm config variables.
npmConfigAuthEnv = "npm_config_%s:%s"
npmVersionSupportingScopedAuthEnv = "9.3.1"
npmVersionSupportingScopedAuthEnv = "9.2.0"
// Legacy un-scoped auth env vars doesn't support access tokens (with _authToken suffix).
npmLegacyConfigAuthEnv = "npm_config__auth"
)
Expand Down
2 changes: 1 addition & 1 deletion artifactory/commands/transferfiles/transfer.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ func (tdc *TransferFilesCommand) reportTransferFilesUsage() {
AttributeValue: sourceStorageInfo.BinariesSize,
},
}
if err = usage.NewArtifactoryCallHome().SendUsage(coreutils.GetCliUserAgent(), tdc.CommandName(), tdc.targetStorageInfoManager.GetServiceManager(), reportUsageAttributes...); err != nil {
if err = usage.NewArtifactoryCallHome().Send(coreutils.GetCliUserAgent(), tdc.CommandName(), tdc.targetStorageInfoManager.GetServiceManager(), reportUsageAttributes...); err != nil {
log.Debug(err.Error())
}
}
Expand Down
133 changes: 92 additions & 41 deletions artifactory/utils/commandsummary/buildinfosummary.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,14 @@ package commandsummary

import (
"fmt"
"net/url"
"path"
"strings"

buildInfo "github.com/jfrog/build-info-go/entities"
"github.com/jfrog/jfrog-cli-core/v2/artifactory/utils"
"github.com/jfrog/jfrog-cli-core/v2/artifactory/utils/container"
"github.com/jfrog/jfrog-client-go/utils/log"
"net/url"
"path"
"strings"
)

const (
Expand Down Expand Up @@ -62,8 +63,14 @@ func (bis *BuildInfoSummary) GenerateMarkdownFromFiles(dataFilePaths []string) (
return
}

buildInfoTableMarkdown := bis.buildInfoTable(builds)
publishedModulesMarkdown := bis.buildInfoModules(builds)
buildInfoTableMarkdown, err := bis.buildInfoTable(builds)
if err != nil {
return "", err
}
publishedModulesMarkdown, err := bis.buildInfoModules(builds)
if err != nil {
return "", err
}
if publishedModulesMarkdown != "" {
publishedModulesMarkdown = WrapCollapsableMarkdown(modulesTitle, publishedModulesMarkdown, 2)
}
Expand All @@ -73,61 +80,75 @@ func (bis *BuildInfoSummary) GenerateMarkdownFromFiles(dataFilePaths []string) (
}

// Create a table with published builds and possible scan results.
func (bis *BuildInfoSummary) buildInfoTable(builds []*buildInfo.BuildInfo) string {
func (bis *BuildInfoSummary) buildInfoTable(builds []*buildInfo.BuildInfo) (string, error) {
var tableBuilder strings.Builder
tableBuilder.WriteString(getBuildInfoTableHeader())
for _, build := range builds {
appendBuildInfoRow(&tableBuilder, build)
if err := appendBuildInfoRow(&tableBuilder, build); err != nil {
return "", err
}
}
tableBuilder.WriteString("\n\n")
return tableBuilder.String()
return tableBuilder.String(), nil
}

// Generates a view for published modules within the build.
// Modules are displayed as tables if they are scannable via CLI command,
// otherwise, they are shown as an artifact tree.
func (bis *BuildInfoSummary) buildInfoModules(builds []*buildInfo.BuildInfo) string {
func (bis *BuildInfoSummary) buildInfoModules(builds []*buildInfo.BuildInfo) (string, error) {
var markdownBuilder strings.Builder
markdownBuilder.WriteString("\n\n<h3>Published Modules</h3>\n\n")
var shouldGenerate bool
for _, build := range builds {
supportedModules := filterModules(build.Modules...)
if modulesMarkdown := bis.generateModulesMarkdown(supportedModules...); modulesMarkdown != "" {
modulesMarkdown, err := bis.generateModulesMarkdown(supportedModules...)
if err != nil {
return "", err
}
if modulesMarkdown != "" {
markdownBuilder.WriteString(modulesMarkdown)
shouldGenerate = true
}
}
if !shouldGenerate {
return ""
return "", nil
}
return markdownBuilder.String()
return markdownBuilder.String(), nil
}

func (bis *BuildInfoSummary) generateModulesMarkdown(modules ...buildInfo.Module) string {
func (bis *BuildInfoSummary) generateModulesMarkdown(modules ...buildInfo.Module) (string, error) {
var modulesMarkdown strings.Builder
// Modules could include nested modules inside of them
// Group the modules by their root module ID
// If a module has no root, it is considered as a root module itself.
groupedModuleMap := groupModules(modules)
if len(groupedModuleMap) == 0 {
return ""
return "", nil
}
for rootModuleID, subModules := range groupedModuleMap {
if len(subModules) == 0 {
continue
}
if !scannableModuleType[subModules[0].Type] {
modulesMarkdown.WriteString(bis.generateModuleArtifactTree(rootModuleID, subModules))
tree, err := bis.generateModuleArtifactTree(rootModuleID, subModules)
if err != nil {
return "", err
}
modulesMarkdown.WriteString(tree)
} else {
modulesMarkdown.WriteString(bis.generateModuleTableView(rootModuleID, subModules))
view, err := bis.generateModuleTableView(rootModuleID, subModules)
if err != nil {
return "", err
}
modulesMarkdown.WriteString(view)
}
}
return modulesMarkdown.String()
return modulesMarkdown.String(), nil
}

func (bis *BuildInfoSummary) generateModuleArtifactTree(rootModuleID string, nestedModules []buildInfo.Module) string {
func (bis *BuildInfoSummary) generateModuleArtifactTree(rootModuleID string, nestedModules []buildInfo.Module) (string, error) {
if len(nestedModules) == 0 {
return ""
return "", nil
}
var markdownBuilder strings.Builder
isMultiModule := len(nestedModules) > 1
Expand All @@ -140,26 +161,33 @@ func (bis *BuildInfoSummary) generateModuleArtifactTree(rootModuleID string, nes
if isMultiModule && rootModuleID == module.Id {
continue
}
markdownBuilder.WriteString(fmt.Sprintf("\n\n<pre>%s</pre>\n\n", bis.generateModuleArtifactsTree(&module, isMultiModule)))
tree, err := bis.generateModuleArtifactsTree(&module, isMultiModule)
if err != nil {
return "", err
}
markdownBuilder.WriteString(fmt.Sprintf("\n\n<pre>%s</pre>\n\n", tree))
}
return markdownBuilder.String()
return markdownBuilder.String(), nil
}

func (bis *BuildInfoSummary) generateModuleTableView(rootModuleID string, subModules []buildInfo.Module) string {
func (bis *BuildInfoSummary) generateModuleTableView(rootModuleID string, subModules []buildInfo.Module) (string, error) {
var markdownBuilder strings.Builder
markdownBuilder.WriteString(generateModuleHeader(rootModuleID))
markdownBuilder.WriteString(generateModuleTableHeader())
isMultiModule := len(subModules) > 1
nestedModuleMarkdownTree := bis.generateTableModuleMarkdown(subModules, rootModuleID, isMultiModule)
nestedModuleMarkdownTree, err := bis.generateTableModuleMarkdown(subModules, rootModuleID, isMultiModule)
if err != nil {
return "", err
}
scanResult := getScanResults(extractDockerImageTag(subModules))
markdownBuilder.WriteString(generateTableRow(nestedModuleMarkdownTree, scanResult))
return markdownBuilder.String()
return markdownBuilder.String(), nil
}

func (bis *BuildInfoSummary) generateTableModuleMarkdown(nestedModules []buildInfo.Module, parentModuleID string, isMultiModule bool) string {
func (bis *BuildInfoSummary) generateTableModuleMarkdown(nestedModules []buildInfo.Module, parentModuleID string, isMultiModule bool) (string, error) {
var nestedModuleMarkdownTree strings.Builder
if len(nestedModules) == 0 {
return ""
return "", nil
}

if !StaticMarkdownConfig.IsExtendedSummary() {
Expand All @@ -174,19 +202,26 @@ func (bis *BuildInfoSummary) generateTableModuleMarkdown(nestedModules []buildIn
if isMultiModule && parentModuleID == module.Id {
continue
}
nestedModuleMarkdownTree.WriteString(bis.generateModuleArtifactsTree(&module, isMultiModule))
tree, err := bis.generateModuleArtifactsTree(&module, isMultiModule)
if err != nil {
return "", err
}
nestedModuleMarkdownTree.WriteString(tree)
}
nestedModuleMarkdownTree.WriteString(appendSpacesToTableColumn(""))
nestedModuleMarkdownTree.WriteString("</pre>")
return nestedModuleMarkdownTree.String()
return nestedModuleMarkdownTree.String(), nil
}

func (bis *BuildInfoSummary) generateModuleArtifactsTree(module *buildInfo.Module, shouldCollapseArtifactsTree bool) string {
artifactsTree := bis.createArtifactsTree(module)
func (bis *BuildInfoSummary) generateModuleArtifactsTree(module *buildInfo.Module, shouldCollapseArtifactsTree bool) (string, error) {
artifactsTree, err := bis.createArtifactsTree(module)
if err != nil {
return "", err
}
if shouldCollapseArtifactsTree {
return bis.generateModuleCollapsibleSection(module, artifactsTree)
return bis.generateModuleCollapsibleSection(module, artifactsTree), nil
}
return artifactsTree
return artifactsTree, nil
}

func (bis *BuildInfoSummary) generateModuleCollapsibleSection(module *buildInfo.Module, sectionContent string) string {
Expand All @@ -198,30 +233,41 @@ func (bis *BuildInfoSummary) generateModuleCollapsibleSection(module *buildInfo.
}
}

func (bis *BuildInfoSummary) createArtifactsTree(module *buildInfo.Module) string {
func (bis *BuildInfoSummary) createArtifactsTree(module *buildInfo.Module) (string, error) {
artifactsTree := utils.NewFileTree()
for _, artifact := range module.Artifacts {
var artifactUrlInArtifactory string
var err error
if StaticMarkdownConfig.IsExtendedSummary() {
artifactUrlInArtifactory = generateArtifactUrl(artifact)
artifactUrlInArtifactory, err = generateArtifactUrl(artifact, *module)
if err != nil {
return "", err
}
}
if artifact.OriginalDeploymentRepo == "" {
artifact.OriginalDeploymentRepo = " "
}
artifactTreePath := path.Join(artifact.OriginalDeploymentRepo, artifact.Path)
artifactsTree.AddFile(artifactTreePath, artifactUrlInArtifactory)
if artifactsTree.IsTreeExceedsMax() {
return ""
return "", nil
}
}
return artifactsTree.String()
return artifactsTree.String(), nil
}

func generateArtifactUrl(artifact buildInfo.Artifact) string {
func generateArtifactUrl(artifact buildInfo.Artifact, module buildInfo.Module) (string, error) {
if strings.TrimSpace(artifact.OriginalDeploymentRepo) == "" {
return ""
return "", nil
}
var section summarySection

if module.Type == buildInfo.Generic {
section = artifactsSection
} else {
section = packagesSection
}
return GenerateArtifactUrl(path.Join(artifact.OriginalDeploymentRepo, artifact.Path))
return GenerateArtifactUrl(path.Join(artifact.OriginalDeploymentRepo, artifact.Path), section)
}

func groupModules(modules []buildInfo.Module) map[string][]buildInfo.Module {
Expand Down Expand Up @@ -280,16 +326,21 @@ func appendSpacesToTableColumn(str string) string {
return str
}

func appendBuildInfoRow(tableBuilder *strings.Builder, build *buildInfo.BuildInfo) {
func appendBuildInfoRow(tableBuilder *strings.Builder, build *buildInfo.BuildInfo) error {
buildName := build.Name + " " + build.Number
buildScanResult := getScanResults(buildName)
if StaticMarkdownConfig.IsExtendedSummary() {
tableBuilder.WriteString(fmt.Sprintf("| [%s](%s) %s | %s | %s | \n", buildName, build.BuildUrl, appendSpacesToTableColumn(""), appendSpacesToTableColumn(buildScanResult.GetViolations()), appendSpacesToTableColumn(buildScanResult.GetVulnerabilities())))
buildInfoUrl, err := addGitHubTrackingToUrl(build.BuildUrl, buildInfoSection)
if err != nil {
return err
}
tableBuilder.WriteString(fmt.Sprintf("| [%s](%s) %s | %s | %s | \n", buildName, buildInfoUrl, appendSpacesToTableColumn(""), appendSpacesToTableColumn(buildScanResult.GetViolations()), appendSpacesToTableColumn(buildScanResult.GetVulnerabilities())))
} else {
upgradeMessage := fmt.Sprintf(basicSummaryUpgradeNotice, StaticMarkdownConfig.GetExtendedSummaryLangPage())
buildName = fmt.Sprintf(" %s %s", upgradeMessage, buildName)
tableBuilder.WriteString(fmt.Sprintf("| %s %s | %s | %s |\n", fitInsideMarkdownTable(buildName), appendSpacesToTableColumn(""), appendSpacesToTableColumn(buildScanResult.GetViolations()), appendSpacesToTableColumn(buildScanResult.GetVulnerabilities())))
}
return nil
}

func getBuildInfoTableHeader() string {
Expand Down
Loading

0 comments on commit 0cfeaaf

Please sign in to comment.