Exposing build artifact metadata from maven and npm (#5008)

SAP · Aug 27, 2024 · 238339c · 238339c
1 parent 70d2abf
commit 238339c
Show file tree

Hide file tree

Showing 15 changed files with 186 additions and 25 deletions.
diff --git a/cmd/mavenBuild.go b/cmd/mavenBuild.go
@@ -1,18 +1,21 @@
 package cmd
 
 import (
+	"encoding/json"
 	"os"
 	"path"
 	"path/filepath"
 	"reflect"
 	"strings"
 
+	"github.com/SAP/jenkins-library/pkg/build"
 	"github.com/SAP/jenkins-library/pkg/buildsettings"
 	"github.com/SAP/jenkins-library/pkg/command"
 	"github.com/SAP/jenkins-library/pkg/log"
 	"github.com/SAP/jenkins-library/pkg/maven"
 	"github.com/SAP/jenkins-library/pkg/piperutils"
 	"github.com/SAP/jenkins-library/pkg/telemetry"
+	"github.com/SAP/jenkins-library/pkg/versioning"
 	"github.com/pkg/errors"
 
 	piperhttp "github.com/SAP/jenkins-library/pkg/http"
@@ -159,7 +162,45 @@ func runMavenBuild(config *mavenBuildOptions, telemetryData *telemetry.CustomDat
 			mavenOptions.Goals = []string{"deploy"}
 			mavenOptions.Defines = []string{}
 			_, err := maven.Execute(&mavenOptions, utils)
-			return err
+			if err != nil {
+				return err
+			}
+			if config.CreateBuildArtifactsMetadata {
+				buildCoordinates := []versioning.Coordinates{}
+				options := versioning.Options{}
+				var utils versioning.Utils
+
+				matches, _ := fileUtils.Glob("**/pom.xml")
+				for _, match := range matches {
+
+					artifact, err := versioning.GetArtifact("maven", match, &options, utils)
+					if err != nil {
+						log.Entry().Warnf("unable to get artifact metdata : %v", err)
+					} else {
+						coordinate, err := artifact.GetCoordinates()
+						if err != nil {
+							log.Entry().Warnf("unable to get artifact coordinates : %v", err)
+						} else {
+							coordinate.BuildPath = filepath.Dir(match)
+							coordinate.URL = config.AltDeploymentRepositoryURL
+							buildCoordinates = append(buildCoordinates, coordinate)
+						}
+					}
+				}
+
+				if len(buildCoordinates) == 0 {
+					log.Entry().Warnf("unable to identify artifact coordinates for the maven packages published")
+					return nil
+				}
+
+				var buildArtifacts build.BuildArtifacts
+
+				buildArtifacts.Coordinates = buildCoordinates
+				jsonResult, _ := json.Marshal(buildArtifacts)
+				commonPipelineEnvironment.custom.mavenBuildArtifacts = string(jsonResult)
+			}
+
+			return nil
 		} else {
 			log.Entry().Infof("publish not detected, ignoring maven deploy")
 		}

diff --git a/cmd/mavenBuild_generated.go b/cmd/mavenBuild_generated.go
diff --git a/cmd/mavenBuild_test.go b/cmd/mavenBuild_test.go
@@ -135,4 +135,25 @@ func TestMavenBuild(t *testing.T) {
 		assert.Contains(t, mockedUtils.Calls[0].Params, "profile1,profile2")
 	})
 
+	t.Run("mavenBuild should not create build artifacts metadata when CreateBuildArtifactsMetadata is false and Publish is true", func(t *testing.T) {
+		mockedUtils := newMavenMockUtils()
+		mockedUtils.AddFile("pom.xml", []byte{})
+		config := mavenBuildOptions{CreateBuildArtifactsMetadata: false, Publish: true}
+		err := runMavenBuild(&config, nil, &mockedUtils, &cpe)
+		assert.Nil(t, err)
+		assert.Equal(t, mockedUtils.Calls[0].Exec, "mvn")
+		assert.Contains(t, mockedUtils.Calls[0].Params, "install")
+		assert.Empty(t, cpe.custom.mavenBuildArtifacts)
+	})
+
+	t.Run("mavenBuild should not create build artifacts metadata when CreateBuildArtifactsMetadata is true and Publish is false", func(t *testing.T) {
+		mockedUtils := newMavenMockUtils()
+		mockedUtils.AddFile("pom.xml", []byte{})
+		config := mavenBuildOptions{CreateBuildArtifactsMetadata: true, Publish: false}
+		err := runMavenBuild(&config, nil, &mockedUtils, &cpe)
+		assert.Nil(t, err)
+		assert.Equal(t, mockedUtils.Calls[0].Exec, "mvn")
+		assert.Empty(t, cpe.custom.mavenBuildArtifacts)
+	})
+
 }
diff --git a/cmd/npmExecuteScripts.go b/cmd/npmExecuteScripts.go
@@ -1,12 +1,15 @@
 package cmd
 
 import (
+	"encoding/json"
 	"os"
 
+	"github.com/SAP/jenkins-library/pkg/build"
 	"github.com/SAP/jenkins-library/pkg/buildsettings"
 	"github.com/SAP/jenkins-library/pkg/log"
 	"github.com/SAP/jenkins-library/pkg/npm"
 	"github.com/SAP/jenkins-library/pkg/telemetry"
+	"github.com/SAP/jenkins-library/pkg/versioning"
 )
 
 func npmExecuteScripts(config npmExecuteScriptsOptions, telemetryData *telemetry.CustomData, commonPipelineEnvironment *npmExecuteScriptsCommonPipelineEnvironment) {
@@ -85,9 +88,11 @@ func runNpmExecuteScripts(npmExecutor npm.Executor, config *npmExecuteScriptsOpt
 	}
 	commonPipelineEnvironment.custom.buildSettingsInfo = buildSettingsInfo
 
+	buildCoordinates := []versioning.Coordinates{}
+
 	if config.Publish {
 		if len(config.BuildDescriptorList) > 0 {
-			err = npmExecutor.PublishAllPackages(config.BuildDescriptorList, config.RepositoryURL, config.RepositoryUsername, config.RepositoryPassword, config.PackBeforePublish)
+			err = npmExecutor.PublishAllPackages(config.BuildDescriptorList, config.RepositoryURL, config.RepositoryUsername, config.RepositoryPassword, config.PackBeforePublish, &buildCoordinates)
 			if err != nil {
 				return err
 			}
@@ -97,12 +102,25 @@ func runNpmExecuteScripts(npmExecutor npm.Executor, config *npmExecuteScriptsOpt
 				return err
 			}
 
-			err = npmExecutor.PublishAllPackages(packageJSONFiles, config.RepositoryURL, config.RepositoryUsername, config.RepositoryPassword, config.PackBeforePublish)
+			err = npmExecutor.PublishAllPackages(packageJSONFiles, config.RepositoryURL, config.RepositoryUsername, config.RepositoryPassword, config.PackBeforePublish, &buildCoordinates)
 			if err != nil {
 				return err
 			}
 		}
 	}
 
+	if config.CreateBuildArtifactsMetadata {
+		if len(buildCoordinates) == 0 {
+			log.Entry().Warnf("unable to identify artifact coordinates for the npm packages published")
+			return nil
+		}
+
+		var buildArtifacts build.BuildArtifacts
+
+		buildArtifacts.Coordinates = buildCoordinates
+		jsonResult, _ := json.Marshal(buildArtifacts)
+		commonPipelineEnvironment.custom.npmBuildArtifacts = string(jsonResult)
+	}
+
 	return nil
 }
diff --git a/cmd/npmExecuteScripts_generated.go b/cmd/npmExecuteScripts_generated.go
diff --git a/cmd/npmExecuteScripts_test.go b/cmd/npmExecuteScripts_test.go
@@ -194,4 +194,5 @@ func TestNpmExecuteScripts(t *testing.T) {
 		v := os.Getenv("NODE_ENV")
 		assert.Equal(t, "production", v)
 	})
+
 }
diff --git a/pkg/build/artifact.go b/pkg/build/artifact.go
@@ -0,0 +1,7 @@
+package build
+
+import "github.com/SAP/jenkins-library/pkg/versioning"
+
+type BuildArtifacts struct {
+	Coordinates []versioning.Coordinates
+}
diff --git a/pkg/npm/mock.go b/pkg/npm/mock.go
@@ -5,6 +5,7 @@ package npm
 
 import (
 	"fmt"
+	"github.com/SAP/jenkins-library/pkg/versioning"
 
 	"github.com/SAP/jenkins-library/pkg/mock"
 )
@@ -123,6 +124,6 @@ func (n *NpmExecutorMock) CreateBOM(packageJSONFiles []string) error {
 }
 
 // CreateBOM mock implementation
-func (n *NpmExecutorMock) PublishAllPackages(packageJSONFiles []string, registry, username, password string, packBeforePublish bool) error {
+func (n *NpmExecutorMock) PublishAllPackages(packageJSONFiles []string, registry, username, password string, packBeforePublish bool, buildCoordinates *[]versioning.Coordinates) error {
 	return nil
 }
diff --git a/pkg/npm/npm.go b/pkg/npm/npm.go
@@ -11,6 +11,7 @@ import (
 	"github.com/SAP/jenkins-library/pkg/command"
 	"github.com/SAP/jenkins-library/pkg/log"
 	"github.com/SAP/jenkins-library/pkg/piperutils"
+	"github.com/SAP/jenkins-library/pkg/versioning"
 )
 
 const (
@@ -34,7 +35,7 @@ type Executor interface {
 	FindPackageJSONFilesWithScript(packageJSONFiles []string, script string) ([]string, error)
 	RunScriptsInAllPackages(runScripts []string, runOptions []string, scriptOptions []string, virtualFrameBuffer bool, excludeList []string, packagesList []string) error
 	InstallAllDependencies(packageJSONFiles []string) error
-	PublishAllPackages(packageJSONFiles []string, registry, username, password string, packBeforePublish bool) error
+	PublishAllPackages(packageJSONFiles []string, registry, username, password string, packBeforePublish bool, buildCoordinates *[]versioning.Coordinates) error
 	SetNpmRegistries() error
 	CreateBOM(packageJSONFiles []string) error
 }

diff --git a/pkg/npm/publish.go b/pkg/npm/publish.go
@@ -11,6 +11,7 @@ import (
 
 	"github.com/SAP/jenkins-library/pkg/log"
 	CredentialUtils "github.com/SAP/jenkins-library/pkg/piperutils"
+	"github.com/SAP/jenkins-library/pkg/versioning"
 )
 
 type npmMinimalPackageDescriptor struct {
@@ -31,7 +32,7 @@ func (pd *npmMinimalPackageDescriptor) Scope() string {
 }
 
 // PublishAllPackages executes npm publish for all package.json files defined in packageJSONFiles list
-func (exec *Execute) PublishAllPackages(packageJSONFiles []string, registry, username, password string, packBeforePublish bool) error {
+func (exec *Execute) PublishAllPackages(packageJSONFiles []string, registry, username, password string, packBeforePublish bool, buildCoordinates *[]versioning.Coordinates) error {
 	for _, packageJSON := range packageJSONFiles {
 		log.Entry().Infof("triggering publish for %s", packageJSON)
 
@@ -43,7 +44,7 @@ func (exec *Execute) PublishAllPackages(packageJSONFiles []string, registry, use
 			return fmt.Errorf("package.json file '%s' not found: %w", packageJSON, err)
 		}
 
-		err = exec.publish(packageJSON, registry, username, password, packBeforePublish)
+		err = exec.publish(packageJSON, registry, username, password, packBeforePublish, buildCoordinates)
 		if err != nil {
 			return err
 		}
@@ -52,7 +53,7 @@ func (exec *Execute) PublishAllPackages(packageJSONFiles []string, registry, use
 }
 
 // publish executes npm publish for package.json
-func (exec *Execute) publish(packageJSON, registry, username, password string, packBeforePublish bool) error {
+func (exec *Execute) publish(packageJSON, registry, username, password string, packBeforePublish bool, buildCoordinates *[]versioning.Coordinates) error {
 	execRunner := exec.Utils.GetExecRunner()
 
 	oldWorkingDirectory, err := exec.Utils.Getwd()
@@ -202,6 +203,25 @@ func (exec *Execute) publish(packageJSON, registry, username, password string, p
 		}
 	}
 
+	options := versioning.Options{}
+	var utils versioning.Utils
+
+	artifact, err := versioning.GetArtifact("npm", packageJSON, &options, utils)
+	if err != nil {
+		log.Entry().Warnf("unable to get artifact metdata : %v", err)
+	} else {
+		coordinate, err := artifact.GetCoordinates()
+		if err != nil {
+			log.Entry().Warnf("unable to get artifact coordinates : %v", err)
+		} else {
+			coordinate.BuildPath = filepath.Dir(packageJSON)
+			coordinate.URL = registry
+			coordinate.Packaging = "tgz"
+
+			*buildCoordinates = append(*buildCoordinates, coordinate)
+		}
+	}
+
 	return nil
 }