-
Notifications
You must be signed in to change notification settings - Fork 2.5k
/
LiquibaseProcessor.java
378 lines (327 loc) · 18.3 KB
/
LiquibaseProcessor.java
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
package io.quarkus.liquibase.deployment;
import static io.quarkus.deployment.annotations.ExecutionTime.STATIC_INIT;
import java.io.IOException;
import java.nio.file.Paths;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.HashSet;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Optional;
import java.util.Set;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import javax.enterprise.context.ApplicationScoped;
import javax.enterprise.inject.Default;
import org.jboss.logging.Logger;
import io.quarkus.agroal.spi.JdbcDataSourceBuildItem;
import io.quarkus.agroal.spi.JdbcDataSourceSchemaReadyBuildItem;
import io.quarkus.arc.deployment.AdditionalBeanBuildItem;
import io.quarkus.arc.deployment.SyntheticBeanBuildItem;
import io.quarkus.arc.deployment.SyntheticBeansRuntimeInitBuildItem;
import io.quarkus.arc.processor.DotNames;
import io.quarkus.datasource.common.runtime.DataSourceUtil;
import io.quarkus.deployment.Capability;
import io.quarkus.deployment.Feature;
import io.quarkus.deployment.annotations.BuildProducer;
import io.quarkus.deployment.annotations.BuildStep;
import io.quarkus.deployment.annotations.Consume;
import io.quarkus.deployment.annotations.ExecutionTime;
import io.quarkus.deployment.annotations.Record;
import io.quarkus.deployment.builditem.CapabilityBuildItem;
import io.quarkus.deployment.builditem.FeatureBuildItem;
import io.quarkus.deployment.builditem.ServiceStartBuildItem;
import io.quarkus.deployment.builditem.SystemPropertyBuildItem;
import io.quarkus.deployment.builditem.nativeimage.NativeImageResourceBuildItem;
import io.quarkus.deployment.builditem.nativeimage.NativeImageResourceBundleBuildItem;
import io.quarkus.deployment.builditem.nativeimage.ReflectiveClassBuildItem;
import io.quarkus.deployment.builditem.nativeimage.RuntimeInitializedClassBuildItem;
import io.quarkus.deployment.builditem.nativeimage.ServiceProviderBuildItem;
import io.quarkus.deployment.pkg.steps.NativeOrNativeSourcesBuild;
import io.quarkus.deployment.util.ServiceUtil;
import io.quarkus.liquibase.LiquibaseDataSource;
import io.quarkus.liquibase.LiquibaseFactory;
import io.quarkus.liquibase.runtime.LiquibaseBuildTimeConfig;
import io.quarkus.liquibase.runtime.LiquibaseFactoryProducer;
import io.quarkus.liquibase.runtime.LiquibaseRecorder;
import liquibase.change.Change;
import liquibase.change.core.CreateProcedureChange;
import liquibase.change.core.CreateViewChange;
import liquibase.change.core.LoadDataChange;
import liquibase.change.core.SQLFileChange;
import liquibase.changelog.ChangeLogParameters;
import liquibase.changelog.ChangeSet;
import liquibase.changelog.DatabaseChangeLog;
import liquibase.exception.LiquibaseException;
import liquibase.parser.ChangeLogParser;
import liquibase.parser.ChangeLogParserFactory;
import liquibase.resource.ClassLoaderResourceAccessor;
class LiquibaseProcessor {
private static final Logger LOGGER = Logger.getLogger(LiquibaseProcessor.class);
private static final String LIQUIBASE_BEAN_NAME_PREFIX = "liquibase_";
@BuildStep
CapabilityBuildItem capability() {
return new CapabilityBuildItem(Capability.LIQUIBASE);
}
@BuildStep
public SystemPropertyBuildItem disableHub() {
// Don't block app startup with prompt:
// Do you want to see this operation's report in Liquibase Hub, which improves team collaboration?
// If so, enter your email. If not, enter [N] to no longer be prompted, or [S] to skip for now, but ask again next time (default "S"):
return new SystemPropertyBuildItem("liquibase.hub.mode", "off");
}
@BuildStep(onlyIf = NativeOrNativeSourcesBuild.class)
@Record(STATIC_INIT)
void nativeImageConfiguration(
LiquibaseRecorder recorder,
LiquibaseBuildTimeConfig liquibaseBuildConfig,
List<JdbcDataSourceBuildItem> jdbcDataSourceBuildItems,
BuildProducer<ReflectiveClassBuildItem> reflective,
BuildProducer<NativeImageResourceBuildItem> resource,
BuildProducer<ServiceProviderBuildItem> services,
BuildProducer<RuntimeInitializedClassBuildItem> runtimeInitialized,
BuildProducer<NativeImageResourceBundleBuildItem> resourceBundle) {
runtimeInitialized.produce(new RuntimeInitializedClassBuildItem(liquibase.diff.compare.CompareControl.class.getName()));
reflective.produce(new ReflectiveClassBuildItem(false, true, false,
liquibase.change.AbstractSQLChange.class.getName(),
liquibase.database.jvm.JdbcConnection.class.getName()));
reflective.produce(new ReflectiveClassBuildItem(true, true, true,
liquibase.parser.ChangeLogParserCofiguration.class.getName(),
liquibase.hub.HubServiceFactory.class.getName(),
liquibase.logging.core.DefaultLoggerConfiguration.class.getName(),
liquibase.configuration.GlobalConfiguration.class.getName(),
com.datical.liquibase.ext.config.LiquibaseProConfiguration.class.getName(),
liquibase.license.LicenseServiceFactory.class.getName(),
liquibase.executor.ExecutorService.class.getName(),
liquibase.change.ChangeFactory.class.getName(),
liquibase.logging.core.LogServiceFactory.class.getName(),
liquibase.logging.LogFactory.class.getName(),
liquibase.change.ColumnConfig.class.getName(),
liquibase.change.AddColumnConfig.class.getName(),
liquibase.change.core.LoadDataColumnConfig.class.getName(),
liquibase.sql.visitor.PrependSqlVisitor.class.getName(),
liquibase.sql.visitor.ReplaceSqlVisitor.class.getName(),
liquibase.sql.visitor.AppendSqlVisitor.class.getName(),
liquibase.sql.visitor.RegExpReplaceSqlVisitor.class.getName()));
reflective.produce(new ReflectiveClassBuildItem(false, false, true,
liquibase.change.ConstraintsConfig.class.getName()));
Collection<String> dataSourceNames = jdbcDataSourceBuildItems.stream()
.map(i -> i.getName())
.collect(Collectors.toSet());
resource.produce(
new NativeImageResourceBuildItem(getChangeLogs(dataSourceNames, liquibaseBuildConfig).toArray(new String[0])));
Stream.of(liquibase.change.Change.class,
liquibase.changelog.ChangeLogHistoryService.class,
liquibase.command.LiquibaseCommand.class,
liquibase.database.Database.class,
liquibase.database.DatabaseConnection.class,
liquibase.datatype.LiquibaseDataType.class,
liquibase.diff.compare.DatabaseObjectComparator.class,
liquibase.diff.DiffGenerator.class,
liquibase.diff.output.changelog.ChangeGenerator.class,
liquibase.executor.Executor.class,
liquibase.license.LicenseService.class,
liquibase.lockservice.LockService.class,
liquibase.logging.LogService.class,
liquibase.parser.ChangeLogParser.class,
liquibase.parser.NamespaceDetails.class,
liquibase.parser.SnapshotParser.class,
liquibase.precondition.Precondition.class,
liquibase.serializer.ChangeLogSerializer.class,
liquibase.serializer.SnapshotSerializer.class,
liquibase.servicelocator.ServiceLocator.class,
liquibase.snapshot.SnapshotGenerator.class,
liquibase.sqlgenerator.SqlGenerator.class,
liquibase.structure.DatabaseObject.class,
liquibase.hub.HubService.class)
.forEach(t -> addService(services, reflective, t, false));
// Register Precondition services, and the implementation class for reflection while also registering fields for reflection
addService(services, reflective, liquibase.precondition.Precondition.class, true);
// liquibase XSD
resource.produce(new NativeImageResourceBuildItem(
"www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.5.xsd",
"www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.6.xsd",
"www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.7.xsd",
"www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.8.xsd",
"www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.9.xsd",
"www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.10.xsd",
"www.liquibase.org/xml/ns/dbchangelog/dbchangelog-4.0.xsd",
"www.liquibase.org/xml/ns/dbchangelog/dbchangelog-4.1.xsd",
"www.liquibase.org/xml/ns/dbchangelog/dbchangelog-ext.xsd",
"www.liquibase.org/xml/ns/pro/liquibase-pro-3.8.xsd",
"www.liquibase.org/xml/ns/pro/liquibase-pro-3.9.xsd",
"www.liquibase.org/xml/ns/pro/liquibase-pro-3.10.xsd",
"www.liquibase.org/xml/ns/pro/liquibase-pro-4.0.xsd",
"www.liquibase.org/xml/ns/pro/liquibase-pro-4.1.xsd",
"liquibase.build.properties"));
// liquibase resource bundles
resourceBundle.produce(new NativeImageResourceBundleBuildItem("liquibase/i18n/liquibase-core"));
}
private void addService(BuildProducer<ServiceProviderBuildItem> services,
BuildProducer<ReflectiveClassBuildItem> reflective, Class<?> serviceClass,
boolean shouldRegisterFieldForReflection) {
try {
String service = "META-INF/services/" + serviceClass.getName();
Set<String> implementations = ServiceUtil.classNamesNamedIn(Thread.currentThread().getContextClassLoader(),
service);
services.produce(new ServiceProviderBuildItem(serviceClass.getName(), implementations.toArray(new String[0])));
reflective.produce(new ReflectiveClassBuildItem(true, true, shouldRegisterFieldForReflection,
implementations.toArray(new String[0])));
} catch (IOException ex) {
throw new IllegalStateException(ex);
}
}
@BuildStep
FeatureBuildItem feature() {
return new FeatureBuildItem(Feature.LIQUIBASE);
}
@BuildStep
@Record(ExecutionTime.RUNTIME_INIT)
void createBeans(LiquibaseRecorder recorder,
List<JdbcDataSourceBuildItem> jdbcDataSourceBuildItems,
BuildProducer<AdditionalBeanBuildItem> additionalBeans,
BuildProducer<SyntheticBeanBuildItem> syntheticBeanBuildItemBuildProducer) {
// make a LiquibaseContainerProducer bean
additionalBeans
.produce(AdditionalBeanBuildItem.builder().addBeanClasses(LiquibaseFactoryProducer.class).setUnremovable()
.setDefaultScope(DotNames.SINGLETON).build());
// add the @LiquibaseDataSource class otherwise it won't registered as a qualifier
additionalBeans.produce(AdditionalBeanBuildItem.builder().addBeanClass(LiquibaseDataSource.class).build());
Collection<String> dataSourceNames = getDataSourceNames(jdbcDataSourceBuildItems);
for (String dataSourceName : dataSourceNames) {
SyntheticBeanBuildItem.ExtendedBeanConfigurator configurator = SyntheticBeanBuildItem
.configure(LiquibaseFactory.class)
.scope(ApplicationScoped.class) // this is what the existing code does, but it doesn't seem reasonable
.setRuntimeInit()
.unremovable()
.supplier(recorder.liquibaseSupplier(dataSourceName));
if (DataSourceUtil.isDefault(dataSourceName)) {
configurator.addQualifier(Default.class);
} else {
String beanName = LIQUIBASE_BEAN_NAME_PREFIX + dataSourceName;
configurator.name(beanName);
configurator.addQualifier().annotation(DotNames.NAMED).addValue("value", beanName).done();
configurator.addQualifier().annotation(LiquibaseDataSource.class).addValue("value", dataSourceName).done();
}
syntheticBeanBuildItemBuildProducer.produce(configurator.done());
}
}
@BuildStep
@Record(ExecutionTime.RUNTIME_INIT)
@Consume(SyntheticBeansRuntimeInitBuildItem.class)
ServiceStartBuildItem startLiquibase(LiquibaseRecorder recorder,
List<JdbcDataSourceBuildItem> jdbcDataSourceBuildItems,
BuildProducer<JdbcDataSourceSchemaReadyBuildItem> schemaReadyBuildItem) {
// will actually run the actions at runtime
recorder.doStartActions();
// once we are done running the migrations, we produce a build item indicating that the
// schema is "ready"
schemaReadyBuildItem.produce(new JdbcDataSourceSchemaReadyBuildItem(getDataSourceNames(jdbcDataSourceBuildItems)));
return new ServiceStartBuildItem("liquibase");
}
private Set<String> getDataSourceNames(List<JdbcDataSourceBuildItem> jdbcDataSourceBuildItems) {
Set<String> result = new HashSet<>(jdbcDataSourceBuildItems.size());
for (JdbcDataSourceBuildItem item : jdbcDataSourceBuildItems) {
result.add(item.getName());
}
return result;
}
/**
* Collect the configured changeLog file for the default and all named datasources.
* <p>
* A {@link LinkedHashSet} is used to avoid duplications.
*/
private List<String> getChangeLogs(Collection<String> dataSourceNames, LiquibaseBuildTimeConfig liquibaseBuildConfig) {
if (dataSourceNames.isEmpty()) {
return Collections.emptyList();
}
ChangeLogParameters changeLogParameters = new ChangeLogParameters();
ClassLoaderResourceAccessor classLoaderResourceAccessor = new ClassLoaderResourceAccessor(
Thread.currentThread().getContextClassLoader());
ChangeLogParserFactory changeLogParserFactory = ChangeLogParserFactory.getInstance();
Set<String> resources = new LinkedHashSet<>();
// default datasource
if (DataSourceUtil.hasDefault(dataSourceNames)) {
resources.addAll(findAllChangeLogFiles(liquibaseBuildConfig.defaultDataSource.changeLog, changeLogParserFactory,
classLoaderResourceAccessor, changeLogParameters));
}
// named datasources
Collection<String> namedDataSourceChangeLogs = dataSourceNames.stream()
.filter(n -> !DataSourceUtil.isDefault(n))
.map(liquibaseBuildConfig::getConfigForDataSourceName)
.map(c -> c.changeLog)
.collect(Collectors.toCollection(LinkedHashSet::new));
for (String namedDataSourceChangeLog : namedDataSourceChangeLogs) {
resources.addAll(
findAllChangeLogFiles(namedDataSourceChangeLog, changeLogParserFactory, classLoaderResourceAccessor,
changeLogParameters));
}
LOGGER.debugf("Liquibase changeLogs: %s", resources);
return new ArrayList<>(resources);
}
/**
* Finds all resource files for the given change log file
*/
private Set<String> findAllChangeLogFiles(String file, ChangeLogParserFactory changeLogParserFactory,
ClassLoaderResourceAccessor classLoaderResourceAccessor,
ChangeLogParameters changeLogParameters) {
try {
ChangeLogParser parser = changeLogParserFactory.getParser(file, classLoaderResourceAccessor);
DatabaseChangeLog changelog = parser.parse(file, changeLogParameters, classLoaderResourceAccessor);
if (changelog != null) {
Set<String> result = new LinkedHashSet<>();
// get all changeSet files
for (ChangeSet changeSet : changelog.getChangeSets()) {
result.add(changeSet.getFilePath());
changeSet.getChanges().stream()
.map(change -> extractChangeFile(change, changeSet.getFilePath()))
.forEach(changeFile -> changeFile.ifPresent(result::add));
// get all parents of the changeSet
DatabaseChangeLog parent = changeSet.getChangeLog();
while (parent != null) {
result.add(parent.getFilePath());
parent = parent.getParentChangeLog();
}
}
result.add(changelog.getFilePath());
return result;
}
} catch (LiquibaseException ex) {
throw new IllegalStateException(ex);
}
return Collections.emptySet();
}
private Optional<String> extractChangeFile(Change change, String changeSetFilePath) {
String path = null;
Boolean relative = null;
if (change instanceof LoadDataChange) {
LoadDataChange loadDataChange = (LoadDataChange) change;
path = loadDataChange.getFile();
relative = loadDataChange.isRelativeToChangelogFile();
} else if (change instanceof SQLFileChange) {
SQLFileChange sqlFileChange = (SQLFileChange) change;
path = sqlFileChange.getPath();
relative = sqlFileChange.isRelativeToChangelogFile();
} else if (change instanceof CreateProcedureChange) {
CreateProcedureChange createProcedureChange = (CreateProcedureChange) change;
path = createProcedureChange.getPath();
relative = createProcedureChange.isRelativeToChangelogFile();
} else if (change instanceof CreateViewChange) {
CreateViewChange createViewChange = (CreateViewChange) change;
path = createViewChange.getPath();
relative = createViewChange.getRelativeToChangelogFile();
}
// unrelated change or change does not reference a file (e.g. inline view)
if (path == null) {
return Optional.empty();
}
// absolute file path or changeSet has no file path
if (relative == null || !relative || changeSetFilePath == null) {
return Optional.of(path);
}
// relative file path needs to be resolved against changeSetFilePath
// notes: ClassLoaderResourceAccessor does not provide a suitable method and CLRA.getFinalPath() is not visible
return Optional.of(Paths.get(changeSetFilePath).resolveSibling(path).toString().replace('\\', '/'));
}
}