build.gradle

buildscript {
  repositories {
    mavenCentral()
    maven { url "https://plugins.gradle.org/m2/" }
  }

  dependencies {
    classpath 'gradle.plugin.gradle-plugins:jartest:1.0.1'            // necessary to depend tests on tests
    //classpath "gradle.plugin.com.github.spotbugs.snom:spotbugs-gradle-plugin:4.5.0"
  }
}

plugins {
  id 'java'        // required for compileJava.dependsOn, manifest etc.
  id 'java-library'
  id 'maven-publish'
  id 'signing'
  id 'jacoco'
  id "com.diffplug.spotless" version "6.25.0"
}

configurations {
  resultJar
  emfJarConfig
  aspectJarConfig
  bytebuddyJarConfig
  javassistJarConfig
}

spotless {
  format 'misc', {
    // define the files to apply `misc` to
    target '*.gradle', '*.md', '.gitignore'

    // define the steps to apply to those files
    trimTrailingWhitespace()
    indentWithSpaces(2) // or tabs. Just in case.
    endWithNewline()
  }
}

dependencies {
  resultJar "org.slf4j:slf4j-api:${libSlf4jApiVersion}"
  resultJar "org.jctools:jctools-core:${libJctoolsVersion}"

  emfJarConfig 'org.eclipse.emf:org.eclipse.emf.common:2.31.0'
  emfJarConfig 'org.eclipse.emf:org.eclipse.emf.ecore.xmi:2.38.0'
  emfJarConfig 'org.eclipse.emf:org.eclipse.emf.ecore:2.37.0'

  aspectJarConfig "org.aspectj:aspectjweaver:${aspectjVersion}"
  aspectJarConfig "com.rabbitmq:amqp-client:5.22.0"

  bytebuddyJarConfig "net.bytebuddy:byte-buddy:$libBytebuddyVersion"
  bytebuddyJarConfig "commons-io:commons-io:2.17.0"

  javassistJarConfig "org.javassist:javassist:3.30.2-GA"
}

// We have multiple subprojects - but we do not want all of them in our JAR files.
// FIXME the jar tasks should handle this requirement instead.
// Otherwise, we need to add a new project twice: once in the settings.gradle and once in this file.
def mainSubprojects = [
  project(':common'),
  project(':monitoring:core'),
  project(':model'),
  project(':analysis'),
  project(':tools'),
  project(':extension-kafka'),
  project(':extension-cassandra')
]

def aspectJSubprojects = [
  project(':common'),
  project(':monitoring:core'),
  project(':monitoring:aspectj')
]

def bytebuddySubprojects = [
  project(':common'),
  project(':monitoring:core'),
  project(':monitoring:bytebuddy')
]

def javassistSubprojects = [
  project(':common'),
  project(':monitoring:core'),
  project(':monitoring:javassist')
]


def springSubprojects = [
  project(':common'),
  project(':monitoring:core'),
  project(':monitoring:spring')
]

allprojects {
  version = kiekerVersion

  repositories {    // must be above subprojects {}
    mavenLocal()
    mavenCentral()
    maven { url 'https://oss.sonatype.org/content/repositories/snapshots/' }
  }
}

subprojects {
  apply plugin: 'java'
  apply plugin: 'signing'
  apply plugin: 'jacoco'
  apply plugin: 'com.diffplug.spotless'
  apply plugin: 'maven-publish'

  sourceCompatibility = sourceVersion
  targetCompatibility = targetVersion

  // Encoding should be UTF-8
  compileJava.options.encoding = 'UTF-8'
  compileTestJava.options.encoding = 'UTF-8'

  sourceSets {
    main {
      java {
        srcDir 'src'
        srcDir 'src-gen'
      }
      resources {
        srcDirs = ['src-resources']
      }
    }
    test {
      java {
        srcDir 'test'
        srcDir 'test-gen'
      }
      resources {
        srcDirs = ['test-resources']
      }
    }
    integrationTest {
      java {
        srcDirs = ['test-integration']

        compileClasspath += main.compileClasspath + test.compileClasspath
        runtimeClasspath += main.runtimeClasspath + test.runtimeClasspath
      }
    }
  }

  test {
    finalizedBy jacocoTestReport // report is always generated after tests run

    systemProperty "java.io.tmpdir", "${buildDir}"
    ignoreFailures = true
    maxHeapSize = "2g"            // Set limit to prevent Travis-CI build to crash

    testLogging {
      showCauses = 'true'
      exceptionFormat = 'full'
      showExceptions = 'true'
      showStandardStreams = 'true'
    }

    jacoco {
      enabled = true
    }

    afterTest { desc, result ->
      println "Executed test ${desc.name} [${desc.className}] with result: ${result.resultType}"
    }
  }

  java {
    withSourcesJar()
    withJavadocJar()
  }

  javadoc {
    failOnError=false
  }

  artifacts {
    archives javadocJar
  }

  publishing {
    publications {
      maven(MavenPublication) {
        pom {
          groupId = 'net.kieker-monitoring'
          artifactId = project.name // Use the subproject's name
          version = project.version
          name = "${project.name} - Kieker Observability Framework"
          description = 'Kieker: Application Performance Observability and Software Analysis'
          url = 'http://kieker-monitoring.net'

          licenses {
            license {
              name = 'The Apache Software License, Version 2.0'
              url = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
            }
          }

          developers {
            developer {
              id = 'thomas.duellmann'
              name = 'Thomas F. Duellmann'
              email = 'duellmann@hitec-hamburg.de'
            }
            developer {
              id = 'andre.van.hoorn'
              name = 'Andre van Hoorn'
              email = 'andre.van.hoorn@uni-hamburg.de'
            }
            developer {
              id = 'reiner.jung'
              name = 'Reiner Jung'
              email = 'reiner.jung@email.uni-kiel.de'
            }
            developer {
              id = 'david.georg.reichelt'
              name = 'David Georg Reichelt'
              email = 'd.g.reichelt@lancaster.ac.uk'
            }
          }

          scm {
            connection = 'scm:git:https://github.com/kieker-monitoring/kieker.git'
            developerConnection = 'scm:git:git@github.com:kieker-monitoring/kieker.git'
            url = 'https://github.com/kieker-monitoring/kieker'
            }
        }
      }
    }
  }

  ext.isReleaseVersion = !version.endsWith("SNAPSHOT")
  signing {
    required { isReleaseVersion && gradle.taskGraph.hasTask("uploadArchives") }
    sign publishing.publications.maven
    println 'Going to sign subproject ' + project.name + ' for releasing: ' + isReleaseVersion
  }

  jacoco {
    toolVersion = '0.8.6'
  }

  jacocoTestReport {
    dependsOn test // tests are required to run before generating the report
    reports {
      xml.required = false
      csv.required = false
      html.required = true
    }
  }

  spotless {
    format 'misc', {
      // define the files to apply `misc` to
      target '*.gradle', '*.md', '.gitignore'

      // define the steps to apply to those files
      trimTrailingWhitespace()
      indentWithTabs() // or spaces. Takes an integer argument if you don't like 4
      endWithNewline()
    }
  }

  task integrationTest(type: Test) {
    testClassesDirs = project.sourceSets.integrationTest.output.classesDirs
    classpath = project.sourceSets.integrationTest.runtimeClasspath
  }
  check.dependsOn integrationTest

  tasks.withType(Zip) {
    duplicatesStrategy = DuplicatesStrategy.EXCLUDE
  }
  tasks.withType(Distribution) {
    duplicatesStrategy = DuplicatesStrategy.EXCLUDE
  }

  // --- quality assurance plugins ---

  apply plugin: 'pmd'
  pmd {    // is represented by the groovy class "PmdExtension"
    // the used PMD version should be the same version as the PMD Eclipse plugin (https://marketplace.eclipse.org/content/eclipse-pmd) uses
    toolVersion = pmdVersion
    ignoreFailures = true
    consoleOutput = true
    threads = 4
    incrementalAnalysis = false

    // Clear the rule set first. Otherwise we would have a lot of additional rules in our rule set.
    ruleSets = []
    ruleSetFiles = files(resolveRelativeToParent(dirConfig, 'pmdrules.xml'))
  }

  apply plugin: 'checkstyle'
  checkstyle {
    toolVersion = checkstyleVersion
    ignoreFailures = true
    showViolations = false

    configFile = resolveRelativeToParent(dirConfig, 'cs-conf.xml')
    configDirectory = rootProject.file(dirConfig)
  }

  //apply plugin: "com.github.spotbugs"
  //spotbugs {
  //   toolVersion = spotbugsVersion
  //   ignoreFailures = false
  //   showStackTraces = true
  //   showProgress = false
  //   effort = 'max'
  //   reportLevel = 'low'
  // visitors = [ 'FindSqlInjection', 'SwitchFallthrough' ]
  // omitVisitors = [ 'FindNonShortCircuit' ]
  // reportsDir = file("$buildDir/spotbugs")
  // includeFilter = file("include.xml")
  //   excludeFilter = resolveRelativeToParent(dirConfig, 'fb-filter.xml')
  // onlyAnalyze = [ 'com.foobar.MyClass', 'com.foobar.mypkg.*' ]
  // maxHeapSize = '1g'
  // extraArgs = [ '-nested:false' ]
  // jvmArgs = [ '-Duser.language=ja' ]
  //}

  tasks.withType(Pmd) {
    reports {
      xml.required = true
      html.required = true
    }
  }

  tasks.withType(Checkstyle) {
    reports {
      xml.required = true
      html.required = true
      html.stylesheet resources.text.fromFile(rootProject.projectDir.path + '/config/checkstyle-noframes-severity-sorted.xsl')
    }
  }

//    tasks.withType(Spotbugs) {
//        reports {
//            xml.enabled = true
//            html.enabled = false // Can only enable either xml OR html
//        }
//    }

  // Those are some dependencies which are needed by all subprojects
  dependencies {
    // compile-time dependency due to the annotation SuppressFBWarnings()
    //implementation "com.google.code.findbugs:findbugs:${fbVersion}"

    implementation "org.slf4j:slf4j-api:$libSlf4jApiVersion"

    // enable logging for test runs
    testImplementation "ch.qos.logback:logback-classic:$libLogbackVersion"

    testImplementation "org.mockito:mockito-core:$libMockitoVersion"
    testImplementation "junit:junit:$libJunitVersion"
    testImplementation "org.hamcrest:hamcrest:$libHamcrestVersion"
  }

}

def parseCheckstyleReport(File reportFile) {
  def errors = 0
  def warnings = 0
  def infos = 0

  if (reportFile.exists()) {
    def xmlFile = (new XmlParser()).parse(reportFile)
    xmlFile.'file'.'error'.each { issue ->
      switch (issue.attribute("severity")) {
        case "error":
          errors++
          break;
        case "warning":
          warnings++
          break;
        default:
          infos++
          break;
      }
    }
  }
  return [errors, warnings, infos]
}

def parseFindbugsReport(File reportFile) {
  def errors = 0
  def warnings = 0
  def infos = 0

  if (reportFile.exists()) {
    def xmlFile = (new XmlParser()).parse(reportFile)
    xmlFile.'FindBugsSummary'.each { issue ->
      def prio1Bugs = issue.attribute("priority_1")
      def prio2Bugs = issue.attribute("priority_2")
      def bugsTotal = issue.attribute("total_bugs")
      def prio1BugsInt = 0
      def prio2BugsInt = 0
      def bugsTotalInt = 0

      if (prio1Bugs != null) {
        prio1BugsInt = Integer.valueOf(prio1Bugs)
      }

      if (prio2Bugs != null) {
        prio2BugsInt = Integer.valueOf(prio2Bugs)
      }

      if (bugsTotal != null) {
        bugsTotalInt = Integer.valueOf(bugsTotal)
      }

      errors += prio1BugsInt
      warnings += prio2BugsInt
      infos += bugsTotalInt - (prio1BugsInt + prio2BugsInt)
    }
  }
  return [errors, warnings, infos]
}

def parsePmdReport(File reportFile) {
  def errors = 0
  def warnings = 0
  def infos = 0

  if (reportFile.exists()) {
    def xmlFile = (new XmlParser()).parse(reportFile)
    xmlFile.'file'.'violation'.each { issue ->

      // https://github.com/jenkinsci/pmd-plugin/blob/master/src/main/java/hudson/plugins/pmd/parser/PmdParser.java#L26-L29
      switch (issue.attribute("priority")) {
        case "1":
        case "2":
          errors++
          break;
        case "3":
        case "4":
          warnings++;
          break;
        case "5":
        default:
          infos++
          break;
      }
    }
  }
  return [errors, warnings, infos]
}

def checkSubprojects = [
  project(':common'),
  project(':monitoring:core'),
  project(':monitoring:aspectj'),
  project(':monitoring:bytebuddy'),
  project(':monitoring:disl'),
  project(':monitoring:javassist'),
  project(':monitoring:spring'),
  project(':model'),
  project(':analysis'),
  project(':tools'),
  project(':tools:restructuring'),
  project(':tools:behavior-analysis'),
  project(':tools:cmi'),
  project(':tools:collector'),
  project(':tools:convert-logging-timestamp'),
  project(':tools:dar'),
  project(':tools:delta'),
  project(':tools:fxca'),
  project(':tools:log-replayer'),
  project(':tools:maa'),
  project(':tools:mktable'),
  project(':tools:mop'),
  project(':tools:mt'),
  project(':tools:mvis'),
  project(':tools:opad'),
  project(':tools:otel-transformer'),
  project(':tools:relabel'),
  project(':tools:resource-monitor'),
  project(':tools:rewrite-log-entries'),
  project(':tools:runtime-analysis'),
  project(':tools:sar'),
  project(':tools:trace-analysis'),
  project(':tools:trace-analysis-gui'),
  project(':extension-kafka'),
  project(':extension-cassandra')
]

checkSubprojects.each { project ->
  configure(project) {

    task checkThresholds(dependsOn: ["build"]) {
      doLast {
        def reportTypes = ['main', 'test']

        // Begin Checkstyle report parsing
        def csErrors = 0
        def csWarnings = 0
        def csInfos = 0

        def p = project

        reportTypes.each { String type ->
          def reportFile = file(p.projectDir.path + '/build/reports/checkstyle/' + type + '.xml')
          def reportResults = parseCheckstyleReport(reportFile)
          csErrors += reportResults[0]
          csWarnings += reportResults[1]
          csInfos += reportResults[2]
        }
        // End Checkstyle report parsing

        // Begin Findbugs report parsing
        def fbErrors = 0
        def fbWarnings = 0
        def fbInfos = 0

        reportTypes.each { String type ->
          def reportFile = file(p.projectDir.path + '/build/reports/findbugs/' + type + '.xml')
          def reportResults = parseFindbugsReport(reportFile)
          fbErrors += reportResults[0]
          fbWarnings += reportResults[1]
          fbInfos += reportResults[2]
        }
        // End Findbugs report parsing

        // Begin PMD report parsing
        def pmdErrors = 0
        def pmdWarnings = 0
        def pmdInfos = 0

        reportTypes.each { String type ->
          def reportFile = file(p.projectDir.path + '/build/reports/pmd/' + type + '.xml')
          def reportResults = parsePmdReport(reportFile)
          pmdErrors += reportResults[0]
          pmdWarnings += reportResults[1]
          pmdInfos += reportResults[2]
        }
        // End PMD report parsing

        // Print results
        println("Static analysis results:")
        println()
        println(" Checkstyle:")
        println("  Errors: " + csErrors + " (Threshold: " + checkstyleErrorThreshold + ")")
        println("  Warnings: " + csWarnings + " (Threshold: " + checkstyleWarningThreshold + ")")
        println("  Info: " + csInfos)
        println()
        println(" Findbugs:")
        println("  Errors: " + fbErrors + " (Threshold: " + findbugsErrorThreshold + ")")
        println("  Warnings: " + fbWarnings + " (Threshold: " + findbugsWarningThreshold + ")")
        println("  Info: " + fbInfos)
        println()
        println(" PMD:")
        println("  Errors: " + pmdErrors + " (Threshold: " + pmdErrorThreshold + ")")
        println("  Warnings: " + pmdWarnings + " (Threshold: " + pmdWarningThreshold + ")")
        println("  Info: " + pmdInfos)
        println()

        def eclipseUserHint = "\nNOTE: If you are using Eclipse, please make sure that you set it up properly as described at: https://github.com/kieker-monitoring/kieker#eclipse-setup-for-contributors"

        // Fail build if Checkstyle thresholds are violated
        if (csWarnings > Integer.valueOf(checkstyleWarningThreshold)) {
          throw new GradleException("There were checkstyle warnings exceeding the warning threshold! Warnings: " + csWarnings + " Threshold: " + checkstyleWarningThreshold + "." + eclipseUserHint)
        }

        if (csErrors > Integer.valueOf(checkstyleErrorThreshold)) {
          throw new GradleException("There were checkstyle errors exceeding the error threshold! Errors: " + csErrors + " Threshold: " + checkstyleErrorThreshold + "." + eclipseUserHint)
        }

        // Fail build if Findbugs thresholds are violated
        if (fbWarnings > Integer.valueOf(findbugsWarningThreshold)) {
          throw new GradleException("There were findbugs warnings exceeding the warning threshold! Warnings: " + fbWarnings + " Threshold: " + findbugsWarningThreshold + ".")
        }

        if (fbErrors > Integer.valueOf(findbugsErrorThreshold)) {
          throw new GradleException("There were findbugs errors exceeding the error threshold! Errors: " + fbErrors + " Threshold: " + findbugsErrorThreshold + ".")
        }

        // Fail build if PMD thresholds are violated
        if (pmdWarnings > Integer.valueOf(pmdWarningThreshold)) {
          throw new GradleException("There were pmd warnings exceeding the warning threshold! Warnings: " + pmdWarnings + " Threshold: " + pmdWarningThreshold + "." + eclipseUserHint)
        }

        if (pmdErrors > Integer.valueOf(pmdErrorThreshold)) {
          throw new GradleException("There were pmd errors exceeding the error threshold! Errors: " + pmdErrors + " Threshold: " + pmdErrorThreshold + "." + eclipseUserHint)
        }
      }
    }

    tasks.check.finalizedBy(checkThresholds)
  }
}

// Execute 'checkThresholds' after all check tasks in the subprojects have been executed
//mainSubprojects.tasks.check*.finalizedBy(checkThresholds)

task checkThresholds(dependsOn: mainSubprojects.tasks["checkThresholds"])


def regexpReplaceInFiles(File file, String searchExp, String replaceExp) {
  //println "Replacing $searchExp by $replaceExp in $file"
  String contents = file.getText('UTF-8')
  contents = contents.replaceAll(searchExp, replaceExp)
  file.write(contents, 'UTF-8')
}

task updateLicenseHeaderYear() {
  doLast {
    FileTree tree = fileTree(dir: '.', include: '**/*.java')
    tree.each { File file ->
      regexpReplaceInFiles(file, 'Copyright 20\\d\\d Kieker Project', 'Copyright 2022 Kieker Project')
    }
    regexpReplaceInFiles(project.file("common/src/kieker/common/util/Version.java"), '20\\d\\d Kieker Project', '2022 Kieker Project')
  }
}

task replaceHardCodedVersionNames() {
  doLast {
    regexpReplaceInFiles(project.file("bin/dev/release-check-short.sh"), "KIEKER_VERSION=\".*?\"", "KIEKER_VERSION=\"${version}\"")
    regexpReplaceInFiles(project.file("monitoring/aspectj/integrationTest-resources/example-projects-aspectj/example-beforeafteroperationevent/gradle.properties"), "kiekerVersion=.*", "kiekerVersion=${version}")
    regexpReplaceInFiles(project.file("monitoring/aspectj/integrationTest-resources/example-projects-aspectj/example-beforeafterconstructorevent/gradle.properties"), "kiekerVersion=.*", "kiekerVersion=${version}")
    regexpReplaceInFiles(project.file("monitoring/aspectj/integrationTest-resources/example-projects-aspectj/example-operationexecutionrecord/gradle.properties"), "kiekerVersion=.*", "kiekerVersion=${version}")

    regexpReplaceInFiles(project.file("documentation/getting-started/AspectJ-Instrumentation-Example.rst"), "kieker-.*-SNAPSHOT-aspectj.jar", "${rootProject.aspectJJar.archiveFileName}")
    regexpReplaceInFiles(project.file("documentation/tutorials/How-to-apply-Kieker-in-Java-EE-Environments.rst"), "kieker-.*-SNAPSHOT-aspectj.jar", "${rootProject.aspectJJar.archiveFileName}")
    regexpReplaceInFiles(project.file("documentation/getting-started/Manual-Monitoring-with-Kieker.rst"), "kieker-.*-SNAPSHOT-emf.jar", "${rootProject.emfJar.archiveFileName}")
    regexpReplaceInFiles(project.file("documentation/getting-started/Download-and-Extract-Tutorial.rst"), "kieker-.*-SNAPSHOT.jar", "${rootProject.mainJar.archiveFileName}")
    regexpReplaceInFiles(project.file("documentation/getting-started/AspectJ-Instrumentation-Example.rst"), "kieker-.*-SNAPSHOT.jar", "${rootProject.mainJar.archiveFileName}")
    regexpReplaceInFiles(project.file("documentation/tutorials/How-to-apply-Kieker-in-Java-EE-Environments.rst"), "kieker-.*-SNAPSHOT.jar", "${rootProject.mainJar.archiveFileName}")
    regexpReplaceInFiles(project.file("documentation/getting-started/Manual-Monitoring-with-Kieker.rst"), "kieker-.*/build/libs/", "kieker-${version}/build/libs/")
    regexpReplaceInFiles(project.file("documentation/getting-started/Download-and-Extract-Tutorial.rst"), "kieker-.*-binaries", "kieker-${version}-binaries")
    regexpReplaceInFiles(project.file("documentation/kieker-tools/Kieker-Tools.rst"), "kieker-.*-binaries", "kieker-${version}-binaries")
    regexpReplaceInFiles(project.file("documentation/conf.py"), "release = '.*'", "release = '${version}'")
  }
}
compileJava.dependsOn replaceHardCodedVersionNames

def resolveRelativeToParent(String directory, String file) {
  return rootProject.file(directory + '/' + file)
}

def today() {
  def date = new Date()
  def formattedDate = date.format('yyyy-MM-dd')
  return formattedDate
}

def year() {
  def date = new Date()
  def formattedDate = date.format('yyyy')
  return formattedDate
}

def monthMMM() {
  def date = new Date()
  def formattedDate = date.format('MMM')
  return formattedDate
}


task apidoc(type: Javadoc) {
  description = 'Generate the Javadoc API documentation for the Kieker Framework'

  source mainSubprojects.collect { project -> project.sourceSets.main.allJava }
  classpath = files(mainSubprojects.collect { project -> project.sourceSets.main.compileClasspath })
  destinationDir = new File(projectDir, 'docs')

  failOnError = false

  title = "Kieker Observability Framework, Vers. $kiekerVersion<br/>API Documentation"
  options.header = "Kieker $kiekerVersion"
  options.footer = "Kieker $kiekerVersion"
  options.bottom = "Copyright " + year() + " $kiekerCopyright, <a href=\"http://monitoring.net\">http://monitoring.net</a>"
  options.author = "true"
  options.version = "false"
  options.use = "true"
  options.tags = ["generated", "ordered", "model"]
  options.encoding = "UTF-8"
  options.charSet = "UTF-8"
  options.docEncoding = "UTF-8"
}

ext.sharedManifest = manifest {
  attributes(
      "Specification-Title": kiekerName,
      "Specification-Version": kiekerVersion,
      "Specification-Vendor": kiekerCopyright,
      "Implementation-Title": kiekerName,
      "Implementation-Version": kiekerVersion + " (" + today() + ")",
      "Implementation-Vendor": kiekerCopyright,
      "kieker" // The section name
  )
}

def allArtifacts = {
  mainSubprojects.each { subproject ->
    from subproject.configurations.archives.allArtifacts.files.collect {
      zipTree(it)
    }
  }
}

def aspectJArtifacts = {
  aspectJSubprojects.each { subproject ->
    from subproject.configurations.archives.allArtifacts.files.collect {
      zipTree(it)
    }
  }
}

def bytebuddyArtifacts = {
  bytebuddySubprojects.each { subproject ->
      from subproject.configurations.archives.allArtifacts.files.collect {
      zipTree(it)
    }
  }
}

def javassistArtifacts = {
  javassistSubprojects.each { subproject ->
      from subproject.configurations.archives.allArtifacts.files.collect {
      zipTree(it)
    }
  }
}

def springArtifacts = {
  springSubprojects.each { subproject ->
    from subproject.configurations.archives.allArtifacts.files.collect {
      zipTree(it)
    }
  }
}

def licence = {
  from file('LICENSE')
}

def aopxml = {
  from(file('examples/aop.example.xml')) {
    into 'META-INF'
  }
}

// Remove the default 'jar' artifact because we have our own artifacts: mainJar, emfJar, aspectJJar
// If you don't do this, we get trouble with the Maven upload task having two Jars (default, mainJar)
// with the same type and classifier.
configurations.archives.artifacts.with { archives ->
  def jarArtifact
  archives.each {
    if (it.file =~ 'jar') {
      jarArtifact = it
    }
  }
  println "JAR to delete: ${jarArtifact}"
  remove(jarArtifact)
}

/**
* Create bundle jars.
*/

task createArtifacts(dependsOn: [ 'mainJar', 'aspectJJar', 'emfJar', 'sourcesJar', 'javadocJar']) {}

/** Kieker jar without aspectj and emf. */
task mainJar(type: Jar, dependsOn: mainSubprojects.tasks["build"], group: "build",
    description: "Assembles a jar archive containing all of Kieker's components, the user guide examples, the documentation etc."
) {
  // default archiveName is [baseName]-[appendix]-[version]-[classifier].[extension]
  configure allArtifacts
  configure licence

  duplicatesStrategy = DuplicatesStrategy.EXCLUDE

  manifest = project.manifest {
    from sharedManifest
  }
}

/** Kieker jar with emf libraries. */
task emfJar(type: Jar, dependsOn: mainSubprojects.tasks["build"], group: "build",
    description: "Assembles a jar archive containing the contents of the mainJar task and additionally the Eclipse Modeling Framework (EMF). The resulting jar can directly be used for analyzing Kieker logs."
) {
  // default archiveFileName is [baseName]-[appendix]-[version]-[classifier].[extension]
  archiveClassifier = 'emf'
  configure allArtifacts
  configure licence

  duplicatesStrategy = DuplicatesStrategy.EXCLUDE

  from configurations.emfJarConfig.asFileTree.files.collect { zipTree(it) }
  from configurations.resultJar.allArtifacts.collect { it.isDirectory() ? it : zipTree(it) }

  from('lib') {
    include "org.eclipse.emf.common_${libEmfVersion}.LICENSE"
    include "org.eclipse.emf.ecore_${libEmfVersion}.LICENSE"
    include "org.eclipse.emf.ecore.xmi_${libEmfVersion}.LICENSE"
  }

  manifest = project.manifest {
    from sharedManifest
  }
}

/** Kieker jar with aspectJ tooling. */
task aspectJJar(type: Jar, dependsOn: aspectJSubprojects.tasks["build"], group: "build",
    description: "Assembles a jar archive containing the contents of the mainJar task and additionally the aspect-oriented framework AspectJ. The resulting jar can directly be used for monitoring and tracing as javaagent."
) {
  // default archiveFileName is [baseName]-[appendix]-[version]-[classifier].[extension]
  archiveClassifier = 'aspectj'
  configure aspectJArtifacts
  configure licence
  configure aopxml

  duplicatesStrategy = DuplicatesStrategy.EXCLUDE

  from file("lib/aspectjweaver-${aspectjVersion}.LICENSE")

  from configurations.resultJar.asFileTree.files.collect { zipTree(it) }
  from configurations.aspectJarConfig.asFileTree.files.collect { zipTree(it) }

  from configurations.resultJar.allArtifacts.collect { it.isDirectory() ? it : zipTree(it) }

  manifest = project.manifest {
    from sharedManifest
    attributes(
        "Can-Redefine-Classes": 'true',
        "Premain-Class": 'kieker.monitoring.probe.aspectj.AspectJLoader'
    )
    attributes(
        "Specification-Title": "AspectJ Weaver Classes",
        "Specification-Version": aspectjVersion,
        "Specification-Vendor": "aspectj.org",
        "Implementation-Title": "org.aspectj.weaver",
        "Implementation-Version": aspectjVersion,
        "Implementation-Vendor": "aspectj.org",
        "Can-Redefine-Classes": "true",
        "Premain-Class": "org.aspectj.weaver.loadtime.Agent",
        "org/aspectj/weaver/" // The section name
    )
  }
}

/** Kieker jar with bytebuddy tooling. */
task bytebuddyJar(type: Jar, dependsOn: bytebuddySubprojects.tasks["build"], group: "build",
    description: "Assembles a jar archive containing the contents of the mainJar task and additionally the a bytebuddy agent. The resulting jar can directly be used for monitoring and tracing as javaagent."
) {
  archiveClassifier = 'bytebuddy'
  configure bytebuddyArtifacts
  configure licence

  duplicatesStrategy = DuplicatesStrategy.EXCLUDE

  from configurations.resultJar.asFileTree.files.collect { zipTree(it) }
  from configurations.resultJar.allArtifacts.collect { it.isDirectory() ? it : zipTree(it) }
  from configurations.bytebuddyJarConfig.asFileTree.files.collect { zipTree(it) }

  manifest = project.manifest {
    from sharedManifest
    attributes(
        "Can-Redefine-Classes": "true",
        "Can-Retransform-Classes": "true",
      "Premain-Class": "kieker.monitoring.probe.bytebuddy.PremainClass"
    )
  }
}

/** Kieker jar with javassist tooling. */
task javassistJar(type: Jar, dependsOn: javassistSubprojects.tasks["build"], group: "build",
    description: "Assembles a jar archive containing the contents of the mainJar task and additionally the a javassist agent. The resulting jar can directly be used for monitoring and tracing as javaagent."
) {
  archiveClassifier = 'javassist'
  configure javassistArtifacts
  configure licence

  duplicatesStrategy = DuplicatesStrategy.EXCLUDE

  from configurations.resultJar.asFileTree.files.collect { zipTree(it) }
  from configurations.resultJar.allArtifacts.collect { it.isDirectory() ? it : zipTree(it) }
  from configurations.javassistJarConfig.asFileTree.files.collect { zipTree(it) }

  manifest = project.manifest {
    from sharedManifest
    attributes(
        "Can-Redefine-Classes": "true",
        "Can-Retransform-Classes": "true",
      "Premain-Class": "kieker.monitoring.probe.javassist.PremainClass"
    )
  }
}

/** Kieker jar with spring tooling. */
task springJar(type: Jar, dependsOn: springSubprojects.tasks["build"], group: "build",
    description: "Assembles a jar archive containing the contents of the mainJar task and additionally the spring framework. The resulting jar can directly be used for monitoring and tracing a spring application."
) {
  archiveClassifier = 'spring'
  configure springArtifacts
  configure licence

  duplicatesStrategy = DuplicatesStrategy.EXCLUDE
}

task sourcesJar(type: Jar, dependsOn: classes) {
  archiveClassifier = 'sources'
  from mainSubprojects.collect { project -> project.sourceSets.main.allJava }
}

task javadocJar(type: Jar, dependsOn: apidoc) {
  archiveClassifier = 'javadoc'
  from apidoc.destinationDir
}

task distribute(group: 'distribution', description: 'Distributes binary and source archives.',
  dependsOn: [':distributeBinaryTar', ':replaceHardCodedVersionNames'])


/**
* Collect binary content.
*/
def binaryContent = project.copySpec {
  from(projectDir) {
    include 'LICENSE'
    include 'HISTORY'

    include 'bin/**'
    include 'lib/**'
    include 'javadoc/**'
    include 'build/libs/*'

    exclude 'bin/**/*.class'
    exclude '**/.gradle/**'
    exclude 'lib/static-analysis/'
    exclude 'bin/dev/release-check*'
    exclude 'caches/**'
  }
  from('documentation') {
    include 'README-bin'
    rename 'README-bin', 'README'
  }
  exclude '**/*.log'
  into kiekerPackagenamebase + "-" + kiekerVersion
}

def tools = [
  'restructuring',
  'behavior-analysis',
  'cmi',
  'collector',
  'convert-logging-timestamp',
  'dar',
  'delta',
  'fxca',
  'log-replayer',
  'maa',
  'mktable',
  'mop',
  'mt',
  'mvis',
  'relabel',
  'resource-monitor',
  'rewrite-log-entries',
  'runtime-analysis',
  'sar',
  'trace-analysis',
  'trace-analysis-gui'
]

/** collect tools for binary distribution. */
def toolsContent = project.copySpec {
  tools.each {
    from("tools/${it}/build/distributions") {
      include "**"
    }
  }
  from("tools") {
    include "README.md"
  }
  into kiekerPackagenamebase + "-" + kiekerVersion + "/tools"
}

/** collect all libraries in tools. */
def libraryContent = project.copySpec {
  from('tools/**/build/libs') {
  include '**jar'
  }
  into kiekerPackagenamebase + "-" + kiekerVersion + "/build/libs"
}

/** collect example content for the binary distribution. */
def exampleContent = project.copySpec {

  from('examples') {
    include '**'

    exclude '**/JavaEEServletContainerExample/build.xml'
    exclude '**/livedemo-source/**'
    exclude '**/.gradle/**'
    exclude '**/build/**'
    exclude '*gradle*'
    exclude '**/*.log'
  }

  from('monitoring/src-resources/META-INF') {
    include 'kieker.monitoring.default.properties'
    rename 'kieker.monitoring.default.properties', 'kieker.monitoring.example.properties'
  }
  into kiekerPackagenamebase + "-" + kiekerVersion + "/examples"

  with {
    from('examples') {
      include '**/build/libs/**'
    }
    includeEmptyDirs = false
  }
}

def exampleJavaEEContent = project.copySpec {
  from('monitoring/src-resources/META-INF') {
    include 'kieker.monitoring.default.properties'
    rename 'kieker.monitoring.default.properties', 'kieker.monitoring.properties'
  }
  into kiekerPackagenamebase + "-" + kiekerVersion + "/examples/JavaEEServletContainerExample/jetty"
}

/** binary distribution in tar.gz format. */
task distributeBinaryTar(type: Tar, group: 'distribution', description: 'Distributes binary archive.', dependsOn: [mainJar, emfJar, aspectJJar, bytebuddyJar, sourcesJar, javadocJar,
  'examples:buildStandaloneExamples',
  ':examples:sourcesJar',
  ':tools:restructuring:distZip',
  ':tools:behavior-analysis:distZip',
  ':tools:cmi:distZip',
  ':tools:collector:distZip',
  ':tools:convert-logging-timestamp:distZip',
  ':tools:dar:distZip',
  ':tools:delta:distZip',
  ':tools:fxca:distZip',
  ':tools:log-replayer:distZip',
  ':tools:maa:distZip',
  ':tools:mktable:distZip',
  ':tools:mop:distZip',
  ':tools:mt:distZip',
  ':tools:mvis:distZip',
  ':tools:relabel:distZip',
  ':tools:resource-monitor:distZip',
  ':tools:rewrite-log-entries:distZip',
  ':tools:runtime-analysis:distZip',
  ':tools:sar:distZip',
  ':tools:trace-analysis:distZip',
  ':tools:trace-analysis-gui:distZip',
  ':examples:jar',
  ':examples:javadocJar',
  ':examples:spotlessMisc' ]) {
  archiveClassifier = 'binaries'
  with binaryContent, toolsContent, libraryContent, exampleContent, exampleJavaEEContent

  compression = Compression.GZIP
  archiveExtension = 'tar.gz'
}

/** collect all sources. */
def sourceContent = project.copySpec {
  from(projectDir) {
    include '**/**' // '*' doesn't seem to include hidden files
    include 'bin/**'
    include 'src/**'
    include 'lib/**'

    exclude 'README'
    exclude 'javadoc/**'
    exclude 'examples/analysis/**/.classpath'
    exclude 'examples/monitoring/**/.classpath'
    exclude 'examples/userguide/**/.classpath'
    exclude 'examples/analysis/**/.settings'
    exclude 'examples/monitoring/**/.settings'
    exclude 'examples/userguide/**/.settings'
    exclude '**/build/**'
    exclude 'build-eclipse/'
    exclude '**/.gradle/**'
    exclude '**/*.log'
    exclude 'caches/**'
    exclude 'docs/**'
  exclude '**/?/**'
    // Exclude all JAR-files in the 'examples' folder except for the opencsv JAR and the JARs in the JavaEEServletContainerExample directory
    exclude {
      jars ->
        jars.file.path.contains('examples') &&
            jars.file.name.endsWith('.jar') &&
            !jars.file.name.startsWith('opencsv-') &&
            !jars.file.path.contains('JavaEEServletContainerExample')
    }
  }
  from('documentation') {
    include 'README-src'
    rename 'README-src', 'README'
  }
  into kiekerPackagenamebase + "-" + kiekerVersion
}

task startRServe() {
  doLast {
    String osName = System.getProperty("os.name").toLowerCase();
    if (osName.contains("windows")) {
      'bin/dev/rserve-control.bat start'.execute()
    } else {
      'bin/dev/rserve-control.sh start'.execute()
    }
  }
}
distribute.mustRunAfter startRServe

task stopRServe(type: Exec) {
  String osName = System.getProperty("os.name").toLowerCase();
  if (osName.contains("windows")) {
    commandLine 'bin/dev/rserve-control.bat', 'stop'
  } else {
    commandLine 'bin/dev/rserve-control.sh', 'stop'
  }
  ignoreExitValue = true
}
startRServe.finalizedBy stopRServe
stopRServe.mustRunAfter distribute

task enableRTests() {
  doLast {
    tasks.withType(Test) {
      systemProperties['TestKiekerRTests'] = 'true'
    }
  }
}
distribute.mustRunAfter enableRTests

// For signing, the following properties (e.g., provided in ~/.gradle/gradle.properties) are needed
//signing.keyId=8E97E26A
//signing.password=XXX
//signing.secretKeyRingFile=/home/USER/.gnupg/secring.gpg
//

ext.isReleaseVersion = !version.endsWith("SNAPSHOT")
signing {
  required { isReleaseVersion && gradle.taskGraph.hasTask("uploadArchives") }
  sign configurations.archives
}

artifacts {
  archives mainJar
  archives emfJar
  archives aspectJJar
  archives bytebuddyJar
  archives javassistJar
  archives sourcesJar
  archives javadocJar
  archives springJar
}

// This is necessary for the RC call, since in the regular non-RC stage, no signatory is configured in Jenkins, but for release-versions, Gradle still requires .asc files
task createDummyAscFiles {
  doLast {
    if (isReleaseVersion) {
      file('build/libs').listFiles().each { file ->
        if (file.name.endsWith('.jar')) {
          new File(file.path + '.asc').text = 'dummy'
        }
      }
      println 'Created build/: ' + new File('build/').mkdir()
      println 'Created build/publications/: ' + new File('build/publications/').mkdir()
      println 'Created build/publications/mavenJava/: ' + new File('build/publications/mavenJava/').mkdir()
      new File('build/publications/mavenJava/pom-default.xml.asc').text = 'dummy'
    }
  }
}

publishToMavenLocal.dependsOn createDummyAscFiles


publishing {
  publications {
    mavenJava(MavenPublication) {
      artifact mainJar
      artifact emfJar
      artifact aspectJJar
      artifact bytebuddyJar
      artifact javassistJar
      artifact sourcesJar
      artifact javadocJar
      artifact springJar

      pom.withXml {
        def dependenciesNode = asNode().appendNode('dependencies')

        configurations.resultJar.allDependencies.each {
          def dependencyNode = dependenciesNode.appendNode('dependency')
          dependencyNode.appendNode('groupId', it.group)
          dependencyNode.appendNode('artifactId', it.name)
          dependencyNode.appendNode('version', it.version)
        }
      }

      pom {
        groupId = 'net.kieker-monitoring'
        artifactId = 'kieker'
        version = version
        name = 'Kieker Observability Framework'
        description = 'Kieker: Application Performance Monitoring and Dynamic Software Analysis'
        url = 'http://kieker-monitoring.net'

        licenses {
          license {
            name = 'The Apache Software License, Version 2.0'
            url = 'http://www.apache.org/licenses/LICENSE-2.0.txt'
          }
        }

        developers {
          developer {
            id = 'thomas.duellmann'
            name = 'Thomas F. Duellmann'
            email = 'duellmann@hitec-hamburg.de'
          }
          developer {
            id = 'andre.van.hoorn'
            name = 'Andre van Hoorn'
            email = 'andre.van.hoorn@uni-hamburg.de'
          }
          developer {
            id = 'reiner.jung'
            name = 'Reiner Jung'
            email = 'reiner.jung@email.uni-kiel.de'
          }
          developer {
            id = 'david.georg.reichelt'
            name = 'David Georg Reichelt'
            email = 'd.g.reichelt@lancaster.ac.uk'
          }
          developer {
            id = 'shinhyung.yang'
            name = 'Shinhyung Yang'
            email = 'shinhyung.yang@email.uni-kiel.de'
          }
        }

        scm {
          connection = 'scm:git:https://github.com/kieker-monitoring/kieker.git'
          developerConnection = 'scm:git:git@github.com:kieker-monitoring/kieker.git'
          url = 'https://github.com/kieker-monitoring/kieker'
        }
      }

    }
  }

  repositories {
    maven {
      def mavenUser = "NoMavenUser"
      if (System.env.kiekerMavenUser != null) {
        mavenUser = System.env.kiekerMavenUser
      }
      def mavenPassword = "NoMavenPassword"
      if (System.env.kiekerMavenPassword != null) {
        mavenPassword = System.env.kiekerMavenPassword
      }
      credentials {
        username = mavenUser
        password = mavenPassword
      }

      // for local tests:
      //def releasesRepoUrl = "/tmp/myRepo/releases"
      //def snapshotsRepoUrl = "/tmp/myRepo/snapshots"
      // Maven central:
      def releasesRepoUrl = 'https://oss.sonatype.org/service/local/staging/deploy/maven2/'
      def snapshotsRepoUrl = 'https://oss.sonatype.org/content/repositories/snapshots/'

      url = version.endsWith('SNAPSHOT') ? snapshotsRepoUrl : releasesRepoUrl
    }
  }
}

tasks.named('jar') {
    enabled = false // Disable the default jar task
}

tasks.named('publishMavenJavaPublicationToMavenLocal') {
    dependsOn mainJar
}


ext.isReleaseVersion = !version.endsWith("SNAPSHOT")
signing {
  println 'Going to sign for releasing: ' + isReleaseVersion
  required { isReleaseVersion }
  sign publishing.publications.mavenJava
}