forked from apache/camel
-
Notifications
You must be signed in to change notification settings - Fork 0
/
ValidateMojo.java
1030 lines (905 loc) · 44 KB
/
ValidateMojo.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
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
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.maven;
import java.io.*;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.*;
import java.util.stream.Collectors;
import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;
import org.apache.camel.catalog.CamelCatalog;
import org.apache.camel.catalog.ConfigurationPropertiesValidationResult;
import org.apache.camel.catalog.DefaultCamelCatalog;
import org.apache.camel.catalog.EndpointValidationResult;
import org.apache.camel.catalog.LanguageValidationResult;
import org.apache.camel.catalog.common.FileUtil;
import org.apache.camel.catalog.lucene.LuceneSuggestionStrategy;
import org.apache.camel.catalog.maven.MavenVersionManager;
import org.apache.camel.parser.RouteBuilderParser;
import org.apache.camel.parser.XmlRouteParser;
import org.apache.camel.parser.model.CamelEndpointDetails;
import org.apache.camel.parser.model.CamelRouteDetails;
import org.apache.camel.parser.model.CamelSimpleExpressionDetails;
import org.apache.camel.support.PatternHelper;
import org.apache.camel.tooling.maven.MavenArtifact;
import org.apache.camel.tooling.maven.MavenDownloaderImpl;
import org.apache.camel.tooling.maven.MavenResolutionException;
import org.apache.camel.util.OrderedProperties;
import org.apache.camel.util.StringHelper;
import org.apache.commons.io.IOUtils;
import org.apache.maven.model.Dependency;
import org.apache.maven.model.Resource;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugins.annotations.Component;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
import org.codehaus.mojo.exec.AbstractExecMojo;
import org.eclipse.aether.RepositorySystem;
import org.eclipse.aether.RepositorySystemSession;
import org.jboss.forge.roaster.Roaster;
import org.jboss.forge.roaster.model.JavaType;
import org.jboss.forge.roaster.model.source.JavaClassSource;
import static org.apache.camel.catalog.common.CatalogHelper.asRelativeFile;
import static org.apache.camel.catalog.common.CatalogHelper.findJavaRouteBuilderClasses;
import static org.apache.camel.catalog.common.CatalogHelper.findXmlRouters;
import static org.apache.camel.catalog.common.CatalogHelper.matchRouteFile;
import static org.apache.camel.catalog.common.CatalogHelper.stripRootPath;
import static org.apache.camel.catalog.common.FileUtil.findJavaFiles;
/**
* Parses the source code and validates the Camel routes has valid endpoint uris and simple expressions, and validates
* configuration files such as application.properties.
*/
@Mojo(name = "validate", threadSafe = true)
public class ValidateMojo extends AbstractExecMojo {
/**
* The maven project.
*/
@Parameter(property = "project", required = true, readonly = true)
protected MavenProject project;
/**
* Whether to fail if invalid Camel endpoints was found. By default the plugin logs the errors at WARN level
*/
@Parameter(property = "camel.failOnError", defaultValue = "false")
private boolean failOnError;
/**
* Whether to log endpoint URIs which was un-parsable and therefore not possible to validate
*/
@Parameter(property = "camel.logUnparseable", defaultValue = "false")
private boolean logUnparseable;
/**
* Whether to include Java files to be validated for invalid Camel endpoints
*/
@Parameter(property = "camel.includeJava", defaultValue = "true")
private boolean includeJava;
/**
* List of extra maven repositories
*/
@Parameter(property = "camel.extraRepositories")
private String[] extraMavenRepositories;
/**
* List of sources transitive dependencies that contains camel routes
*/
@Parameter(property = "camel.sourcesArtifacts")
private String[] sourcesArtifacts;
@Parameter(defaultValue = "${project.build.directory}")
private String projectBuildDir;
/**
* Whether to include XML files to be validated for invalid Camel endpoints
*/
@Parameter(property = "camel.includeXml", defaultValue = "true")
private boolean includeXml;
/**
* Whether to include test source code
*/
@Parameter(property = "camel.includeTest", defaultValue = "false")
private boolean includeTest;
/**
* To filter the names of java and xml files to only include files matching any of the given list of patterns
* (wildcard and regular expression). Multiple values can be separated by comma.
*/
@Parameter(property = "camel.includes")
private String includes;
/**
* To filter the names of java and xml files to exclude files matching any of the given list of patterns (wildcard
* and regular expression). Multiple values can be separated by comma.
*/
@Parameter(property = "camel.excludes")
private String excludes;
/**
* Whether to ignore unknown components
*/
@Parameter(property = "camel.ignoreUnknownComponent", defaultValue = "true")
private boolean ignoreUnknownComponent;
/**
* Whether to ignore incapable of parsing the endpoint uri
*/
@Parameter(property = "camel.ignoreIncapable", defaultValue = "true")
private boolean ignoreIncapable;
/**
* Whether to ignore deprecated options being used in the endpoint uri
*/
@Parameter(property = "camel.ignoreDeprecated", defaultValue = "true")
private boolean ignoreDeprecated;
/**
* Whether to ignore components that uses lenient properties. When this is true, then the uri validation is stricter
* but would fail on properties that are not part of the component but in the uri because of using lenient
* properties. For example using the HTTP components to provide query parameters in the endpoint uri.
*/
@Parameter(property = "camel.ignoreLenientProperties", defaultValue = "true")
private boolean ignoreLenientProperties;
/**
* Whether to show all endpoints and simple expressions (both invalid and valid).
*/
@Parameter(property = "camel.showAll", defaultValue = "false")
private boolean showAll;
/**
* Whether to allow downloading Camel catalog version from the internet. This is needed if the project uses a
* different Camel version than this plugin is using by default.
*/
@Parameter(property = "camel.downloadVersion", defaultValue = "true")
private boolean downloadVersion;
/**
* Whether to validate for duplicate route ids. Route ids should be unique and if there are duplicates then Camel
* will fail to startup.
*/
@Parameter(property = "camel.duplicateRouteId", defaultValue = "true")
private boolean duplicateRouteId;
/**
* Whether to validate direct/seda endpoints sending to non existing consumers.
*/
@Parameter(property = "camel.directOrSedaPairCheck", defaultValue = "true")
private boolean directOrSedaPairCheck;
/**
* When sourcesArtifacts are declared, choose to download transitive artifacts or not carefully enable this flag
* since it will try to download the whole dependency tree
*/
@Parameter(property = "camel.downloadTransitiveArtifacts", defaultValue = "false")
private boolean downloadTransitiveArtifacts;
/**
* Location of configuration files to validate. The default is application.properties Multiple values can be
* separated by comma and use wildcard pattern matching.
*/
@Parameter(property = "camel.configurationFiles")
private String configurationFiles = "application.properties";
@Component
private RepositorySystem repositorySystem;
@Parameter(defaultValue = "${repositorySystemSession}", readonly = true)
private RepositorySystemSession repositorySystemSession;
/**
* javaFiles in memory cache, useful for multi modules maven project
*/
private static Set<File> javaFiles = new LinkedHashSet<>();
/**
* xmlFiles in memory cache, useful for multi modules maven project
*/
private static Set<File> xmlFiles = new LinkedHashSet<>();
private static Set<String> downloadedArtifacts = new LinkedHashSet<>();
@Override
public void execute() throws MojoExecutionException {
// Download extra sources only if artifacts sources are defined and the current project is not a parent project
if (!"pom".equals(project.getPackaging()) && sourcesArtifacts != null && sourcesArtifacts.length > 0) {
// setup MavenDownloader, it will be used to download and locate artifacts declared via sourcesArtifacts
List<String> artifacts = Arrays.asList(sourcesArtifacts);
artifacts
.parallelStream()
.forEach(artifact -> {
if (!artifact.contains(":sources:")) {
getLog().warn("The artifact " + artifact
+ " does not contain sources classifier, and may be excluded in future releases");
}
});
try (MavenDownloaderImpl downloader
= new MavenDownloaderImpl(repositorySystem, repositorySystemSession, getSession().getSettings())) {
downloader.init();
Set<String> repositorySet = Arrays.stream(extraMavenRepositories)
.collect(Collectors.toSet());
List<String> artifactList = new ArrayList<>(artifacts);
// Remove already downloaded Artifacts
artifactList.removeAll(downloadedArtifacts);
if (!artifactList.isEmpty()) {
getLog().info("Downloading the following artifacts: " + artifactList);
List<MavenArtifact> mavenSourcesArtifacts
= downloader.resolveArtifacts(artifactList, repositorySet, downloadTransitiveArtifacts, false);
// Create folder into the target folder that will be used to unzip
// the downloaded artifacts
Path extraSourcesPath = Paths.get(projectBuildDir, "camel-validate-sources");
if (!Files.exists(extraSourcesPath)) {
Files.createDirectories(extraSourcesPath);
}
// Unzip all the downloaded artifacts and add javas and xmls files into the cache
for (MavenArtifact artifact : mavenSourcesArtifacts) {
StringBuilder sb = new StringBuilder();
sb.append(artifact.getGav().getGroupId()).append(":")
.append(artifact.getGav().getArtifactId()).append(":")
.append(artifact.getGav().getPackaging()).append(":")
.append(artifact.getGav().getClassifier()).append(":")
.append(artifact.getGav().getVersion());
// Avoid downloading the same dependency multiple times
downloadedArtifacts.add(sb.toString());
Path target = extraSourcesPath.resolve(artifact.getGav().getArtifactId());
getLog().info("Unzipping the artifact: " + artifact + " to " + target);
if (Files.exists(target)) {
continue;
}
unzipArtifact(artifact, target);
FileUtil.findJavaFiles(target.toFile(), javaFiles);
FileUtil.findXmlFiles(target.toFile(), xmlFiles);
}
}
} catch (IOException e) {
throw new MojoExecutionException(e);
} catch (MavenResolutionException e) {
// missing artifact, log and proceed
getLog().warn(e.getMessage());
}
}
CamelCatalog catalog = new DefaultCamelCatalog();
// add activemq as known component
catalog.addComponent("activemq", "org.apache.activemq.camel.component.ActiveMQComponent");
// enable did you mean
catalog.setSuggestionStrategy(new LuceneSuggestionStrategy());
// enable loading other catalog versions dynamically
catalog.setVersionManager(
new MavenVersionManager(repositorySystem, repositorySystemSession, getSession().getSettings()));
// use custom class loading
catalog.getJSonSchemaResolver().setClassLoader(ValidateMojo.class.getClassLoader());
// enable caching
catalog.enableCache();
String detectedVersion = findCamelVersion(project);
if (detectedVersion != null) {
getLog().info("Detected Camel version used in project: " + detectedVersion);
}
if (downloadVersion) {
String catalogVersion = catalog.getCatalogVersion();
String version = findCamelVersion(project);
if (version != null && !version.equals(catalogVersion)) {
// the project uses a different Camel version so attempt to load it
getLog().info("Downloading Camel version: " + version);
boolean loaded = catalog.loadVersion(version);
if (!loaded) {
getLog().warn("Error downloading Camel version: " + version);
}
}
}
if (catalog.getLoadedVersion() != null) {
getLog().info("Validating using downloaded Camel version: " + catalog.getLoadedVersion());
} else {
getLog().info("Validating using Camel version: " + catalog.getCatalogVersion());
}
doExecuteRoutes(catalog);
doExecuteConfigurationFiles(catalog);
}
private static void unzipArtifact(MavenArtifact artifact, Path target) throws IOException {
try (ZipFile zipFile = new ZipFile(artifact.getFile().toPath().toFile())) {
Enumeration<? extends ZipEntry> entries = zipFile.entries();
while (entries.hasMoreElements()) {
ZipEntry entry = entries.nextElement();
File entryDestination = new File(target.toString(), entry.getName());
if (entry.isDirectory()) {
entryDestination.mkdirs();
} else {
entryDestination.getParentFile().mkdirs();
try (InputStream in = zipFile.getInputStream(entry);
OutputStream out = new FileOutputStream(entryDestination)) {
IOUtils.copy(in, out);
}
}
}
}
}
protected void doExecuteConfigurationFiles(CamelCatalog catalog) throws MojoExecutionException {
Set<File> propertiesFiles = new LinkedHashSet<>();
for (Resource dir : project.getResources()) {
findPropertiesFiles(new File(dir.getDirectory()), propertiesFiles);
}
if (includeTest) {
for (Resource dir : project.getTestResources()) {
findPropertiesFiles(new File(dir.getDirectory()), propertiesFiles);
}
}
List<ConfigurationPropertiesValidationResult> results = new ArrayList<>();
for (File file : propertiesFiles) {
parseProperties(catalog, file, results);
}
validateResults(results);
}
private void validateResults(List<ConfigurationPropertiesValidationResult> results) throws MojoExecutionException {
int configurationErrors = 0;
int unknownComponents = 0;
int incapableErrors = 0;
int deprecatedOptions = 0;
for (ConfigurationPropertiesValidationResult result : results) {
int deprecated = result.getDeprecated() != null ? result.getDeprecated().size() : 0;
deprecatedOptions += deprecated;
boolean ok = result.isSuccess() && !result.hasWarnings();
if (!ok && ignoreUnknownComponent && result.getUnknownComponent() != null) {
// if we failed due unknown component then be okay if we should ignore that
unknownComponents++;
ok = true;
}
if (!ok && ignoreIncapable && result.getIncapable() != null) {
// if we failed due incapable then be okay if we should ignore that
incapableErrors++;
ok = true;
}
if (ok && !ignoreDeprecated && deprecated > 0) {
ok = false;
}
if (!ok) {
if (result.getUnknownComponent() != null) {
unknownComponents++;
} else if (result.getIncapable() != null) {
incapableErrors++;
} else {
configurationErrors++;
}
StringBuilder sb = new StringBuilder();
sb.append("Configuration validation error at: ");
sb.append("(").append(result.getFileName());
if (result.getLineNumber() > 0) {
sb.append(":").append(result.getLineNumber());
}
sb.append(")");
sb.append("\n\n");
String out = result.summaryErrorMessage(false, ignoreDeprecated, true);
sb.append(out);
sb.append("\n\n");
getLog().warn(sb.toString());
} else if (showAll) {
StringBuilder sb = new StringBuilder();
sb.append("Configuration validation passed at: ");
sb.append(result.getFileName());
if (result.getLineNumber() > 0) {
sb.append(":").append(result.getLineNumber());
}
sb.append("\n");
sb.append("\n\t").append(result.getText());
sb.append("\n\n");
getLog().info(sb.toString());
}
}
String configurationSummary;
if (configurationErrors == 0) {
int ok = results.size() - configurationErrors - incapableErrors - unknownComponents;
configurationSummary = String.format(
"Configuration validation success: (%s = passed, %s = invalid, %s = incapable, %s = unknown components, %s = deprecated options)",
ok, configurationErrors, incapableErrors, unknownComponents, deprecatedOptions);
} else {
int ok = results.size() - configurationErrors - incapableErrors - unknownComponents;
configurationSummary = String.format(
"Configuration validation error: (%s = passed, %s = invalid, %s = incapable, %s = unknown components, %s = deprecated options)",
ok, configurationErrors, incapableErrors, unknownComponents, deprecatedOptions);
}
if (configurationErrors > 0) {
getLog().warn(configurationSummary);
} else {
getLog().info(configurationSummary);
}
if (failOnError && (configurationErrors > 0)) {
throw new MojoExecutionException(configurationSummary + "\n");
}
}
private void parseProperties(CamelCatalog catalog, File file, List<ConfigurationPropertiesValidationResult> results) {
if (matchPropertiesFile(file)) {
try (InputStream is = new FileInputStream(file)) {
Properties prop = new OrderedProperties();
prop.load(is);
// validate each line
for (String name : prop.stringPropertyNames()) {
String value = prop.getProperty(name);
if (value != null) {
String text = name + "=" + value;
ConfigurationPropertiesValidationResult result = catalog.validateConfigurationProperty(text);
// only include lines that camel can accept (as there may be non camel properties too)
if (result.isAccepted()) {
// try to find line number
int lineNumber = findLineNumberInPropertiesFile(file, name);
if (lineNumber != -1) {
result.setLineNumber(lineNumber);
}
results.add(result);
result.setText(text);
result.setFileName(file.getName());
}
}
}
} catch (Exception e) {
getLog().warn("Error parsing file " + file + " code due " + e.getMessage(), e);
}
}
}
private int findLineNumberInPropertiesFile(File file, String name) {
name = name.trim();
// try to find the line number
try (LineNumberReader r = new LineNumberReader(new FileReader(file))) {
String line = r.readLine();
while (line != null) {
int pos = line.indexOf('=');
if (pos > 0) {
line = line.substring(0, pos);
}
line = line.trim();
if (line.equals(name)) {
return r.getLineNumber();
}
line = r.readLine();
}
} catch (Exception e) {
// ignore
}
return -1;
}
protected void doExecuteRoutes(CamelCatalog catalog) throws MojoExecutionException {
List<CamelEndpointDetails> endpoints = new ArrayList<>();
List<CamelSimpleExpressionDetails> simpleExpressions = new ArrayList<>();
List<CamelRouteDetails> routeIds = new ArrayList<>();
// find all java route builder classes
findJavaRouteBuilderClasses(javaFiles, includeJava, includeTest, project);
// find all xml routes
findXmlRouters(xmlFiles, includeXml, includeTest, project);
for (File file : javaFiles) {
if (matchFile(file)) {
parseJavaRouteFile(endpoints, simpleExpressions, routeIds, file);
}
}
for (File file : xmlFiles) {
if (matchFile(file)) {
parseXmlRouteFile(endpoints, simpleExpressions, routeIds, file);
}
}
// endpoint uris
validateResults(catalog, endpoints, simpleExpressions, routeIds);
}
private void validateResults(
CamelCatalog catalog, List<CamelEndpointDetails> endpoints, List<CamelSimpleExpressionDetails> simpleExpressions,
List<CamelRouteDetails> routeIds)
throws MojoExecutionException {
int endpointErrors = 0;
int unknownComponents = 0;
int incapableErrors = 0;
int deprecatedOptions = 0;
for (CamelEndpointDetails detail : endpoints) {
getLog().debug("Validating endpoint: " + detail.getEndpointUri());
EndpointValidationResult result
= catalog.validateEndpointProperties(detail.getEndpointUri(), ignoreLenientProperties);
int deprecated = result.getDeprecated() != null ? result.getDeprecated().size() : 0;
deprecatedOptions += deprecated;
boolean ok = result.isSuccess() && !result.hasWarnings();
if (!ok && ignoreUnknownComponent && result.getUnknownComponent() != null) {
// if we failed due unknown component then be okay if we should ignore that
unknownComponents++;
ok = true;
}
if (!ok && ignoreIncapable && result.getIncapable() != null) {
// if we failed due incapable then be okay if we should ignore that
incapableErrors++;
ok = true;
}
if (ok && !ignoreDeprecated && deprecated > 0) {
ok = false;
}
if (!ok) {
if (result.getUnknownComponent() != null) {
unknownComponents++;
} else if (result.getIncapable() != null) {
incapableErrors++;
} else {
endpointErrors++;
}
String msg = buildValidationErrorMessage(detail, result);
getLog().warn(msg);
} else if (showAll) {
String msg = buildValidationPassedMessage(detail, result);
getLog().info(msg);
}
}
String endpointSummary
= buildEndpointSummaryMessage(endpoints, endpointErrors, unknownComponents, incapableErrors, deprecatedOptions);
if (endpointErrors > 0) {
getLog().warn(endpointSummary);
} else {
getLog().info(endpointSummary);
}
// simple
int simpleErrors = validateSimple(catalog, simpleExpressions);
String simpleSummary = buildSimpleSummaryMessage(simpleExpressions, simpleErrors);
if (simpleErrors > 0) {
getLog().warn(simpleSummary);
} else {
getLog().info(simpleSummary);
}
// endpoint pairs
int sedaDirectErrors = 0;
String sedaDirectSummary = "";
if (directOrSedaPairCheck) {
long sedaDirectEndpoints
= (long) countEndpointPairs(endpoints, "direct") + (long) countEndpointPairs(endpoints, "seda");
sedaDirectErrors += validateEndpointPairs(endpoints, "direct") + validateEndpointPairs(endpoints, "seda");
if (sedaDirectErrors == 0) {
sedaDirectSummary
= String.format("Endpoint pair (seda/direct) validation success: (%s = pairs)", sedaDirectEndpoints);
} else {
sedaDirectSummary = String.format("Endpoint pair (seda/direct) validation error: (%s = pairs, %s = non-pairs)",
sedaDirectEndpoints, sedaDirectErrors);
}
if (sedaDirectErrors > 0) {
getLog().warn(sedaDirectSummary);
} else {
getLog().info(sedaDirectSummary);
}
}
// route id
int duplicateRouteIdErrors = validateDuplicateRouteId(routeIds);
String routeIdSummary = "";
if (duplicateRouteId) {
routeIdSummary = handleDuplicateRouteId(duplicateRouteIdErrors, routeIds);
}
if (failOnError && hasErrors(endpointErrors, simpleErrors, duplicateRouteIdErrors) || sedaDirectErrors > 0) {
throw new MojoExecutionException(
endpointSummary + "\n" + simpleSummary + "\n" + routeIdSummary + "\n" + sedaDirectSummary);
}
}
private static boolean hasErrors(int endpointErrors, int simpleErrors, int duplicateRouteIdErrors) {
return endpointErrors > 0 || simpleErrors > 0 || duplicateRouteIdErrors > 0;
}
private String handleDuplicateRouteId(int duplicateRouteIdErrors, List<CamelRouteDetails> routeIds) {
String routeIdSummary;
if (duplicateRouteIdErrors == 0) {
routeIdSummary = String.format("Duplicate route id validation success: (%s = ids)", routeIds.size());
} else {
routeIdSummary = String.format("Duplicate route id validation error: (%s = ids, %s = duplicates)",
routeIds.size(), duplicateRouteIdErrors);
}
if (duplicateRouteIdErrors > 0) {
getLog().warn(routeIdSummary);
} else {
getLog().info(routeIdSummary);
}
return routeIdSummary;
}
private String buildSimpleSummaryMessage(List<CamelSimpleExpressionDetails> simpleExpressions, int simpleErrors) {
String simpleSummary;
if (simpleErrors == 0) {
int ok = simpleExpressions.size() - simpleErrors;
simpleSummary = String.format("Simple validation success: (%s = passed, %s = invalid)", ok, simpleErrors);
} else {
int ok = simpleExpressions.size() - simpleErrors;
simpleSummary = String.format("Simple validation error: (%s = passed, %s = invalid)", ok, simpleErrors);
}
return simpleSummary;
}
private String buildEndpointSummaryMessage(
List<CamelEndpointDetails> endpoints, int endpointErrors, int unknownComponents, int incapableErrors,
int deprecatedOptions) {
String endpointSummary;
if (endpointErrors == 0) {
int ok = endpoints.size() - endpointErrors - incapableErrors - unknownComponents;
endpointSummary = String.format(
"Endpoint validation success: (%s = passed, %s = invalid, %s = incapable, %s = unknown components, %s = deprecated options)",
ok, endpointErrors, incapableErrors, unknownComponents, deprecatedOptions);
} else {
int ok = endpoints.size() - endpointErrors - incapableErrors - unknownComponents;
endpointSummary = String.format(
"Endpoint validation error: (%s = passed, %s = invalid, %s = incapable, %s = unknown components, %s = deprecated options)",
ok, endpointErrors, incapableErrors, unknownComponents, deprecatedOptions);
}
return endpointSummary;
}
private String buildValidationPassedMessage(CamelEndpointDetails detail, EndpointValidationResult result) {
StringBuilder sb = buildValidationSuccessMessage("Endpoint validation passed at: ", detail.getClassName(),
detail.getLineNumber(), detail.getMethodName(), detail.getFileName(), result.getUri());
return sb.toString();
}
private String buildValidationErrorMessage(CamelEndpointDetails detail, EndpointValidationResult result) {
StringBuilder sb = new StringBuilder();
sb.append("Endpoint validation error at: ");
buildErrorMessage(sb, detail.getClassName(), detail.getLineNumber(), detail.getMethodName(), detail.getFileName());
sb.append("\n\n");
String out = result.summaryErrorMessage(false, ignoreDeprecated, true);
sb.append(out);
sb.append("\n\n");
return sb.toString();
}
private void parseXmlRouteFile(
List<CamelEndpointDetails> endpoints, List<CamelSimpleExpressionDetails> simpleExpressions,
List<CamelRouteDetails> routeIds, File file) {
try {
List<CamelEndpointDetails> fileEndpoints = new ArrayList<>();
List<CamelSimpleExpressionDetails> fileSimpleExpressions = new ArrayList<>();
List<CamelRouteDetails> fileRouteIds = new ArrayList<>();
// parse the xml source code and find Camel routes
String fqn = file.getPath();
String baseDir = ".";
try (InputStream is = new FileInputStream(file)) {
XmlRouteParser.parseXmlRouteEndpoints(is, baseDir, fqn, fileEndpoints);
}
// need a new stream
try (InputStream is = new FileInputStream(file)) {
XmlRouteParser.parseXmlRouteSimpleExpressions(is, baseDir, fqn, fileSimpleExpressions);
}
if (duplicateRouteId) {
// need a new stream
try (InputStream is = new FileInputStream(file)) {
XmlRouteParser.parseXmlRouteRouteIds(is, baseDir, fqn, fileRouteIds);
}
}
// add what we found in this file to the total list
endpoints.addAll(fileEndpoints);
simpleExpressions.addAll(fileSimpleExpressions);
routeIds.addAll(fileRouteIds);
} catch (Exception e) {
getLog().warn("Error parsing xml file " + file + " code due " + e.getMessage(), e);
}
}
private void parseJavaRouteFile(
List<CamelEndpointDetails> endpoints, List<CamelSimpleExpressionDetails> simpleExpressions,
List<CamelRouteDetails> routeIds, File file) {
try {
List<CamelEndpointDetails> fileEndpoints = new ArrayList<>();
List<CamelRouteDetails> fileRouteIds = new ArrayList<>();
List<CamelSimpleExpressionDetails> fileSimpleExpressions = new ArrayList<>();
List<String> unparsable = new ArrayList<>();
// parse the java source code and find Camel RouteBuilder classes
String fqn = file.getPath();
String baseDir = ".";
JavaType<?> out = Roaster.parse(file);
// we should only parse java classes (not interfaces and enums etc)
if (out instanceof JavaClassSource clazz) {
RouteBuilderParser.parseRouteBuilderEndpoints(clazz, baseDir, fqn, fileEndpoints, unparsable, includeTest);
RouteBuilderParser.parseRouteBuilderSimpleExpressions(clazz, baseDir, fqn, fileSimpleExpressions);
if (duplicateRouteId) {
RouteBuilderParser.parseRouteBuilderRouteIds(clazz, baseDir, fqn, fileRouteIds);
}
// add what we found in this file to the total list
endpoints.addAll(fileEndpoints);
simpleExpressions.addAll(fileSimpleExpressions);
routeIds.addAll(fileRouteIds);
// was there any unparsable?
if (logUnparseable && !unparsable.isEmpty()) {
for (String uri : unparsable) {
getLog().warn("Cannot parse endpoint uri " + uri + " in java file " + file);
}
}
}
} catch (Exception e) {
getLog().warn("Error parsing java file " + file + " code due " + e.getMessage(), e);
}
}
private int countEndpointPairs(List<CamelEndpointDetails> endpoints, String scheme) {
int pairs = 0;
Set<CamelEndpointDetails> consumers = endpoints.stream()
.filter(e -> e.isConsumerOnly() && e.getEndpointUri().startsWith(scheme + ":")).collect(Collectors.toSet());
Set<CamelEndpointDetails> producers = endpoints.stream()
.filter(e -> e.isProducerOnly() && e.getEndpointUri().startsWith(scheme + ":")).collect(Collectors.toSet());
// find all pairs, eg producers that has a consumer (no need to check for opposite)
for (CamelEndpointDetails p : producers) {
boolean any = consumers.stream().anyMatch(c -> matchEndpointPath(p.getEndpointUri(), c.getEndpointUri()));
if (any) {
pairs++;
}
}
return pairs;
}
private int validateEndpointPairs(List<CamelEndpointDetails> endpoints, String scheme) {
int errors = 0;
Set<CamelEndpointDetails> consumers = endpoints.stream()
.filter(e -> e.isConsumerOnly() && e.getEndpointUri().startsWith(scheme + ":")).collect(Collectors.toSet());
Set<CamelEndpointDetails> producers = endpoints.stream()
.filter(e -> e.isProducerOnly() && e.getEndpointUri().startsWith(scheme + ":")).collect(Collectors.toSet());
// are there any producers that do not have a consumer pair
for (CamelEndpointDetails detail : producers) {
boolean none = consumers.stream().noneMatch(c -> matchEndpointPath(detail.getEndpointUri(), c.getEndpointUri()));
if (none) {
errors++;
final String msg = buildEndpointValidationErrorMessage(detail);
getLog().warn(msg);
} else if (showAll) {
StringBuilder sb = buildValidationSuccessMessage("Endpoint pair (seda/direct) validation passed at: ",
detail.getClassName(), detail.getLineNumber(), detail.getMethodName(), detail.getFileName(),
detail.getEndpointUri());
final String msg = sb.toString();
getLog().info(msg);
}
}
// NOTE: are there any consumers that do not have a producer pair
// You can have a consumer which you send to from outside a Camel route such as via ProducerTemplate
return errors;
}
private StringBuilder buildValidationSuccessMessage(
String str, String className, String lineNumber, String methodName, String fileName, String uri) {
StringBuilder sb = new StringBuilder();
sb.append(str);
buildErrorMessage(sb, className, lineNumber, methodName, fileName);
sb.append("\n");
sb.append("\n\t").append(uri);
sb.append("\n\n");
return sb;
}
private String buildEndpointValidationErrorMessage(CamelEndpointDetails detail) {
StringBuilder sb = new StringBuilder();
sb.append("Endpoint pair (seda/direct) validation error at: ");
buildErrorMessage(sb, detail.getClassName(), detail.getLineNumber(), detail.getMethodName(), detail.getFileName());
sb.append("\n");
sb.append("\n\t").append(detail.getEndpointUri());
sb.append("\n\n\t\t\t\t").append(endpointPathSummaryError(detail));
sb.append("\n\n");
return sb.toString();
}
private void buildErrorMessage(StringBuilder sb, String className, String lineNumber, String methodName, String fileName) {
if (className != null && lineNumber != null) {
// this is from java code
sb.append(className);
if (methodName != null) {
sb.append(".").append(methodName);
}
sb.append("(").append(asSimpleClassName(className)).append(".java:");
sb.append(lineNumber).append(")");
} else if (lineNumber != null) {
// this is from xml
String fqn = stripRootPath(asRelativeFile(fileName, project), project);
if (fqn.endsWith(".xml")) {
fqn = fqn.substring(0, fqn.length() - 4);
fqn = asPackageName(fqn);
}
sb.append(fqn);
sb.append("(").append(asSimpleClassName(fqn)).append(".xml:");
sb.append(lineNumber).append(")");
} else {
sb.append(fileName);
}
}
private static String endpointPathSummaryError(CamelEndpointDetails detail) {
String uri = detail.getEndpointUri();
String p = uri.contains("?") ? StringHelper.before(uri, "?") : uri;
String path = StringHelper.after(p, ":");
return path + "\t" + "Sending to non existing " + detail.getEndpointComponentName() + " queue name";
}
private static boolean matchEndpointPath(String uri, String uri2) {
String p = uri.contains("?") ? StringHelper.before(uri, "?") : uri;
String p2 = uri2.contains("?") ? StringHelper.before(uri2, "?") : uri2;
p = p.trim();
p2 = p2.trim();
return p.equals(p2);
}
private int validateSimple(CamelCatalog catalog, List<CamelSimpleExpressionDetails> simpleExpressions) {
int simpleErrors = 0;
for (CamelSimpleExpressionDetails detail : simpleExpressions) {
LanguageValidationResult result;
boolean predicate = detail.isPredicate();
if (predicate) {
getLog().debug("Validating simple predicate: " + detail.getSimple());
result = catalog.validateLanguagePredicate(null, "simple", detail.getSimple());
} else {
getLog().debug("Validating simple expression: " + detail.getSimple());
result = catalog.validateLanguageExpression(null, "simple", detail.getSimple());
}
if (!result.isSuccess()) {
simpleErrors++;
StringBuilder sb = new StringBuilder();
sb.append("Simple validation error at: ");
buildErrorMessage(sb, detail.getClassName(), detail.getLineNumber(), detail.getMethodName(),
detail.getFileName());
sb.append("\n");
String[] lines = result.getError().split("\n");
for (String line : lines) {
sb.append("\n\t").append(line);
}
sb.append("\n");
getLog().warn(sb.toString());
} else if (showAll) {
StringBuilder sb = buildValidationSuccessMessage("Simple validation passed at: ", detail.getClassName(),
detail.getLineNumber(), detail.getMethodName(), detail.getFileName(), result.getText());
getLog().info(sb.toString());
}
}
return simpleErrors;
}
private int validateDuplicateRouteId(List<CamelRouteDetails> routeIds) {
int duplicateRouteIdErrors = 0;
if (duplicateRouteId) {
// filter out all non uniques
for (CamelRouteDetails detail : routeIds) {
// skip empty route ids
if (detail.getRouteId() == null || "".equals(detail.getRouteId())) {
continue;
}
int count = countRouteId(routeIds, detail.getRouteId());
if (count > 1) {
duplicateRouteIdErrors++;
final String msg = buildRouteIdValidationMessage("Duplicate route id validation error at: ", detail);
getLog().warn(msg);
} else if (showAll) {
final String msg = buildRouteIdValidationMessage("Duplicate route id validation passed at: ", detail);
getLog().info(msg);
}
}
}
return duplicateRouteIdErrors;
}
private String buildRouteIdValidationMessage(String str, CamelRouteDetails detail) {
StringBuilder sb = buildValidationSuccessMessage(str, detail.getClassName(), detail.getLineNumber(),
detail.getMethodName(), detail.getFileName(), detail.getRouteId());
return sb.toString();
}
private static int countRouteId(List<CamelRouteDetails> details, String routeId) {
int answer = 0;
for (CamelRouteDetails detail : details) {
if (routeId.equals(detail.getRouteId())) {
answer++;
}
}
return answer;
}
private static String findCamelVersion(MavenProject project) {
Dependency candidate = null;
for (Dependency dep : project.getDependencies()) {
if ("org.apache.camel".equals(dep.getGroupId())) {
if ("camel-core".equals(dep.getArtifactId())) {
// favor camel-core
candidate = dep;
break;
} else {
candidate = dep;
}
}
}
if (candidate != null) {
return candidate.getVersion();
}
return null;
}
private void findPropertiesFiles(File dir, Set<File> propertiesFiles) {
File[] files = dir.isDirectory() ? dir.listFiles() : null;
if (files != null) {
for (File file : files) {
if (file.getName().endsWith(".properties")) {
propertiesFiles.add(file);
} else if (file.isDirectory()) {
findJavaFiles(file, propertiesFiles);
}
}
}
}