/
build.gradle
1249 lines (1130 loc) · 52.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
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
import de.undercouch.gradle.tasks.download.Download
plugins {
// https://plugins.gradle.org/plugin/com.github.johnrengelman.shadow (v5 requires Gradle 5)
id 'com.github.johnrengelman.shadow' version '7.1.2'
// https://plugins.gradle.org/plugin/de.undercouch.download
id "de.undercouch.download" version "5.2.0"
id 'java'
// https://github.com/tbroyer/gradle-errorprone-plugin
id "net.ltgt.errorprone" version "2.0.2"
// https://plugins.gradle.org/plugin/org.ajoberstar.grgit
id 'org.ajoberstar.grgit' version '4.1.1' apply false
// Code formatting; defines targets "spotlessApply" and "spotlessCheck"
id "com.diffplug.spotless" version "6.11.0"
}
apply plugin: "de.undercouch.download"
import org.ajoberstar.grgit.Grgit
repositories {
mavenCentral()
}
ext {
release = false
// On a Java 8 JVM, use error-prone javac and source/target 8.
// On a Java 9+ JVM, use the host javac, default source/target, and required module flags.
isJava8 = JavaVersion.current() == JavaVersion.VERSION_1_8
// This call to `isCompatibleWith` causes a Gradle run-time failure: "No signature of method".
// isJava17compatible = JavaVersion.isCompatibleWith(JavaVersion.VERSION_17)
isJava17compatible = JavaVersion.current() >= JavaVersion.VERSION_17
errorproneJavacVersion = '9+181-r4173-1'
parentDir = file("${rootDir}/../").absolutePath
annotationTools = "${parentDir}/annotation-tools"
afu = "${annotationTools}/annotation-file-utilities"
stubparser = "${parentDir}/stubparser"
stubparserJar = "${stubparser}/javaparser-core/target/stubparser-3.24.3.jar"
formatScriptsHome = "${project(':checker').projectDir}/bin-devel/.run-google-java-format"
plumeScriptsHome = "${project(':checker').projectDir}/bin-devel/.plume-scripts"
htmlToolsHome = "${project(':checker').projectDir}/bin-devel/.html-tools"
javadocMemberLevel = JavadocMemberLevel.PROTECTED
// The local git repository, typically in the .git directory, but not for worktrees.
// This value is always overwritten, but Gradle needs the variable to be initialized.
localRepo = ".git"
}
// Keep in sync with check in
// framework/src/main/java/org/checkerframework/framework/source/SourceChecker.java .
switch (JavaVersion.current()) {
case JavaVersion.VERSION_1_9:
case JavaVersion.VERSION_1_10:
case JavaVersion.VERSION_12:
case JavaVersion.VERSION_19:
case JavaVersion.VERSION_20:
logger.note("The Checker Framework has only been tested with JDK 8, 11, 17, and 18." +
" You are using JDK " + JavaVersion.current().majorVersion + ".");
break;
case JavaVersion.VERSION_1_8:
case JavaVersion.VERSION_11:
case JavaVersion.VERSION_17:
case JavaVersion.VERSION_18:
break; // Supported versions
default:
throw new GradleException("Unexpected Java version found: " + JavaVersion.current().majorVersion);
}
task setLocalRepo(type:Exec) {
commandLine 'git', 'worktree', 'list'
standardOutput = new ByteArrayOutputStream()
doLast {
String worktreeList = standardOutput.toString()
localRepo = worktreeList.substring(0, worktreeList.indexOf(" ")) + "/.git"
}
}
// No group so it does not show up in the output of `gradlew tasks`
task installGitHooks(type: Copy, dependsOn: 'setLocalRepo') {
description 'Copies git hooks to .git directory'
from files("checker/bin-devel/git.post-merge", "checker/bin-devel/git.pre-commit")
rename('git\\.(.*)', '$1')
into localRepo + "/hooks"
}
spotless {
// Resolve the spottless plugin dependencies from the buildscript repositories rather than the
// project repositories. That way the spotless plugin does not use the locally built version of
// checker-qual as a dependency. Without this, errors like the follow are issued when running
// a spotless task without a locally-built version of checker-qual.jar:
// Could not determine the dependencies of task ':checker-qual:spotlessCheck'.
// > Could not create task ':checker-qual:spotlessJavaCheck'.
// > Could not create task ':checker-qual:spotlessJava'.
// > File signature can only be created for existing regular files, given:
// /Users/smillst/jsr308/checker-framework/checker-qual/build/libs/checker-qual-3.25.1-SNAPSHOT.jar
predeclareDepsFromBuildscript()
}
spotlessPredeclare {
// Put all the formatters that have dependencies here. Without this, errors like the following
// will happen:
// Could not determine the dependencies of task ':spotlessCheck'.
// > Could not create task ':spotlessJavaCheck'.
// > Could not create task ':spotlessJava'.
// > Add a step with [com.google.googlejavaformat:google-java-format:1.15.0] into the `spotlessPredeclare` block in the root project.
java {
googleJavaFormat()
}
}
allprojects {
tasks.withType(JavaCompile).configureEach {
options.fork = true
}
apply plugin: 'java'
apply plugin: 'com.github.johnrengelman.shadow'
apply plugin: "de.undercouch.download"
apply plugin: 'net.ltgt.errorprone'
apply plugin: 'com.diffplug.spotless'
group 'org.checkerframework'
// Increment the minor version (second number) rather than just the patch
// level (third number) if:
// * any new checkers have been added, or
// * backward-incompatible changes have been made to APIs or elsewhere.
version '3.25.1-SNAPSHOT'
repositories {
mavenCentral()
}
configurations {
javacJar
// Holds the combined classpath of all subprojects including the subprojects themselves.
allProjects
// Exclude checker-qual dependency added by Error Prone to avoid a circular dependency.
annotationProcessor.exclude group:'org.checkerframework', module:'checker-qual'
}
dependencies {
javacJar group: 'com.google.errorprone', name: 'javac', version: "$errorproneJavacVersion"
errorproneJavac("com.google.errorprone:javac:$errorproneJavacVersion")
allProjects subprojects
}
ext {
// A list of add-export and add-open arguments to be used when running the Checker Framework.
// Keep this list in sync with the lists in CheckerMain#getExecArguments,
// the sections with labels "javac-jdk11-non-modularized", "maven", and "sbt" in the manual
// and in the checker-framework-gradle-plugin, CheckerFrameworkPlugin#applyToProject
compilerArgsForRunningCF = [
// These are required in Java 16+ because the --illegal-access option is set to deny
// by default. None of these packages are accessed via reflection, so the module
// only needs to be exported, but not opened.
"--add-exports", "jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED",
"--add-exports", "jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED",
"--add-exports", "jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED",
"--add-exports", "jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED",
"--add-exports", "jdk.compiler/com.sun.tools.javac.model=ALL-UNNAMED",
"--add-exports", "jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED",
"--add-exports", "jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED",
"--add-exports", "jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED",
// Required because the Checker Framework reflectively accesses private members in com.sun.tools.javac.comp.
"--add-opens", "jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED",
]
reflectionUtilVersion = '1.0.5'
plumeUtilVersion = '1.5.9'
}
spotless {
// TODO: Remove the line below.
enforceCheck false
// If you add any formatters to this block that require dependencies here, then you must also
// add them to spotlessPredeclare block.
format 'misc', {
// define the files to apply `misc` to
target '*.gradle', '*.md', '.gitignore'
// define the steps to apply to those files
trimTrailingWhitespace()
indentWithSpaces(2)
endWithNewline()
}
java {
googleJavaFormat()
formatAnnotations()
}
}
// After all the tasks have been created, modify some of them.
afterEvaluate {
configurations {
checkerFatJar {
canBeConsumed = false
canBeResolved = true
}
}
dependencies {
checkerFatJar(project(path: ":checker", configuration: 'fatJar'))
}
// Add the fat checker.jar to the classpath of every Javadoc task. This allows Javadoc in
// any module to reference classes in any other module.
// Also, build and use ManualTaglet as a taglet.
tasks.withType(Javadoc) {
def tagletVersion = isJava8 ? 'taglet' : 'tagletJdk11'
dependsOn(':checker:shadowJar')
dependsOn(":framework-test:${tagletVersion}Classes")
doFirst {
options.encoding = 'UTF-8'
if (!name.equals("javadocDoclintAll")) {
options.memberLevel = javadocMemberLevel
}
classpath += configurations.getByName('checkerFatJar').asFileTree
if (isJava8) {
classpath += configurations.javacJar
}
options.taglets 'org.checkerframework.taglet.ManualTaglet'
options.tagletPath(project(':framework-test').sourceSets."${tagletVersion}".output.classesDirs.getFiles() as File[])
// We want to link to Java 9 documentation of the compiler classes since we use Java 9
// versions of those classes and Java 8 for everything else. Because the compiler classes are not
// a part of the main documentation of Java 8, javadoc links to the Java 9 versions.
// TODO, this creates broken links to the com.sun.tools.javac package.
options.links = ['https://docs.oracle.com/javase/8/docs/api/', 'https://docs.oracle.com/javase/9/docs/api/']
// This file is looked for by Javadoc.
file("${destinationDir}/resources/fonts/").mkdirs()
ant.touch(file: "${destinationDir}/resources/fonts/dejavu.css")
options.addStringOption('source', '8')
// "-Xwerror" requires Javadoc everywhere. Currently, CI jobs require Javadoc only
// on changed lines. Enable -Xwerror in the future when all Javadoc exists.
// options.addBooleanOption('Xwerror', true)
options.addStringOption('Xmaxwarns', '99999')
}
}
// Add standard javac options
tasks.withType(JavaCompile) { compilationTask ->
dependsOn(':installGitHooks')
// Sorting is commented out because it disables incremental compilation.
// Uncomment when needed.
// // Put source files in deterministic order, for debugging.
// compilationTask.source = compilationTask.source.sort()
sourceCompatibility = 8
targetCompatibility = 8
// Because the target is 8, all of the public compiler classes are accessible, so
// --add-exports are not required, (nor are they allowed with target 8). See
// https://openjdk.java.net/jeps/247 for details on compiling for older versions.
// When sourceCompatibilty is changed to 11, then the following will be required.
// options.compilerArgs += [
// "--add-exports", "jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED",
// "--add-exports", "jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED",
// "--add-exports", "jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED",
// "--add-exports", "jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED",
// "--add-exports", "jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED",
// "--add-exports", "jdk.compiler/com.sun.tools.javac.model=ALL-UNNAMED",
// "--add-exports", "jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED",
// "--add-exports", "jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED",
// "--add-exports", "jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED",
// ]
// This is equivalent to writing "exports jdk.compiler/... to ALL-UNNAMED" in the
// module-info.java of jdk.compiler, so corresponding --add-opens are only required for
// reflective access to private members.
//
// From https://openjdk.java.net/jeps/261, Section titled: "Breaking encapsulation"
// "The effect of each instance [of --add-exports] is to add a qualified export of the
// named package from the source module to the target module. This is, essentially, a
// command-line form of an exports clause in a module declaration[...].
// [...]
// The --add-exports option enables access to the public types of a specified package.
// It is sometimes necessary to go further and enable access to all non-public elements
// via the setAccessible method of the core reflection API. The --add-opens option can
// be used, at run time, to do this."
options.failOnError = true
options.deprecation = true
options.compilerArgs += [
'-g',
'-Werror',
// -options: To not get a warning about missing bootstrap classpath for Java 8 (once we use Java 9).
// -fallthrough: Don't check fallthroughs. Instead, use Error Prone. Its
// warnings are suppressible with a "// fall through" comment.
// -classfile: classgraph jar file and https://bugs.openjdk.java.net/browse/JDK-8190452
"-Xlint:-options,-fallthrough,-classfile",
"-Xlint",
]
options.encoding = 'UTF-8'
options.fork = true
if (isJava8) {
options.forkOptions.jvmArgs += ["-Xbootclasspath/p:${configurations.javacJar.asPath}".toString()]
}
// Error Prone depends on checker-qual.jar, so don't run it on that project to avoid a circular dependency.
// TODO: enable Error Prone on test classes.
if (compilationTask.name.equals('compileJava') && !project.name.startsWith('checker-qual')) {
// Error Prone must be available in the annotation processor path
options.annotationProcessorPath = configurations.errorprone
// Enable Error Prone
options.errorprone.enabled = !isJava8
options.errorprone.disableWarningsInGeneratedCode = true
options.errorprone.errorproneArgs = [
// Many compiler classes are interned.
'-Xep:ReferenceEquality:OFF',
// These might be worth fixing.
'-Xep:DefaultCharset:OFF',
// Not useful to suggest Splitter; maybe clean up.
'-Xep:StringSplitter:OFF',
// Too broad, rejects seemingly-correct code.
'-Xep:EqualsGetClass:OFF',
// Not a real problem
'-Xep:MixedMutabilityReturnType:OFF',
// Don't want to add a dependency to ErrorProne.
'-Xep:AnnotateFormatMethod:OFF',
// Warns for every use of "@checker_framework.manual"
'-Xep:InvalidBlockTag:OFF',
// Recommends writing @InlineMe which is an Error-Prone-specific annotation
'-Xep:InlineMeSuggester:OFF',
// Recommends writing @CanIgnoreReturnValue which is an Error-Prone-specific annotation.
// It would be great if Error Prone recognized the @This annotation.
'-Xep:CanIgnoreReturnValueSuggester:OFF',
// Should be turned off when using the Checker Framework.
'-Xep:ExtendsObject:OFF',
// -Werror halts the build if Error Prone issues a warning, which ensures that
// the errors get fixed. On the downside, Error Prone (or maybe the compiler?)
// stops as soon as it issues one warning, rather than outputting them all.
// https://github.com/google/error-prone/issues/436
'-Werror',
]
} else {
options.errorprone.enabled = false
}
}
}
}
task cloneAndBuildDependencies(type: Exec, group: 'Build') {
description 'Clones (or updates) and builds all dependencies'
executable 'checker/bin-devel/build.sh'
}
task maybeCloneAndBuildDependencies() {
// No group so it does not show up in the output of `gradlew tasks`
description 'Clones (or updates) and builds all dependencies if they are not present.'
onlyIf {
!file(stubparserJar).exists()
// The jdk repository is cloned via the copyAndMinimizeAnnotatedJdkFiles task that is run if
// the repository does not exist when building checker.jar.
}
doFirst {
if (file(stubparser).exists()) {
exec {
workingDir stubparser
executable 'git'
args = ['pull', '-q']
ignoreExitValue = true
}
exec {
workingDir stubparser
executable "${stubparser}/.build-without-test.sh"
}
} else {
exec {
executable 'checker/bin-devel/build.sh'
}
}
}
doLast {
if (!file(stubparserJar).exists()) {
println "The contents of ${stubparser}/javaparser-core/target (which does not contain stubparser.jar!) are:"
exec {
workingDir "${stubparser}/javaparser-core/target"
executable 'ls'
ignoreExitValue = true
}
throw new RuntimeException("Can't find stubparser jar: " + stubparserJar)
}
}
}
task version(group: 'Documentation') {
description 'Print Checker Framework version'
doLast {
println version
}
}
/**
* Creates a task that runs the checker on the main source set of each subproject. The task is named
* "check${taskName}", for example "checkPurity" or "checkNullness".
*
* @param projectName name of the project
* @param taskName short name (often the checker name) to use as part of the task name
* @param checker fully qualified name of the checker to run
* @param args list of arguments to pass to the checker
*/
def createCheckTypeTask(projectName, taskName, checker, args = []) {
project("${projectName}").tasks.create(name: "check${taskName}", type: JavaCompile, dependsOn: ':checker:shadowJar') {
description "Run the ${taskName} Checker on the main sources."
group 'Verification'
// Always run the task.
outputs.upToDateWhen { false }
source = project("${projectName}").sourceSets.main.java
classpath = files(project("${projectName}").compileJava.classpath,project(':checker-qual').sourceSets.main.output)
destinationDirectory = file("${buildDir}")
options.annotationProcessorPath = files(project(':checker').tasks.shadowJar.archivePath)
options.compilerArgs += [
'-processor', "${checker}",
'-proc:only',
'-Xlint:-processing',
'-Xmaxerrs', '10000',
'-Xmaxwarns', '10000',
'-ArequirePrefixInWarningSuppressions',
'-AwarnUnneededSuppressions',
]
options.compilerArgs += args
options.forkOptions.jvmArgs += ["-Xmx2g"]
if (isJava8) {
options.compilerArgs += [
"-source",
"8",
"-target",
"8"
]
} else {
options.fork = true
options.forkOptions.jvmArgs += compilerArgsForRunningCF
}
}
}
/**
* Returns a list of all the Java files that should be formatted for the given project. These are:
*
* All Java files in the main sourceSet.
* All Java files in the tests directory that compile.
*
* @param projectName name of the project to format
* @return a list of all Java files that should be formatted for projectName
*/
List<String> getJavaFilesToFormat(projectName) {
List<File> javaFiles = new ArrayList<>();
project(':' + projectName).sourceSets.forEach { set ->
javaFiles.addAll(set.java.files)
}
// Collect all Java files in tests directory
fileTree("${project(projectName).projectDir}/tests").visit { details ->
// If you change this, also change checker/bin-devel/git.pre-commit
if (!details.path.contains("nullness-javac-errors")
&& !details.path.contains("calledmethods-delomboked")
&& !details.path.contains("returnsreceiverdelomboked")
&& !details.path.contains("build")
&& (isJava17compatible || !details.path.contains("-records"))
&& (isJava17compatible || !details.path.contains("java17"))
&& details.name.endsWith('.java')) {
javaFiles.add(details.file)
}
}
// Collect all Java files in jtreg directory
fileTree("${project(projectName).projectDir}/jtreg").visit { details ->
if (!details.path.contains("nullness-javac-errors") && details.name.endsWith('.java')) {
javaFiles.add(details.file)
}
}
// Collect all Java files in jtregJdk11 directory
fileTree("${project(projectName).projectDir}/jtregJdk11").visit { details ->
if (!details.path.contains("nullness-javac-errors") && details.name.endsWith('.java')) {
javaFiles.add(details.file)
}
}
List<String> args = new ArrayList<>(javaFiles.size());
for (File f : javaFiles) {
args += project(projectName).relativePath(f)
}
return args
}
task writeListOfJavaFilesToFormat(group: 'Format') {
description "Writes a list of Java files subject to formatting, to ${buildDir}/javafiles.txt"
doLast {
mkdir buildDir
File list = new File("${buildDir}/javafiles.txt");
list.createNewFile();
FileWriter fileWriter = new FileWriter(list)
subprojects.forEach {
if (!it.name.startsWith("checker-qual-android")) {
for (String fileName : getJavaFilesToFormat(it.name)) {
fileWriter.write(fileName)
fileWriter.write(System.lineSeparator())
}
}
}
}
}
task htmlValidate(type: Exec, group: 'Format') {
description 'Validate that HTML files are well-formed'
executable 'html5validator'
args = [
"--ignore",
"/api/",
"/build/",
"/docs/manual/manual.html",
"/docs/manual/plume-bib/docs/index.html",
"/checker/jdk/nullness/src/java/lang/ref/package.html"
]
}
// `gradle allJavadoc` builds the Javadoc for all modules in `docs/api`.
// This is what is published to checkerframework.org.
// `gradle javadoc` builds the Javadoc for each sub-project in <subproject>/build/docs/javadoc/ .
// It's needed to create the Javadoc jars that we release in Maven Central.
// To make javadoc for only one subproject, run `./gradlew javadoc`
// in the subproject or `./gradlew :checker:javadoc` at the top level.
task allJavadoc(type: Javadoc, group: 'Documentation') {
description = 'Generates API documentation that includes all the modules.'
dependsOn(':checker:shadowJar', 'getPlumeScripts', 'getHtmlTools')
destinationDir = file("${rootDir}/docs/api")
source(project(':checker-util').sourceSets.main.allJava, project(':checker-qual').sourceSets.main.allJava, project(':checker').sourceSets.main.allJava, project(':framework').sourceSets.main.allJava,
project(':dataflow').sourceSets.main.allJava, project(':javacutil').sourceSets.main.allJava)
classpath = configurations.allProjects
if (isJava8) {
classpath += configurations.javacJar
}
doLast {
exec {
// Javadoc for to com.sun.tools.java.* is not publicly available, so these links are broken.
// This command removes those links.
workingDir "${rootDir}/docs/api"
executable "${plumeScriptsHome}/preplace"
args += ['<a href="https://docs.oracle.com/javase/9/docs/api/com/sun/tools/javac/.*?>(.*?)</a>', '\\1']
}
copy {
from 'docs/logo/Checkmark/CFCheckmark_favicon.png'
rename('CFCheckmark_favicon.png', 'favicon-checkerframework.png')
into "${rootDir}/docs/api"
}
exec {
workingDir "${rootDir}/docs/api"
executable "${htmlToolsHome}/html-add-favicon"
args += ['.', 'favicon-checkerframework.png']
}
}
}
// See documentation for allJavadoc task.
javadoc.dependsOn(allJavadoc)
configurations {
requireJavadoc
}
dependencies {
requireJavadoc "org.plumelib:require-javadoc:1.0.4"
}
task requireJavadoc(type: JavaExec, group: 'Documentation') {
description = 'Ensures that Javadoc documentation exists in source code.'
mainClass = "org.plumelib.javadoc.RequireJavadoc"
classpath = configurations.requireJavadoc
args "checker/src/main/java", "checker-qual/src/main/java", "checker-util/src/main/java", "dataflow/src/main/java", "framework/src/main/java", "framework-test/src/main/java", "javacutil/src/main/java"
}
/**
* Creates a task named taskName that runs javadoc with the -Xdoclint:all option.
*
* @param taskName the name of the task to create
* @param taskDescription description of the task
* @param memberLevel the JavadocMemberLevel to use
* @return the new task
*/
def createJavadocTask(taskName, taskDescription, memberLevel) {
tasks.create(name: taskName, type: Javadoc) {
description = taskDescription
destinationDir = file("${rootDir}/docs/tmpapi")
destinationDir.mkdirs()
subprojects.forEach {
if (!it.name.startsWith("checker-qual-android")) {
source += it.sourceSets.main.allJava
}
}
classpath = configurations.allProjects
destinationDir.deleteDir()
options.memberLevel = memberLevel
options.addBooleanOption('Xdoclint:all', true)
options.addStringOption('Xmaxwarns', '99999')
// options.addStringOption('skip', 'ClassNotToCheck|OtherClass')
}
}
createJavadocTask('javadocDoclintAll', 'Runs javadoc with -Xdoclint:all option.', JavadocMemberLevel.PRIVATE)
task manual(group: 'Documentation') {
description 'Build the manual'
doLast {
exec {
commandLine "make", "-C", "docs/manual", "all"
}
}
}
// See alternate implementation getCodeFormatScriptsInGradle below.
// No group so it does not show up in the output of `gradlew tasks`
task getCodeFormatScripts() {
description 'Obtain or update the run-google-java-format scripts'
if (file(formatScriptsHome).exists()) {
exec {
workingDir formatScriptsHome
executable 'git'
args = ['pull', '-q']
ignoreExitValue = true
}
} else {
exec {
workingDir "${formatScriptsHome}/../"
executable 'git'
args = ['clone', '-q', '--depth', '1', 'https://github.com/plume-lib/run-google-java-format.git', '.run-google-java-format']
}
}
}
// This implementation is preferable to the above because it does work in Gradle rather than in bash.
// However, it fails in the presence of worktrees: https://github.com/ajoberstar/grgit/issues/97 .
// No group so it does not show up in the output of `gradlew tasks`
task getCodeFormatScriptsInGradle {
description "Obtain the run-google-java-format scripts"
doLast {
if (! new File(formatScriptsHome).exists()) {
// There is no support for the --depth argument:
// https://github.com/ajoberstar/grgit/issues/155 https://bugs.eclipse.org/bugs/show_bug.cgi?id=475615
def rgjfGit = Grgit.clone(dir: formatScriptsHome, uri: 'https://github.com/plume-lib/run-google-java-format.git')
} else {
def rgjfGit = Grgit.open(dir: formatScriptsHome)
rgjfGit.pull()
}
}
}
// No group so it does not show up in the output of `gradlew tasks`
task getPlumeScripts() {
description 'Obtain or update plume-scripts'
if (file(plumeScriptsHome).exists()) {
exec {
workingDir plumeScriptsHome
executable 'git'
args = ['pull', '-q']
ignoreExitValue = true
}
} else {
exec {
workingDir "${plumeScriptsHome}/../"
executable 'git'
args = ['clone', '-q', '--depth', '1', 'https://github.com/plume-lib/plume-scripts.git', '.plume-scripts']
}
}
}
// No group so it does not show up in the output of `gradlew tasks`
task getHtmlTools() {
description 'Obtain or update html-tools'
if (file(htmlToolsHome).exists()) {
exec {
workingDir htmlToolsHome
executable 'git'
args = ['pull', '-q']
ignoreExitValue = true
}
} else {
exec {
workingDir "${htmlToolsHome}/../"
executable 'git'
args = ['clone', '-q', '--depth', '1', 'https://github.com/plume-lib/html-tools.git', '.html-tools']
}
}
}
// No group so it does not show up in the output of `gradlew tasks`
task pythonIsInstalled(type: Exec) {
description "Check that the python3 executable is installed."
executable = "python3"
args "--version"
}
task tags {
group 'Emacs'
description 'Create Emacs TAGS table'
doLast {
exec {
commandLine "etags", "-i", "checker/TAGS", "-i", "checker-qual/TAGS", "-i", "checker-util/TAGS", "-i", "dataflow/TAGS", "-i", "framework/TAGS", "-i", "framework-test/TAGS", "-i", "javacutil/TAGS", "-i", "docs/manual/TAGS"
}
exec {
commandLine "make", "-C", "docs/manual", "tags"
}
}
}
subprojects {
configurations {
errorprone
annotatedGuava
}
dependencies {
// https://mvnrepository.com/artifact/com.google.errorprone/error_prone_core
// If you update this:
// * Temporarily comment out "-Werror" elsewhere in this file
// * Repeatedly run `./gradlew clean compileJava` and fix all errors
// * Uncomment "-Werror"
ext.errorproneVersion = '2.15.0'
errorprone group: 'com.google.errorprone', name: 'error_prone_core', version: errorproneVersion
// TODO: it's a bug that annotatedlib:guava requires the error_prone_annotations dependency.
annotatedGuava "com.google.errorprone:error_prone_annotations:${errorproneVersion}"
annotatedGuava ('org.checkerframework.annotatedlib:guava:30.1.1-jre') {
// So long as Guava only uses annotations from checker-qual, excluding it should not cause problems.
exclude group: 'org.checkerframework'
}
}
task checkFormat(type: Exec, dependsOn: [getCodeFormatScripts, pythonIsInstalled], group: 'Format') {
description 'Check whether the source code is properly formatted'
// checker-qual-android project has no source, so skip
onlyIf {!project.name.startsWith('checker-qual-android') }
executable 'python3'
doFirst {
if (isJava8) {
println 'The checkFormat task cannot be run on Java 8. Please use Java 11+.'
return
}
args += "${formatScriptsHome}/check-google-java-format.py"
args += getJavaFilesToFormat(project.name)
// Since the scripts are downloaded from third-party Github, the environment variable
// is the only way to add the necessary open:
environment('JDK_JAVA_OPTIONS', '--add-opens jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED --add-opens jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED --add-opens jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED --add-opens jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED --add-opens jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED --add-opens jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED --add-opens jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED --add-opens jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED')
}
ignoreExitValue = true
doLast {
if (!executionResult.isPresent() || executionResult.get().getExitValue() != 0) {
throw new RuntimeException('Found improper formatting, try running: ./gradlew reformat"')
}
}
}
task reformat(type: Exec, dependsOn: [getCodeFormatScripts, pythonIsInstalled], group: 'Format') {
description 'Format the Java source code'
// checker-qual-android project has no source, so skip
onlyIf {!project.name.startsWith('checker-qual-android') }
executable 'python3'
doFirst {
if (isJava8) {
println 'The reformat task cannot be run on Java 8. Please use Java 11+.'
return
}
args += "${formatScriptsHome}/run-google-java-format.py"
args += getJavaFilesToFormat(project.name)
}
}
shadowJar {
// If you add an external dependency, then do the following:
// 1. Before adding the dependency, run ./gradlew copyJarsToDist.
// 2. Copy checker/dist/checker.jar elsewhere.
// 3. Add the dependency, then run ./gradlew clean copyJarsToDist.
// 4. Unzip both jars and compare the contents.
// 5. Add relocate lines below for the packages.
// 6. Do steps 3-5 until all new classes are in org/checkerframework/.
// Relocate packages that might conflict with user's classpath.
relocate 'org.apache', 'org.checkerframework.org.apache'
relocate 'org.relaxng', 'org.checkerframework.org.relaxng'
relocate 'org.plumelib', 'org.checkerframework.org.plumelib'
relocate 'org.codehaus', 'org.checkerframework.org.codehaus'
relocate 'org.objectweb.asm', 'org.checkerframework.org.objectweb.asm'
relocate 'io.github.classgraph', 'org.checkerframework.io.github.classgraph'
relocate 'nonapi.io.github.classgraph', 'org.checkerframework.nonapi.io.github.classgraph'
// relocate 'sun', 'org.checkerframework.sun'
relocate 'com.google', 'org.checkerframework.com.google'
relocate 'plume', 'org.checkerframework.plume'
exclude '**/module-info.class'
doFirst {
if (release) {
// Only relocate JavaParser during a release:
relocate 'com.github.javaparser', 'org.checkerframework.com.github.javaparser'
}
}
}
if (!project.name.startsWith('checker-qual-android')) {
task tags(type: Exec) {
description 'Create Emacs TAGS table'
commandLine "bash", "-c", "find . \\( -name build \\) -prune -o -name '*.java' -print | sort-directory-order | xargs ctags -e -f TAGS"
}
}
java {
withJavadocJar()
withSourcesJar()
}
// Things in this block reference definitions in the subproject that do not exist,
// until the project is evaluated.
afterEvaluate {
// Adds manifest to all Jar files
tasks.withType(Jar) {
includeEmptyDirs = false
if (archiveFileName.get().startsWith("checker-qual") || archiveFileName.get().startsWith("checker-util")) {
metaInf {
from './LICENSE.txt'
}
} else {
metaInf {
from "${rootDir}/LICENSE.txt"
}
}
manifest {
attributes("Implementation-Version": "${project.version}")
attributes("Implementation-URL": "https://checkerframework.org")
if (! archiveFileName.get().endsWith("source.jar")) {
attributes('Automatic-Module-Name': "org.checkerframework." + project.name.replaceAll('-', '.'))
}
if (archiveFileName.get().startsWith("checker-qual") || archiveFileName.get().startsWith("checker-util")) {
attributes("Bundle-License": "MIT")
} else {
attributes("Bundle-License": "(GPL-2.0-only WITH Classpath-exception-2.0)")
}
}
}
// Add tasks to run various checkers on all the main source sets.
// These pass and are run by typecheckTests.
createCheckTypeTask(project.name, 'Formatter',
'org.checkerframework.checker.formatter.FormatterChecker')
createCheckTypeTask(project.name, 'Interning',
'org.checkerframework.checker.interning.InterningChecker',
['-Astubs=javax-lang-model-element-name.astub'])
createCheckTypeTask(project.name, 'NullnessOnlyAnnotatedFor',
'org.checkerframework.checker.nullness.NullnessChecker',
['-AskipUses=com\\.sun\\.*', '-AuseConservativeDefaultsForUncheckedCode=source'])
createCheckTypeTask(project.name, 'Purity',
'org.checkerframework.framework.util.PurityChecker')
createCheckTypeTask(project.name, 'Signature',
'org.checkerframework.checker.signature.SignatureChecker')
// These pass on some subprojects, which the `typecheck` task runs.
// TODO: Incrementally add @AnnotatedFor on more classes.
createCheckTypeTask(project.name, 'Nullness',
'org.checkerframework.checker.nullness.NullnessChecker',
['-AskipUses=com.sun.*'])
// Add jtregTests to framework and checker modules
if (project.name.is('framework') || project.name.is('checker')) {
tasks.create(name: 'jtregTests', group: 'Verification') {
description 'Run the jtreg tests.'
dependsOn('compileJava')
dependsOn('compileTestJava')
dependsOn('shadowJar')
String jtregOutput = "${buildDir}/jtreg"
String name = 'all'
String tests = '.'
doLast {
exec {
executable "jtreg"
args = [
"-dir:${projectDir}/jtreg",
"-workDir:${jtregOutput}/${name}/work",
"-reportDir:${jtregOutput}/${name}/report",
"-verbose:error,fail",
// Don't add debugging information
// "-javacoptions:-g",
"-keywords:!ignore",
"-samevm",
"-javacoptions:-classpath ${tasks.shadowJar.archiveFile.get()}:${sourceSets.test.output.asPath}",
// Required for checker/jtreg/nullness/PersistUtil.java and other tests
"-vmoptions:-classpath ${tasks.shadowJar.archiveFile.get()}:${sourceSets.test.output.asPath}",
]
if (isJava8) {
// Use Error Prone javac and source/target 8
args += [
"-vmoptions:-Xbootclasspath/p:${configurations.javacJar.asPath}",
"-javacoptions:-Xbootclasspath/p:${configurations.javacJar.asPath}",
"-javacoptions:-source 8",
"-javacoptions:-target 8"
]
} else {
args += [
// checker/jtreg/nullness/defaultsPersist/ReferenceInfoUtil.java
// uses the jdk.jdeps module.
"-javacoptions:--add-modules jdk.jdeps",
"-javacoptions:--add-exports=jdk.jdeps/com.sun.tools.classfile=ALL-UNNAMED",
"-vmoptions:--add-opens=jdk.jdeps/com.sun.tools.classfile=ALL-UNNAMED",
"-vmoptions:--add-opens=jdk.compiler/com.sun.tools.javac.api=ALL-UNNAMED",
"-vmoptions:--add-opens=jdk.compiler/com.sun.tools.javac.code=ALL-UNNAMED",
"-vmoptions:--add-opens=jdk.compiler/com.sun.tools.javac.comp=ALL-UNNAMED",
"-vmoptions:--add-opens=jdk.compiler/com.sun.tools.javac.file=ALL-UNNAMED",
"-vmoptions:--add-opens=jdk.compiler/com.sun.tools.javac.main=ALL-UNNAMED",
"-vmoptions:--add-opens=jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED",
"-vmoptions:--add-opens=jdk.compiler/com.sun.tools.javac.processing=ALL-UNNAMED",
"-vmoptions:--add-opens=jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED",
"-vmoptions:--add-opens=jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED",
]
}
if (project.name.is('framework')) {
// Do not check for the annotated JDK
args += [
"-javacoptions:-ApermitMissingJdk"
]
} else if (project.name.is('checker')) {
args += [
"-javacoptions:-classpath ${sourceSets.testannotations.output.asPath}",
]
}
// Location of jtreg tests
args += "${tests}"
}
}
}
}
// Create a task for each JUnit test class whose name is the same as the JUnit class name.
sourceSets.test.allJava.filter { it.path.contains('test/junit') }.forEach { file ->
String junitClassName = file.name.replaceAll(".java", "")
tasks.create(name: "${junitClassName}", type: Test) {
description "Run ${junitClassName} tests."
include "**/${name}.class"
}
}
// Configure JUnit tests
tasks.withType(Test) {
if (isJava8) {
jvmArgs "-Xbootclasspath/p:${configurations.javacJar.asPath}".toString()
} else {
jvmArgs += compilerArgsForRunningCF
}
maxParallelForks = Integer.MAX_VALUE
if (project.name.is('checker')) {
dependsOn('copyJarsToDist')
}
if (project.hasProperty('emit.test.debug')) {
systemProperties += ["emit.test.debug": 'true']
}
testLogging {
showStandardStreams = true
// Always run the tests
outputs.upToDateWhen { false }
// Show the found unexpected diagnostics and expected diagnostics not found.
exceptionFormat "full"
events "failed"
}
// After each test, print a summary.
afterSuite { desc, result ->
if (desc.getClassName() != null) {
long mils = result.getEndTime() - result.getStartTime()
double seconds = mils / 1000.0
println "Testsuite: ${desc.getClassName()}\n" +
"Tests run: ${result.testCount}, " +
"Failures: ${result.failedTestCount}, " +
"Skipped: ${result.skippedTestCount}, " +
"Time elapsed: ${seconds} sec\n"
}
}
}