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