Merge pull request #1246 from IETS3/feature/package_sbom

Package SBOM in the language library distribution

Author: wsafonov

build.gradle

@@ -2,6 +2,7 @@ import de.itemis.mps.gradle.*
 import de.itemis.mps.gradle.tasks.MpsMigrate
 import de.itemis.mps.gradle.tasks.Remigrate
 import de.itemis.mps.gradle.downloadJBR.DownloadJbrForPlatform
+import groovy.transform.TupleConstructor
 import groovy.xml.XmlSlurper
 import java.time.LocalDate
 import java.time.format.DateTimeFormatter
@@ -20,7 +21,7 @@ plugins {
     id 'de.itemis.mps.gradle.common' version '1.29.+'
     id 'de.itemis.mps.gradle.launcher' version '2.5.2.+'
     id "com.github.breadmoirai.github-release" version "2.4.1"
-    id "org.cyclonedx.bom" version "1.8.2"
+    id "org.cyclonedx.bom" version "2.2.0"
 }
 
 ext.dependencyRepositories = [
@@ -115,13 +116,16 @@ ext.snapshotRepository = 'https://artifacts.itemis.cloud/repository/maven-mps-sn
 ext.publishingRepository = version.toString().endsWith("-SNAPSHOT") ? snapshotRepository : releaseRepository
 
 
+def buildDirPath(pathUnderBuildDir) {
+    project.layout.buildDirectory.dir(pathUnderBuildDir).get().asFile
+}
 
 // 'artifacts' is used in the generated ant scripts as build output directory
-ext.artifactsDir = new File(buildDir, 'artifacts')
-
+ext.artifactsDir = buildDirPath('artifacts')
+ext.reportsDir = buildDirPath('reports')
 
 wrapper {
-    gradleVersion '8.0.2'
+    gradleVersion '8.13'
     distributionType Wrapper.DistributionType.ALL
 }
 
@@ -130,8 +134,6 @@ configurations {
     rerunMigrationsBackend
     languageLibs
     junitAnt
-    pcollections // Synced to org.iets3.core.expr.base.collections.stubs/lib
-    bigMath // Synced to org.iets3.core.expr.math.interpreter/lib
 }
 
 dependencies {
@@ -140,8 +142,62 @@ dependencies {
     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'
+}
+
+@TupleConstructor
+class BundledDep {
+    String name
+    List<String> entries
+    String libSolutionName
+    Closure configClosure = { transitive = false }
+    // in case a legacy dependency has a broken artifact name, e.g. w/o extension
+    String jarNameOverride
+    String getConfigName() {
+        name + '_bundled'
+    }
+    String getResolveTaskName() {
+        'resolve_' + this.configName
+    }
+    BundledDep overrideArtifactName(String artifactName) {
+        this.jarNameOverride = artifactName
+        this
+    }
+}
+
+def bundledDeps = [
+        new BundledDep('pcollections', ['org.pcollections:pcollections:4.0.1'], 'org.iets3.core.expr.base.collections.stubs'),
+        new BundledDep('bigMath', ['ch.obermuhlner:big-math:2.3.2'], 'org.iets3.core.expr.math.interpreter'),
+        new BundledDep('functionalJava', ['org.functionaljava:functionaljava:4.8.1'], 'org.iets3.core.expr.genjava.functionalJava'),
+        new BundledDep('cpsSuite', ['io.takari.junit:takari-cpsuite:1.2.7'], 'org.iets3.opensource.build.gentests.rt').overrideArtifactName('takari-cpsuite.jar')
+]
+
+bundledDeps.each { dep ->
+    configurations {
+        create(dep.configName)
+    }
+    dependencies {
+        dep.entries.each {entry ->
+            add(dep.configName, entry, dep.configClosure)
+        }
+    }
+    tasks.create(dep.resolveTaskName, Sync.class) {
+        from configurations.getByName(dep.configName)
+        into file("code/languages/org.iets3.opensource/solutions/${dep.libSolutionName}/lib")
+
+        // Strip version numbers from file names
+        rename { filename ->
+            def ra = configurations.getByName(dep.configName).resolvedConfiguration.resolvedArtifacts.find { ResolvedArtifact ra -> ra.file.name == filename }
+            String finalName
+            if (dep.jarNameOverride != null) {
+                finalName = dep.jarNameOverride
+            } else if (ra.classifier != null) {
+                finalName = "${ra.name}-${ra.classifier}.${ra.extension}"
+            } else {
+                finalName = "${ra.name}.${ra.extension}"
+            }
+            return finalName
+        }
+    }
 }
 
 
@@ -160,41 +216,8 @@ task resolveLanguageLibs(type: Sync) {
     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])
+task resolveDependencies(dependsOn: ['downloadJbr', resolveMps, resolveLanguageLibs])
+resolveDependencies.dependsOn << bundledDeps.collect {it.resolveTaskName }
 
 ext.mpsHomeDir = resolveMps.destinationDir
 
@@ -344,10 +367,14 @@ checkmodels {
     dependsOn(resolveMps)
 }
 
-task packageLanguages(type: Zip, dependsOn: buildLanguages) {
+task packageLanguages(type: Zip, dependsOn: [buildLanguages, cyclonedxBom]) {
     archiveBaseName = 'org.iets3.opensource'
-    from artifactsDir
-    include 'org.iets3.opensource/**'
+    from(artifactsDir) {
+        include 'org.iets3.opensource/**'
+    }
+    from(reportsDir) {
+        include 'sbom.json'
+    }
 }
 
 task packageTests(type: Zip, dependsOn: buildAndRunTests) {
@@ -565,15 +592,11 @@ tasks.named('githubRelease').configure {
 
 cyclonedxBom {
     // SBOM destination directory
-    destination = file("build/reports")
+    destination = reportsDir
     // 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')
-}

build/scripts/build-allScripts.xml

@@ -283,7 +283,7 @@
       <classpath>
         <fileset file="${artifacts.mps}/lib/mps-references.jar" />
         <pathelement path="${build.tmp}/java/out/org.iets3.opensource.build.gentests.rt" />
-        <fileset file="${iets3.lang.opensource}/solutions/org.iets3.opensource.build.gentests.rt/lib/takari-cpsuite-1.2.7.jar" />
+        <fileset file="${iets3.lang.opensource}/solutions/org.iets3.opensource.build.gentests.rt/lib/takari-cpsuite.jar" />
         <fileset file="${artifacts.com.mbeddr.platform}/com.mbeddr.platform.jar" />
         <fileset file="${artifacts.com.mbeddr.platform}/de.itemis.mps.extensions.build/languages/de.itemis.mps.extensions.build/de.itemis.mps.extensions.build.jar" />
       </classpath>
@@ -440,7 +440,7 @@
       </src>
       <classpath>
         <fileset file="${artifacts.mps}/lib/mps-references.jar" />
-        <fileset file="${iets3.lang.opensource}/solutions/org.iets3.opensource.build.gentests.rt/lib/takari-cpsuite-1.2.7.jar" />
+        <fileset file="${iets3.lang.opensource}/solutions/org.iets3.opensource.build.gentests.rt/lib/takari-cpsuite.jar" />
         <fileset file="${artifacts.mps}/lib/junit4.jar" />
       </classpath>
     </javac>

code/languages/org.iets3.opensource/solutions/org.iets3.core.expr.genjava.functionalJava/lib/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore

code/languages/org.iets3.opensource/solutions/org.iets3.core.expr.genjava.functionalJava/lib/functionaljava_1.8-4.8-SNAPSHOT.jar

@@ -1,14 +1,14 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <solution name="org.iets3.core.expr.genjava.functionalJava" uuid="708a03ad-8699-43c9-821a-6cd00b68e9f8" moduleVersion="0">
   <models>
-    <modelRoot contentPath="${module}" type="java_classes">
-      <sourceRoot location="lib/functionaljava_1.8-4.8-SNAPSHOT.jar" />
+    <modelRoot type="java_classes" contentPath="${module}/lib">
+      <sourceRoot location="functionaljava.jar" />
     </modelRoot>
   </models>
   <facets>
-    <facet type="java" compile="mps" classes="mps" ext="no">
+    <facet type="java" compile="ext" classes="mps" ext="no">
       <classes generated="true" path="${module}/classes_gen" />
-      <library location="${module}/lib/functionaljava_1.8-4.8-SNAPSHOT.jar" />
+      <library location="${module}/lib/functionaljava.jar" />
     </facet>
   </facets>
   <dependencies>

code/languages/org.iets3.opensource/solutions/org.iets3.core.expr.genjava.functionalJava/org.iets3.core.expr.genjava.functionalJava.msd

@@ -1,2 +1,2 @@
- *
+*
 !.gitignore

code/languages/org.iets3.opensource/solutions/org.iets3.core.expr.math.interpreter/lib/.gitignore

@@ -89,6 +89,7 @@
       </concept>
       <concept id="868032131020265945" name="jetbrains.mps.build.mps.structure.BuildMPSPlugin" flags="ng" index="3b7kt6" />
       <concept id="5253498789149381388" name="jetbrains.mps.build.mps.structure.BuildMps_Module" flags="ng" index="3bQrTs">
+        <property id="1500819558096356884" name="doNotCompile" index="2GAjPV" />
         <child id="5253498789149547825" name="sources" index="3bR31x" />
         <child id="5253498789149547704" name="dependencies" index="3bR37C" />
       </concept>
@@ -403,6 +404,7 @@
         <property role="BnDLt" value="true" />
         <property role="TrG5h" value="org.iets3.opensource.build.gentests.rt" />
         <property role="3LESm3" value="e70ad515-8ff0-4a50-8cb4-41406f14e348" />
+        <property role="2GAjPV" value="true" />
         <node concept="398BVA" id="3ZBI8Awh4x5" role="3LF7KH">
           <ref role="398BVh" node="5wLtKNeTaqD" resolve="iets3.lang.opensource" />
           <node concept="2Ry0Ak" id="3ZBI8Awh4x6" role="iGT6I">
@@ -463,18 +465,18 @@
             </node>
           </node>
         </node>
-        <node concept="1SiIV0" id="67tIbohRuGz" role="3bR37C">
-          <node concept="1BurEX" id="67tIbohRuG$" role="1SiIV1">
-            <node concept="398BVA" id="67tIbohRuGm" role="1BurEY">
+        <node concept="1SiIV0" id="5C16jUTWDYH" role="3bR37C">
+          <node concept="1BurEX" id="5C16jUTWDYI" role="1SiIV1">
+            <node concept="398BVA" id="5C16jUTWDYw" role="1BurEY">
               <ref role="398BVh" node="5wLtKNeTaqD" resolve="iets3.lang.opensource" />
-              <node concept="2Ry0Ak" id="67tIbohRuGn" role="iGT6I">
+              <node concept="2Ry0Ak" id="5C16jUTWDYx" role="iGT6I">
                 <property role="2Ry0Am" value="solutions" />
-                <node concept="2Ry0Ak" id="67tIbohRuGo" role="2Ry0An">
+                <node concept="2Ry0Ak" id="5C16jUTWDYy" role="2Ry0An">
                   <property role="2Ry0Am" value="org.iets3.opensource.build.gentests.rt" />
-                  <node concept="2Ry0Ak" id="67tIbohRuGp" role="2Ry0An">
+                  <node concept="2Ry0Ak" id="5C16jUTWDYz" role="2Ry0An">
                     <property role="2Ry0Am" value="lib" />
-                    <node concept="2Ry0Ak" id="67tIbohRuGq" role="2Ry0An">
-                      <property role="2Ry0Am" value="takari-cpsuite-1.2.7.jar" />
+                    <node concept="2Ry0Ak" id="5C16jUTWDY$" role="2Ry0An">
+                      <property role="2Ry0Am" value="takari-cpsuite.jar" />
                     </node>
                   </node>
                 </node>

code/languages/org.iets3.opensource/solutions/org.iets3.core.expr.math.interpreter/lib/big-math.jar

@@ -0,0 +1,2 @@
+*
+!.gitignore