-
Notifications
You must be signed in to change notification settings - Fork 5
/
GenerateJooqClassesTask.kt
404 lines (368 loc) · 14.6 KB
/
GenerateJooqClassesTask.kt
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
package dev.monosoul.jooq
import dev.monosoul.jooq.codegen.ConfigurationProvider
import dev.monosoul.jooq.codegen.ConfigurationProvider.Companion.postProcess
import dev.monosoul.jooq.codegen.UniversalJooqCodegenRunner
import dev.monosoul.jooq.migration.MigrationLocation
import dev.monosoul.jooq.migration.SchemaVersion
import dev.monosoul.jooq.migration.UniversalMigrationRunner
import dev.monosoul.jooq.settings.DatabaseCredentials
import dev.monosoul.jooq.settings.JooqDockerPluginSettings
import dev.monosoul.jooq.settings.JooqDockerPluginSettings.WithContainer
import dev.monosoul.jooq.settings.JooqDockerPluginSettings.WithoutContainer
import dev.monosoul.jooq.settings.SettingsAware
import dev.monosoul.jooq.util.CodegenClasspathAwareClassLoaders
import dev.monosoul.jooq.util.callWith
import dev.monosoul.jooq.util.copy
import dev.monosoul.jooq.util.getCodegenLogging
import groovy.lang.Closure
import org.gradle.api.Action
import org.gradle.api.DefaultTask
import org.gradle.api.Project
import org.gradle.api.file.FileCollection
import org.gradle.api.file.FileSystemOperations
import org.gradle.api.file.ProjectLayout
import org.gradle.api.file.RegularFile
import org.gradle.api.model.ObjectFactory
import org.gradle.api.provider.ListProperty
import org.gradle.api.provider.Property
import org.gradle.api.provider.Provider
import org.gradle.api.provider.ProviderFactory
import org.gradle.api.tasks.CacheableTask
import org.gradle.api.tasks.Classpath
import org.gradle.api.tasks.Input
import org.gradle.api.tasks.Nested
import org.gradle.api.tasks.OutputDirectory
import org.gradle.api.tasks.TaskAction
import org.gradle.kotlin.dsl.getByType
import org.gradle.kotlin.dsl.listProperty
import org.gradle.kotlin.dsl.mapProperty
import org.gradle.kotlin.dsl.property
import org.gradle.kotlin.dsl.setProperty
import org.jooq.meta.jaxb.Configuration
import org.jooq.meta.jaxb.Generator
import javax.inject.Inject
import org.gradle.api.artifacts.Configuration as GradleConfiguration
@CacheableTask
open class GenerateJooqClassesTask
@Inject
constructor(
objectFactory: ObjectFactory,
private val providerFactory: ProviderFactory,
private val fsOperations: FileSystemOperations,
private val projectLayout: ProjectLayout,
) : DefaultTask(),
SettingsAware {
/**
* List of schemas to take into account when running migrations and generating code.
*/
@Input
val schemas = objectFactory.listProperty<String>().convention(listOf("public"))
/**
* Base package for generated classes.
*/
@Input
val basePackageName = objectFactory.property<String>().convention("org.jooq.generated")
/**
* Flyway configuration.
*/
@Input
val flywayProperties = objectFactory.mapProperty<String, String>().convention(emptyMap())
/**
* List of schemas to not generate schema information for (generate classes as for default schema).
*/
@Input
val outputSchemaToDefault = objectFactory.setProperty<String>().convention(emptySet())
/**
* Map of schema name to specific package name.
*/
@Input
val schemaToPackageMapping = objectFactory.mapProperty<String, String>().convention(emptyMap())
/**
* Include Flyway migration history table to generated code.
*/
@Input
val includeFlywayTable = objectFactory.property<Boolean>().convention(false)
private val _generatorConfig =
objectFactory.property<PrivateValueHolder<Configuration>>().convention(
providerFactory
.provider {
configurationProvider.defaultConfiguration()
}.map(::PrivateValueHolder),
)
/**
* Use [usingJavaConfig] or [usingXmlConfig] to provide configuration.
*/
@get:Input
@Suppress("unused")
val generatorConfig: Property<out ValueHolder<Configuration>> get() = _generatorConfig
/**
* Location of Flyway migrations to use for code generation.
*
* Can be:
* - [MigrationLocation.Filesystem]:
* - directory with SQL migrations
* - [MigrationLocation.Classpath]:
* - directory with Java-based migrations (compiled classes)
* - directory with JAR files having Java-based or SQL migrations
* - path to a single JAR file having Java-based or SQL migrations
*
* Default: "src/main/resources/db/migration" directory of current project.
*
* @see MigrationLocation
*/
@Nested
val migrationLocations =
objectFactory.listProperty<MigrationLocation>().convention(
listOf(
MigrationLocation.Filesystem(objectFactory.fileCollection().from("src/main/resources/db/migration")),
),
)
/**
* Location of generated classes.
*/
@OutputDirectory
val outputDirectory =
objectFactory.directoryProperty().convention(projectLayout.buildDirectory.dir("generated-jooq"))
/**
* Classpath for code generation. Derived from jooqCodegen configuration.
*/
@Classpath
val codegenClasspath =
objectFactory.fileCollection().from(
project.configurations.named(JooqDockerPlugin.CONFIGURATION_NAME),
)
private val localPluginSettings = objectFactory.property<JooqDockerPluginSettings>()
private val globalPluginSettings = project.extensions.getByType<JooqExtension>().pluginSettings
private val _pluginSettings: Provider<PrivateValueHolder<JooqDockerPluginSettings>>
get() = localPluginSettings.orElse(globalPluginSettings).map(::PrivateValueHolder)
/**
* Use [withContainer] or [withoutContainer] to provide configuration.
*/
@Nested
@Suppress("unused")
fun getPluginSettings(): Provider<out ValueHolder<JooqDockerPluginSettings>> = _pluginSettings
private val migrationRunner = UniversalMigrationRunner(schemas, migrationLocations, flywayProperties)
private val codegenRunner = UniversalJooqCodegenRunner()
private val configurationProvider =
ConfigurationProvider(
basePackageName = basePackageName,
outputSchemaToDefault = outputSchemaToDefault,
schemaToPackageMapping = schemaToPackageMapping,
schemas = schemas,
logLevel = logger.getCodegenLogging(),
)
private fun classLoaders() = CodegenClasspathAwareClassLoaders.from(codegenClasspath)
init {
group = "jooq"
description = "Generates jOOQ classes from Flyway migrations"
}
override fun withContainer(configure: Action<WithContainer>) =
localPluginSettings.set(
globalPluginSettings.map { settings ->
settings.let { it as? WithContainer }?.copy()?.apply(configure::execute) ?: WithContainer(configure)
},
)
override fun withoutContainer(configure: Action<WithoutContainer>) =
localPluginSettings.set(
globalPluginSettings.map { settings ->
settings.let { it as? WithoutContainer }?.copy()?.apply(configure::execute) ?: WithoutContainer(configure)
},
)
/**
* Configure the jOOQ code generator with an XML configuration file.
*/
@Suppress("unused")
fun usingXmlConfig(
file: RegularFile = projectLayout.projectDirectory.file("src/main/resources/db/jooq.xml"),
customizer: Action<Generator> = Action<Generator> { },
) {
_generatorConfig.set(
configurationProvider
.fromXml(providerFactory.fileContents(file))
.map { config ->
config.also { customizer.execute(it.generator) }
}.map(::PrivateValueHolder),
)
}
/**
* Configure the jOOQ code generator with an XML configuration file.
*/
@Suppress("unused")
fun usingXmlConfig(
file: RegularFile,
closure: Closure<Generator>,
) = usingXmlConfig(file, closure::callWith)
/**
* Configure the jOOQ code generator programmatically with [Generator].
*/
@Suppress("unused")
fun usingJavaConfig(customizer: Action<Generator>) {
_generatorConfig.set(
providerFactory
.provider {
configurationProvider.defaultConfiguration().also {
customizer.execute(it.generator)
}
}.map(::PrivateValueHolder),
)
}
/**
* Configure the jOOQ code generator programmatically with [Generator].
*/
@Suppress("unused")
fun usingJavaConfig(closure: Closure<Generator>) = usingJavaConfig(closure::callWith)
@TaskAction
fun generateClasses() {
_pluginSettings
.get()
.value
.runWithDatabaseCredentials(classLoaders()) { classLoaders, credentials ->
val schemaVersion = migrationRunner.migrateDb(classLoaders, credentials)
generateJooqClasses(classLoaders, credentials, schemaVersion)
}
}
private fun generateJooqClasses(
jdbcAwareClassLoader: CodegenClasspathAwareClassLoaders,
credentials: DatabaseCredentials,
schemaVersion: SchemaVersion,
) {
fsOperations.delete {
delete(outputDirectory)
}
codegenRunner.generateJooqClasses(
codegenAwareClassLoader = jdbcAwareClassLoader,
configuration =
_generatorConfig.get().value.copy().postProcess(
schemaVersion = schemaVersion,
credentials = credentials,
extraTableExclusions =
listOfNotNull(
migrationRunner.flywayTableName.takeUnless { includeFlywayTable.get() },
),
),
outputDirectory = outputDirectory,
)
}
/**
* Set location of Flyway migrations to use for code generation
*
* @see migrationLocations
* @see MigrationLocation
*/
fun ListProperty<MigrationLocation>.set(migrationLocation: MigrationLocation) = set(listOf(migrationLocation))
/**
* Set location of SQL migrations on the file system to use for code generation
*
* Example:
*
* ```
* migrationLocations.setFromFilesystem(project.files("src/main/resources/db/migration"))
* ```
*
* @see migrationLocations
* @see MigrationLocation
* @see Project.files
*/
fun ListProperty<MigrationLocation>.setFromFilesystem(files: FileCollection) =
set(
MigrationLocation.Filesystem(files),
)
/**
* Set location of SQL migrations on the file system to use for code generation
*
* Example:
*
* ```
* migrationLocations.setFromFilesystem("src/main/resources/db/migration")
* ```
*
* @see migrationLocations
* @see MigrationLocation
*/
fun ListProperty<MigrationLocation>.setFromFilesystem(path: String) = setFromFilesystem(project.files(path))
/**
* Add location of Java-based or SQL migrations to Flyway classpath from the specified path
*
* Example:
*
* ```
* tasks.generateJooqClasses {
* migrationLocations.setFromClasspath(project.files("build/libs/some.jar"))
* }
* ```
*
* @see migrationLocations
* @see MigrationLocation
* @see Project.files
* @see Project.project
* @see FileCollection
*/
fun ListProperty<MigrationLocation>.setFromClasspath(
path: FileCollection,
location: String = "/db/migration",
) = set(MigrationLocation.Classpath(path, location))
/**
* Add location of Java-based or SQL migrations to Flyway classpath from the specified provider
*
* Examples:
*
* Using compiled Java-based migrations from a Gradle submodule:
*
* ```
* tasks.generateJooqClasses {
* migrationLocations.setFromClasspath(
* project(":migrations").sourceSets.main.map { it.output }
* )
* }
* ```
*
* Similarly, if you use some extra dependencies in your migrations module, you can do this:
*
*
* ```
* tasks.generateJooqClasses {
* migrationLocations.setFromClasspath(
* // notice extra + it.runtimeClasspath
* project(":migrations").sourceSets.main.map { it.output + it.runtimeClasspath }
* )
* }
* ```
*
* @see migrationLocations
* @see MigrationLocation
* @see Project.project
*/
fun <T> ListProperty<MigrationLocation>.setFromClasspath(
pathProvider: Provider<T>,
location: String = "/db/migration",
) = setFromClasspath(project.files(pathProvider), location)
/**
* Add location of Java-based or SQL migrations to Flyway classpath from a configuration
*
* Example:
*
* ```
* val migrationClasspath by configurations.creating
*
* dependencies {
* migrationClasspath("third.party:some.artifact:some.version")
* }
*
* tasks.generateJooqClasses {
* migrationLocations.setFromClasspath(migrationClasspath)
* }
* ```
*
* @see migrationLocations
* @see MigrationLocation
* @see Project.getConfigurations
* @see GradleConfiguration
*/
fun ListProperty<MigrationLocation>.setFromClasspath(
configuration: GradleConfiguration,
location: String = "/db/migration",
) = setFromClasspath(project.files(configuration), location)
}
private data class PrivateValueHolder<T>(
@get:Nested val value: T,
) : ValueHolder<T>()