build: stop using local Eclipse as a part of dependency

This change makes it possible to build Eclipse plugins without local Eclipse IDE. It is also possible to use metadata of artifacts (pom.xml) to maintain license, vulnerability, and version of dependencies. close #1868
spotbugs · Jan 15, 2022 · 4c89533 · 4c89533
1 parent 2b7b633
commit 4c89533
Show file tree

Hide file tree

Showing 10 changed files with 120 additions and 108 deletions.
diff --git a/.github/dependabot.yml b/.github/dependabot.yml
@@ -4,3 +4,7 @@ updates:
     directory: "/"
     schedule:
       interval: "daily"
+  - package-ecosystem: "gradle"
+    directory: "/buildSrc"
+    schedule:
+      interval: "daily"
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -18,6 +18,7 @@ jobs:
           java-version: '17'
           distribution: temurin
           cache: gradle
+      - uses: gradle/wrapper-validation-action@v1
       - name: Download Eclipse
         run: |
           wget -nv 'https://www.eclipse.org/downloads/download.php?file=/eclipse/downloads/drops4/R-4.6.3-201703010400/eclipse-SDK-4.6.3-linux-gtk-x86_64.tar.gz&r=1' -O eclipse-SDK-4.6.3-linux-gtk-x86_64.tar.gz
@@ -31,7 +32,7 @@ jobs:
           if [ "$GPG_SECRET_PASSPHRASE" != "" ]; then
             gpg --quiet --batch --yes --decrypt --passphrase="$GPG_SECRET_PASSPHRASE" --output spotbugs.jks .github/workflows/spotbugs.jks.gpg;
           fi
-          ./gradlew spotlessCheck build smoketest ${SONAR_LOGIN:+sonarqube} --no-daemon -Dsonar.login=$SONAR_LOGIN
+          ./gradlew spotlessCheck build smoketest ${SONAR_LOGIN:+sonarqube} --no-daemon -Dsonar.login=$SONAR_LOGIN --scan
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
           GPG_SECRET_PASSPHRASE: ${{ secrets.GPG_SECRET_PASSPHRASE }}

diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -17,6 +17,7 @@ jobs:
           java-version: '17'
           distribution: temurin
           cache: gradle
+      - uses: gradle/wrapper-validation-action@v1
       - name: Download Eclipse
         run: |
           wget 'https://www.eclipse.org/downloads/download.php?file=/eclipse/downloads/drops4/R-4.6.3-201703010400/eclipse-SDK-4.6.3-linux-gtk-x86_64.tar.gz&r=1' -O eclipse-SDK-4.6.3-linux-gtk-x86_64.tar.gz

diff --git a/buildSrc/build.gradle.kts b/buildSrc/build.gradle.kts
@@ -0,0 +1,10 @@
+plugins {
+    `kotlin-dsl`
+}
+
+repositories {
+    gradlePluginPortal()
+}
+dependencies {
+    implementation("com.diffplug.gradle:goomph:3.34.1")
+}
diff --git a/buildSrc/src/main/kotlin/eclipse-convention.gradle.kts b/buildSrc/src/main/kotlin/eclipse-convention.gradle.kts
@@ -0,0 +1,46 @@
+plugins {
+  id ("com.diffplug.eclipse.mavencentral")
+}
+
+val pdeTool by configurations.creating {
+  setTransitive(false)
+}
+
+eclipseMavenCentral {
+  release("4.6.3") {
+    compileOnly("org.eclipse.ant.core")
+    compileOnly("org.eclipse.core.resources")
+    compileOnly("org.eclipse.core.runtime")
+    compileOnly("org.eclipse.jdt.core")
+    compileOnly("org.eclipse.jdt.ui")
+    compileOnly("org.eclipse.jface")
+    compileOnly("org.eclipse.pde")
+    compileOnly("org.eclipse.ui.workbench")
+    testImplementation("org.eclipse.core.runtime")
+
+    dep("pdeTool", "org.eclipse.pde.build")
+
+    // TODO these packages are not listed in the manifest
+    compileOnly("org.eclipse.pde.ui")
+    compileOnly("org.eclipse.swt")
+
+    // necessary to build with the org.eclipse.swt module
+    useNativesForRunningPlatform()
+
+    constrainTransitivesToThisRelease()
+  }
+}
+
+/**
+ * Unzip "org.eclipse.pde.build" package into the outputDir.
+ */
+val unzipPdeTool = tasks.register<Copy>("unzipPdeTool") {
+  from(zipTree(pdeTool.singleFile))
+  into("$buildDir/pdeTool")
+}
+
+dependencies {
+  compileOnly(files("$buildDir/pdeTool/pdebuild.jar"){
+    builtBy(unzipPdeTool)
+  })
+}
diff --git a/eclipsePlugin-junit/build.gradle b/eclipsePlugin-junit/build.gradle
@@ -1,33 +1,14 @@
+plugins {
+  id "eclipse-convention"
+}
+
 apply from: "$rootDir/gradle/checkstyle.gradle"
 apply from: "$rootDir/gradle/jacoco.gradle"
 
-def localProps = new Properties()
-localProps.load(new FileInputStream("$rootDir/eclipsePlugin/local.properties"))
-
-def eclipseRootDir = file(localProps.getProperty('eclipseRoot.dir'))
-// Eclipse 4.5+ uses a different directory layout under macOS. Try to detect this first.
-def eclipseExecutable = new File(eclipseRootDir, "Contents/MacOS/eclipse")
-def eclipsePluginsDir = new File(eclipseRootDir, "Contents/Eclipse/plugins")
-if (!eclipseExecutable.exists()) {
-  // Fall back to non-macOS directory layout.
-  eclipsePluginsDir = new File(eclipseRootDir, "plugins")
-}
-
 dependencies {
   implementation project(':eclipsePlugin')
   testImplementation 'junit:junit:4.13.2'
   testImplementation 'org.mockito:mockito-core:4.2.0'
-
-  // List below includes all Eclipse SDK plugins except few causing troubles.
-  // TODO: it should include what is required in the MANIFEST.MF, and nothing else
-  testImplementation fileTree(dir:eclipsePluginsDir, include:'**/*.jar',
-          exclude:[
-                  '**/datanucleus-enhancer*.jar',
-                  'edu.umd.cs.findbugs.**/*.jar',
-                  'org.mockito*.jar',
-                  'com.github.spotbugs.**/*.jar',
-                  '**/*source_*.jar'
-          ])
 }
 
 tasks.named('jacocoTestReport', JacocoReport).configure {

diff --git a/eclipsePlugin-test/build.gradle b/eclipsePlugin-test/build.gradle
@@ -1,16 +1,7 @@
-apply from: "$rootDir/gradle/checkstyle.gradle"
-
-def localProps = new Properties()
-localProps.load(new FileInputStream("$rootDir/eclipsePlugin/local.properties"))
-
-def eclipseRootDir = file(localProps.getProperty('eclipseRoot.dir'))
-// Eclipse 4.5+ uses a different directory layout under macOS. Try to detect this first.
-def eclipseExecutable = new File(eclipseRootDir, "Contents/MacOS/eclipse")
-def eclipsePluginsDir = new File(eclipseRootDir, "Contents/Eclipse/plugins")
-if (!eclipseExecutable.exists()) {
-  // Fall back to non-macOS directory layout.
-  eclipsePluginsDir = new File(eclipseRootDir, "plugins")
+plugins {
+  id "eclipse-convention"
 }
+apply from: "$rootDir/gradle/checkstyle.gradle"
 
 sourceSets {
   main {
@@ -29,16 +20,6 @@ dependencies {
   implementation(project(':eclipsePlugin')) {
     transitive = true
   }
-  // List below includes all Eclipse SDK plugins except few causing troubles.
-  // TODO: it should include what is required in the MANIFEST.MF, and nothing else
-  compileOnly fileTree(dir:eclipsePluginsDir, include:'**/*.jar',
-          exclude:[
-                  '**/datanucleus-enhancer*.jar',
-                  'edu.umd.cs.findbugs.**/*.jar',
-                  'org.mockito*.jar',
-                  'com.github.spotbugs.**/*.jar',
-                  '**/*source_*.jar'
-          ])
 
   implementation project(':test-harness')
   implementation 'org.hamcrest:hamcrest-all:1.3'

diff --git a/eclipsePlugin/build.gradle b/eclipsePlugin/build.gradle
@@ -4,6 +4,7 @@ import static groovy.io.FileType.FILES
 // apply from: "$rootDir/gradle/maven.gradle"
 plugins {
   id 'org.ajoberstar.grgit' version '4.1.1'
+  id "eclipse-convention"
 }
 
 def readLastCommitHash() {
@@ -41,33 +42,27 @@ sourceSets {
   }
 }
 
-def eclipsePluginId = 'com.github.spotbugs.plugin.eclipse'
-
-def localProps = new Properties()
-localProps.load(new FileInputStream("$projectDir/local.properties"))
+def findEclipseExecutable() {
+  if (!file("$projectDir/local.properties").exists()) {
+    return null
+  }
 
-def eclipseRootDir = file(localProps.getProperty('eclipseRoot.dir'))
-// Eclipse 4.5+ uses a different directory layout under macOS. Try to detect this first.
-def eclipseExecutable = new File(eclipseRootDir, "Contents/MacOS/eclipse")
-def eclipsePluginsDir = new File(eclipseRootDir, "Contents/Eclipse/plugins")
-if (!eclipseExecutable.exists()) {
-   // Fall back to non-macOS directory layout.
-   eclipseExecutable = new File(eclipseRootDir, "eclipse")
-   eclipsePluginsDir = new File(eclipseRootDir, "plugins")
+  def localProps = new Properties()
+  localProps.load(new FileInputStream("$projectDir/local.properties"))
+  def eclipseRootDir = file(localProps.getProperty('eclipseRoot.dir'))
+  // Eclipse 4.5+ uses a different directory layout under macOS. Try to detect this first.
+  def eclipseExecutable = new File(eclipseRootDir, "Contents/MacOS/eclipse")
+  if (!eclipseExecutable.exists()) {
+    // Fall back to non-macOS directory layout.
+    eclipseExecutable = new File(eclipseRootDir, "eclipse")
+  }
+  return eclipseExecutable
 }
 
-dependencies {
-  // List below includes all Eclipse SDK plugins except few causing troubles.
-  // TODO: it should include what is required in the MANIFEST.MF, and nothing else
-  compileOnly fileTree(dir:eclipsePluginsDir, include:'**/*.jar',
-    exclude:[
-        '**/datanucleus-enhancer*.jar',
-        'edu.umd.cs.findbugs.**/*.jar',
-        'org.mockito*.jar',
-        'com.github.spotbugs.**/*.jar',
-        '**/*source_*.jar'
-        ])
+def eclipsePluginId = 'com.github.spotbugs.plugin.eclipse'
+def eclipseExecutable = findEclipseExecutable()
 
+dependencies {
   api (project(':spotbugs')) {
     transitive = true
   }
@@ -92,19 +87,7 @@ tasks.named('javadoc', Javadoc).configure {
 }
 
 def copyLibsForEclipse = tasks.register('copyLibsForEclipse', Copy) {
-    from ('../spotbugs/.libs') {
-      include "*.jar"
-      exclude "*xml-apis*.jar"
-      exclude "*ant-*.jar"
-      exclude "Apple*.jar"
-      exclude "hamcrest*.jar"
-      exclude "slf4j-*alpha*.jar"
-      exclude "Saxon*.jar"
-    }
-    from ('../spotbugs/build/libs') {
-      include "*.jar"
-    }
-    from ('../spotbugs-annotations/build/libs') {
+    from (configurations.runtimeClasspath) {
       include "*.jar"
     }
     into "lib"
@@ -250,7 +233,7 @@ def testPluginJar = tasks.register('testPluginJar') {
             .matching { include 'lib/spotbugs.jar' }
             .singleFile
     if (!spotbugsJar.exists()) {
-      throw new GradleException('Eclipse plugin does not contain spotbugs.jar');
+      throw new TaskInstantiationException('Eclipse plugin does not contain spotbugs.jar');
     } else {
       println 'Eclipse plugin contains spotbugs.jar'
     }
@@ -465,14 +448,22 @@ ext.signJar = { File dir ->
   }
 }
 
+def confirmEclipse = tasks.register('confirmEclipse') {
+  doFirst {
+    if (eclipseExecutable == null || !eclipseExecutable.exists()) {
+      throw new GradleScriptException("No eclipse found in local")
+    }
+  }
+}
+
 def generateP2Metadata = tasks.register('generateP2Metadata', Exec) {
   doFirst {
     project.delete "${buildDir}/site/eclipse/artifacts.xml"
     project.delete "${buildDir}/site/eclipse/content.xml"
     signJar(file("${buildDir}/site/eclipse"))
   }
   inputs.file 'local.properties'
-  dependsOn pluginJar, featureJar, siteXml, siteHtml
+  dependsOn confirmEclipse, pluginJar, featureJar, siteXml, siteHtml
   commandLine "${eclipseExecutable}", '-nosplash',
     '-application', 'org.eclipse.equinox.p2.publisher.UpdateSitePublisher',
     '-metadataRepository', "file:${buildDir}/site/eclipse", // TODO : May not work on Windows
@@ -487,7 +478,7 @@ def generateCandidateP2Metadata = tasks.register('generateCandidateP2Metadata',
     signJar(file("${buildDir}/site/eclipse-candidate"))
   }
   inputs.file 'local.properties'
-  dependsOn pluginCandidateJar, featureCandidateJar, siteCandidateXml, siteCandidateHtml
+  dependsOn confirmEclipse, pluginCandidateJar, featureCandidateJar, siteCandidateXml, siteCandidateHtml
   commandLine "${eclipseExecutable}", '-nosplash',
     '-application', 'org.eclipse.equinox.p2.publisher.UpdateSitePublisher',
     '-metadataRepository', "file:${buildDir}/site/eclipse-candidate", // TODO : May not work on Windows
@@ -502,7 +493,7 @@ def generateP2MetadataDaily = tasks.register('generateP2MetadataDaily', Exec) {
     signJar(file("${buildDir}/site/eclipse-daily"))
   }
   inputs.file 'local.properties'
-  dependsOn pluginDailyJar, featureDailyJar, siteDailyXml, siteDailyHtml
+  dependsOn confirmEclipse, pluginDailyJar, featureDailyJar, siteDailyXml, siteDailyHtml
   commandLine "${eclipseExecutable}", '-nosplash',
     '-application', 'org.eclipse.equinox.p2.publisher.UpdateSitePublisher',
     '-metadataRepository', "file:${buildDir}/site/eclipse-daily", // TODO : May not work on Windows
@@ -517,7 +508,7 @@ def generateP2MetadataStableLatest = tasks.register('generateP2MetadataStableLat
     signJar(file("${buildDir}/site/eclipse-stable-latest"))
   }
   inputs.file 'local.properties'
-  dependsOn pluginStableLatestJar, featureStableLatestJar, siteStableLatestXml, siteStableLatestHtml
+  dependsOn confirmEclipse, pluginStableLatestJar, featureStableLatestJar, siteStableLatestXml, siteStableLatestHtml
   commandLine "${eclipseExecutable}", '-nosplash',
     '-application', 'org.eclipse.equinox.p2.publisher.UpdateSitePublisher',
     '-metadataRepository', "file:${buildDir}/site/eclipse-stable-latest", // TODO : May not work on Windows
@@ -536,7 +527,11 @@ def eclipseSiteZip = tasks.register('eclipseSiteZip', Zip) {
   archiveFileName = "eclipsePlugin.zip"
 }
 
-tasks.named('assemble').configure { dependsOn eclipseSite, eclipseSiteZip }
+if (eclipseExecutable == null) {
+  println "Create local.properties to build eclipse site"
+} else {
+  tasks.named('assemble').configure { dependsOn eclipseSiteZip }
+}
 
 spotbugs {
   ignoreFailures = true

diff --git a/settings.gradle b/settings.gradle
@@ -2,15 +2,17 @@ plugins {
   id "com.gradle.enterprise" version "3.8"
 }
 
-def eclipseFile = "eclipsePlugin/local.properties"
-if (new File(rootDir, eclipseFile).exists()) {
-  include ':eclipsePlugin', ':eclipsePlugin-test', ':eclipsePlugin-junit', ':spotbugsTestCases', ':spotbugs', ':spotbugs-tests', ':test-harness', ':spotbugs-annotations', ':spotbugs-ant'
-} else {
-  logger.lifecycle('Eclipse plugin configuration (' + eclipseFile + ') was not found. Skipping Eclipse plugin...')
-  include ':spotbugsTestCases', ':spotbugs', ':spotbugs-tests', ':test-harness', ':spotbugs-annotations', ':spotbugs-ant'
-}
-
-include ':test-harness-core', ':test-harness-jupiter'
+include ':eclipsePlugin'
+include ':eclipsePlugin-test'
+include ':eclipsePlugin-junit'
+include ':spotbugs'
+include ':spotbugs-annotations'
+include ':spotbugs-ant'
+include ':spotbugs-tests'
+include ':spotbugsTestCases'
+include ':test-harness'
+include ':test-harness-core'
+include ':test-harness-jupiter'
 
 gradleEnterprise {
   buildScan {

diff --git a/spotbugs/build.gradle b/spotbugs/build.gradle
@@ -126,25 +126,16 @@ eclipse.classpath.file {
     }
 }
 
-def copyLibsForEclipse = tasks.register('copyLibsForEclipse', Copy) {
-    from configurations.testCompileClasspath, configurations.testRuntimeClasspath, configurations.guiRuntimeClasspath, configurations.guiCompileClasspath, configurations.logBinding
-    into ".libs"
-    include "*.jar"
-    exclude "*xml-apis*.jar"
-    exclude "*spotbugs-annotations*.jar"
-    duplicatesStrategy = DuplicatesStrategy.EXCLUDE
-}
-
 def updateManifest = tasks.register('updateManifest') {
   inputs.file "$projectDir/META-INF/MANIFEST-TEMPLATE.MF"
   outputs.file "$projectDir/META-INF/MANIFEST.MF"
-  dependsOn configurations.runtimeClasspath, copyLibsForEclipse
+  dependsOn configurations.runtimeClasspath
   doLast {
     def manifestSpec = manifest {
       from "$projectDir/META-INF/MANIFEST-TEMPLATE.MF"
       attributes 'Main-Class': 'edu.umd.cs.findbugs.LaunchAppropriateUI',
                'Bundle-Version': project.version.replace('-', '.'),
-               'Bundle-ClassPath': 'spotbugs.jar,' +  fileTree(dir: '.libs').collect { projectDir.toPath().relativize(it.toPath()).toString() }.join(',')
+               'Bundle-ClassPath': 'spotbugs.jar,' +  configurations.runtimeClasspath.collect { it.name }.join(',')
     }
     // write manifests
     manifestSpec.writeTo("$projectDir/META-INF/MANIFEST.MF")