wip

Signed-off-by: tobiasKaminsky <[email protected]>

Author: tobiasKaminsky

build.gradle

@@ -17,7 +17,6 @@ buildscript {
     }
     dependencies {
         classpath 'com.android.tools.build:gradle:8.13.2'
-        classpath 'com.github.spotbugs.snom:spotbugs-gradle-plugin:6.4.8'
         classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
         classpath "io.gitlab.arturbosch.detekt:detekt-gradle-plugin:1.23.8"
     }
@@ -31,6 +30,5 @@ allprojects {
     }
 }
 
-apply plugin: "com.github.spotbugs"
 apply plugin: "io.gitlab.arturbosch.detekt"
 apply plugin: 'maven-publish' // needed for JitPack.io

gradle/verification-metadata.xml

@@ -8522,6 +8522,16 @@
             <sha256 value="a36a5f4b7289b643d422372a2e92dbe56c27219514eb10e483edb09a9babec27" origin="Generated by Gradle" reason="A key couldn't be downloaded"/>
          </artifact>
       </component>
+       <component group="com.mebigfatguy.fb-contrib" name="fb-contrib" version="7.7.3">
+           <artifact name="fb-contrib-7.7.3.jar">
+               <sha256 value="f97f9d3cc5166b1d9745342d23f3d97fe353dfe426d6c3d31fb315d784f92b06"
+                   origin="Generated by Gradle" reason="A key couldn't be downloaded" />
+           </artifact>
+           <artifact name="fb-contrib-7.7.3.pom">
+               <sha256 value="02503912009e6d5b9e2fe589982c367e5133fb9cdeabe5751681cb2362ec3af7"
+                   origin="Generated by Gradle" reason="A key couldn't be downloaded" />
+           </artifact>
+       </component>
       <component group="com.pinterest" name="ktlint" version="0.51.0-FINAL">
          <artifact name="ktlint-0.51.0-FINAL.pom">
             <sha256 value="62609714173a8e0fc63ddb2990c8e1d261e0ff2eb10650f296d10f0a421b61a5" origin="Generated by Gradle" reason="A key couldn't be downloaded"/>

lib/build.gradle

@@ -11,6 +11,14 @@ import com.github.spotbugs.snom.Effort
 import com.github.spotbugs.snom.SpotBugsTask
 import org.jetbrains.kotlin.gradle.dsl.JvmTarget
 
+buildscript {
+    ext {
+        junit_version = '4.13.2'
+    }
+    dependencies {
+        classpath 'com.github.spotbugs.snom:spotbugs-gradle-plugin:6.4.8'
+    }
+}
 
 plugins {
     id "com.diffplug.spotless" version "8.1.0"
@@ -84,13 +92,13 @@ android {
     }
 }
 
-tasks.withType(SpotBugsTask).configureEach { task ->
+tasks.withType(SpotBugsTask) { task ->
     String variantNameCap = task.name.replace("spotbugs", "")
-
+    String variantName = variantNameCap.substring(0, 1).toLowerCase() + variantNameCap.substring(1)
     dependsOn "compile${variantNameCap}Sources"
 
-    excludeFilter.set(file("${project.rootDir}/spotbugs-filter.xml"))
-    classes = fileTree("$project.layout.buildDirectory/intermediates/javac/debug/classes/")
+    classes = files("$project.buildDir/intermediates/javac/${variantName}")
+    excludeFilter = file("${project.rootDir}/spotbugs-filter.xml")
     reports {
         xml {
             required = true
@@ -141,7 +149,7 @@ dependencies {
     implementation 'com.squareup.okhttp3:okhttp:5.3.2'
 
     spotbugsPlugins 'com.h3xstream.findsecbugs:findsecbugs-plugin:1.14.0'
-    spotbugsPlugins 'com.mebigfatguy.fb-contrib:fb-contrib:7.7.2'
+    spotbugsPlugins 'com.mebigfatguy.fb-contrib:fb-contrib:7.7.3'
 
     ktlint "com.pinterest.ktlint:ktlint-cli:1.8.0"
 

scripts/analysis/analysis-wrapper.sh

@@ -14,76 +14,72 @@ stableBranch="main"
 repository="android-singleSignOn"
 codacyProject=160903
 
-ruby scripts/analysis/findbugs-up.rb $1 $2 $3
-findbugsValue=$?
+curl "https://www.kaminsky.me/nc-dev/$repository-findbugs/$stableBranch.xml" -o "/tmp/$stableBranch.xml"
+ruby scripts/analysis/spotbugs-up.rb "$stableBranch"
+spotbugsValue=$?
 
 # exit codes:
 # 0: count was reduced
 # 1: count was increased
 # 2: count stayed the same
 
-echo "Branch: $1"
+source scripts/lib.sh
 
-if [ $1 = $stableBranch ]; then
-    echo "New findbugs result for $stableBranch at: https://www.kaminsky.me/nc-dev/$repository-findbugs/$stableBranch.html"
-    curl -u "${LOG_USERNAME}:${LOG_PASSWORD}" -X PUT https://nextcloud.kaminsky.me/remote.php/webdav/$repository-findbugs/$stableBranch.html --upload-file lib/build/reports/spotbugs/spotbugs.html
+echo "Branch: $BRANCH"
 
-    summary=$(sed -n "/<h1>Summary<\/h1>/,/<h1>Warnings<\/h1>/p" lib/build/reports/spotbugs/spotbugs.html | head -n-1 | sed s'/<\/a>//'g | sed s'/<a.*>//'g | sed s"/Summary/SpotBugs ($stableBranch)/" | tr "\"" "\'" | tr -d "\r\n")
-    curl -u "${LOG_USERNAME}:${LOG_PASSWORD}" -X PUT -d "$summary" https://nextcloud.kaminsky.me/remote.php/webdav/$repository-findbugs/findbugs-summary-$stableBranch.html
+if [ "$BRANCH" = $stableBranch ]; then
+    echo "New spotbugs result for $stableBranch at: https://www.kaminsky.me/nc-dev/$repository-findbugs/$stableBranch.html"
+    curl -u "${LOG_USERNAME}:${LOG_PASSWORD}" -X PUT https://nextcloud.kaminsky.me/remote.php/webdav/$repository-findbugs/$stableBranch.html --upload-file library/build/reports/spotbugs/spotbugs.html
+    curl 2>/dev/null -u "${LOG_USERNAME}:${LOG_PASSWORD}" -X PUT "https://nextcloud.kaminsky.me/remote.php/webdav/$repository-findbugs/$stableBranch.xml" --upload-file library/build/reports/spotbugs/debug.xml
 else
-    if [ -e $6 ]; then
-        name=$stableBranch"-"$(date +%F)
-    else 
-        name=$6;
+    if [ -e "${BUILD_NUMBER}" ]; then
+        6=$stableBranch"-"$(date +%F)
     fi
 
-    echo "New findbugs results at https://www.kaminsky.me/nc-dev/$repository-findbugs/$name.html"
-    curl 2>/dev/null -u "${LOG_USERNAME}:${LOG_PASSWORD}" -X PUT https://nextcloud.kaminsky.me/remote.php/webdav/$repository-findbugs/$name.html --upload-file lib/build/reports/spotbugs/spotbugs.html
+    echo "New spotbugs results at https://www.kaminsky.me/nc-dev/$repository-findbugs/${BUILD_NUMBER}.html"
+    curl 2>/dev/null -u "${LOG_USERNAME}:${LOG_PASSWORD}" -X PUT "https://nextcloud.kaminsky.me/remote.php/webdav/$repository-findbugs/${BUILD_NUMBER}.html" --upload-file library/build/reports/spotbugs/spotbugs.html
 
     # delete all old comments, starting with Codacy
-    oldComments=$(curl 2>/dev/null -u $1:$2 -X GET https://api.github.com/repos/nextcloud/$repository/issues/$7/comments | jq '.[] | (.id |tostring) + "|" + (.user.login | test("nextcloud-android-bot") | tostring) + "|" + (.body | test("<h1>Codacy.*") | tostring)'  | grep "true|true" | tr -d "\"" | cut -f1 -d"|")
+    oldComments=$(curl_gh -X GET "https://api.github.com/repos/nextcloud/$repository/issues/${PR_NUMBER}/comments" | jq '.[] | select((.user.login | contains("github-actions")) and  (.body | test("<h1>Codacy.*"))) | .id')
 
-    echo $oldComments | while read comment ; do
-        curl 2>/dev/null -u "${LOG_USERNAME}:${LOG_PASSWORD}" -X DELETE https://api.github.com/repos/nextcloud/$repository/issues/comments/$comment
+    echo "$oldComments" | while read -r comment ; do
+        curl_gh -X DELETE "https://api.github.com/repos/nextcloud/$repository/issues/comments/$comment"
     done
 
-    # findbugs file must exist
-    if [ ! -s lib/build/reports/spotbugs/spotbugs.html ] ; then
+    # spotbugs file must exist
+    if [ ! -s library/build/reports/spotbugs/spotbugs.html ] ; then
         echo "spotbugs.html file is missing!"
         exit 1
     fi
 
     # add comment with results
-    if [ $stableBranch = "master" ] ; then
-        codacyValue=$(curl 2>/dev/null https://app.codacy.com/dashboards/breakdown\?projectId\=$codacyProject | grep "total issues" | cut -d">" -f3 | cut -d"<" -f1)
-        codacyResult="<h1>Codacy</h1>$codacyValue"
-    else
-        codacyResult=""
-    fi
+    spotbugsResult="<h1>SpotBugs</h1>$(scripts/analysis/spotbugsComparison.py "/tmp/$stableBranch.xml" library/build/reports/spotbugs/debug.xml --link-new "https://www.kaminsky.me/nc-dev/$repository-findbugs/${BUILD_NUMBER}.html" --link-base "https://www.kaminsky.me/nc-dev/$repository-findbugs/$stableBranch.html")"
 
-    findbugsResultNew=$(sed -n "/<h1>Summary<\/h1>/,/<h1>Warnings<\/h1>/p" lib/build/reports/spotbugs/spotbugs.html |head -n-1 | sed s'/<\/a>//'g | sed s'/<a.*>//'g | sed s"#Summary#<a href=\"https://www.kaminsky.me/nc-dev/$repository-findbugs/$name.html\">SpotBugs</a> (new)#" | tr "\"" "\'" | tr -d "\n")
-    findbugsResultOld=$(curl 2>/dev/null https://www.kaminsky.me/nc-dev/$repository-findbugs/findbugs-summary-$stableBranch.html | tr "\"" "\'" | tr -d "\r\n" | sed s"#SpotBugs#<a href=\"https://www.kaminsky.me/nc-dev/$repository-findbugs/$stableBranch.html\">SpotBugs</a>#" | tr "\"" "\'" | tr -d "\n")
-
-    if ( [ $findbugsValue -eq 1 ] ) ; then
-        findbugsMessage="<h1>SpotBugs increased!</h1>"
+    if ( [ $spotbugsValue -eq 1 ] ) ; then
+        spotbugsMessage="<h1>SpotBugs increased!</h1>"
+    fi
+    
+    # check for NotNull
+    if [[ $(grep org.jetbrains.annotations library/src/main/* -irl | wc -l) -gt 0 ]] ; then
+        notNull="org.jetbrains.annotations.* is used. Please use androidx.annotation.* instead.<br><br>"
     fi
 
-    # check gplay limitation: all changelog files must only have 500 chars
-    gplayLimitation=$(scripts/checkGplayLimitation.sh)
+    bodyContent="$spotbugsResult $spotbugsMessage $gplayLimitation $notNull"
+    echo "$bodyContent" >> "$GITHUB_STEP_SUMMARY"
+    payload="{ \"body\" : \"$bodyContent\" }"
+    curl_gh -X POST "https://api.github.com/repos/nextcloud/$repository/issues/${PR_NUMBER}/comments" -d "$payload"
 
     if [ ! -z "$gplayLimitation" ]; then
-        gplayLimitation="<h1>Following files are beyond 500 char limit:</h1><br><br>"$gplayLimitation
+        exit 1
     fi
 
-    curl -u $1:$2 -X POST https://api.github.com/repos/nextcloud/$repository/issues/$7/comments -d "{ \"body\" : \"$codacyResult $findbugsResultNew $findbugsResultOld $findbugsMessage $gplayLimitation \" }"
-
-    if [ ! -z "$gplayLimitation" ]; then
+    if [ -n "$notNull" ]; then
         exit 1
     fi
 
-    if [ $findbugsValue -eq 2 ]; then
+    if [ $spotbugsValue -eq 2 ]; then
         exit 0
     else
-        exit $findbugsValue
+        exit $spotbugsValue
     fi
 fi

scripts/analysis/findbugs-up.rb

@@ -0,0 +1,53 @@
+## Script originally from https://github.com/tir38/android-lint-entropy-reducer at 07.05.2017
+# heavily modified since then
+
+# SPDX-FileCopyrightText: 2017-2024 Nextcloud GmbH and Nextcloud contributors
+# SPDX-FileCopyrightText: 2017 Jason Atwood 
+# SPDX-FileCopyrightText: 2017 Tobias Kaminsky <[email protected]>
+# SPDX-License-Identifier: GPL-3.0-or-later
+
+Encoding.default_external = Encoding::UTF_8
+Encoding.default_internal = Encoding::UTF_8
+
+puts "=================== starting Android Spotbugs Entropy Reducer ===================="
+
+# get args
+base_branch = ARGV[0]
+
+require 'fileutils'
+require 'pathname'
+require 'open3'
+
+# run Spotbugs
+puts "running Spotbugs..."
+system './gradlew spotbugsDebug'
+
+# find number of warnings
+current_warning_count = `./scripts/analysis/spotbugsSummary.py --file library/build/reports/spotbugs/debug.xml --total`.to_i
+puts "found warnings: " + current_warning_count.to_s
+
+# get warning counts from target branch
+previous_xml = "/tmp/#{base_branch}.xml"
+previous_results = File.file?(previous_xml)
+
+if previous_results == true
+    previous_warning_count = `./scripts/analysis/spotbugsSummary.py --total --file #{previous_xml}`.to_i
+    puts "previous warnings: " + previous_warning_count.to_s
+end
+
+# compare previous warning count with current warning count
+if previous_results == true && current_warning_count > previous_warning_count
+    puts "FAIL: warning count increased"
+    exit 1
+end
+
+# check if warning and error count stayed the same
+if  previous_results == true && current_warning_count == previous_warning_count
+    puts "SUCCESS: count stayed the same"
+    exit 0
+end
+
+# warning count DECREASED
+if previous_results == true && current_warning_count < previous_warning_count
+    puts "SUCCESS: count decreased from " + previous_warning_count.to_s + " to " + current_warning_count.to_s
+end