build.gradle

import de.itemis.mps.gradle.*
import groovy.xml.XmlSlurper
import java.time.LocalDate
import java.time.format.DateTimeFormatter
import java.time.format.FormatStyle

//will pull the groovy classes/types from nexus to the classpath
buildscript {
    repositories {
        maven { url 'https://artifacts.itemis.cloud/repository/maven-mps/' }
    }
    dependencies {
        classpath 'de.itemis.mps:mps-gradle-plugin:1.23.1.412.a54f29f'
    }
}

plugins {
    id 'base'
    id 'maven-publish'
    id "com.github.breadmoirai.github-release" version "2.4.1"
    id "org.cyclonedx.bom" version "1.8.2"
}

ext.dependencyRepositories = [
    'https://artifacts.itemis.cloud/repository/maven-mps/'
]

repositories {
    // we don't use mavenLocal() repo, since it can cause various issues with resolving dependencies,
    // see https://docs.gradle.org/current/userguide/declaring_repositories.html#sec:case-for-maven-local
    for (repoUrl in project.dependencyRepositories) {
        maven {
            url repoUrl
        }
    }
    mavenCentral()
}

apply plugin: 'download-jbr'

// configure jbr download
downloadJbr {
    jbrVersion = '17.0.8.1-b1000.32'
}

// detect if we are in a CI build
if (project.hasProperty("forceCI")) {
    ext.ciBuild = true
} else {
    //on teamcity we are in a CI build
    ext.ciBuild = project.hasProperty("teamcity")
}

def forceLocal = project.hasProperty("forceLocalDependencies")

def major = "2023"
def minor = "2"

// Dependency versions
ext.mpsVersion = '2023.2.1'

def mbeddrVersion = "2023.2+"
def mpsQAVersion = "$major.$minor+"

// if building a against a special branch from mbeddr is required add the name here
// the name is enough no trailing "." is required, also the plain name from git can
// be used here. No need to convert "/" the script will take care of that.
def mbeddrBranch = ""
def currentBranch = ""


if (mbeddrBranch != null && !mbeddrBranch.trim().isEmpty()) {
    ext.mbeddrVersionSelector = "${mbeddrBranch.replace("/", "-")}.${mbeddrVersion}"
} else {
    ext.mbeddrVersionSelector = mbeddrVersion
}

// Project group
group = 'org.iets3'

// Project name cannot be defined here, see settings.gradle#rootProject.name instead
// name = 'opensource'

// Project version
if (project.hasProperty('iets3OpenSourceVersion')) {
    version = project.iets3OpenSourceVersion
} else {
    if (ciBuild) {
        currentBranch = GitBasedVersioning.gitBranch

        def buildNumber = System.env.BUILD_COUNTER.toInteger()
        if (currentBranch.startsWith("maintenance-")) {
            version = "$major.$minor.$buildNumber.${GitBasedVersioning.gitShortCommitHash}"
        } else {
            def isSnapshot = !(currentBranch.equals("master") || currentBranch.startsWith("datev-loon-staging-") || currentBranch.startsWith("datev-steuer-staging-"))
            version = GitBasedVersioning.getVersionWithCount(major, minor, buildNumber) + (isSnapshot ? "-SNAPSHOT" : "")
        } 
        println "##teamcity[buildNumber '${version}']"
    } else {
        version = "$major.$minor-SNAPSHOT"
        println "Local build detected, version will be $version"
    }
}

if (project.hasProperty("mbeddrVersion")) {
    logger.log(LogLevel.WARN, "mbeddr version externally overwritten to $ext.mbeddrVersion")
    ext.mbeddrVersionSelector = ext.mbeddrVersion
}

ext.releaseRepository = 'https://artifacts.itemis.cloud/repository/maven-mps-releases/'
ext.snapshotRepository = 'https://artifacts.itemis.cloud/repository/maven-mps-snapshots'
ext.publishingRepository = version.toString().endsWith("-SNAPSHOT") ? snapshotRepository : releaseRepository



// 'artifacts' is used in the generated ant scripts as build output directory
ext.artifactsDir = new File(buildDir, 'artifacts')
ext.incrementalBuild = !project.hasProperty("disableIncrementalBuild")


wrapper {
    gradleVersion '8.0.2'
    distributionType Wrapper.DistributionType.ALL
}

configurations {
    mps
    languageLibs
    junitAnt
    pcollections // Synced to org.iets3.core.expr.base.collections.stubs/lib
    bigMath // Synced to org.iets3.core.expr.math.interpreter/lib
}

dependencies {
    mps "com.jetbrains:mps:$mpsVersion"
    languageLibs "org.mpsqa:all-in-one:$mpsQAVersion"
    languageLibs "com.mbeddr:platform:$mbeddrVersionSelector"
    junitAnt 'org.apache.ant:ant-junit:1.10.6'
    pcollections 'org.pcollections:pcollections:4.0.1'
    bigMath 'ch.obermuhlner:big-math:2.3.2'
}


task resolveMps(type: Sync) {
    dependsOn configurations.mps
    from {
        configurations.mps.resolve().collect { zipTree(it) }
    }
    into "$buildDir/mps"
}

task resolveLanguageLibs(type: Sync) {
    from {
        configurations.languageLibs.resolve().collect { zipTree(it) }
    }
    into "$buildDir/dependencies"
}

task resolvePcollections(type: Sync) {
    from configurations.pcollections
    into file('code/languages/org.iets3.opensource/solutions/org.iets3.core.expr.base.collections.stubs/lib')

    // Strip version numbers from file names
    rename { filename ->
        def ra = configurations.pcollections.resolvedConfiguration.resolvedArtifacts.find { ResolvedArtifact ra -> ra.file.name == filename }
        String finalName
        if (ra.classifier != null) {
            finalName = "${ra.name}-${ra.classifier}.${ra.extension}"
        } else {
            finalName = "${ra.name}.${ra.extension}"
        }
        return finalName
    }
}

task resolveBigMath(type: Sync) {
    from configurations.bigMath
    into file('code/languages/org.iets3.opensource/solutions/org.iets3.core.expr.math.interpreter/lib')

    // Strip version numbers from file names
    rename { filename ->
        def ra = configurations.bigMath.resolvedConfiguration.resolvedArtifacts.find { ResolvedArtifact ra -> ra.file.name == filename }
        String finalName
        if (ra.classifier != null) {
            finalName = "${ra.name}-${ra.classifier}.${ra.extension}"
        } else {
            finalName = "${ra.name}.${ra.extension}"
        }
        return finalName
    }
}

task resolveDependencies(dependsOn: ['downloadJbr', resolveMps, resolveLanguageLibs, resolvePcollections, resolveBigMath])

// Default arguments for ant scripts
def defaultScriptArgs = [
        'mps.home'                          : resolveMps.destinationDir,
        'iets3.github.opensource.home'      : rootDir,
        'build.dir'                         : buildDir,
        'mps.generator.skipUnmodifiedModels': incrementalBuild,
        'version'                           : version
]
if (gradle.startParameter.logLevel.toString() != "LIFECYCLE") {
    defaultScriptArgs.put('mps.ant.log', gradle.startParameter.logLevel.toString().toLowerCase())
}

// enables https://github.com/mbeddr/mps-gradle-plugin#providing-global-defaults
ext["itemis.mps.gradle.ant.defaultScriptArgs"] = defaultScriptArgs.collect { "-D$it.key=$it.value".toString() }
ext["itemis.mps.gradle.ant.defaultScriptClasspath"] = project.configurations.junitAnt.fileCollection { true }
afterEvaluate {
    project.ext["itemis.mps.gradle.ant.defaultJavaExecutable"] = tasks.getByName('downloadJbr').javaExecutable
}

task buildAllScripts(type: BuildLanguages, dependsOn: resolveDependencies) {
    script "$buildDir/scripts/build-allScripts.xml"
}

task prebuild(type: BuildLanguages, dependsOn: buildAllScripts) {
    script "$buildDir/scripts/prebuild.xml"
    targets "clean", "generate"
}

task buildLanguages(type: BuildLanguages, dependsOn: prebuild) {
    script "$buildDir/scripts/build-languages.xml"
}

task buildAndRunTests(type: TestLanguages, dependsOn: buildLanguages) {
    script "$buildDir/scripts/build-tests.xml"
    doLast {
        ant.taskdef(name: 'junitreport',
                classname: 'org.apache.tools.ant.taskdefs.optional.junit.XMLResultAggregator',
                classpath: configurations.junitAnt.asPath)
        ant.junitreport {
            fileset(dir: "$buildDir", includes: '**/TEST*.xml')
            report(format: 'frames', todir: "$buildDir/junitreport")
        }
        ant.echo("JUnit report placed into $buildDir/junitreport/index.html")
    }
}

task failOnTestError() {
    description 'evaluate junit result and fail on error'
    doLast {
        
        def juniXml = file('TESTS-TestSuites.xml')
        if(juniXml.exists()){
            def junitResult = new XmlSlurper().parse(juniXml)
            def failures = junitResult.'**'.findAll { it.name() == 'failure' }
            def errors = junitResult.'**'.findAll { it.name() == 'error' }

            if (failures || errors) {
                def amount = failures.size() + errors.size()
                throw new GradleException(amount + " JUnit tests failed. Check the test report for details.")
            }
        }
    }
}
buildAndRunTests.configure { finalizedBy failOnTestError }
check.dependsOn buildAndRunTests

apply plugin: 'modelcheck'

File modelcheckresult = new File("$buildDir/TEST-checkProject.xml")

def pluginsList = []

modelcheck {
    projectLocation =  new File("$projectDir/code")
    mpsLocation = new File("$buildDir/mps")
    plugins = pluginsList
    mpsConfig = configurations.mps
    macros = [new Macro("iets3.github.opensource.home", "$projectDir")]
    junitFile = modelcheckresult
    junitFormat = "message"
    errorNoFail = true
    debug = false
    maxHeap = "4G"
}


afterEvaluate {  project ->
    check.configure {
        dependsOn tasks.named('checkmodels')
    }
}

checkmodels {
    dependsOn(resolveMps)
}

task packageLanguages(type: Zip, dependsOn: buildLanguages) {
    archiveBaseName = 'org.iets3.opensource'
    from artifactsDir
    include 'org.iets3.opensource/**'
}

task packageTests(type: Zip, dependsOn: buildAndRunTests) {
    archiveBaseName = 'org.iets3.opensource.tests'
    from artifactsDir
    include 'org.iets3.opensource.tests/**'
}

task buildDistroWithDependencies(type: RunAntScript, dependsOn: buildLanguages) {
    script "$buildDir/scripts/build-distro.xml"
    targets 'clean', 'assemble'
}

task packageDistroWithDependencies(type: Zip, dependsOn: buildDistroWithDependencies) {
    archiveBaseName = 'org.iets3.opensource-with-dependencies'
    from artifactsDir
    include 'org.iets3.opensource.distro/**'
}

assemble.dependsOn packageLanguages, packageTests

static def addDependency(Object pom, Object groupId, Object artifactId, Object version, Object type = null) {
    pom.withXml { XmlProvider prov ->
        Node root = prov.asNode()
        Node deps = root.dependencies[0] ?: root.appendNode("dependencies")
        def dep = deps.appendNode("dependency")
        dep.appendNode("groupId", groupId)
        dep.appendNode("artifactId", artifactId)
        dep.appendNode("version", version)
        if (type != null) {
            dep.appendNode("type", type)
        }
    }
}

static def addDependency(Object pom, Configuration config) {
    config.resolvedConfiguration.firstLevelModuleDependencies.each {
        addDependency(pom, it.moduleGroup, it.moduleName, it.moduleVersion, it.moduleArtifacts[0].type)
    }

}

ext.additionalPomInfo = {
    licenses {
        // official SPDX identifier
        // see https://spdx.org/licenses/ for list
        license {
            name = "Apache-2.0"
            url = "https://www.apache.org/licenses/LICENSE-2.0"
            comments = "Apache License Version 2.0"
            distribution = "repo"
        }
    }
    organization {
        name = "itemis AG"
        url = "https://www.itemis.com"
    }
    scm {
        tag = GitBasedVersioning.getGitCommitHash()
        url = "https://github.com/IETS3/iets3.opensource"
    }
}

publishing {
    repositories {
        maven {
            url = project.publishingRepository
            if (project.hasProperty("artifacts.itemis.cloud.user") && project.hasProperty("artifacts.itemis.cloud.pw")) {
                credentials {
                    username = project.findProperty("artifacts.itemis.cloud.user")
                    password = project.findProperty("artifacts.itemis.cloud.pw")
                }
            }
        }
        if (currentBranch == "master" || currentBranch.startsWith("maintenance") ) {
            maven {
                name = "GitHubPackages"
                url = uri("https://maven.pkg.github.com/IETS3/iets3.opensource")
                if (project.hasProperty("gpr.token")) {
                    credentials {
                        username = project.findProperty("gpr.user")
                        password = project.findProperty("gpr.token")
                    }
                }
            }
        }
    }

    publications {
        opensource(MavenPublication) {
            groupId group
            artifactId name
            artifact packageLanguages

            addDependency(pom, configurations.languageLibs)

            pom additionalPomInfo
        }

        tests(MavenPublication) {
            groupId 'org.iets3.opensource'
            artifactId 'tests'
            artifact packageTests
            addDependency(pom, 'org.iets3', 'opensource', project.version, 'zip')

            pom additionalPomInfo
        }

        def runtimesDir = new File(artifactsDir, 'org.iets3.opensource/org.iets3.core.os/languages/iets3.core.os')

        'org.iets3.core.expr.base.shared.runtime'(MavenPublication) {
            groupId 'org.iets3.core.expr.base.shared'
            artifactId 'shared-runtime'
            artifact(new File(runtimesDir, 'org.iets3.core.expr.base.shared.runtime.jar')) {
                builtBy buildLanguages
            }
            artifact(new File(runtimesDir, 'org.iets3.core.expr.base.shared.runtime-src.jar')) {
                builtBy buildLanguages
                classifier 'sources'
            }

            pom additionalPomInfo
        }

        'org.iets3.core.expr.simpleTypes.runtime'(MavenPublication) {
            // GitHub Packages refuse uppercase artifactId (not sure about groupId) so use lower case here
            groupId 'org.iets3.core.expr.simpletypes'
            artifactId 'simpletypes-runtime'
            artifact(new File(runtimesDir, 'org.iets3.core.expr.simpleTypes.runtime.jar')) {
                builtBy buildLanguages
            }
            artifact(new File(runtimesDir, 'org.iets3.core.expr.simpleTypes.runtime-src.jar')) {
                builtBy buildLanguages
                classifier 'sources'
            }

            addDependency(pom, 'org.iets3.core.expr.base.shared', 'shared-runtime', project.version)

            pom additionalPomInfo
        }

        'org.iets3.core.expr.datetime.runtime'(MavenPublication) {
            groupId 'org.iets3.core.expr.datetime'
            artifactId 'datetime-runtime'
            artifact(new File(runtimesDir, 'org.iets3.core.expr.datetime.runtime.jar')) {
                builtBy buildLanguages
            }
            artifact(new File(runtimesDir, 'org.iets3.core.expr.datetime.runtime-src.jar')) {
                builtBy buildLanguages
                classifier 'sources'
            }

            addDependency(pom, 'org.iets3.core.expr.base.shared', 'shared-runtime', project.version)

            pom additionalPomInfo
        }

        'org.iets3.core.expr.temporal.runtime'(MavenPublication) {
            groupId 'org.iets3.core.expr.temporal'
            artifactId 'temporal-runtime'
            artifact(new File(runtimesDir, 'org.iets3.core.expr.temporal.runtime.jar')) {
                builtBy buildLanguages
            }
            artifact(new File(runtimesDir, 'org.iets3.core.expr.temporal.runtime-src.jar')) {
                builtBy buildLanguages
                classifier 'sources'
            }

            addDependency(pom, 'org.iets3.core.expr.datetime', 'datetime-runtime', project.version)

            pom additionalPomInfo
        }
    }
}

defaultTasks 'buildLanguages'

def listMergedPRs = {
    def stdout = new ByteArrayOutputStream()
    exec {
        commandLine 'sh', './listMergedPRs.sh'
        standardOutput = stdout
    }
    stdout.toString()
}

def currentDate = LocalDate.now().format(DateTimeFormatter.ofLocalizedDate(FormatStyle.FULL))
def prCommitsList = "${-> listMergedPRs().readLines().collect { line -> "- $line"}.join("\n")}"
def langLibDeps = project.configurations.languageLibs.resolvedConfiguration.lenientConfiguration.allModuleDependencies
def depsList = langLibDeps.collect {"- `${it.moduleGroup}:${it.moduleName}` : `${it.moduleVersion}`"}.join("\n")
def releaseNotes = """Automated Nighly build from ${currentDate}.

Included pull requests since last Nightly build:
${prCommitsList}

Includes dependencies:
${depsList}
"""

githubRelease {
    owner = 'IETS3'
    repo = 'iets3.opensource'
    token = rootProject.findProperty('github.token') ?: 'empty'
    tagName = 'nightly-' + version
    targetCommitish = GitBasedVersioning.getGitCommitHash()
    body = releaseNotes
    prerelease = true
    releaseAssets = packageDistroWithDependencies.outputs.files.collect {it.path}
    dryRun = false
}

tasks.named('githubRelease').configure {
  dependsOn packageDistroWithDependencies
}

cyclonedxBom {
    // SBOM destination directory
    destination = file("build/reports")
    // The file name for the generated SBOMs (before the file format suffix)
    outputName = "sbom"
    // The file format generated, can be xml, json or all for generating both
    outputFormat = "json"
    // Don't include license texts in generated SBOMs
    includeLicenseText = false
}

assemble {
    dependsOn('cyclonedxBom')
}