Merge branch 'main' into fix/npm-publish-nil-pointer-dereference

Author: reshmifrog

artifactory/commands/flexpack/gradle/gradle.go

@@ -0,0 +1,398 @@
+package flexpack
+
+import (
+	"encoding/json"
+	"fmt"
+	"io"
+	"os"
+	"path/filepath"
+	"strconv"
+	"strings"
+	"time"
+
+	"github.com/jfrog/build-info-go/build"
+	"github.com/jfrog/build-info-go/entities"
+	"github.com/jfrog/build-info-go/flexpack"
+	gradle "github.com/jfrog/build-info-go/flexpack/gradle"
+	"github.com/jfrog/jfrog-cli-core/v2/artifactory/utils"
+	buildUtils "github.com/jfrog/jfrog-cli-core/v2/common/build"
+	"github.com/jfrog/jfrog-cli-core/v2/utils/config"
+	"github.com/jfrog/jfrog-client-go/artifactory"
+	"github.com/jfrog/jfrog-client-go/artifactory/services"
+	servicesutils "github.com/jfrog/jfrog-client-go/artifactory/services/utils"
+	"github.com/jfrog/jfrog-client-go/utils/io/content"
+	"github.com/jfrog/jfrog-client-go/utils/log"
+)
+
+func CollectGradleBuildInfoWithFlexPack(workingDir, buildName, buildNumber string, tasks []string, buildConfiguration *buildUtils.BuildConfiguration, serverDetails *config.ServerDetails) error {
+	if workingDir == "" {
+		return fmt.Errorf("working directory is required")
+	}
+	if buildName == "" || buildNumber == "" {
+		return fmt.Errorf("build name and build number are required")
+	}
+
+	absWorkingDir, err := filepath.Abs(workingDir)
+	if err != nil {
+		return fmt.Errorf("failed to resolve absolute path for working directory")
+	}
+	workingDir = absWorkingDir
+	config := flexpack.GradleConfig{
+		WorkingDirectory:        workingDir,
+		IncludeTestDependencies: true,
+	}
+
+	gradleFlex, err := gradle.NewGradleFlexPack(config)
+	if err != nil {
+		log.Debug("failed to create Gradle FlexPack: " + err.Error())
+		return fmt.Errorf("could not initialize Gradle FlexPack")
+	}
+
+	isPublishCommand := wasPublishCommand(tasks)
+	gradleFlex.SetWasPublishCommand(isPublishCommand)
+
+	buildInfo, err := gradleFlex.CollectBuildInfo(buildName, buildNumber)
+	if err != nil {
+		return fmt.Errorf("failed to collect build info with FlexPack")
+	}
+
+	projectKey := ""
+	if buildConfiguration != nil {
+		projectKey = buildConfiguration.GetProject()
+	}
+
+	if err := saveGradleFlexPackBuildInfo(buildInfo, projectKey); err != nil {
+		return fmt.Errorf("failed to save build info for jfrog-cli compatibility")
+	} else {
+		log.Info("Build info saved locally. Use 'jf rt bp " + buildName + " " + buildNumber + "' to publish it to Artifactory.")
+	}
+
+	if isPublishCommand {
+		if err := setGradleBuildPropertiesOnArtifacts(workingDir, buildName, buildNumber, projectKey, buildInfo, serverDetails); err != nil {
+			log.Warn("Failed to set build properties on deployed artifacts")
+		}
+	}
+	log.Info("Gradle build completed successfully")
+	return nil
+}
+
+func wasPublishCommand(tasks []string) bool {
+	for _, task := range tasks {
+		// Handle tasks with project paths (e.g., ":subproject:publish")
+		if idx := strings.LastIndex(task, ":"); idx != -1 {
+			task = task[idx+1:]
+		}
+		if task == gradleTaskPublish {
+			return true
+		}
+
+		if strings.HasPrefix(task, gradleTaskPublish) {
+			toIdx := strings.Index(task, "To")
+			if toIdx != -1 {
+				afterTo := task[toIdx+2:]
+				// Exclude local publishing tasks like "publishToMavenLocal" or "publishAllPublicationsToLocal"
+				if len(afterTo) > 0 && !strings.HasSuffix(task, "Local") {
+					return true
+				}
+			}
+		}
+	}
+	return false
+}
+
+func saveGradleFlexPackBuildInfo(buildInfo *entities.BuildInfo, projectKey string) error {
+	service := build.NewBuildInfoService()
+	// Pass the project key to organize build info under the correct project (same as non-FlexPack flow)
+	buildInstance, err := service.GetOrCreateBuildWithProject(buildInfo.Name, buildInfo.Number, projectKey)
+	if err != nil {
+		return fmt.Errorf("failed to create build: %w", err)
+	}
+	return buildInstance.SaveBuildInfo(buildInfo)
+}
+
+func setGradleBuildPropertiesOnArtifacts(workingDir, buildName, buildNumber, projectKey string, buildInfo *entities.BuildInfo, serverDetails *config.ServerDetails) error {
+	if serverDetails == nil {
+		log.Warn("No server details configured, skipping build properties")
+		return nil
+	}
+
+	servicesManager, err := utils.CreateServiceManager(serverDetails, -1, 0, false)
+	if err != nil {
+		return fmt.Errorf("failed to create services manager: %w", err)
+	}
+
+	artifacts := collectArtifactsFromBuildInfo(buildInfo, workingDir)
+	if len(artifacts) == 0 {
+		log.Warn("No artifacts found to set build properties")
+		return nil
+	}
+
+	artifacts = resolveArtifactsByChecksum(servicesManager, artifacts)
+	buildProps, err := buildUtils.CreateBuildProperties(buildName, buildNumber, projectKey)
+	if err != nil {
+		// Fallback to manual creation if CreateBuildProperties fails
+		log.Debug(fmt.Sprintf("CreateBuildProperties failed, using fallback: %s", err.Error()))
+		timestamp := strconv.FormatInt(time.Now().UnixNano()/int64(time.Millisecond), 10)
+		buildProps = fmt.Sprintf("build.name=%s;build.number=%s;build.timestamp=%s", buildName, buildNumber, timestamp)
+	}
+
+	if projectKey != "" {
+		buildProps += fmt.Sprintf(";build.project=%s", projectKey)
+	}
+
+	writer, err := content.NewContentWriter(content.DefaultKey, true, false)
+	if err != nil {
+		return fmt.Errorf("failed to create content writer: %w", err)
+	}
+
+	// Write all artifacts to the writer
+	for _, art := range artifacts {
+		writer.Write(art)
+	}
+
+	if closeErr := writer.Close(); closeErr != nil {
+		// Clean up temp file on error
+		if writerFilePath := writer.GetFilePath(); writerFilePath != "" {
+			if removeErr := os.Remove(writerFilePath); removeErr != nil {
+				log.Debug(fmt.Sprintf("Failed to remove temp file after write error: %s", removeErr))
+			}
+		}
+		return fmt.Errorf("failed to close content writer: %w", closeErr)
+	}
+	writerFilePath := writer.GetFilePath()
+	defer func() {
+		if writerFilePath != "" {
+			if removeErr := os.Remove(writerFilePath); removeErr != nil {
+				log.Debug(fmt.Sprintf("Failed to remove temp file: %s", removeErr))
+			}
+		}
+	}()
+
+	reader := content.NewContentReader(writerFilePath, content.DefaultKey)
+	defer func() {
+		if closeErr := reader.Close(); closeErr != nil {
+			log.Debug(fmt.Sprintf("Failed to close reader: %s", closeErr))
+		}
+	}()
+
+	propsParams := services.PropsParams{
+		Reader: reader,
+		Props:  buildProps,
+	}
+
+	if _, err = servicesManager.SetProps(propsParams); err != nil {
+		return fmt.Errorf("failed to set properties on artifacts: %w", err)
+	}
+
+	log.Info("Successfully set build properties on deployed Gradle artifacts")
+	return nil
+}
+
+func collectArtifactsFromBuildInfo(buildInfo *entities.BuildInfo, workingDir string) []servicesutils.ResultItem {
+	// Always return empty slice instead of nil for consistent behavior
+	if buildInfo == nil {
+		return []servicesutils.ResultItem{}
+	}
+	result := make([]servicesutils.ResultItem, 0)
+
+	// Cache per (module dir, version) to avoid repeated lookups and wrong reuse.
+	moduleRepoCache := make(map[string]string)
+
+	for _, module := range buildInfo.Modules {
+		// Resolve repo once per module (OriginalDeploymentRepo is not populated for Gradle FlexPack).
+		repo := resolveRepoForModule(module, workingDir, moduleRepoCache)
+		if repo == "" {
+			continue
+		}
+
+		for _, art := range module.Artifacts {
+			if art.Name == "" {
+				continue
+			}
+
+			itemPath := art.Path
+			if strings.HasSuffix(itemPath, "/"+art.Name) {
+				itemPath = strings.TrimSuffix(itemPath, "/"+art.Name)
+			}
+			result = append(result, servicesutils.ResultItem{
+				Repo:   repo,
+				Path:   itemPath,
+				Name:   art.Name,
+				Sha256: art.Sha256,
+			})
+		}
+	}
+	return result
+}
+
+func resolveArtifactsByChecksum(servicesManager artifactory.ArtifactoryServicesManager, artifacts []servicesutils.ResultItem) []servicesutils.ResultItem {
+	if servicesManager == nil || len(artifacts) == 0 {
+		return artifacts
+	}
+
+	cache := make(map[string][]servicesutils.ResultItem)
+	resolved := make([]servicesutils.ResultItem, 0, len(artifacts))
+
+	for _, art := range artifacts {
+		if art.Sha256 == "" {
+			resolved = append(resolved, art)
+			continue
+		}
+
+		if cached, ok := cache[art.Sha256]; ok {
+			if len(cached) == 0 {
+				resolved = append(resolved, art)
+			} else {
+				resolved = append(resolved, cached...)
+			}
+			continue
+		}
+
+		results, err := searchArtifactsBySha256(servicesManager, art.Sha256, art.Repo, art.Path)
+		if err != nil {
+			log.Debug(fmt.Sprintf("Checksum AQL search failed for %s/%s/%s: %s", art.Repo, art.Path, art.Name, err))
+			cache[art.Sha256] = nil
+			resolved = append(resolved, art)
+			continue
+		}
+		if len(results) == 0 {
+			cache[art.Sha256] = nil
+			resolved = append(resolved, art)
+			continue
+		}
+
+		cache[art.Sha256] = results
+		resolved = append(resolved, results...)
+	}
+	return resolved
+}
+
+func searchArtifactsBySha256(servicesManager artifactory.ArtifactoryServicesManager, sha256, repo, pathHint string) ([]servicesutils.ResultItem, error) {
+	if sha256 == "" {
+		return []servicesutils.ResultItem{}, nil
+	}
+
+	criteria := []string{fmt.Sprintf(`"sha256": { "$eq": "%s" }`, sha256)}
+	if repo != "" {
+		criteria = append(criteria, fmt.Sprintf(`"repo": { "$eq": "%s" }`, repo))
+	}
+	if pathHint != "" {
+		criteria = append(criteria, fmt.Sprintf(`"path": { "$match": "%s*" }`, strings.TrimSuffix(pathHint, "/")))
+	}
+
+	aql := fmt.Sprintf(`items.find({ %s }).include("name", "repo", "path", "sha256", "type", "modified", "size")`, strings.Join(criteria, ", "))
+
+	reader, err := servicesManager.Aql(aql)
+	if err != nil {
+		return nil, err
+	}
+	defer func() {
+		if reader != nil {
+			_ = reader.Close()
+		}
+	}()
+
+	raw, err := io.ReadAll(reader)
+	if err != nil {
+		return nil, err
+	}
+
+	var parsed servicesutils.AqlSearchResult
+	if err := json.Unmarshal(raw, &parsed); err != nil {
+		return nil, err
+	}
+
+	if parsed.Results == nil {
+		return []servicesutils.ResultItem{}, nil
+	}
+	return parsed.Results, nil
+}
+
+func resolveRepoForModule(module entities.Module, workingDir string, moduleRepoCache map[string]string) string {
+	version := inferModuleVersion(module.Id)
+	moduleWorkingDir := resolveModuleDir(module, workingDir)
+
+	cacheKey := fmt.Sprintf("%s|%s", moduleWorkingDir, version)
+	rootCacheKey := fmt.Sprintf("%s|%s", workingDir, version)
+
+	if cached, ok := moduleRepoCache[cacheKey]; ok {
+		return cached
+	}
+
+	repo, err := getGradleDeployRepository(moduleWorkingDir, workingDir, version)
+	if err != nil && moduleWorkingDir != workingDir {
+		log.Debug(fmt.Sprintf("Repo not found in module dir %s, trying root: %v", moduleWorkingDir, err))
+		if cached, ok := moduleRepoCache[rootCacheKey]; ok && cached != "" {
+			moduleRepoCache[cacheKey] = cached
+			return cached
+		}
+		repo, err = getGradleDeployRepository(workingDir, workingDir, version)
+		if err == nil {
+			moduleRepoCache[rootCacheKey] = repo
+		}
+	}
+	if err != nil {
+		log.Warn("failed to resolve Gradle deploy repository for module " + module.Id)
+	}
+	if repo == "" {
+		log.Warn("Gradle deploy repository not found for module " + module.Id + ", skipping artifacts without repo")
+	}
+	moduleRepoCache[cacheKey] = repo
+	return repo
+}
+
+func inferModuleVersion(id string) string {
+	if parts := strings.Split(id, ":"); len(parts) >= 3 {
+		return parts[len(parts)-1]
+	}
+	return ""
+}
+
+func resolveModuleDir(module entities.Module, workingDir string) string {
+	moduleDir := workingDir
+
+	if moduleName := extractModuleName(module.Properties); moduleName != "" {
+		relPath := strings.ReplaceAll(moduleName, ":", string(filepath.Separator))
+		candidate := filepath.Join(workingDir, relPath)
+		cleanCandidate := filepath.Clean(candidate)
+
+		if rel, err := filepath.Rel(workingDir, cleanCandidate); err == nil && rel != ".." && !strings.HasPrefix(rel, ".."+string(filepath.Separator)) {
+			if stat, err := os.Stat(cleanCandidate); err == nil && stat.IsDir() {
+				return cleanCandidate
+			}
+			log.Debug(fmt.Sprintf("Module directory %s from moduleName '%s' not found, using root %s", cleanCandidate, moduleName, workingDir))
+		} else {
+			log.Debug(fmt.Sprintf("Ignoring moduleName '%s' due to path traversal, using root %s", moduleName, workingDir))
+		}
+	}
+	return moduleDir
+}
+
+func extractModuleName(props interface{}) string {
+	switch val := props.(type) {
+	case map[string]string:
+		return val["moduleName"]
+	case map[string]interface{}:
+		if name, ok := val["moduleName"]; ok {
+			if nameStr, ok := name.(string); ok {
+				return nameStr
+			}
+		}
+	}
+	return ""
+}
+
+// ValidateWorkingDirectory checks if the working directory is valid.
+func ValidateWorkingDirectory(workingDir string) error {
+	if workingDir == "" {
+		return fmt.Errorf("working directory cannot be empty")
+	}
+	info, err := os.Stat(workingDir)
+	if err != nil {
+		return fmt.Errorf("invalid working directory: %s - %w", workingDir, err)
+	}
+	if !info.IsDir() {
+		return fmt.Errorf("working directory is not a directory: %s", workingDir)
+	}
+	return nil
+}