JAL-3541 rejigged clover tasks very mildly
[jalview.git] / build.gradle
1 import org.apache.tools.ant.filters.ReplaceTokens
2 import org.gradle.internal.os.OperatingSystem
3 import org.gradle.plugins.ide.eclipse.model.Output
4 import org.gradle.plugins.ide.eclipse.model.Library
5 import java.security.MessageDigest
6 import groovy.transform.ExternalizeMethods
7 import groovy.util.XmlParser
8 import groovy.xml.XmlUtil
9
10
11 buildscript {
12   repositories {
13     mavenCentral()
14     mavenLocal()
15   }
16   dependencies {
17     classpath 'org.openclover:clover:4.4.1'
18   }
19 }
20
21
22 plugins {
23   id 'java'
24   id 'application'
25   id 'eclipse'
26   id 'com.github.johnrengelman.shadow' version '4.0.3'
27   id 'com.install4j.gradle' version '8.0.4'
28   id 'com.dorongold.task-tree' version '1.5' // only needed to display task dependency tree with  gradle task1 [task2 ...] taskTree
29 }
30
31 repositories {
32   jcenter()
33   mavenCentral()
34   mavenLocal()
35 }
36
37
38 // in ext the values are cast to Object. Ensure string values are cast as String (and not GStringImpl) for later use
39 def string(Object o) {
40   return o == null ? "" : o.toString()
41 }
42
43
44 ext {
45   jalviewDirAbsolutePath = file(jalviewDir).getAbsolutePath()
46   jalviewDirRelativePath = jalviewDir
47
48   // local build environment properties
49   def localProps = "${jalviewDirAbsolutePath}/local.properties"
50   if (file(localProps).exists()) {
51     try {
52       def p = new Properties()
53       def localPropsFIS = new FileInputStream(localProps)
54       p.load(localPropsFIS)
55       localPropsFIS.close()
56       p.each {
57         key, val -> 
58           def oldval = findProperty(key)
59           setProperty(key, val)
60           if (oldval != null) {
61             println("Overriding property '${key}' ('${oldval}') with local.properties value '${val}'")
62           } else {
63             println("Setting unknown property '${key}' with local.properties value '${val}'")
64           }
65       }
66     } catch (Exception e) {
67       System.out.println("Exception reading local.properties")
68     }
69   }
70
71   // this property set when running Eclipse headlessly
72   j2sHeadlessBuildProperty = string("net.sf.j2s.core.headlessbuild")
73   // this property set by Eclipse
74   eclipseApplicationProperty = string("eclipse.application")
75   // CHECK IF RUNNING FROM WITHIN ECLIPSE
76   def eclipseApplicationPropertyVal = System.properties[eclipseApplicationProperty]
77   IN_ECLIPSE = eclipseApplicationPropertyVal != null && eclipseApplicationPropertyVal.startsWith("org.eclipse.ui.")
78   // BUT WITHOUT THE HEADLESS BUILD PROPERTY SET
79   if (System.properties[j2sHeadlessBuildProperty].equals("true")) {
80     println("Setting IN_ECLIPSE to ${IN_ECLIPSE} as System.properties['${j2sHeadlessBuildProperty}'] == '${System.properties[j2sHeadlessBuildProperty]}'")
81     IN_ECLIPSE = false
82   }
83   if (IN_ECLIPSE) {
84     println("WITHIN ECLIPSE IDE")
85   } else {
86     println("HEADLESS BUILD")
87   }
88   /* *-/
89   System.properties.sort { it.key }.each {
90     key, val -> println("SYSTEM PROPERTY ${key}='${val}'")
91   }
92   /-* *-/
93   if (false && IN_ECLIPSE) {
94     jalviewDir = jalviewDirAbsolutePath
95   }
96   */
97
98   // essentials
99   bareSourceDir = string(source_dir)
100   sourceDir = string("${jalviewDir}/${bareSourceDir}")
101   resourceDir = string("${jalviewDir}/${resource_dir}")
102   bareTestSourceDir = string(test_source_dir)
103   testSourceDir = string("${jalviewDir}/${bareTestSourceDir}")
104
105   // clover
106   cloverInstrDir = file("${buildDir}/${cloverSourcesInstrDir}")
107   cloverDb = string("${buildDir}/clover/clover.db")
108   classesDir = string("${jalviewDir}/${classes_dir}")
109   if (clover.equals("true")) {
110     use_clover = true
111     classesDir = string("${buildDir}/${cloverClassesDir}")
112   } else {
113     use_clover = false
114     classesDir = string("${jalviewDir}/${classes_dir}")
115   }
116
117   classes = classesDir
118
119   getdownWebsiteDir = string("${jalviewDir}/${getdown_website_dir}/${JAVA_VERSION}")
120   buildDist = true
121
122   // the following values might be overridden by the CHANNEL switch
123   getdownChannelName = CHANNEL.toLowerCase()
124   getdownDir = string("${getdownChannelName}/${JAVA_VERSION}")
125   getdownAppBase = string("${getdown_channel_base}/${getdownDir}")
126   getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher}")
127   getdownAppDistDir = getdown_app_dir_alt
128   buildProperties = string("${classesDir}/${build_properties_file}")
129   reportRsyncCmd = false
130   jvlChannelName = CHANNEL.toLowerCase()
131   switch (CHANNEL) {
132
133     case "BUILD":
134     // TODO: get bamboo build artifact URL for getdown artifacts
135     getdown_channel_base = bamboo_channelbase
136     getdownChannelName = string("${bamboo_planKey}/${JAVA_VERSION}")
137     getdownAppBase = string("${bamboo_channelbase}/${bamboo_planKey}${bamboo_getdown_channel_suffix}/${JAVA_VERSION}")
138     jvlChannelName += "_${getdownChannelName}"
139     break
140
141     case "RELEASE":
142     getdownAppDistDir = getdown_app_dir_release
143     reportRsyncCommand = true
144     break
145
146     case "ARCHIVE":
147     getdownChannelName = CHANNEL.toLowerCase()+"/${JALVIEW_VERSION}"
148     getdownDir = string("${getdownChannelName}/${JAVA_VERSION}")
149     getdownAppBase = string("${getdown_channel_base}/${getdownDir}")
150     if (!file("${ARCHIVEDIR}/${packageDir}").exists()) {
151       throw new GradleException("Must provide an ARCHIVEDIR value to produce an archive distribution")
152     } else {
153       packageDir = string("${ARCHIVEDIR}/${packageDir}")
154       buildProperties = string("${ARCHIVEDIR}/${classes_dir}/${build_properties_file}")
155       buildDist = false
156     }
157     reportRsyncCommand = true
158     break
159
160     case "ARCHIVELOCAL":
161     getdownChannelName = string("archive/${JALVIEW_VERSION}")
162     getdownDir = string("${getdownChannelName}/${JAVA_VERSION}")
163     getdownAppBase = file(getdownWebsiteDir).toURI().toString()
164     if (!file("${ARCHIVEDIR}/${packageDir}").exists()) {
165       throw new GradleException("Must provide an ARCHIVEDIR value to produce an archive distribution")
166     } else {
167       packageDir = string("${ARCHIVEDIR}/${packageDir}")
168       buildProperties = string("${ARCHIVEDIR}/${classes_dir}/${build_properties_file}")
169       buildDist = false
170     }
171     reportRsyncCommand = true
172     getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}")
173     break
174
175     case "DEVELOP":
176     reportRsyncCommand = true
177     break
178
179     case "TEST-RELEASE":
180     reportRsyncCommand = true
181     break
182
183     case ~/^SCRATCH(|-[-\w]*)$/:
184     getdownChannelName = CHANNEL
185     getdownDir = string("${getdownChannelName}/${JAVA_VERSION}")
186     getdownAppBase = string("${getdown_channel_base}/${getdownDir}")
187     reportRsyncCommand = true
188     break
189
190     case "TEST-LOCAL":
191     if (!file("${LOCALDIR}").exists()) {
192       throw new GradleException("Must provide a LOCALDIR value to produce a local distribution")
193     } else {
194       getdownAppBase = file(file("${LOCALDIR}").getAbsolutePath()).toURI().toString()
195       getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}")
196     }
197     break
198
199     case "LOCAL":
200     getdownAppBase = file(getdownWebsiteDir).toURI().toString()
201     getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}")
202     break
203
204     default: // something wrong specified
205     throw new GradleException("CHANNEL must be one of BUILD, RELEASE, ARCHIVE, DEVELOP, TEST-RELEASE, SCRATCH-..., LOCAL [default]")
206     break
207
208   }
209   // override getdownAppBase if requested
210   if (findProperty("getdown_appbase_override") != null) {
211     getdownAppBase = string(getProperty("getdown_appbase_override"))
212     println("Overriding getdown appbase with '${getdownAppBase}'")
213   }
214   // sanitise file name for jalview launcher file for this channel
215   jvlChannelName = jvlChannelName.replaceAll(/[^\w\-]/,"_")
216
217   getdownAppDir = string("${getdownWebsiteDir}/${getdownAppDistDir}")
218   //getdownJ11libDir = "${getdownWebsiteDir}/${getdown_j11lib_dir}"
219   getdownResourceDir = string("${getdownWebsiteDir}/${getdown_resource_dir}")
220   getdownInstallDir = string("${getdownWebsiteDir}/${getdown_install_dir}")
221   getdownFilesDir = string("${jalviewDir}/${getdown_files_dir}/${JAVA_VERSION}/")
222   getdownFilesInstallDir = string("${getdownFilesDir}/${getdown_install_dir}")
223   /* compile without modules -- using classpath libraries
224   modules_compileClasspath = fileTree(dir: "${jalviewDir}/${j11modDir}", include: ["*.jar"])
225   modules_runtimeClasspath = modules_compileClasspath
226   */
227   gitHash = string("")
228   gitBranch = string("")
229
230   println("Using a ${CHANNEL} profile.")
231
232   additional_compiler_args = []
233   // configure classpath/args for j8/j11 compilation
234   if (JAVA_VERSION.equals("1.8")) {
235     JAVA_INTEGER_VERSION = string("8")
236     //libDir = j8libDir
237     libDir = j11libDir
238     libDistDir = j8libDir
239     compile_source_compatibility = 1.8
240     compile_target_compatibility = 1.8
241     // these are getdown.txt properties defined dependent on the JAVA_VERSION
242     getdownAltJavaMinVersion = string(findProperty("getdown_alt_java8_min_version"))
243     getdownAltJavaMaxVersion = string(findProperty("getdown_alt_java8_max_version"))
244     // this property is assigned below and expanded to multiple lines in the getdown task
245     getdownAltMultiJavaLocation = string(findProperty("getdown_alt_java8_txt_multi_java_location"))
246     // this property is for the Java library used in eclipse
247     eclipseJavaRuntimeName = string("JavaSE-1.8")
248   } else if (JAVA_VERSION.equals("11")) {
249     JAVA_INTEGER_VERSION = string("11")
250     libDir = j11libDir
251     libDistDir = j11libDir
252     compile_source_compatibility = 11
253     compile_target_compatibility = 11
254     getdownAltJavaMinVersion = string(findProperty("getdown_alt_java11_min_version"))
255     getdownAltJavaMaxVersion = string(findProperty("getdown_alt_java11_max_version"))
256     getdownAltMultiJavaLocation = string(findProperty("getdown_alt_java11_txt_multi_java_location"))
257     eclipseJavaRuntimeName = string("JavaSE-11")
258     /* compile without modules -- using classpath libraries
259     additional_compiler_args += [
260     '--module-path', modules_compileClasspath.asPath,
261     '--add-modules', j11modules
262     ]
263      */
264   } else if (JAVA_VERSION.equals("12") || JAVA_VERSION.equals("13")) {
265     JAVA_INTEGER_VERSION = JAVA_VERSION
266     libDir = j11libDir
267     libDistDir = j11libDir
268     compile_source_compatibility = JAVA_VERSION
269     compile_target_compatibility = JAVA_VERSION
270     getdownAltJavaMinVersion = string(findProperty("getdown_alt_java11_min_version"))
271     getdownAltJavaMaxVersion = string(findProperty("getdown_alt_java11_max_version"))
272     getdownAltMultiJavaLocation = string(findProperty("getdown_alt_java11_txt_multi_java_location"))
273     eclipseJavaRuntimeName = string("JavaSE-11")
274     /* compile without modules -- using classpath libraries
275     additional_compiler_args += [
276     '--module-path', modules_compileClasspath.asPath,
277     '--add-modules', j11modules
278     ]
279      */
280   } else {
281     throw new GradleException("JAVA_VERSION=${JAVA_VERSION} not currently supported by Jalview")
282   }
283
284
285   // for install4j
286   JAVA_MIN_VERSION = JAVA_VERSION
287   JAVA_MAX_VERSION = JAVA_VERSION
288   def jreInstallsDir = string(jre_installs_dir)
289   if (jreInstallsDir.startsWith("~/")) {
290     jreInstallsDir = System.getProperty("user.home") + jreInstallsDir.substring(1)
291   }
292   macosJavaVMDir = string("${jreInstallsDir}/jre-${JAVA_INTEGER_VERSION}-mac-x64/jre")
293   macosJavaVMTgz = string("${jreInstallsDir}/tgz/jre-${JAVA_INTEGER_VERSION}-mac-x64.tar.gz")
294   windowsJavaVMDir = string("${jreInstallsDir}/jre-${JAVA_INTEGER_VERSION}-windows-x64/jre")
295   windowsJavaVMTgz = string("${jreInstallsDir}/tgz/jre-${JAVA_INTEGER_VERSION}-windows-x64.tar.gz")
296   linuxJavaVMDir = string("${jreInstallsDir}/jre-${JAVA_INTEGER_VERSION}-linux-x64/jre")
297   linuxJavaVMTgz = string("${jreInstallsDir}/tgz/jre-${JAVA_INTEGER_VERSION}-linux-x64.tar.gz")
298   install4jDir = string("${jalviewDir}/${install4j_utils_dir}")
299   install4jConfFileName = string("jalview-install4j-conf.install4j")
300   install4jConfFile = file("${install4jDir}/${install4jConfFileName}")
301   install4jHomeDir = install4j_home_dir
302   if (install4jHomeDir.startsWith("~/")) {
303     install4jHomeDir = System.getProperty("user.home") + install4jHomeDir.substring(1)
304   }
305
306
307
308   buildingHTML = string("${jalviewDir}/${docDir}/building.html")
309   helpFile = string("${classesDir}/${help_dir}/help.jhm")
310   helpParentDir = string("${jalviewDir}/${help_parent_dir}")
311   helpSourceDir = string("${helpParentDir}/${help_dir}")
312
313
314   relativeBuildDir = file(jalviewDirAbsolutePath).toPath().relativize(buildDir.toPath())
315   jalviewjsBuildDir = string("${relativeBuildDir}/jalviewjs")
316   jalviewjsSiteDir = string("${jalviewjsBuildDir}/${jalviewjs_site_dir}")
317   if (IN_ECLIPSE) {
318     jalviewjsTransferSiteJsDir = string(jalviewjsSiteDir)
319   } else {
320     jalviewjsTransferSiteJsDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_js")
321   }
322   jalviewjsTransferSiteLibDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_lib")
323   jalviewjsTransferSiteSwingJsDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_swingjs")
324   jalviewjsTransferSiteCoreDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_core")
325   jalviewjsJalviewCoreHtmlFile = string("")
326   jalviewjsJalviewCoreName = string(jalviewjs_core_name)
327   jalviewjsCoreClasslists = []
328   jalviewjsJalviewTemplateName = string(jalviewjs_name)
329   jalviewjsJ2sSettingsFileName = string("${jalviewDir}/${jalviewjs_j2s_settings}")
330   jalviewjsJ2sProps = null
331
332   eclipseWorkspace = null
333   eclipseBinary = string("")
334   eclipseVersion = string("")
335   eclipseDebug = false
336   // ENDEXT
337 }
338
339
340 sourceSets {
341   main {
342     java {
343       srcDirs sourceDir
344       outputDir = file(classesDir)
345     }
346
347     resources {
348       srcDirs resourceDir
349       srcDirs += helpParentDir
350     }
351
352     jar.destinationDir = file("${jalviewDir}/${packageDir}")
353
354     compileClasspath = files(sourceSets.main.java.outputDir)
355     //compileClasspath += files(sourceSets.main.resources.srcDirs)
356     compileClasspath += fileTree(dir: "${jalviewDir}/${libDir}", include: ["*.jar"])
357
358     runtimeClasspath = compileClasspath
359   }
360
361   clover {
362     java {
363       srcDirs = [ cloverInstrDir ]
364       outputDir = file("${buildDir}/${cloverClassesDir}")
365     }
366
367     resources {
368       srcDirs = sourceSets.main.resources.srcDirs
369     }
370     compileClasspath = configurations.cloverRuntime + files( sourceSets.clover.java.outputDir )
371     compileClasspath += files(sourceSets.main.java.outputDir)
372     compileClasspath += sourceSets.main.compileClasspath
373     compileClasspath += fileTree(dir: "${jalviewDir}/${utilsDir}", include: ["**/*.jar"])
374     compileClasspath += fileTree(dir: "${jalviewDir}/${libDir}", include: ["*.jar"])
375
376     runtimeClasspath = compileClasspath
377   }
378
379   test {
380     java {
381       srcDirs testSourceDir
382       outputDir = file("${jalviewDir}/${testOutputDir}")
383     }
384
385     resources {
386       srcDirs = sourceSets.main.resources.srcDirs
387     }
388
389     compileClasspath = files( sourceSets.test.java.outputDir )
390
391     if (use_clover) {
392       compileClasspath = sourceSets.clover.compileClasspath
393     } else {
394       compileClasspath += files(sourceSets.main.java.outputDir)
395     }
396
397     compileClasspath += fileTree(dir: "${jalviewDir}/${libDir}", include: ["*.jar"])
398     compileClasspath += fileTree(dir: "${jalviewDir}/${utilsDir}/testnglibs", include: ["**/*.jar"])
399     compileClasspath += fileTree(dir: "${jalviewDir}/${utilsDir}/testlibs", include: ["**/*.jar"])
400
401     runtimeClasspath = compileClasspath
402   }
403 }
404
405
406 // clover bits
407 dependencies {
408   cloverCompile 'org.openclover:clover:4.4.1'
409   if (use_clover) {
410     testCompile 'org.openclover:clover:4.4.1'
411   }
412 }
413
414 configurations {
415   cloverRuntime
416   cloverRuntime.extendsFrom cloverCompile
417 }
418
419
420 // eclipse project and settings files creation, also used by buildship
421 eclipse {
422   project {
423     name = eclipse_project_name
424
425     natures 'org.eclipse.jdt.core.javanature',
426     'org.eclipse.jdt.groovy.core.groovyNature',
427     'org.eclipse.buildship.core.gradleprojectnature'
428
429     buildCommand 'org.eclipse.jdt.core.javabuilder'
430     buildCommand 'org.eclipse.buildship.core.gradleprojectbuilder'
431   }
432
433   classpath {
434     //defaultOutputDir = sourceSets.main.java.outputDir
435     def removeThese = []
436     configurations.each{
437       if (it.isCanBeResolved()) {
438         removeThese += it
439       }
440     }
441
442     minusConfigurations += removeThese
443     plusConfigurations = [ ]
444     file {
445
446       whenMerged { cp ->
447         def removeTheseToo = []
448         HashMap<String, Boolean> alreadyAddedSrcPath = new HashMap<>();
449         cp.entries.each { entry ->
450           // This conditional removes all src classpathentries that a) have already been added or b) aren't "src" or "test".
451           // e.g. this removes the resources dir being copied into bin/main, bin/test AND bin/clover
452           // we add the resources and help/help dirs in as libs afterwards (see below)
453           if (entry.kind == 'src') {
454             if (alreadyAddedSrcPath.getAt(entry.path) || !(entry.path == bareSourceDir || entry.path == bareTestSourceDir)) {
455               removeTheseToo += entry
456             } else {
457               alreadyAddedSrcPath.putAt(entry.path, true)
458             }
459           }
460
461         }
462         cp.entries.removeAll(removeTheseToo)
463
464         //cp.entries += new Output("${eclipse_bin_dir}/main")
465         if (file(helpParentDir).isDirectory()) {
466           cp.entries += new Library(fileReference(helpParentDir))
467         }
468         if (file(resourceDir).isDirectory()) {
469           cp.entries += new Library(fileReference(resourceDir))
470         }
471
472         HashMap<String, Boolean> alreadyAddedLibPath = new HashMap<>();
473
474         sourceSets.main.compileClasspath.findAll { it.name.endsWith(".jar") }.any {
475           //don't want to add outputDir as eclipse is using its own output dir in bin/main
476           if (it.isDirectory() || ! it.exists()) {
477             // don't add dirs to classpath, especially if they don't exist
478             return false // groovy "continue" in .any closure
479           }
480           def itPath = it.toString()
481           if (itPath.startsWith("${jalviewDirAbsolutePath}/")) {
482             // make relative path
483             itPath = itPath.substring(jalviewDirAbsolutePath.length()+1)
484           }
485           if (alreadyAddedLibPath.get(itPath)) {
486             //println("Not adding duplicate entry "+itPath)
487           } else {
488             //println("Adding entry "+itPath)
489             cp.entries += new Library(fileReference(itPath))
490             alreadyAddedLibPath.put(itPath, true)
491           }
492         }
493
494         sourceSets.test.compileClasspath.findAll { it.name.endsWith(".jar") }.any {
495           //no longer want to add outputDir as eclipse is using its own output dir in bin/main
496           if (it.isDirectory() || ! it.exists()) {
497             // don't add dirs to classpath
498             return false // groovy "continue" in .any closure
499           }
500
501           def itPath = it.toString()
502           if (itPath.startsWith("${jalviewDirAbsolutePath}/")) {
503             itPath = itPath.substring(jalviewDirAbsolutePath.length()+1)
504           }
505           if (alreadyAddedLibPath.get(itPath)) {
506             // don't duplicate
507           } else {
508             def lib = new Library(fileReference(itPath))
509             lib.entryAttributes["test"] = "true"
510             cp.entries += lib
511             alreadyAddedLibPath.put(itPath, true)
512           }
513         }
514
515       } // whenMerged
516
517     } // file
518
519     containers 'org.eclipse.buildship.core.gradleclasspathcontainer'
520
521   } // classpath
522
523   jdt {
524     // for the IDE, use java 11 compatibility
525     sourceCompatibility = compile_source_compatibility
526     targetCompatibility = compile_target_compatibility
527     javaRuntimeName = eclipseJavaRuntimeName
528
529     // add in jalview project specific properties/preferences into eclipse core preferences
530     file {
531       withProperties { props ->
532         def jalview_prefs = new Properties()
533         def ins = new FileInputStream("${jalviewDirAbsolutePath}/${eclipse_extra_jdt_prefs_file}")
534         jalview_prefs.load(ins)
535         ins.close()
536         jalview_prefs.forEach { t, v ->
537           if (props.getAt(t) == null) {
538             props.putAt(t, v)
539           }
540         }
541       }
542     }
543
544   } // jdt
545
546   if (IN_ECLIPSE) {
547     // Don't want these to be activated if in headless build
548     synchronizationTasks "eclipseSynchronizationTask"
549     autoBuildTasks "eclipseAutoBuildTask"
550
551   }
552 }
553
554
555 task cloverInstr {
556   // only instrument source, we build test classes as normal
557   inputs.files files (sourceSets.main.allJava,sourceSets.test.allJava) // , fileTree(dir:"$jalviewDir/$testSourceDir", include: ["**/*.java"]))
558   outputs.dir cloverInstrDir
559
560   doFirst {
561     //delete cloverInstrDir
562     def argsList = [
563       "--initstring",
564       cloverDb,
565       "-d",
566       cloverInstrDir.getPath(),
567     ]
568     argsList.addAll(
569       inputs.files.files.collect(
570         { file -> file.absolutePath }
571       )
572     )
573     String[] args = argsList.toArray()
574     println("About to instrument "+args.length +" files")
575     com.atlassian.clover.CloverInstr.mainImpl(args)
576   }
577 }
578
579
580 cloverClasses.dependsOn cloverInstr
581
582
583 task cloverReport {
584   group = "Verification"
585   description = "Creates the Clover report"
586   inputs.dir "${buildDir}/clover"
587   outputs.dir "${reportsDir}/clover"
588   onlyIf {
589     file(cloverDb).exists()
590   }
591   doFirst {
592     def argsList = [
593       "--initstring",
594       cloverDb,
595       "-o",
596       "${reportsDir}/clover"
597     ]
598     String[] args = argsList.toArray()
599     com.atlassian.clover.reporters.html.HtmlReporter.runReport(args)
600
601     // and generate ${reportsDir}/clover/clover.xml
602     args = [
603       "--initstring",
604       cloverDb,
605       "-o",
606       "${reportsDir}/clover/clover.xml"
607     ].toArray()
608     com.atlassian.clover.reporters.xml.XMLReporter.runReport(args)
609   }
610 }
611 // end clover bits
612
613
614 compileJava {
615
616   doFirst {
617     sourceCompatibility = compile_source_compatibility
618     targetCompatibility = compile_target_compatibility
619     options.compilerArgs = additional_compiler_args
620     print ("Setting target compatibility to "+targetCompatibility+"\n")
621   }
622
623 }
624
625
626 compileTestJava {
627   if (use_clover) {
628     dependsOn compileCloverJava
629     classpath += configurations.cloverRuntime
630   } else {
631     classpath += sourceSets.main.runtimeClasspath
632   }
633   doFirst {
634     sourceCompatibility = compile_source_compatibility
635     targetCompatibility = compile_target_compatibility
636     options.compilerArgs = additional_compiler_args
637     print ("Setting target compatibility to "+targetCompatibility+"\n")
638   }
639 }
640
641
642 compileCloverJava {
643
644   doFirst {
645     sourceCompatibility = compile_source_compatibility
646     targetCompatibility = compile_target_compatibility
647     options.compilerArgs += additional_compiler_args
648     print ("Setting target compatibility to "+targetCompatibility+"\n")
649   }
650   classpath += configurations.cloverRuntime
651 }
652
653
654 clean {
655   doFirst {
656     delete sourceSets.main.java.outputDir
657   }
658 }
659
660
661 cleanTest {
662   doFirst {
663     delete sourceSets.test.java.outputDir
664     delete cloverInstrDir
665     delete cloverDb
666   }
667 }
668
669
670 // format is a string like date.format("dd MMMM yyyy")
671 def getDate(format) {
672   def date = new Date()
673   return date.format(format)
674 }
675
676
677 task setGitVals {
678   def hashStdOut = new ByteArrayOutputStream()
679   exec {
680     commandLine "git", "rev-parse", "--short", "HEAD"
681     standardOutput = hashStdOut
682     ignoreExitValue true
683   }
684
685   def branchStdOut = new ByteArrayOutputStream()
686   exec {
687     commandLine "git", "rev-parse", "--abbrev-ref", "HEAD"
688     standardOutput = branchStdOut
689     ignoreExitValue true
690   }
691
692   gitHash = hashStdOut.toString().trim()
693   gitBranch = branchStdOut.toString().trim()
694
695   outputs.upToDateWhen { false }
696 }
697
698
699 task createBuildProperties(type: WriteProperties) {
700   dependsOn setGitVals
701   inputs.dir(sourceDir)
702   inputs.dir(resourceDir)
703   file(buildProperties).getParentFile().mkdirs()
704   outputFile (buildProperties)
705   // taking time specific comment out to allow better incremental builds
706   comment "--Jalview Build Details--\n"+getDate("yyyy-MM-dd HH:mm:ss")
707   //comment "--Jalview Build Details--\n"+getDate("yyyy-MM-dd")
708   property "BUILD_DATE", getDate("HH:mm:ss dd MMMM yyyy")
709   property "VERSION", JALVIEW_VERSION
710   property "INSTALLATION", INSTALLATION+" git-commit:"+gitHash+" ["+gitBranch+"]"
711   outputs.file(outputFile)
712 }
713
714
715 task cleanBuildingHTML(type: Delete) {
716   doFirst {
717     delete buildingHTML
718   }
719 }
720
721
722 task convertBuildingMD(type: Exec) {
723   dependsOn cleanBuildingHTML
724   def buildingMD = "${jalviewDir}/${docDir}/building.md"
725   def css = "${jalviewDir}/${docDir}/github.css"
726
727   def pandoc = null
728   pandoc_exec.split(",").each {
729     if (file(it.trim()).exists()) {
730       pandoc = it.trim()
731       return true
732     }
733   }
734
735   def hostname = "hostname".execute().text.trim()
736   def buildtoolsPandoc = System.getProperty("user.home")+"/buildtools/pandoc/bin/pandoc"
737   if ((pandoc == null || ! file(pandoc).exists()) && file(buildtoolsPandoc).exists()) {
738     pandoc = System.getProperty("user.home")+"/buildtools/pandoc/bin/pandoc"
739   }
740
741   doFirst {
742     if (pandoc != null && file(pandoc).exists()) {
743         commandLine pandoc, '-s', '-o', buildingHTML, '--metadata', 'pagetitle="Building Jalview from Source"', '--toc', '-H', css, buildingMD
744     } else {
745         println("Cannot find pandoc. Skipping convert building.md to HTML")
746         throw new StopExecutionException("Cannot find pandoc. Skipping convert building.md to HTML")
747     }
748   }
749
750   ignoreExitValue true
751
752   inputs.file(buildingMD)
753   inputs.file(css)
754   outputs.file(buildingHTML)
755 }
756
757
758 clean {
759   doFirst {
760     delete buildingHTML
761   }
762 }
763
764
765 task syncDocs(type: Sync) {
766   dependsOn convertBuildingMD
767   def syncDir = "${classesDir}/${docDir}"
768   from fileTree("${jalviewDir}/${docDir}")
769   into syncDir
770
771 }
772
773
774 task copyHelp(type: Copy) {
775   def inputDir = helpSourceDir
776   def outputDir = "${classesDir}/${help_dir}"
777   from(inputDir) {
778     exclude '**/*.gif'
779     exclude '**/*.jpg'
780     exclude '**/*.png'
781     filter(ReplaceTokens,
782       beginToken: '$$',
783       endToken: '$$',
784       tokens: [
785         'Version-Rel': JALVIEW_VERSION,
786         'Year-Rel': getDate("yyyy")
787       ]
788     )
789   }
790   from(inputDir) {
791     include '**/*.gif'
792     include '**/*.jpg'
793     include '**/*.png'
794   }
795   into outputDir
796
797   inputs.dir(inputDir)
798   outputs.files(helpFile)
799   outputs.dir(outputDir)
800 }
801
802
803 task syncLib(type: Sync) {
804   def syncDir = "${classesDir}/${libDistDir}"
805   from fileTree("${jalviewDir}/${libDistDir}")
806   into syncDir
807 }
808
809
810 task syncResources(type: Sync) {
811   from resourceDir
812   include "**/*.*"
813   into "${classesDir}"
814   preserve {
815     include "**"
816   }
817 }
818
819
820 task prepare {
821   dependsOn syncResources
822   dependsOn syncDocs
823   dependsOn copyHelp
824 }
825
826
827 //testReportDirName = "test-reports" // note that test workingDir will be $jalviewDir
828 test {
829   dependsOn prepare
830   dependsOn compileJava
831   if (use_clover) {
832     dependsOn cloverInstr
833   }
834
835   if (use_clover) {
836     print("Running tests " + (use_clover?"WITH":"WITHOUT") + " clover [clover="+use_clover+"]\n")
837   }
838
839   useTestNG() {
840     includeGroups testngGroups
841     preserveOrder true
842     useDefaultListeners=true
843   }
844
845   workingDir = jalviewDir
846   //systemProperties 'clover.jar' System.properties.clover.jar
847   sourceCompatibility = compile_source_compatibility
848   targetCompatibility = compile_target_compatibility
849   jvmArgs += additional_compiler_args
850
851 }
852
853
854 task buildIndices(type: JavaExec) {
855   dependsOn copyHelp
856   classpath = sourceSets.main.compileClasspath
857   main = "com.sun.java.help.search.Indexer"
858   workingDir = "${classesDir}/${help_dir}"
859   def argDir = "html"
860   args = [ argDir ]
861   inputs.dir("${workingDir}/${argDir}")
862
863   outputs.dir("${classesDir}/doc")
864   outputs.dir("${classesDir}/help")
865   outputs.file("${workingDir}/JavaHelpSearch/DOCS")
866   outputs.file("${workingDir}/JavaHelpSearch/DOCS.TAB")
867   outputs.file("${workingDir}/JavaHelpSearch/OFFSETS")
868   outputs.file("${workingDir}/JavaHelpSearch/POSITIONS")
869   outputs.file("${workingDir}/JavaHelpSearch/SCHEMA")
870   outputs.file("${workingDir}/JavaHelpSearch/TMAP")
871 }
872
873
874 task compileLinkCheck(type: JavaCompile) {
875   options.fork = true
876   classpath = files("${jalviewDir}/${utilsDir}")
877   destinationDir = file("${jalviewDir}/${utilsDir}")
878   source = fileTree(dir: "${jalviewDir}/${utilsDir}", include: ["HelpLinksChecker.java", "BufferedLineReader.java"])
879
880   inputs.file("${jalviewDir}/${utilsDir}/HelpLinksChecker.java")
881   inputs.file("${jalviewDir}/${utilsDir}/HelpLinksChecker.java")
882   outputs.file("${jalviewDir}/${utilsDir}/HelpLinksChecker.class")
883   outputs.file("${jalviewDir}/${utilsDir}/BufferedLineReader.class")
884 }
885
886
887 task linkCheck(type: JavaExec) {
888   dependsOn prepare, compileLinkCheck
889
890   def helpLinksCheckerOutFile = file("${jalviewDir}/${utilsDir}/HelpLinksChecker.out")
891   classpath = files("${jalviewDir}/${utilsDir}")
892   main = "HelpLinksChecker"
893   workingDir = jalviewDir
894   args = [ "${classesDir}/${help_dir}", "-nointernet" ]
895
896   def outFOS = new FileOutputStream(helpLinksCheckerOutFile, false) // false == don't append
897   def errFOS = outFOS
898   standardOutput = new org.apache.tools.ant.util.TeeOutputStream(
899     outFOS,
900     standardOutput)
901   errorOutput = new org.apache.tools.ant.util.TeeOutputStream(
902     outFOS,
903     errorOutput)
904
905   inputs.dir("${classesDir}/${help_dir}")
906   outputs.file(helpLinksCheckerOutFile)
907 }
908
909 // import the pubhtmlhelp target
910 ant.properties.basedir = "${jalviewDir}"
911 ant.properties.helpBuildDir = "${jalviewDirAbsolutePath}/${classes_dir}/${help_dir}"
912 ant.importBuild "${utilsDir}/publishHelp.xml"
913
914
915 task cleanPackageDir(type: Delete) {
916   doFirst {
917     delete fileTree(dir: "${jalviewDir}/${packageDir}", include: "*.jar")
918   }
919 }
920
921 jar {
922   dependsOn linkCheck
923   dependsOn buildIndices
924   dependsOn createBuildProperties
925
926   manifest {
927     attributes "Main-Class": mainClass,
928     "Permissions": "all-permissions",
929     "Application-Name": "Jalview Desktop",
930     "Codebase": application_codebase
931   }
932
933   destinationDir = file("${jalviewDir}/${packageDir}")
934   archiveName = rootProject.name+".jar"
935
936   exclude "cache*/**"
937   exclude "*.jar"
938   exclude "*.jar.*"
939   exclude "**/*.jar"
940   exclude "**/*.jar.*"
941
942   inputs.dir(classesDir)
943   outputs.file("${jalviewDir}/${packageDir}/${archiveName}")
944 }
945
946
947 task copyJars(type: Copy) {
948   from fileTree(dir: classesDir, include: "**/*.jar").files
949   into "${jalviewDir}/${packageDir}"
950 }
951
952
953 // doing a Sync instead of Copy as Copy doesn't deal with "outputs" very well
954 task syncJars(type: Sync) {
955   from fileTree(dir: "${jalviewDir}/${libDistDir}", include: "**/*.jar").files
956   into "${jalviewDir}/${packageDir}"
957   preserve {
958     include jar.archiveName
959   }
960 }
961
962
963 task makeDist {
964   group = "build"
965   description = "Put all required libraries in dist"
966   // order of "cleanPackageDir", "copyJars", "jar" important!
967   jar.mustRunAfter cleanPackageDir
968   syncJars.mustRunAfter cleanPackageDir
969   dependsOn cleanPackageDir
970   dependsOn syncJars
971   dependsOn jar
972   outputs.dir("${jalviewDir}/${packageDir}")
973 }
974
975
976 task cleanDist {
977   dependsOn cleanPackageDir
978   dependsOn cleanTest
979   dependsOn clean
980 }
981
982 shadowJar {
983   group = "distribution"
984   if (buildDist) {
985     dependsOn makeDist
986   }
987   from ("${jalviewDir}/${libDistDir}") {
988     include("*.jar")
989   }
990   manifest {
991     attributes 'Implementation-Version': JALVIEW_VERSION
992   }
993   mainClassName = shadowJarMainClass
994   mergeServiceFiles()
995   classifier = "all-"+JALVIEW_VERSION+"-j"+JAVA_VERSION
996   minimize()
997 }
998
999
1000 task getdownWebsite() {
1001   group = "distribution"
1002   description = "Create the getdown minimal app folder, and website folder for this version of jalview. Website folder also used for offline app installer"
1003   if (buildDist) {
1004     dependsOn makeDist
1005   }
1006
1007   def getdownWebsiteResourceFilenames = []
1008   def getdownTextString = ""
1009   def getdownResourceDir = getdownResourceDir
1010   def getdownResourceFilenames = []
1011
1012   doFirst {
1013     // clean the getdown website and files dir before creating getdown folders
1014     delete getdownWebsiteDir
1015     delete getdownFilesDir
1016
1017     copy {
1018       from buildProperties
1019       rename(build_properties_file, getdown_build_properties)
1020       into getdownAppDir
1021     }
1022     getdownWebsiteResourceFilenames += "${getdownAppDistDir}/${getdown_build_properties}"
1023
1024     // go through properties looking for getdown_txt_...
1025     def props = project.properties.sort { it.key }
1026     if (getdownAltJavaMinVersion != null && getdownAltJavaMinVersion.length() > 0) {
1027       props.put("getdown_txt_java_min_version", getdownAltJavaMinVersion)
1028     }
1029     if (getdownAltJavaMaxVersion != null && getdownAltJavaMaxVersion.length() > 0) {
1030       props.put("getdown_txt_java_max_version", getdownAltJavaMaxVersion)
1031     }
1032     if (getdownAltMultiJavaLocation != null && getdownAltMultiJavaLocation.length() > 0) {
1033       props.put("getdown_txt_multi_java_location", getdownAltMultiJavaLocation)
1034     }
1035
1036     props.put("getdown_txt_appbase", getdownAppBase)
1037     props.each{ prop, val ->
1038       if (prop.startsWith("getdown_txt_") && val != null) {
1039         if (prop.startsWith("getdown_txt_multi_")) {
1040           def key = prop.substring(18)
1041           val.split(",").each{ v ->
1042             def line = "${key} = ${v}\n"
1043             getdownTextString += line
1044           }
1045         } else {
1046           // file values rationalised
1047           if (val.indexOf('/') > -1 || prop.startsWith("getdown_txt_resource")) {
1048             def r = null
1049             if (val.indexOf('/') == 0) {
1050               // absolute path
1051               r = file(val)
1052             } else if (val.indexOf('/') > 0) {
1053               // relative path (relative to jalviewDir)
1054               r = file( "${jalviewDir}/${val}" )
1055             }
1056             if (r.exists()) {
1057               val = "${getdown_resource_dir}/" + r.getName()
1058               getdownWebsiteResourceFilenames += val
1059               getdownResourceFilenames += r.getPath()
1060             }
1061           }
1062           if (! prop.startsWith("getdown_txt_resource")) {
1063             def line = prop.substring(12) + " = ${val}\n"
1064             getdownTextString += line
1065           }
1066         }
1067       }
1068     }
1069
1070     getdownWebsiteResourceFilenames.each{ filename ->
1071       getdownTextString += "resource = ${filename}\n"
1072     }
1073     getdownResourceFilenames.each{ filename ->
1074       copy {
1075         from filename
1076         into getdownResourceDir
1077       }
1078     }
1079
1080     def codeFiles = []
1081     fileTree(file(packageDir)).each{ f ->
1082       if (f.isDirectory()) {
1083         def files = fileTree(dir: f, include: ["*"]).getFiles()
1084         codeFiles += files
1085       } else if (f.exists()) {
1086         codeFiles += f
1087       }
1088     }
1089     codeFiles.sort().each{f ->
1090       def name = f.getName()
1091       def line = "code = ${getdownAppDistDir}/${name}\n"
1092       getdownTextString += line
1093       copy {
1094         from f.getPath()
1095         into getdownAppDir
1096       }
1097     }
1098
1099     // NOT USING MODULES YET, EVERYTHING SHOULD BE IN dist
1100     /*
1101     if (JAVA_VERSION.equals("11")) {
1102     def j11libFiles = fileTree(dir: "${jalviewDir}/${j11libDir}", include: ["*.jar"]).getFiles()
1103     j11libFiles.sort().each{f ->
1104     def name = f.getName()
1105     def line = "code = ${getdown_j11lib_dir}/${name}\n"
1106     getdownTextString += line
1107     copy {
1108     from f.getPath()
1109     into getdownJ11libDir
1110     }
1111     }
1112     }
1113      */
1114
1115     // getdown-launcher.jar should not be in main application class path so the main application can move it when updated.  Listed as a resource so it gets updated.
1116     //getdownTextString += "class = " + file(getdownLauncher).getName() + "\n"
1117     getdownTextString += "resource = ${getdown_launcher_new}\n"
1118     getdownTextString += "class = ${mainClass}\n"
1119
1120     def getdown_txt = file("${getdownWebsiteDir}/getdown.txt")
1121     getdown_txt.write(getdownTextString)
1122
1123     def getdownLaunchJvl = getdown_launch_jvl_name + ( (jvlChannelName != null && jvlChannelName.length() > 0)?"-${jvlChannelName}":"" ) + ".jvl"
1124     def launchJvl = file("${getdownWebsiteDir}/${getdownLaunchJvl}")
1125     launchJvl.write("appbase="+props.get("getdown_txt_appbase"))
1126
1127     copy {
1128       from getdownLauncher
1129       rename(file(getdownLauncher).getName(), getdown_launcher_new)
1130       into getdownWebsiteDir
1131     }
1132
1133     copy {
1134       from getdownLauncher
1135       if (file(getdownLauncher).getName() != getdown_launcher) {
1136         rename(file(getdownLauncher).getName(), getdown_launcher)
1137       }
1138       into getdownWebsiteDir
1139     }
1140
1141     if (! (CHANNEL.startsWith("ARCHIVE") || CHANNEL.startsWith("DEVELOP"))) {
1142       copy {
1143         from getdown_txt
1144         from getdownLauncher
1145         from "${getdownWebsiteDir}/${getdown_build_properties}"
1146         if (file(getdownLauncher).getName() != getdown_launcher) {
1147           rename(file(getdownLauncher).getName(), getdown_launcher)
1148         }
1149         into getdownInstallDir
1150       }
1151
1152       copy {
1153         from getdownInstallDir
1154         into getdownFilesInstallDir
1155       }
1156     }
1157
1158     copy {
1159       from getdown_txt
1160       from launchJvl
1161       from getdownLauncher
1162       from "${getdownWebsiteDir}/${getdown_build_properties}"
1163       if (file(getdownLauncher).getName() != getdown_launcher) {
1164         rename(file(getdownLauncher).getName(), getdown_launcher)
1165       }
1166       into getdownFilesDir
1167     }
1168
1169     copy {
1170       from getdownResourceDir
1171       into "${getdownFilesDir}/${getdown_resource_dir}"
1172     }
1173   }
1174
1175   if (buildDist) {
1176     inputs.dir("${jalviewDir}/${packageDir}")
1177   }
1178   outputs.dir(getdownWebsiteDir)
1179   outputs.dir(getdownFilesDir)
1180 }
1181
1182
1183 // a helper task to allow getdown digest of any dir: `gradle getdownDigestDir -PDIGESTDIR=/path/to/my/random/getdown/dir
1184 task getdownDigestDir(type: JavaExec) {
1185   def digestDirPropertyName = "DIGESTDIR"
1186   description = "Digest a local dir (-P${digestDirPropertyName}=...) for getdown"
1187   doFirst {
1188     classpath = files(getdownLauncher)
1189     def digestDir = findProperty(digestDirPropertyName)
1190     if (digestDir == null) {
1191       throw new GradleException("Must provide a DIGESTDIR value to produce an alternative getdown digest")
1192     }
1193     args digestDir
1194   }
1195   main = "com.threerings.getdown.tools.Digester"
1196 }
1197
1198
1199 task getdownDigest(type: JavaExec) {
1200   group = "distribution"
1201   description = "Digest the getdown website folder"
1202   dependsOn getdownWebsite
1203   doFirst {
1204     classpath = files(getdownLauncher)
1205   }
1206   main = "com.threerings.getdown.tools.Digester"
1207   args getdownWebsiteDir
1208   inputs.dir(getdownWebsiteDir)
1209   outputs.file("${getdownWebsiteDir}/digest2.txt")
1210 }
1211
1212
1213 task getdown() {
1214   group = "distribution"
1215   description = "Create the minimal and full getdown app folder for installers and website and create digest file"
1216   dependsOn getdownDigest
1217   doLast {
1218     if (reportRsyncCommand) {
1219       def fromDir = getdownWebsiteDir + (getdownWebsiteDir.endsWith('/')?'':'/')
1220       def toDir = "${getdown_rsync_dest}/${getdownDir}" + (getdownDir.endsWith('/')?'':'/')
1221       println "LIKELY RSYNC COMMAND:"
1222       println "mkdir -p '$toDir'\nrsync -avh --delete '$fromDir' '$toDir'"
1223       if (RUNRSYNC == "true") {
1224         exec {
1225           commandLine "mkdir", "-p", toDir
1226         }
1227         exec {
1228           commandLine "rsync", "-avh", "--delete", fromDir, toDir
1229         }
1230       }
1231     }
1232   }
1233 }
1234
1235
1236 clean {
1237   doFirst {
1238     delete getdownWebsiteDir
1239     delete getdownFilesDir
1240   }
1241 }
1242
1243
1244 install4j {
1245   if (file(install4jHomeDir).exists()) {
1246     // good to go!
1247   } else if (file(System.getProperty("user.home")+"/buildtools/install4j").exists()) {
1248     install4jHomeDir = System.getProperty("user.home")+"/buildtools/install4j"
1249   } else if (file("/Applications/install4j.app/Contents/Resources/app").exists()) {
1250     install4jHomeDir = "/Applications/install4j.app/Contents/Resources/app"
1251   }
1252   installDir(file(install4jHomeDir))
1253
1254   mediaTypes = Arrays.asList(install4j_media_types.split(","))
1255 }
1256
1257
1258 task copyInstall4jTemplate {
1259   def install4jTemplateFile = file("${install4jDir}/${install4j_template}")
1260   def install4jFileAssociationsFile = file("${install4jDir}/${install4j_installer_file_associations}")
1261   inputs.file(install4jTemplateFile)
1262   inputs.file(install4jFileAssociationsFile)
1263   outputs.file(install4jConfFile)
1264
1265   doLast {
1266     def install4jConfigXml = new XmlParser().parse(install4jTemplateFile)
1267
1268     // turn off code signing if no OSX_KEYPASS
1269     if (OSX_KEYPASS == "") {
1270       install4jConfigXml.'**'.codeSigning.each { codeSigning ->
1271         codeSigning.'@macEnabled' = "false"
1272       }
1273       install4jConfigXml.'**'.windows.each { windows ->
1274         windows.'@runPostProcessor' = "false"
1275       }
1276     }
1277
1278     // turn off checksum creation for LOCAL channel
1279     def e = install4jConfigXml.application[0]
1280     if (CHANNEL == "LOCAL") {
1281       e.'@createChecksums' = "false"
1282     } else {
1283       e.'@createChecksums' = "true"
1284     }
1285
1286     // put file association actions where placeholder action is
1287     def install4jFileAssociationsText = install4jFileAssociationsFile.text
1288     def fileAssociationActions = new XmlParser().parseText("<actions>${install4jFileAssociationsText}</actions>")
1289     install4jConfigXml.'**'.action.any { a ->
1290       if (a.'@name' == 'EXTENSIONS_REPLACED_BY_GRADLE') {
1291         def parent = a.parent()
1292         parent.remove(a)
1293         fileAssociationActions.each { faa ->
1294             parent.append(faa)
1295         }
1296         // don't need to continue in .any loop once replacements have been made
1297         return true
1298       }
1299     }
1300
1301     // write install4j file
1302     install4jConfFile.text = XmlUtil.serialize(install4jConfigXml)
1303   }
1304 }
1305
1306
1307 clean {
1308   doFirst {
1309     delete install4jConfFile
1310   }
1311 }
1312
1313
1314 task installers(type: com.install4j.gradle.Install4jTask) {
1315   group = "distribution"
1316   description = "Create the install4j installers"
1317   dependsOn setGitVals
1318   dependsOn getdown
1319   dependsOn copyInstall4jTemplate
1320
1321   projectFile = install4jConfFile
1322
1323   // create an md5 for the input files to use as version for install4j conf file
1324   def digest = MessageDigest.getInstance("MD5")
1325   digest.update(
1326     (file("${install4jDir}/${install4j_template}").text + 
1327     file("${install4jDir}/${install4j_info_plist_file_associations}").text +
1328     file("${install4jDir}/${install4j_installer_file_associations}").text).bytes)
1329   def filesMd5 = new BigInteger(1, digest.digest()).toString(16)
1330   if (filesMd5.length() >= 8) {
1331     filesMd5 = filesMd5.substring(0,8)
1332   }
1333   def install4jTemplateVersion = "${JALVIEW_VERSION}_F${filesMd5}_C${gitHash}"
1334   // make install4jBuildDir relative to jalviewDir
1335   def install4jBuildDir = "${install4j_build_dir}/${JAVA_VERSION}"
1336
1337   variables = [
1338     'JALVIEW_NAME': getdown_txt_title,
1339     'JALVIEW_DIR': "../..",
1340     'OSX_KEYSTORE': OSX_KEYSTORE,
1341     'JSIGN_SH': JSIGN_SH,
1342     'JRE_DIR': getdown_app_dir_java,
1343     'INSTALLER_TEMPLATE_VERSION': install4jTemplateVersion,
1344     'JALVIEW_VERSION': JALVIEW_VERSION,
1345     'JAVA_MIN_VERSION': JAVA_MIN_VERSION,
1346     'JAVA_MAX_VERSION': JAVA_MAX_VERSION,
1347     'JAVA_VERSION': JAVA_VERSION,
1348     'JAVA_INTEGER_VERSION': JAVA_INTEGER_VERSION,
1349     'VERSION': JALVIEW_VERSION,
1350     'MACOS_JAVA_VM_DIR': macosJavaVMDir,
1351     'WINDOWS_JAVA_VM_DIR': windowsJavaVMDir,
1352     'LINUX_JAVA_VM_DIR': linuxJavaVMDir,
1353     'MACOS_JAVA_VM_TGZ': macosJavaVMTgz,
1354     'WINDOWS_JAVA_VM_TGZ': windowsJavaVMTgz,
1355     'LINUX_JAVA_VM_TGZ': linuxJavaVMTgz,
1356     'COPYRIGHT_MESSAGE': install4j_copyright_message,
1357     'MACOS_BUNDLE_ID': install4j_macOS_bundle_id,
1358     'INSTALLER_NAME': install4j_installer_name,
1359     'INSTALL4J_UTILS_DIR': install4j_utils_dir,
1360     'GETDOWN_WEBSITE_DIR': getdown_website_dir,
1361     'GETDOWN_FILES_DIR': getdown_files_dir,
1362     'GETDOWN_RESOURCE_DIR': getdown_resource_dir,
1363     'GETDOWN_DIST_DIR': getdownAppDistDir,
1364     'GETDOWN_ALT_DIR': getdown_app_dir_alt,
1365     'GETDOWN_INSTALL_DIR': getdown_install_dir,
1366     'INFO_PLIST_FILE_ASSOCIATIONS_FILE': install4j_info_plist_file_associations,
1367     'BUILD_DIR': install4jBuildDir,
1368   ]
1369
1370   destination = "${jalviewDir}/${install4jBuildDir}"
1371   buildSelected = true
1372
1373   if (install4j_faster.equals("true") || CHANNEL.startsWith("LOCAL")) {
1374     faster = true
1375     disableSigning = true
1376   }
1377
1378   if (OSX_KEYPASS) {
1379     macKeystorePassword = OSX_KEYPASS
1380   }
1381
1382   doFirst {
1383     println("Using projectFile "+projectFile)
1384   }
1385
1386   inputs.dir(getdownWebsiteDir)
1387   inputs.file(install4jConfFile)
1388   inputs.file("${install4jDir}/${install4j_info_plist_file_associations}")
1389   inputs.dir(macosJavaVMDir)
1390   inputs.dir(windowsJavaVMDir)
1391   outputs.dir("${jalviewDir}/${install4j_build_dir}/${JAVA_VERSION}")
1392 }
1393
1394
1395 task sourceDist(type: Tar) {
1396   
1397   def VERSION_UNDERSCORES = JALVIEW_VERSION.replaceAll("\\.", "_")
1398   def outputFileName = "${project.name}_${VERSION_UNDERSCORES}.tar.gz"
1399   // cater for buildship < 3.1 [3.0.1 is max version in eclipse 2018-09]
1400   try {
1401     archiveFileName = outputFileName
1402   } catch (Exception e) {
1403     archiveName = outputFileName
1404   }
1405   
1406   compression Compression.GZIP
1407   
1408   into project.name
1409
1410   def EXCLUDE_FILES=[
1411     "build/*",
1412     "bin/*",
1413     "test-output/",
1414     "test-reports",
1415     "tests",
1416     "clover*/*",
1417     ".*",
1418     "benchmarking/*",
1419     "**/.*",
1420     "*.class",
1421     "**/*.class","$j11modDir/**/*.jar","appletlib","**/*locales",
1422     "*locales/**",
1423     "utils/InstallAnywhere",
1424     "**/*.log",
1425   ] 
1426   def PROCESS_FILES=[
1427     "AUTHORS",
1428     "CITATION",
1429     "FEATURETODO",
1430     "JAVA-11-README",
1431     "FEATURETODO",
1432     "LICENSE",
1433     "**/README",
1434     "RELEASE",
1435     "THIRDPARTYLIBS",
1436     "TESTNG",
1437     "build.gradle",
1438     "gradle.properties",
1439     "**/*.java",
1440     "**/*.html",
1441     "**/*.xml",
1442     "**/*.gradle",
1443     "**/*.groovy",
1444     "**/*.properties",
1445     "**/*.perl",
1446     "**/*.sh",
1447   ]
1448   def INCLUDE_FILES=[
1449     ".settings/org.eclipse.jdt.core.jalview.prefs",
1450   ]
1451
1452   from(jalviewDir) {
1453     exclude (EXCLUDE_FILES)
1454     include (PROCESS_FILES)
1455     filter(ReplaceTokens,
1456       beginToken: '$$',
1457       endToken: '$$',
1458       tokens: [
1459         'Version-Rel': JALVIEW_VERSION,
1460         'Year-Rel': getDate("yyyy")
1461       ]
1462     )
1463   }
1464   from(jalviewDir) {
1465     exclude (EXCLUDE_FILES)
1466     exclude (PROCESS_FILES)
1467     exclude ("appletlib")
1468     exclude ("**/*locales")
1469     exclude ("*locales/**")
1470     exclude ("utils/InstallAnywhere")
1471
1472     exclude (getdown_files_dir)
1473     exclude (getdown_website_dir)
1474
1475     // exluding these as not using jars as modules yet
1476     exclude ("$j11modDir/**/*.jar")
1477   }
1478   from(jalviewDir) {
1479     include(INCLUDE_FILES)
1480   }
1481 //  from (jalviewDir) {
1482 //    // explicit includes for stuff that seemed to not get included
1483 //    include(fileTree("test/**/*."))
1484 //    exclude(EXCLUDE_FILES)
1485 //    exclude(PROCESS_FILES)
1486 //  }
1487 }
1488
1489
1490 task helppages {
1491   dependsOn copyHelp
1492   dependsOn pubhtmlhelp
1493   
1494   inputs.dir("${classesDir}/${help_dir}")
1495   outputs.dir("${buildDir}/distributions/${help_dir}")
1496 }
1497
1498 // LARGE AMOUNT OF JALVIEWJS STUFF DELETED HERE
1499 task eclipseAutoBuildTask {}
1500 task eclipseSynchronizationTask {}