-
Notifications
You must be signed in to change notification settings - Fork 584
/
gradleExecuteBuild.go
298 lines (267 loc) · 8.75 KB
/
gradleExecuteBuild.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
package cmd
import (
"bytes"
"encoding/json"
"fmt"
"io/fs"
"path/filepath"
"strings"
"text/template"
"github.com/SAP/jenkins-library/pkg/command"
"github.com/SAP/jenkins-library/pkg/gradle"
"github.com/SAP/jenkins-library/pkg/log"
"github.com/SAP/jenkins-library/pkg/piperenv"
"github.com/SAP/jenkins-library/pkg/piperutils"
"github.com/SAP/jenkins-library/pkg/telemetry"
)
const (
gradleBomFilename = "bom-gradle"
)
var (
bomGradleTaskName = "cyclonedxBom"
publishTaskName = "publish"
pathToModuleFile = filepath.Join("build", "publications", "maven", "module.json")
rootPath = "."
)
const publishInitScriptContentTemplate = `
{{ if .ApplyPublishingForAllProjects}}allprojects{{else}}rootProject{{ end }} {
def gradleExecuteBuild_skipPublishingProjects = [{{ if .ApplyPublishingForAllProjects}}{{range .ExcludePublishingForProjects}} "{{.}}",{{end}}{{end}} ];
if (!gradleExecuteBuild_skipPublishingProjects.contains(project.name)) {
apply plugin: 'maven-publish'
apply plugin: 'java'
publishing {
publications {
maven(MavenPublication) {
versionMapping {
usage('java-api') {
fromResolutionOf('runtimeClasspath')
}
usage('java-runtime') {
fromResolutionResult()
}
}
{{- if .ArtifactGroupID}}
groupId = '{{.ArtifactGroupID}}'
{{- end }}
{{- if .ApplyPublishingForAllProjects }}
{{else if .ArtifactID}}
artifactId = '{{.ArtifactID}}'
{{- end }}
{{- if .ArtifactVersion}}
version = '{{.ArtifactVersion}}'
{{- end }}
from components.java
}
}
repositories {
maven {
credentials {
username = "{{.RepositoryUsername}}"
password = "{{.RepositoryPassword}}"
}
url = "{{.RepositoryURL}}"
}
}
}
}
}
`
const bomInitScriptContentTemplate = `
initscript {
repositories {
mavenCentral()
maven {
url "https://plugins.gradle.org/m2/"
}
}
dependencies {
classpath "org.cyclonedx:cyclonedx-gradle-plugin:1.7.0"
}
}
allprojects {
def gradleExecuteBuild_skipBOMProjects = [{{range .ExcludeCreateBOMForProjects}} "{{.}}",{{end}} ];
if (!gradleExecuteBuild_skipBOMProjects.contains(project.name)) {
apply plugin: 'java'
apply plugin: org.cyclonedx.gradle.CycloneDxPlugin
cyclonedxBom {
outputName = "` + gradleBomFilename + `"
outputFormat = "xml"
schemaVersion = "1.4"
includeConfigs = ["runtimeClasspath"]
skipConfigs = ["compileClasspath", "testCompileClasspath"]
}
}
}
`
// PublishedArtifacts contains information about published artifacts
type PublishedArtifacts struct {
Info Component `json:"component,omitempty"`
Elements []Element `json:"variants,omitempty"`
}
type Component struct {
Module string `json:"module,omitempty"`
}
type Element struct {
Name string `json:"name,omitempty"`
Artifacts []Artifact `json:"files,omitempty"`
}
type Artifact struct {
Name string `json:"name,omitempty"`
}
type WalkDir func(root string, fn fs.WalkDirFunc) error
type Filepath interface {
WalkDir(root string, fn fs.WalkDirFunc) error
}
type WalkDirFunc func(root string, fn fs.WalkDirFunc) error
func (f WalkDirFunc) WalkDir(root string, fn fs.WalkDirFunc) error {
return f(root, fn)
}
type gradleExecuteBuildUtils interface {
command.ExecRunner
piperutils.FileUtils
Filepath
}
type gradleExecuteBuildUtilsBundle struct {
*command.Command
*piperutils.Files
Filepath
}
func newGradleExecuteBuildUtils() gradleExecuteBuildUtils {
var walkDirFunc WalkDirFunc = filepath.WalkDir
utils := gradleExecuteBuildUtilsBundle{
Command: &command.Command{
StepName: "gradleExecuteBuild",
},
Files: &piperutils.Files{},
Filepath: walkDirFunc,
}
utils.Stdout(log.Writer())
utils.Stderr(log.Writer())
return &utils
}
func gradleExecuteBuild(config gradleExecuteBuildOptions, telemetryData *telemetry.CustomData, pipelineEnv *gradleExecuteBuildCommonPipelineEnvironment) {
utils := newGradleExecuteBuildUtils()
err := runGradleExecuteBuild(&config, telemetryData, utils, pipelineEnv)
if err != nil {
log.Entry().WithError(err).Fatalf("step execution failed: %v", err)
}
}
func runGradleExecuteBuild(config *gradleExecuteBuildOptions, telemetryData *telemetry.CustomData, utils gradleExecuteBuildUtils, pipelineEnv *gradleExecuteBuildCommonPipelineEnvironment) error {
log.Entry().Info("BOM file creation...")
if config.CreateBOM {
if err := createBOM(config, utils); err != nil {
return err
}
}
// gradle build
// if user provides BuildFlags, it is respected over a single Task
gradleOptions := &gradle.ExecuteOptions{
BuildGradlePath: config.Path,
Task: config.Task,
BuildFlags: config.BuildFlags,
UseWrapper: config.UseWrapper,
}
if _, err := gradle.Execute(gradleOptions, utils); err != nil {
log.Entry().WithError(err).Errorf("gradle build execution was failed: %v", err)
return err
}
log.Entry().Info("Publishing of artifacts to staging repository...")
if config.Publish {
if err := publishArtifacts(config, utils, pipelineEnv); err != nil {
return err
}
}
return nil
}
func createBOM(config *gradleExecuteBuildOptions, utils gradleExecuteBuildUtils) error {
createBOMInitScriptContent, err := getInitScriptContent(config, bomInitScriptContentTemplate)
if err != nil {
return fmt.Errorf("failed to get BOM init script content: %v", err)
}
gradleOptions := &gradle.ExecuteOptions{
BuildGradlePath: config.Path,
Task: bomGradleTaskName,
UseWrapper: config.UseWrapper,
InitScriptContent: createBOMInitScriptContent,
}
if _, err := gradle.Execute(gradleOptions, utils); err != nil {
log.Entry().WithError(err).Errorf("failed to create BOM: %v", err)
return err
}
return nil
}
func publishArtifacts(config *gradleExecuteBuildOptions, utils gradleExecuteBuildUtils, pipelineEnv *gradleExecuteBuildCommonPipelineEnvironment) error {
publishInitScriptContent, err := getInitScriptContent(config, publishInitScriptContentTemplate)
if err != nil {
return fmt.Errorf("failed to get publish init script content: %v", err)
}
gradleOptions := &gradle.ExecuteOptions{
BuildGradlePath: config.Path,
Task: publishTaskName,
UseWrapper: config.UseWrapper,
InitScriptContent: publishInitScriptContent,
}
if _, err := gradle.Execute(gradleOptions, utils); err != nil {
log.Entry().WithError(err).Errorf("failed to publish artifacts: %v", err)
return err
}
var artifacts piperenv.Artifacts
err = utils.WalkDir(rootPath, func(path string, d fs.DirEntry, err error) error {
if d.IsDir() {
return nil
}
if strings.HasSuffix(path, pathToModuleFile) {
pathArtifacts, artifactsErr := getPublishedArtifactsNames(path, utils)
if artifactsErr != nil {
return fmt.Errorf("failed to get published artifacts in path %s: %v", path, artifactsErr)
}
artifacts = append(artifacts, pathArtifacts...)
}
return nil
})
if err != nil {
return err
}
pipelineEnv.custom.artifacts = artifacts
return nil
}
func getInitScriptContent(options *gradleExecuteBuildOptions, templateContent string) (string, error) {
tmpl, err := template.New("resources").Parse(templateContent)
if err != nil {
return "", err
}
var generatedCode bytes.Buffer
err = tmpl.Execute(&generatedCode, options)
if err != nil {
return "", err
}
return generatedCode.String(), nil
}
func getPublishedArtifactsNames(file string, utils gradleExecuteBuildUtils) (piperenv.Artifacts, error) {
artifacts := piperenv.Artifacts{}
publishedArtifacts := PublishedArtifacts{}
exists, err := utils.FileExists(file)
if err != nil {
return nil, fmt.Errorf("failed to check existence of the file '%s': %v", file, err)
}
if !exists {
return nil, fmt.Errorf("failed to get '%s': file does not exist", file)
}
content, err := utils.ReadFile(file)
if err != nil {
return nil, fmt.Errorf("failed to read '%s': %v", file, err)
}
err = json.Unmarshal(content, &publishedArtifacts)
if err != nil {
return nil, fmt.Errorf("failed to unmarshal '%s': %v", file, err)
}
for _, element := range publishedArtifacts.Elements {
if element.Name != "apiElements" {
continue
}
for _, artifact := range element.Artifacts {
artifacts = append(artifacts, piperenv.Artifact{Id: publishedArtifacts.Info.Module, Name: artifact.Name})
}
}
return artifacts, nil
}