-
Notifications
You must be signed in to change notification settings - Fork 69
/
build.gradle
474 lines (392 loc) · 13.7 KB
/
build.gradle
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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
import groovy.text.GStringTemplateEngine
import org.openapitools.generator.gradle.plugin.tasks.GenerateTask
import org.yaml.snakeyaml.Yaml
plugins {
id "java"
id "war"
id "distribution"
id "maven-publish"
id "jacoco"
alias(libs.plugins.dependency.check)
alias(libs.plugins.gradle.versions)
alias(libs.plugins.nebula.lint)
alias(libs.plugins.openapi.generator)
alias(libs.plugins.sonarqube)
// The following are plugins are plugins we wrote in the buildSrc folder
id "org.candlepin.gradle.gettext"
id "org.candlepin.gradle.msgfmt"
id "org.candlepin.gradle.SpecVersion"
id "checkstyle-conventions"
id "test-logging-conventions"
}
group = "org.candlepin"
ext {
api_spec_path = "${projectDir}/api/candlepin-api-spec.yaml"
config_file = "${projectDir}/api/candlepin-api-config.json"
cpdb_username = "candlepin"
cpdb_password = ""
db_name = "candlepin"
if (project.findProperty("hidden_resources")) {
hidden_resources = project.findProperty("hidden_resources")
}
if (project.findProperty("hidden_capabilities")) {
hidden_capabilities = project.findProperty("hidden_capabilities")
}
if (!project.findProperty("db_host") ||
(project.findProperty("db_host") && "".equals(project.findProperty("db_host")))) {
db_host = "localhost"
}
if (project.findProperty("app_db_name") && !"".equals(project.findProperty("app_db_name"))) {
db_name = project.findProperty("app_db_name")
}
// If MYSQL set up the mysql stuff else set up postgres (default)
if (project.findProperty("database_server") == "mysql") {
jdbc_driver_class = "org.mariadb.jdbc.Driver"
jdbc_dialect = "org.hibernate.dialect.MySQL5InnoDBDialect"
jdbc_quartz_driver_class = "org.quartz.impl.jdbcjobstore.StdJDBCDelegate"
jdbc_url = "jdbc:mariadb://${db_host}/${db_name}"
} else {
jdbc_driver_class = "org.postgresql.Driver"
jdbc_dialect = "org.hibernate.dialect.PostgreSQL92Dialect"
jdbc_quartz_driver_class = "org.quartz.impl.jdbcjobstore.PostgreSQLDelegate"
jdbc_url = "jdbc:postgresql://${db_host}/${db_name}"
}
external_broker = "true".equals(project.findProperty("external_broker"))
async_scheduler_enabled = !project.findProperty("async_scheduler_enabled") ||
"true".equals(project.findProperty("async_scheduler_enabled"))
}
dependencies {
// Bouncy Castle
implementation(libs.bouncycastle.prov)
implementation(libs.bouncycastle.pkix)
// Cache
implementation(libs.caffeine)
// Commons
implementation(libs.commons.codec)
implementation(libs.commons.collections)
implementation(libs.commons.io)
implementation(libs.commons.lang)
// Gettext libraries used for internationalization & translation
implementation(libs.gettext)
// Guice Libraries
implementation(libs.guice.servlet)
implementation(libs.guice.persist)
// Jackson
implementation(libs.jackson.hibernate)
implementation(libs.jackson.jaxrs)
implementation(libs.jackson.jdk8)
implementation(libs.jackson.json.schema)
implementation(libs.jackson.jsr310)
implementation(libs.jackson.xml)
implementation(libs.jackson.yaml)
// Bean validation API is explicitly added to this version
// This is a transitive dependency of
// com.fasterxml.jackson.module:jackson-module-jsonSchema
implementation(libs.javax.validation)
// Javax
implementation(libs.hibernate)
implementation(libs.javax.annotation)
// Liquibase
implementation(libs.liquibase)
implementation(libs.picocli)
// Logging
implementation(libs.logback)
// Artifacts that bridge other logging frameworks to slf4j. Mime4j uses
// JCL for example.
implementation(libs.slf4j)
implementation(libs.slf4j.jcl)
implementation(libs.slf4j.log4j)
implementation(libs.logstash)
// Oauth
implementation(libs.oauth)
// Resteasy
implementation(libs.resteasy.atom)
implementation(libs.resteasy.guice)
implementation(libs.resteasy.multipart)
implementation(libs.resteasy.validator)
implementation(libs.javax.rs)
// Sun jaxb
implementation(libs.jaxb)
implementation(libs.jaxb.core)
// Swagger
implementation(libs.swagger)
// Validator
implementation(libs.hibernate.validator)
implementation(libs.hibernate.validator.processor)
// Hibernate
implementation(libs.hibernate.c3p0)
// Ehcache (for use with hibernate primarily)
implementation(libs.hibernate.jcache)
implementation(libs.ehcache)
implementation(libs.javax.cache)
// Artemis server & client
implementation(libs.artemis.server)
implementation(libs.artemis.stomp)
// Javascript Engine
implementation(libs.rhino)
implementation(libs.quartz)
// Keycloak
implementation(libs.keycloak)
// Hibernate JPA integration
implementation(libs.hibernate.jpamodelgen)
annotationProcessor(libs.hibernate.jpamodelgen)
// Smallrye Config
implementation(libs.smallrye.config)
implementation(libs.tomcat.annotations)
// OTEL
implementation(libs.otel.annotation)
providedCompile(libs.javax.servlet)
// DB Drivers
runtimeOnly(libs.postgresql)
runtimeOnly(libs.mariadb)
testRuntimeOnly(libs.hsqldb)
testRuntimeOnly(libs.javax.el)
// Core testing libraries
// Junit 5
testImplementation(libs.junit.api)
testImplementation(libs.junit.params)
testRuntimeOnly(libs.junit.engine)
testImplementation(libs.hamcrest)
testImplementation(libs.mockito.junit)
testImplementation(libs.liquibase.slf4j)
testImplementation(libs.assertj)
}
// Copy the resources to the main classes directory so that the
// persistence context is in the the same classpath entry for
// Hibernate annotation based discovery.
sourceSets.main.output.resourcesDir = new File(buildDir, "classes/java/main")
compileJava.dependsOn(processResources)
// Add the openapi generated classes to the main java source sets to compile in the generated interfaces
sourceSets {
main.java.srcDir "${buildDir}/generated/api/src/gen/java"
}
java {
sourceCompatibility = JavaVersion.VERSION_17
targetCompatibility = JavaVersion.VERSION_17
}
gradleLint {
rules = ["dependency-parentheses"]
// Turn these on selectively. They are a little too sensitive to leave on all the time,
// but they provide useful information when run occasionally.
// rules = ["dependency-parentheses", "unused-exclude-by-dep"]
// criticalRules = ["unused-dependency"]
}
tasks.withType(JavaCompile).configureEach {
options.encoding = "UTF-8"
// options.compilerArgs << "-Xlint:unchecked"
// options.compilerArgs << "-Xlint:deprecation"
// options.compilerArgs.addAll(['--release', '8'])
}
repositories {
mavenCentral()
maven { url "https://repo.jenkins-ci.org/public/" }
maven { url "https://repository.jboss.org/nexus/content/groups/public/" }
}
openApiGenerate {
generatorName = "jaxrs-spec"
inputSpec = api_spec_path
configFile = config_file
outputDir = "$buildDir/generated/api"
configOptions = [
interfaceOnly: 'true',
dateLibrary : "java8",
useTags : "true",
containerDefaultToNull: "true"
]
templateDir = "$rootDir/buildSrc/src/main/resources/templates"
}
openApiValidate {
inputSpec = api_spec_path
}
tasks.register('generateApiDocs', GenerateTask) {
generatorName = "html"
inputSpec = api_spec_path
outputDir = "$buildDir/docs"
generateApiDocumentation = true
generateModelDocumentation = true
generateModelTests = false
generateApiTests = false
}
tasks.register('generateOpenApiJson', GenerateTask) {
generatorName = "openapi"
inputSpec = api_spec_path
outputDir = "$buildDir/generated/json"
generateApiDocumentation = true
generateModelDocumentation = true
generateModelTests = false
generateApiTests = false
}
//Update the compileJava & processResourcesTasks depend on the openapi generation so that the generated classes
//can be used during compilation.
compileJava.dependsOn tasks.openApiGenerate
processResources.dependsOn tasks.generateOpenApiJson
gettext {
keys_project_dir = "${project.rootDir}/"
}
msgfmt {
resource "org.candlepin.common.i18n.Messages"
}
test {
debugOptions {
host = '*'
}
useJUnitPlatform()
// Sometimes causes out of memory on vagrant
maxHeapSize = "2g"
jvmArgs = [
'-XX:+HeapDumpOnOutOfMemoryError'
]
}
jacocoTestReport {
dependsOn test
reports {
csv.required = false
html.required = false
xml.required = true
}
doLast {
println "Generated unit test coverage report at $buildDir/reports/jacoco/test/jacocoTestReport.xml"
}
}
// User-friendly alias for jacocoTestReport task
tasks.register("coverage") {
dependsOn jacocoTestReport
}
project.tasks["sonar"].dependsOn "coverage"
sonar {
properties {
property "sonar.sourceEncoding", "Utf-8"
property "sonar.projectKey", "candlepin_candlepin"
property "sonar.organization", "candlepin"
property "sonar.host.url", "https://sonarcloud.io"
}
}
wrapper {
distributionType = Wrapper.DistributionType.BIN
}
clean.doFirst {
delete "${rootDir}/buildSrc/build"
// Maven clean up
delete "${rootDir}/src/main/webapp/docs/candlepin-api-spec.yaml"
delete "${rootDir}/target"
}
// substitute the version & release in the version.properties used by the status resource at runtime
processResources {
from("src/main/resources") {
duplicatesStrategy = "include"
include "version.properties"
expand([version: project.getVersion(), release: project.findProperty("release")])
}
}
// A task to generate the the candlepin config file for use in etc or other locations.
tasks.register('generateConfig') {
dependsOn ":processResources"
def template = file("$projectDir/config/candlepin/candlepin.conf.template")
def targetFile = file("$buildDir/candlepin.conf")
doLast {
def defaults = [candlepin: project.ext.properties]
def binding = [candlepin: defaults['candlepin']]
try {
def custom = new Yaml().load(new File("$projectDir/custom.yaml").newInputStream())
// Overwrite the defaults with the values from custom.yaml
// We have to use the key 'candlepin' instead of 'candlepin.conf' since the dot in the
// key name would otherwise be interpreted as a dereference in the template.
if (custom && custom['candlepin.conf']) {
binding['candlepin'] << custom['candlepin.conf']
}
}
catch (FileNotFoundException e) {
println "No custom.yaml found. Using defaults."
}
// change contents via cli options
// change file contents
def tmp = new GStringTemplateEngine()
.createTemplate(template)
.make(binding)
targetFile.write(tmp.toString(), "UTF-8")
}
}
assemble.dependsOn(generateConfig)
// task to generate candlepin-api jar that Hosted adapters build against
// invoked as `./gradlew apiJar`
tasks.register('apiJar', Jar) {
archiveBaseName = 'candlepin-api'
from sourceSets.main.output
includes = [
'auth',
'config',
'controller',
'exceptions',
'jackson',
'model',
'pki',
'resteasy',
'service',
'util'
].collect { "/org/candlepin/${it}/" }
duplicatesStrategy = 'exclude'
}
war {
// This is a bit wonky and has potential to miss stuff, but we don't really have a much nicer
// way of doing this, outside the real correct answer of converting them to subprojects like
// they probably should be.
if (project.hasProperty('test_extensions')) {
List<String> testexts = test_extensions.tokenize(',');
// If we've defined one or more test extensions, selectively exclude subpackages that are
// not in the list of test extensions
String testExtRootPath = "${buildDir}/classes/java/main/org/candlepin/testext/";
File[] packages = new File(testExtRootPath)
.listFiles((FileFilter) File::isDirectory);
packages.each { pkg ->
if (!testexts.contains(pkg.getName())) {
rootSpec.exclude("**/testext/${pkg.getName()}/**");
}
else {
println("Including test extension: ${pkg.getName()}")
}
}
}
else {
// Building with no test extensions; exclude the whole package
rootSpec.exclude("**/testext/**");
}
manifest {
attributes(
"Implementation-Title": "The Candlepin Project",
"Copyright": "Red Hat, Inc. 2009-" + new Date().format("y")
)
}
// Copy the license file into place in the final manifest
from(projectDir) {
include "LICENSE"
into("META-INF")
}
from("./api") {
include "candlepin-api-spec.yaml"
into("docs")
}
from("$buildDir/generated/api/src/main/openapi") {
include "openapi.yaml"
into("WEB-INF/classes")
}
from("$buildDir/generated/json") {
include "openapi.json"
into("WEB-INF/classes")
}
}
publishing {
publications {
// Publish the candlepin war
warArtifact(MavenPublication) {
from components.web
groupId 'org.candlepin'
artifactId 'candlepin'
}
// Publish the candlepin-api jar
jarArtifact(MavenPublication) {
artifact tasks.apiJar
groupId = 'org.candlepin'
artifactId = 'candlepin-api'
}
}
}