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
12 classpath 'org.openclover:clover:4.4.1'
20 id 'com.github.johnrengelman.shadow' version '4.0.3'
21 id 'com.install4j.gradle' version '8.0.2'
22 id 'com.dorongold.task-tree' version '1.5' // only needed to display task dependency tree with gradle task1 [task2 ...] taskTree
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()
45 jalviewDirAbsolutePath = file(jalviewDir).getAbsolutePath()
46 jalviewDirRelativePath = jalviewDir
48 // local build environment properties
49 def localProps = "${jalviewDirAbsolutePath}/local.properties"
50 if (file(localProps).exists()) {
52 def p = new Properties()
53 def localPropsFIS = new FileInputStream(localProps)
58 def oldval = findProperty(key)
61 println("Overriding property '${key}' ('${oldval}') with local.properties value '${val}'")
63 println("Setting unknown property '${key}' with local.properties value '${val}'")
66 } catch (Exception e) {
67 System.out.println("Exception reading local.properties")
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]}'")
84 println("WITHIN ECLIPSE IDE")
86 println("HEADLESS BUILD")
89 System.properties.sort { it.key }.each {
90 key, val -> println("SYSTEM PROPERTY ${key}='${val}'")
93 if (false && IN_ECLIPSE) {
94 jalviewDir = jalviewDirAbsolutePath
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}")
106 cloverInstrDir = file("${buildDir}/${cloverSourcesInstrDir}")
107 classesDir = string("${jalviewDir}/${classes_dir}")
108 if (clover.equals("true")) {
110 classesDir = string("${buildDir}/${cloverClassesDir}")
113 classesDir = string("${jalviewDir}/${classes_dir}")
118 getdownWebsiteDir = string("${jalviewDir}/${getdown_website_dir}/${JAVA_VERSION}")
121 // the following values might be overridden by the CHANNEL switch
122 getdownChannelName = CHANNEL.toLowerCase()
123 getdownDir = string("${getdownChannelName}/${JAVA_VERSION}")
124 getdownAppBase = string("${getdown_channel_base}/${getdownDir}")
125 getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher}")
126 getdownAppDistDir = getdown_app_dir_alt
127 buildProperties = string("${classesDir}/${build_properties_file}")
128 reportRsyncCmd = false
129 jvlChannelName = CHANNEL.toLowerCase()
133 // TODO: get bamboo build artifact URL for getdown artifacts
134 getdown_channel_base = bamboo_channelbase
135 getdownChannelName = string("${bamboo_planKey}/${JAVA_VERSION}")
136 getdownAppBase = string("${bamboo_channelbase}/${bamboo_planKey}${bamboo_getdown_channel_suffix}/${JAVA_VERSION}")
137 jvlChannelName += "_${getdownChannelName}"
141 getdownAppDistDir = getdown_app_dir_release
142 reportRsyncCommand = true
146 getdownChannelName = CHANNEL.toLowerCase()+"/${JALVIEW_VERSION}"
147 getdownDir = string("${getdownChannelName}/${JAVA_VERSION}")
148 getdownAppBase = string("${getdown_channel_base}/${getdownDir}")
149 if (!file("${ARCHIVEDIR}/${packageDir}").exists()) {
150 throw new GradleException("Must provide an ARCHIVEDIR value to produce an archive distribution")
152 packageDir = string("${ARCHIVEDIR}/${packageDir}")
153 buildProperties = string("${ARCHIVEDIR}/${classes_dir}/${build_properties_file}")
156 reportRsyncCommand = true
160 getdownChannelName = string("archive/${JALVIEW_VERSION}")
161 getdownDir = string("${getdownChannelName}/${JAVA_VERSION}")
162 getdownAppBase = file(getdownWebsiteDir).toURI().toString()
163 if (!file("${ARCHIVEDIR}/${packageDir}").exists()) {
164 throw new GradleException("Must provide an ARCHIVEDIR value to produce an archive distribution")
166 packageDir = string("${ARCHIVEDIR}/${packageDir}")
167 buildProperties = string("${ARCHIVEDIR}/${classes_dir}/${build_properties_file}")
170 reportRsyncCommand = true
171 getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}")
175 reportRsyncCommand = true
179 reportRsyncCommand = true
182 case ~/^SCRATCH(|-[-\w]*)$/:
183 getdownChannelName = CHANNEL
184 getdownDir = string("${getdownChannelName}/${JAVA_VERSION}")
185 getdownAppBase = string("${getdown_channel_base}/${getdownDir}")
186 reportRsyncCommand = true
190 if (!file("${LOCALDIR}").exists()) {
191 throw new GradleException("Must provide a LOCALDIR value to produce a local distribution")
193 getdownAppBase = file(file("${LOCALDIR}").getAbsolutePath()).toURI().toString()
194 getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}")
199 getdownAppBase = file(getdownWebsiteDir).toURI().toString()
200 getdownLauncher = string("${jalviewDir}/${getdown_lib_dir}/${getdown_launcher_local}")
203 default: // something wrong specified
204 throw new GradleException("CHANNEL must be one of BUILD, RELEASE, ARCHIVE, DEVELOP, TEST-RELEASE, SCRATCH-..., LOCAL [default]")
208 // override getdownAppBase if requested
209 if (findProperty("getdown_appbase_override") != null) {
210 getdownAppBase = string(getProperty("getdown_appbase_override"))
211 println("Overriding getdown appbase with '${getdownAppBase}'")
213 // sanitise file name for jalview launcher file for this channel
214 jvlChannelName = jvlChannelName.replaceAll(/[^\w\-]/,"_")
216 getdownAppDir = string("${getdownWebsiteDir}/${getdownAppDistDir}")
217 //getdownJ11libDir = "${getdownWebsiteDir}/${getdown_j11lib_dir}"
218 getdownResourceDir = string("${getdownWebsiteDir}/${getdown_resource_dir}")
219 getdownInstallDir = string("${getdownWebsiteDir}/${getdown_install_dir}")
220 getdownFilesDir = string("${jalviewDir}/${getdown_files_dir}/${JAVA_VERSION}/")
221 getdownFilesInstallDir = string("${getdownFilesDir}/${getdown_install_dir}")
222 /* compile without modules -- using classpath libraries
223 modules_compileClasspath = fileTree(dir: "${jalviewDir}/${j11modDir}", include: ["*.jar"])
224 modules_runtimeClasspath = modules_compileClasspath
227 gitBranch = string("")
229 println("Using a ${CHANNEL} profile.")
231 additional_compiler_args = []
232 // configure classpath/args for j8/j11 compilation
233 if (JAVA_VERSION.equals("1.8")) {
234 JAVA_INTEGER_VERSION = string("8")
237 libDistDir = j8libDir
238 compile_source_compatibility = 1.8
239 compile_target_compatibility = 1.8
240 // these are getdown.txt properties defined dependent on the JAVA_VERSION
241 getdownAltJavaMinVersion = string(findProperty("getdown_alt_java8_min_version"))
242 getdownAltJavaMaxVersion = string(findProperty("getdown_alt_java8_max_version"))
243 // this property is assigned below and expanded to multiple lines in the getdown task
244 getdownAltMultiJavaLocation = string(findProperty("getdown_alt_java8_txt_multi_java_location"))
245 // this property is for the Java library used in eclipse
246 eclipseJavaRuntimeName = string("JavaSE-1.8")
247 } else if (JAVA_VERSION.equals("11")) {
248 JAVA_INTEGER_VERSION = string("11")
250 libDistDir = j11libDir
251 compile_source_compatibility = 11
252 compile_target_compatibility = 11
253 getdownAltJavaMinVersion = string(findProperty("getdown_alt_java11_min_version"))
254 getdownAltJavaMaxVersion = string(findProperty("getdown_alt_java11_max_version"))
255 getdownAltMultiJavaLocation = string(findProperty("getdown_alt_java11_txt_multi_java_location"))
256 eclipseJavaRuntimeName = string("JavaSE-11")
257 /* compile without modules -- using classpath libraries
258 additional_compiler_args += [
259 '--module-path', modules_compileClasspath.asPath,
260 '--add-modules', j11modules
263 } else if (JAVA_VERSION.equals("12") || JAVA_VERSION.equals("13")) {
264 JAVA_INTEGER_VERSION = JAVA_VERSION
266 libDistDir = j11libDir
267 compile_source_compatibility = JAVA_VERSION
268 compile_target_compatibility = JAVA_VERSION
269 getdownAltJavaMinVersion = string(findProperty("getdown_alt_java11_min_version"))
270 getdownAltJavaMaxVersion = string(findProperty("getdown_alt_java11_max_version"))
271 getdownAltMultiJavaLocation = string(findProperty("getdown_alt_java11_txt_multi_java_location"))
272 eclipseJavaRuntimeName = string("JavaSE-11")
273 /* compile without modules -- using classpath libraries
274 additional_compiler_args += [
275 '--module-path', modules_compileClasspath.asPath,
276 '--add-modules', j11modules
280 throw new GradleException("JAVA_VERSION=${JAVA_VERSION} not currently supported by Jalview")
285 JAVA_MIN_VERSION = JAVA_VERSION
286 JAVA_MAX_VERSION = JAVA_VERSION
287 def jreInstallsDir = string(jre_installs_dir)
288 if (jreInstallsDir.startsWith("~/")) {
289 jreInstallsDir = System.getProperty("user.home") + jreInstallsDir.substring(1)
291 macosJavaVMDir = string("${jreInstallsDir}/jre-${JAVA_INTEGER_VERSION}-mac-x64/jre")
292 macosJavaVMTgz = string("${jreInstallsDir}/tgz/jre-${JAVA_INTEGER_VERSION}-mac-x64.tar.gz")
293 windowsJavaVMDir = string("${jreInstallsDir}/jre-${JAVA_INTEGER_VERSION}-windows-x64/jre")
294 windowsJavaVMTgz = string("${jreInstallsDir}/tgz/jre-${JAVA_INTEGER_VERSION}-windows-x64.tar.gz")
295 linuxJavaVMDir = string("${jreInstallsDir}/jre-${JAVA_INTEGER_VERSION}-linux-x64/jre")
296 linuxJavaVMTgz = string("${jreInstallsDir}/tgz/jre-${JAVA_INTEGER_VERSION}-linux-x64.tar.gz")
297 install4jDir = string("${jalviewDir}/${install4j_utils_dir}")
298 install4jConfFileName = string("jalview-install4j-conf.install4j")
299 install4jConfFile = file("${install4jDir}/${install4jConfFileName}")
300 install4jHomeDir = install4j_home_dir
301 if (install4jHomeDir.startsWith("~/")) {
302 install4jHomeDir = System.getProperty("user.home") + install4jHomeDir.substring(1)
307 buildingHTML = string("${jalviewDir}/${docDir}/building.html")
308 helpFile = string("${classesDir}/${help_dir}/help.jhm")
309 helpParentDir = string("${jalviewDir}/${help_parent_dir}")
310 helpSourceDir = string("${helpParentDir}/${help_dir}")
313 relativeBuildDir = file(jalviewDirAbsolutePath).toPath().relativize(buildDir.toPath())
314 jalviewjsBuildDir = string("${relativeBuildDir}/jalviewjs")
315 jalviewjsSiteDir = string("${jalviewjsBuildDir}/${jalviewjs_site_dir}")
317 jalviewjsTransferSiteJsDir = string(jalviewjsSiteDir)
319 jalviewjsTransferSiteJsDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_js")
321 jalviewjsTransferSiteLibDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_lib")
322 jalviewjsTransferSiteSwingJsDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_swingjs")
323 jalviewjsTransferSiteCoreDir = string("${jalviewjsBuildDir}/tmp/${jalviewjs_site_dir}_core")
324 jalviewjsJalviewCoreHtmlFile = string("")
325 jalviewjsJalviewCoreName = string(jalviewjs_core_name)
326 jalviewjsCoreClasslists = []
327 jalviewjsJalviewTemplateName = string(jalviewjs_name)
328 jalviewjsJ2sSettingsFileName = string("${jalviewDir}/${jalviewjs_j2s_settings}")
329 jalviewjsJ2sProps = null
331 eclipseWorkspace = null
332 eclipseBinary = string("")
333 eclipseVersion = string("")
343 outputDir = file(classesDir)
348 srcDirs += helpParentDir
351 jar.destinationDir = file("${jalviewDir}/${packageDir}")
353 compileClasspath = files(sourceSets.main.java.outputDir)
354 //compileClasspath += files(sourceSets.main.resources.srcDirs)
355 compileClasspath += fileTree(dir: "${jalviewDir}/${libDir}", include: ["*.jar"])
357 runtimeClasspath = compileClasspath
362 srcDirs = [ cloverInstrDir ]
363 outputDir = file("${buildDir}/${cloverClassesDir}")
367 srcDirs = sourceSets.main.resources.srcDirs
369 compileClasspath = configurations.cloverRuntime + files( sourceSets.clover.java.outputDir )
370 compileClasspath += files(sourceSets.main.java.outputDir)
371 compileClasspath += sourceSets.main.compileClasspath
372 compileClasspath += fileTree(dir: "${jalviewDir}/${utilsDir}", include: ["**/*.jar"])
373 compileClasspath += fileTree(dir: "${jalviewDir}/${libDir}", include: ["*.jar"])
375 runtimeClasspath = compileClasspath
380 srcDirs testSourceDir
381 outputDir = file("${jalviewDir}/${testOutputDir}")
385 srcDirs = sourceSets.main.resources.srcDirs
388 compileClasspath = files( sourceSets.test.java.outputDir )
391 compileClasspath = sourceSets.clover.compileClasspath
393 compileClasspath += files(sourceSets.main.java.outputDir)
396 compileClasspath += fileTree(dir: "${jalviewDir}/${libDir}", include: ["*.jar"])
397 compileClasspath += fileTree(dir: "${jalviewDir}/${utilsDir}/testnglibs", include: ["**/*.jar"])
398 compileClasspath += fileTree(dir: "${jalviewDir}/${utilsDir}/testlibs", include: ["**/*.jar"])
400 runtimeClasspath = compileClasspath
408 cloverCompile 'org.openclover:clover:4.4.1'
409 testCompile 'org.openclover:clover:4.4.1'
416 cloverRuntime.extendsFrom cloverCompile
421 name = eclipse_project_name
423 natures 'org.eclipse.jdt.core.javanature',
424 'org.eclipse.jdt.groovy.core.groovyNature',
425 'org.eclipse.buildship.core.gradleprojectnature'
427 buildCommand 'org.eclipse.jdt.core.javabuilder'
428 buildCommand 'org.eclipse.buildship.core.gradleprojectbuilder'
432 //defaultOutputDir = sourceSets.main.java.outputDir
435 if (it.isCanBeResolved()) {
440 minusConfigurations += removeThese
441 plusConfigurations = [ ]
445 def removeTheseToo = []
446 HashMap<String, Boolean> alreadyAddedSrcPath = new HashMap<>();
447 cp.entries.each { entry ->
448 // This conditional removes all src classpathentries that a) have already been added or b) aren't "src" or "test".
449 // e.g. this removes the resources dir being copied into bin/main, bin/test AND bin/clover
450 // we add the resources and help/help dirs in as libs afterwards (see below)
451 if (entry.kind == 'src') {
452 if (alreadyAddedSrcPath.getAt(entry.path) || !(entry.path == bareSourceDir || entry.path == bareTestSourceDir)) {
453 removeTheseToo += entry
455 alreadyAddedSrcPath.putAt(entry.path, true)
460 cp.entries.removeAll(removeTheseToo)
462 //cp.entries += new Output("${eclipse_bin_dir}/main")
463 if (file(helpParentDir).isDirectory()) {
464 cp.entries += new Library(fileReference(helpParentDir))
466 if (file(resourceDir).isDirectory()) {
467 cp.entries += new Library(fileReference(resourceDir))
470 HashMap<String, Boolean> alreadyAddedLibPath = new HashMap<>();
472 sourceSets.main.compileClasspath.findAll { it.name.endsWith(".jar") }.any {
473 //don't want to add outputDir as eclipse is using its own output dir in bin/main
474 if (it.isDirectory() || ! it.exists()) {
475 // don't add dirs to classpath, especially if they don't exist
476 return false // groovy "continue" in .any closure
478 def itPath = it.toString()
479 if (itPath.startsWith("${jalviewDirAbsolutePath}/")) {
480 // make relative path
481 itPath = itPath.substring(jalviewDirAbsolutePath.length()+1)
483 if (alreadyAddedLibPath.get(itPath)) {
484 //println("Not adding duplicate entry "+itPath)
486 //println("Adding entry "+itPath)
487 cp.entries += new Library(fileReference(itPath))
488 alreadyAddedLibPath.put(itPath, true)
492 sourceSets.test.compileClasspath.findAll { it.name.endsWith(".jar") }.any {
493 //no longer want to add outputDir as eclipse is using its own output dir in bin/main
494 if (it.isDirectory() || ! it.exists()) {
495 // don't add dirs to classpath
496 return false // groovy "continue" in .any closure
499 def itPath = it.toString()
500 if (itPath.startsWith("${jalviewDirAbsolutePath}/")) {
501 itPath = itPath.substring(jalviewDirAbsolutePath.length()+1)
503 if (alreadyAddedLibPath.get(itPath)) {
506 def lib = new Library(fileReference(itPath))
507 lib.entryAttributes["test"] = "true"
509 alreadyAddedLibPath.put(itPath, true)
517 containers 'org.eclipse.buildship.core.gradleclasspathcontainer'
522 // for the IDE, use java 11 compatibility
523 sourceCompatibility = compile_source_compatibility
524 targetCompatibility = compile_target_compatibility
525 javaRuntimeName = eclipseJavaRuntimeName
527 // add in jalview project specific properties/preferences into eclipse core preferences
529 withProperties { props ->
530 def jalview_prefs = new Properties()
531 def ins = new FileInputStream("${jalviewDirAbsolutePath}/${eclipse_extra_jdt_prefs_file}")
532 jalview_prefs.load(ins)
534 jalview_prefs.forEach { t, v ->
535 if (props.getAt(t) == null) {
545 // Don't want these to be activated if in headless build
546 synchronizationTasks "eclipseSynchronizationTask"
547 autoBuildTasks "eclipseAutoBuildTask"
554 // only instrument source, we build test classes as normal
555 inputs.files files (sourceSets.main.allJava,sourceSets.test.allJava) // , fileTree(dir:"$jalviewDir/$testSourceDir", include: ["**/*.java"]))
556 outputs.dir cloverInstrDir
559 delete cloverInstrDir
560 def argsList = ["--initstring", "${buildDir}/clover/clover.db",
561 "-d", "${buildDir}/${cloverSourcesInstrDir}"]
562 argsList.addAll(inputs.files.files.collect({ file ->
565 String[] args = argsList.toArray()
566 println("About to instrument "+args.length +" files")
567 com.atlassian.clover.CloverInstr.mainImpl(args)
572 task cloverReportHTML (type: JavaExec) {
573 inputs.dir "${buildDir}/clover"
574 outputs.dir "${reportsDir}/clover"
576 classpath configurations.cloverRuntime
577 maxHeapSize "${cloverReportJVMHeap}"
578 jvmArgs += "${cloverReportJVMArgs}"
579 main = "com.atlassian.clover.reporters.html.HtmlReporter"
580 args "--initstring", "${buildDir}/clover/clover.db", "-o", "${reportsDir}/clover"
581 "${cloverReportHTMLOptions}".split(",").each {
586 task cloverReportXML (type: JavaExec) {
587 inputs.dir "${buildDir}/clover"
588 outputs.dir "${reportsDir}/clover"
589 maxHeapSize "${cloverReportJVMHeap}"
590 jvmArgs "${cloverReportJVMArgs}"
591 classpath configurations.cloverRuntime
592 main = "com.atlassian.clover.reporters.xml.XMLReporter"
593 args "--initstring", "${buildDir}/clover/clover.db", "-o", "${reportsDir}/clover/clover.xml"
595 "${cloverReportXMLOptions}".split(",").each {
600 group = "Verification"
601 description = "Creates the Clover report"
602 inputs.dir "${buildDir}/clover"
603 outputs.dir "${reportsDir}/clover"
605 file("${buildDir}/clover/clover.db").exists()
607 dependsOn cloverReportXML
608 dependsOn cloverReportHTML
616 sourceCompatibility = compile_source_compatibility
617 targetCompatibility = compile_target_compatibility
618 options.compilerArgs = additional_compiler_args
619 print ("Setting target compatibility to "+targetCompatibility+"\n")
627 dependsOn compileCloverJava
628 classpath += configurations.cloverRuntime
630 classpath += sourceSets.main.runtimeClasspath
633 sourceCompatibility = compile_source_compatibility
634 targetCompatibility = compile_target_compatibility
635 options.compilerArgs = additional_compiler_args
636 print ("Setting target compatibility to "+targetCompatibility+"\n")
644 sourceCompatibility = compile_source_compatibility
645 targetCompatibility = compile_target_compatibility
646 options.compilerArgs += additional_compiler_args
647 print ("Setting target compatibility to "+targetCompatibility+"\n")
649 classpath += configurations.cloverRuntime
655 delete sourceSets.main.java.outputDir
662 delete sourceSets.test.java.outputDir
663 delete cloverInstrDir
668 // format is a string like date.format("dd MMMM yyyy")
669 def getDate(format) {
670 def date = new Date()
671 return date.format(format)
676 def hashStdOut = new ByteArrayOutputStream()
678 commandLine "git", "rev-parse", "--short", "HEAD"
679 standardOutput = hashStdOut
683 def branchStdOut = new ByteArrayOutputStream()
685 commandLine "git", "rev-parse", "--abbrev-ref", "HEAD"
686 standardOutput = branchStdOut
690 gitHash = hashStdOut.toString().trim()
691 gitBranch = branchStdOut.toString().trim()
693 outputs.upToDateWhen { false }
697 task createBuildProperties(type: WriteProperties) {
699 inputs.dir(sourceDir)
700 inputs.dir(resourceDir)
701 file(buildProperties).getParentFile().mkdirs()
702 outputFile (buildProperties)
703 // taking time specific comment out to allow better incremental builds
704 comment "--Jalview Build Details--\n"+getDate("yyyy-MM-dd HH:mm:ss")
705 //comment "--Jalview Build Details--\n"+getDate("yyyy-MM-dd")
706 property "BUILD_DATE", getDate("HH:mm:ss dd MMMM yyyy")
707 property "VERSION", JALVIEW_VERSION
708 property "INSTALLATION", INSTALLATION+" git-commit:"+gitHash+" ["+gitBranch+"]"
709 outputs.file(outputFile)
713 task cleanBuildingHTML(type: Delete) {
720 task convertBuildingMD(type: Exec) {
721 dependsOn cleanBuildingHTML
722 def buildingMD = "${jalviewDir}/${docDir}/building.md"
723 def css = "${jalviewDir}/${docDir}/github.css"
726 pandoc_exec.split(",").each {
727 if (file(it.trim()).exists()) {
733 def hostname = "hostname".execute().text.trim()
734 def buildtoolsPandoc = System.getProperty("user.home")+"/buildtools/pandoc/bin/pandoc"
735 if ((pandoc == null || ! file(pandoc).exists()) && file(buildtoolsPandoc).exists()) {
736 pandoc = System.getProperty("user.home")+"/buildtools/pandoc/bin/pandoc"
740 if (pandoc != null && file(pandoc).exists()) {
741 commandLine pandoc, '-s', '-o', buildingHTML, '--metadata', 'pagetitle="Building Jalview from Source"', '--toc', '-H', css, buildingMD
743 println("Cannot find pandoc. Skipping convert building.md to HTML")
744 throw new StopExecutionException("Cannot find pandoc. Skipping convert building.md to HTML")
750 inputs.file(buildingMD)
752 outputs.file(buildingHTML)
763 task syncDocs(type: Sync) {
764 dependsOn convertBuildingMD
765 def syncDir = "${classesDir}/${docDir}"
766 from fileTree("${jalviewDir}/${docDir}")
772 task copyHelp(type: Copy) {
773 def inputDir = helpSourceDir
774 def outputDir = "${classesDir}/${help_dir}"
779 filter(ReplaceTokens,
783 'Version-Rel': JALVIEW_VERSION,
784 'Year-Rel': getDate("yyyy")
796 outputs.files(helpFile)
797 outputs.dir(outputDir)
801 task syncLib(type: Sync) {
802 def syncDir = "${classesDir}/${libDistDir}"
803 from fileTree("${jalviewDir}/${libDistDir}")
808 task syncResources(type: Sync) {
819 dependsOn syncResources
825 //testReportDirName = "test-reports" // note that test workingDir will be $jalviewDir
828 dependsOn compileJava
830 dependsOn cloverInstr
834 print("Running tests " + (use_clover?"WITH":"WITHOUT") + " clover [clover="+use_clover+"]\n")
838 includeGroups testngGroups
840 useDefaultListeners=true
843 workingDir = jalviewDir
844 //systemProperties 'clover.jar' System.properties.clover.jar
845 sourceCompatibility = compile_source_compatibility
846 targetCompatibility = compile_target_compatibility
847 jvmArgs += additional_compiler_args
852 task buildIndices(type: JavaExec) {
854 classpath = sourceSets.main.compileClasspath
855 main = "com.sun.java.help.search.Indexer"
856 workingDir = "${classesDir}/${help_dir}"
859 inputs.dir("${workingDir}/${argDir}")
861 outputs.dir("${classesDir}/doc")
862 outputs.dir("${classesDir}/help")
863 outputs.file("${workingDir}/JavaHelpSearch/DOCS")
864 outputs.file("${workingDir}/JavaHelpSearch/DOCS.TAB")
865 outputs.file("${workingDir}/JavaHelpSearch/OFFSETS")
866 outputs.file("${workingDir}/JavaHelpSearch/POSITIONS")
867 outputs.file("${workingDir}/JavaHelpSearch/SCHEMA")
868 outputs.file("${workingDir}/JavaHelpSearch/TMAP")
872 task compileLinkCheck(type: JavaCompile) {
874 classpath = files("${jalviewDir}/${utilsDir}")
875 destinationDir = file("${jalviewDir}/${utilsDir}")
876 source = fileTree(dir: "${jalviewDir}/${utilsDir}", include: ["HelpLinksChecker.java", "BufferedLineReader.java"])
878 inputs.file("${jalviewDir}/${utilsDir}/HelpLinksChecker.java")
879 inputs.file("${jalviewDir}/${utilsDir}/HelpLinksChecker.java")
880 outputs.file("${jalviewDir}/${utilsDir}/HelpLinksChecker.class")
881 outputs.file("${jalviewDir}/${utilsDir}/BufferedLineReader.class")
885 task linkCheck(type: JavaExec) {
886 dependsOn prepare, compileLinkCheck
888 def helpLinksCheckerOutFile = file("${jalviewDir}/${utilsDir}/HelpLinksChecker.out")
889 classpath = files("${jalviewDir}/${utilsDir}")
890 main = "HelpLinksChecker"
891 workingDir = jalviewDir
892 args = [ "${classesDir}/${help_dir}", "-nointernet" ]
894 def outFOS = new FileOutputStream(helpLinksCheckerOutFile, false) // false == don't append
896 standardOutput = new org.apache.tools.ant.util.TeeOutputStream(
899 errorOutput = new org.apache.tools.ant.util.TeeOutputStream(
903 inputs.dir("${classesDir}/${help_dir}")
904 outputs.file(helpLinksCheckerOutFile)
907 // import the pubhtmlhelp target
908 ant.properties.basedir = "${jalviewDir}"
909 ant.properties.helpBuildDir = "${jalviewDirAbsolutePath}/${classes_dir}/${help_dir}"
910 ant.importBuild "${utilsDir}/publishHelp.xml"
913 task cleanPackageDir(type: Delete) {
915 delete fileTree(dir: "${jalviewDir}/${packageDir}", include: "*.jar")
921 dependsOn buildIndices
922 dependsOn createBuildProperties
925 attributes "Main-Class": mainClass,
926 "Permissions": "all-permissions",
927 "Application-Name": "Jalview Desktop",
928 "Codebase": application_codebase
931 destinationDir = file("${jalviewDir}/${packageDir}")
932 archiveName = rootProject.name+".jar"
940 inputs.dir(classesDir)
941 outputs.file("${jalviewDir}/${packageDir}/${archiveName}")
945 task copyJars(type: Copy) {
946 from fileTree(dir: classesDir, include: "**/*.jar").files
947 into "${jalviewDir}/${packageDir}"
951 // doing a Sync instead of Copy as Copy doesn't deal with "outputs" very well
952 task syncJars(type: Sync) {
953 from fileTree(dir: "${jalviewDir}/${libDistDir}", include: "**/*.jar").files
954 into "${jalviewDir}/${packageDir}"
956 include jar.archiveName
963 description = "Put all required libraries in dist"
964 // order of "cleanPackageDir", "copyJars", "jar" important!
965 jar.mustRunAfter cleanPackageDir
966 syncJars.mustRunAfter cleanPackageDir
967 dependsOn cleanPackageDir
970 outputs.dir("${jalviewDir}/${packageDir}")
975 dependsOn cleanPackageDir
981 group = "distribution"
985 from ("${jalviewDir}/${libDistDir}") {
989 attributes 'Implementation-Version': JALVIEW_VERSION
991 mainClassName = shadowJarMainClass
993 classifier = "all-"+JALVIEW_VERSION+"-j"+JAVA_VERSION
998 task getdownWebsite() {
999 group = "distribution"
1000 description = "Create the getdown minimal app folder, and website folder for this version of jalview. Website folder also used for offline app installer"
1005 def getdownWebsiteResourceFilenames = []
1006 def getdownTextString = ""
1007 def getdownResourceDir = getdownResourceDir
1008 def getdownResourceFilenames = []
1011 // clean the getdown website and files dir before creating getdown folders
1012 delete getdownWebsiteDir
1013 delete getdownFilesDir
1016 from buildProperties
1017 rename(build_properties_file, getdown_build_properties)
1020 getdownWebsiteResourceFilenames += "${getdownAppDistDir}/${getdown_build_properties}"
1022 // go through properties looking for getdown_txt_...
1023 def props = project.properties.sort { it.key }
1024 if (getdownAltJavaMinVersion != null && getdownAltJavaMinVersion.length() > 0) {
1025 props.put("getdown_txt_java_min_version", getdownAltJavaMinVersion)
1027 if (getdownAltJavaMaxVersion != null && getdownAltJavaMaxVersion.length() > 0) {
1028 props.put("getdown_txt_java_max_version", getdownAltJavaMaxVersion)
1030 if (getdownAltMultiJavaLocation != null && getdownAltMultiJavaLocation.length() > 0) {
1031 props.put("getdown_txt_multi_java_location", getdownAltMultiJavaLocation)
1034 props.put("getdown_txt_appbase", getdownAppBase)
1035 props.each{ prop, val ->
1036 if (prop.startsWith("getdown_txt_") && val != null) {
1037 if (prop.startsWith("getdown_txt_multi_")) {
1038 def key = prop.substring(18)
1039 val.split(",").each{ v ->
1040 def line = "${key} = ${v}\n"
1041 getdownTextString += line
1044 // file values rationalised
1045 if (val.indexOf('/') > -1 || prop.startsWith("getdown_txt_resource")) {
1047 if (val.indexOf('/') == 0) {
1050 } else if (val.indexOf('/') > 0) {
1051 // relative path (relative to jalviewDir)
1052 r = file( "${jalviewDir}/${val}" )
1055 val = "${getdown_resource_dir}/" + r.getName()
1056 getdownWebsiteResourceFilenames += val
1057 getdownResourceFilenames += r.getPath()
1060 if (! prop.startsWith("getdown_txt_resource")) {
1061 def line = prop.substring(12) + " = ${val}\n"
1062 getdownTextString += line
1068 getdownWebsiteResourceFilenames.each{ filename ->
1069 getdownTextString += "resource = ${filename}\n"
1071 getdownResourceFilenames.each{ filename ->
1074 into getdownResourceDir
1079 fileTree(file(packageDir)).each{ f ->
1080 if (f.isDirectory()) {
1081 def files = fileTree(dir: f, include: ["*"]).getFiles()
1083 } else if (f.exists()) {
1087 codeFiles.sort().each{f ->
1088 def name = f.getName()
1089 def line = "code = ${getdownAppDistDir}/${name}\n"
1090 getdownTextString += line
1097 // NOT USING MODULES YET, EVERYTHING SHOULD BE IN dist
1099 if (JAVA_VERSION.equals("11")) {
1100 def j11libFiles = fileTree(dir: "${jalviewDir}/${j11libDir}", include: ["*.jar"]).getFiles()
1101 j11libFiles.sort().each{f ->
1102 def name = f.getName()
1103 def line = "code = ${getdown_j11lib_dir}/${name}\n"
1104 getdownTextString += line
1107 into getdownJ11libDir
1113 // 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.
1114 //getdownTextString += "class = " + file(getdownLauncher).getName() + "\n"
1115 getdownTextString += "resource = ${getdown_launcher_new}\n"
1116 getdownTextString += "class = ${mainClass}\n"
1118 def getdown_txt = file("${getdownWebsiteDir}/getdown.txt")
1119 getdown_txt.write(getdownTextString)
1121 def getdownLaunchJvl = getdown_launch_jvl_name + ( (jvlChannelName != null && jvlChannelName.length() > 0)?"-${jvlChannelName}":"" ) + ".jvl"
1122 def launchJvl = file("${getdownWebsiteDir}/${getdownLaunchJvl}")
1123 launchJvl.write("appbase="+props.get("getdown_txt_appbase"))
1126 from getdownLauncher
1127 rename(file(getdownLauncher).getName(), getdown_launcher_new)
1128 into getdownWebsiteDir
1132 from getdownLauncher
1133 if (file(getdownLauncher).getName() != getdown_launcher) {
1134 rename(file(getdownLauncher).getName(), getdown_launcher)
1136 into getdownWebsiteDir
1139 if (! (CHANNEL.startsWith("ARCHIVE") || CHANNEL.startsWith("DEVELOP"))) {
1142 from getdownLauncher
1143 from "${getdownWebsiteDir}/${getdown_build_properties}"
1144 if (file(getdownLauncher).getName() != getdown_launcher) {
1145 rename(file(getdownLauncher).getName(), getdown_launcher)
1147 into getdownInstallDir
1151 from getdownInstallDir
1152 into getdownFilesInstallDir
1159 from getdownLauncher
1160 from "${getdownWebsiteDir}/${getdown_build_properties}"
1161 if (file(getdownLauncher).getName() != getdown_launcher) {
1162 rename(file(getdownLauncher).getName(), getdown_launcher)
1164 into getdownFilesDir
1168 from getdownResourceDir
1169 into "${getdownFilesDir}/${getdown_resource_dir}"
1174 inputs.dir("${jalviewDir}/${packageDir}")
1176 outputs.dir(getdownWebsiteDir)
1177 outputs.dir(getdownFilesDir)
1181 // a helper task to allow getdown digest of any dir: `gradle getdownDigestDir -PDIGESTDIR=/path/to/my/random/getdown/dir
1182 task getdownDigestDir(type: JavaExec) {
1183 def digestDirPropertyName = "DIGESTDIR"
1184 description = "Digest a local dir (-P${digestDirPropertyName}=...) for getdown"
1186 classpath = files(getdownLauncher)
1187 def digestDir = findProperty(digestDirPropertyName)
1188 if (digestDir == null) {
1189 throw new GradleException("Must provide a DIGESTDIR value to produce an alternative getdown digest")
1193 main = "com.threerings.getdown.tools.Digester"
1197 task getdownDigest(type: JavaExec) {
1198 group = "distribution"
1199 description = "Digest the getdown website folder"
1200 dependsOn getdownWebsite
1202 classpath = files(getdownLauncher)
1204 main = "com.threerings.getdown.tools.Digester"
1205 args getdownWebsiteDir
1206 inputs.dir(getdownWebsiteDir)
1207 outputs.file("${getdownWebsiteDir}/digest2.txt")
1212 group = "distribution"
1213 description = "Create the minimal and full getdown app folder for installers and website and create digest file"
1214 dependsOn getdownDigest
1216 if (reportRsyncCommand) {
1217 def fromDir = getdownWebsiteDir + (getdownWebsiteDir.endsWith('/')?'':'/')
1218 def toDir = "${getdown_rsync_dest}/${getdownDir}" + (getdownDir.endsWith('/')?'':'/')
1219 println "LIKELY RSYNC COMMAND:"
1220 println "mkdir -p '$toDir'\nrsync -avh --delete '$fromDir' '$toDir'"
1221 if (RUNRSYNC == "true") {
1223 commandLine "mkdir", "-p", toDir
1226 commandLine "rsync", "-avh", "--delete", fromDir, toDir
1236 delete getdownWebsiteDir
1237 delete getdownFilesDir
1243 if (file(install4jHomeDir).exists()) {
1245 } else if (file(System.getProperty("user.home")+"/buildtools/install4j").exists()) {
1246 install4jHomeDir = System.getProperty("user.home")+"/buildtools/install4j"
1247 } else if (file("/Applications/install4j.app/Contents/Resources/app").exists()) {
1248 install4jHomeDir = "/Applications/install4j.app/Contents/Resources/app"
1250 installDir(file(install4jHomeDir))
1252 mediaTypes = Arrays.asList(install4j_media_types.split(","))
1256 task copyInstall4jTemplate {
1257 def install4jTemplateFile = file("${install4jDir}/${install4j_template}")
1258 def install4jFileAssociationsFile = file("${install4jDir}/${install4j_installer_file_associations}")
1259 inputs.file(install4jTemplateFile)
1260 inputs.file(install4jFileAssociationsFile)
1261 outputs.file(install4jConfFile)
1264 def install4jConfigXml = new XmlParser().parse(install4jTemplateFile)
1266 // turn off code signing if no OSX_KEYPASS
1267 if (OSX_KEYPASS == "") {
1268 install4jConfigXml.'**'.codeSigning.each { codeSigning ->
1269 codeSigning.'@macEnabled' = "false"
1271 install4jConfigXml.'**'.windows.each { windows ->
1272 windows.'@runPostProcessor' = "false"
1276 // turn off checksum creation for LOCAL channel
1277 def e = install4jConfigXml.application[0]
1278 if (CHANNEL == "LOCAL") {
1279 e.'@createChecksums' = "false"
1281 e.'@createChecksums' = "true"
1284 // put file association actions where placeholder action is
1285 def install4jFileAssociationsText = install4jFileAssociationsFile.text
1286 def fileAssociationActions = new XmlParser().parseText("<actions>${install4jFileAssociationsText}</actions>")
1287 install4jConfigXml.'**'.action.any { a ->
1288 if (a.'@name' == 'EXTENSIONS_REPLACED_BY_GRADLE') {
1289 def parent = a.parent()
1291 fileAssociationActions.each { faa ->
1294 // don't need to continue in .any loop once replacements have been made
1299 // write install4j file
1300 install4jConfFile.text = XmlUtil.serialize(install4jConfigXml)
1307 delete install4jConfFile
1312 task installers(type: com.install4j.gradle.Install4jTask) {
1313 group = "distribution"
1314 description = "Create the install4j installers"
1315 dependsOn setGitVals
1317 dependsOn copyInstall4jTemplate
1319 projectFile = install4jConfFile
1321 // create an md5 for the input files to use as version for install4j conf file
1322 def digest = MessageDigest.getInstance("MD5")
1324 (file("${install4jDir}/${install4j_template}").text +
1325 file("${install4jDir}/${install4j_info_plist_file_associations}").text +
1326 file("${install4jDir}/${install4j_installer_file_associations}").text).bytes)
1327 def filesMd5 = new BigInteger(1, digest.digest()).toString(16)
1328 if (filesMd5.length() >= 8) {
1329 filesMd5 = filesMd5.substring(0,8)
1331 def install4jTemplateVersion = "${JALVIEW_VERSION}_F${filesMd5}_C${gitHash}"
1332 // make install4jBuildDir relative to jalviewDir
1333 def install4jBuildDir = "${install4j_build_dir}/${JAVA_VERSION}"
1336 'JALVIEW_NAME': getdown_txt_title,
1337 'JALVIEW_DIR': "../..",
1338 'OSX_KEYSTORE': OSX_KEYSTORE,
1339 'JSIGN_SH': JSIGN_SH,
1340 'JRE_DIR': getdown_app_dir_java,
1341 'INSTALLER_TEMPLATE_VERSION': install4jTemplateVersion,
1342 'JALVIEW_VERSION': JALVIEW_VERSION,
1343 'JAVA_MIN_VERSION': JAVA_MIN_VERSION,
1344 'JAVA_MAX_VERSION': JAVA_MAX_VERSION,
1345 'JAVA_VERSION': JAVA_VERSION,
1346 'JAVA_INTEGER_VERSION': JAVA_INTEGER_VERSION,
1347 'VERSION': JALVIEW_VERSION,
1348 'MACOS_JAVA_VM_DIR': macosJavaVMDir,
1349 'WINDOWS_JAVA_VM_DIR': windowsJavaVMDir,
1350 'LINUX_JAVA_VM_DIR': linuxJavaVMDir,
1351 'MACOS_JAVA_VM_TGZ': macosJavaVMTgz,
1352 'WINDOWS_JAVA_VM_TGZ': windowsJavaVMTgz,
1353 'LINUX_JAVA_VM_TGZ': linuxJavaVMTgz,
1354 'COPYRIGHT_MESSAGE': install4j_copyright_message,
1355 'MACOS_BUNDLE_ID': install4j_macOS_bundle_id,
1356 'INSTALLER_NAME': install4j_installer_name,
1357 'INSTALL4J_UTILS_DIR': install4j_utils_dir,
1358 'GETDOWN_WEBSITE_DIR': getdown_website_dir,
1359 'GETDOWN_FILES_DIR': getdown_files_dir,
1360 'GETDOWN_RESOURCE_DIR': getdown_resource_dir,
1361 'GETDOWN_DIST_DIR': getdownAppDistDir,
1362 'GETDOWN_ALT_DIR': getdown_app_dir_alt,
1363 'GETDOWN_INSTALL_DIR': getdown_install_dir,
1364 'INFO_PLIST_FILE_ASSOCIATIONS_FILE': install4j_info_plist_file_associations,
1365 'BUILD_DIR': install4jBuildDir,
1368 destination = "${jalviewDir}/${install4jBuildDir}"
1369 buildSelected = true
1371 if (install4j_faster.equals("true") || CHANNEL.startsWith("LOCAL")) {
1373 disableSigning = true
1377 macKeystorePassword = OSX_KEYPASS
1381 println("Using projectFile "+projectFile)
1384 inputs.dir(getdownWebsiteDir)
1385 inputs.file(install4jConfFile)
1386 inputs.file("${install4jDir}/${install4j_info_plist_file_associations}")
1387 inputs.dir(macosJavaVMDir)
1388 inputs.dir(windowsJavaVMDir)
1389 outputs.dir("${jalviewDir}/${install4j_build_dir}/${JAVA_VERSION}")
1393 task sourceDist(type: Tar) {
1395 def VERSION_UNDERSCORES = JALVIEW_VERSION.replaceAll("\\.", "_")
1396 def outputFileName = "${project.name}_${VERSION_UNDERSCORES}.tar.gz"
1397 // cater for buildship < 3.1 [3.0.1 is max version in eclipse 2018-09]
1399 archiveFileName = outputFileName
1400 } catch (Exception e) {
1401 archiveName = outputFileName
1404 compression Compression.GZIP
1419 "**/*.class","$j11modDir/**/*.jar","appletlib","**/*locales",
1421 "utils/InstallAnywhere",
1436 "gradle.properties",
1447 ".settings/org.eclipse.jdt.core.jalview.prefs",
1451 exclude (EXCLUDE_FILES)
1452 include (PROCESS_FILES)
1453 filter(ReplaceTokens,
1457 'Version-Rel': JALVIEW_VERSION,
1458 'Year-Rel': getDate("yyyy")
1463 exclude (EXCLUDE_FILES)
1464 exclude (PROCESS_FILES)
1465 exclude ("appletlib")
1466 exclude ("**/*locales")
1467 exclude ("*locales/**")
1468 exclude ("utils/InstallAnywhere")
1470 exclude (getdown_files_dir)
1471 exclude (getdown_website_dir)
1473 // exluding these as not using jars as modules yet
1474 exclude ("$j11modDir/**/*.jar")
1477 include(INCLUDE_FILES)
1479 // from (jalviewDir) {
1480 // // explicit includes for stuff that seemed to not get included
1481 // include(fileTree("test/**/*."))
1482 // exclude(EXCLUDE_FILES)
1483 // exclude(PROCESS_FILES)
1490 dependsOn pubhtmlhelp
1492 inputs.dir("${classesDir}/${help_dir}")
1493 outputs.dir("${buildDir}/distributions/${help_dir}")
1496 // LARGE AMOUNT OF JALVIEWJS STUFF DELETED HERE
1497 task eclipseAutoBuildTask {}
1498 task eclipseSynchronizationTask {}