Add coverage report

.github/workflows/coverage.yml

@@ -0,0 +1,74 @@
+name: Generate coverage report
+
+on:
+  push:
+    branches: [ develop, main ]
+  pull_request:
+    branches: [ main ]
+  workflow_dispatch:
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Set up JDK 11
+        uses: actions/setup-java@v3
+        with:
+          java-version: '11'
+          distribution: 'temurin'
+      - uses: gradle/gradle-build-action@v2
+        with:
+          gradle-version: 7.6.1
+      - name: Build and run tests
+        run: |
+          gradle clean build --no-daemon --info
+
+      - name: Generate JaCoCo badge
+        id: jacoco
+        uses: cicirello/jacoco-badge-generator@v2
+        with:
+          badges-directory: docs/badges
+          generate-branches-badge: true
+          generate-summary: true
+          jacoco-csv-file: >
+            jacodb-analysis/build/reports/jacoco/test/jacocoTestReport.csv
+            jacodb-core/build/reports/jacoco/test/jacocoTestReport.csv
+
+      - name: Log coverage percentages to workflow output
+        run: |
+          echo "coverage = ${{ steps.jacoco.outputs.coverage }}"
+          echo "branches = ${{ steps.jacoco.outputs.branches }}"
+      - name: Upload JaCoCo coverage report as a workflow artifact
+        uses: actions/upload-artifact@v3
+        with:
+          name: jacoco-report
+          path: jacodb-*/build/reports/jacoco/
+
+      - name: Commit and push the coverage badges and summary file
+        if: ${{ github.event_name != 'pull_request' }}
+        run: |
+          cd docs/badges
+          if [[ `git status --porcelain *.svg *.json` ]]; then
+            git config --global user.name 'github-actions'
+            git config --global user.email '41898282+github-actions[bot]@users.noreply.github.com'
+            git add *.svg *.json
+            git commit -m "Autogenerated JaCoCo coverage badges" *.svg *.json
+            git push
+          fi
+      - name: Comment on PR with coverage percentages
+        if: ${{ github.event_name == 'pull_request' }}
+        run: |
+          REPORT=$(<badges/coverage-summary.json)
+          COVERAGE=$(jq -r '.coverage' <<< "$REPORT")%
+          BRANCHES=$(jq -r '.branches' <<< "$REPORT")%
+          NEWLINE=$'\n'
+          BODY="## JaCoCo Test Coverage Summary Statistics${NEWLINE}* __Coverage:__ ${COVERAGE}${NEWLINE}* __Branches:__ ${BRANCHES}"
+          gh pr comment ${{github.event.pull_request.number}} -b "${BODY}"
+        continue-on-error: true
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -1,4 +1,5 @@
 [![ci status](https://github.com/UnitTestBot/jacodb/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/UnitTestBot/jacodb/actions/workflows/build-and-test.yml)
+[![Coverage](./docs/badges/jacoco.svg)](https://github.com/UnitTestBot/jacodb/actions/workflows/coverage.yml)
 
 ## Overview
 

build.gradle.kts

@@ -26,6 +26,7 @@ plugins {
     kotlin("jvm") version kotlinVersion
     kotlin("plugin.allopen") version kotlinVersion
     id("org.cadixdev.licenser") version "0.6.1"
+    jacoco
 }
 
 repositories {
@@ -41,6 +42,7 @@ allprojects {
         plugin("kotlin")
         plugin("org.jetbrains.kotlin.plugin.allopen")
         plugin("org.cadixdev.licenser")
+        plugin("jacoco")
     }
 
     repositories {
@@ -95,14 +97,25 @@ allprojects {
                 allWarningsAsErrors = false
             }
         }
+
+        jacocoTestReport {
+            dependsOn(test) // tests are required to run before generating the report
+            reports {
+                csv.required.set(true)
+            }
+
+        }
+
         withType<Test> {
             useJUnitPlatform()
             jvmArgs = listOf("-Xmx2g", "-XX:+HeapDumpOnOutOfMemoryError", "-XX:HeapDumpPath=heapdump.hprof")
             testLogging {
                 events("passed", "skipped", "failed")
             }
+            finalizedBy(jacocoTestReport) // report is always generated after tests run
         }
 
+
         val sourcesJar by creating(Jar::class) {
             archiveClassifier.set("sources")
             from(sourceSets.getByName("main").kotlin.srcDirs)

docs/badges/coverage-summary.json

@@ -0,0 +1 @@
+{"branches": 68.34195614683419, "coverage": 70.38198957259596}

jacodb-api/src/main/kotlin/org/jacodb/api/cfg/JcInst.kt

@@ -680,14 +680,14 @@ data class JcLambdaExpr(
 data class JcDynamicCallExpr(
     private val bsmRef: TypedMethodRef,
     val bsmArgs: List<BsmArg>,
-    val callCiteMethodName: String,
-    val callCiteArgTypes: List<JcType>,
-    val callCiteReturnType: JcType,
-    val callCiteArgs: List<JcValue>
+    val callSiteMethodName: String,
+    val callSiteArgTypes: List<JcType>,
+    val callSiteReturnType: JcType,
+    val callSiteArgs: List<JcValue>
 ) : JcCallExpr {
 
     override val method get() = bsmRef.method
-    override val args get() = callCiteArgs
+    override val args get() = callSiteArgs
 
     override fun <T> accept(visitor: JcExprVisitor<T>): T {
         return visitor.visitJcDynamicCallExpr(this)

jacodb-api/src/main/kotlin/org/jacodb/api/cfg/JcRawInst.kt

@@ -690,17 +690,17 @@ data class BsmHandle(
 data class JcRawDynamicCallExpr(
     val bsm: BsmHandle,
     val bsmArgs: List<BsmArg>,
-    val callCiteMethodName: String,
-    val callCiteArgTypes: List<TypeName>,
-    val callCiteReturnType: TypeName,
-    val callCiteArgs: List<JcRawValue>
+    val callSiteMethodName: String,
+    val callSiteArgTypes: List<TypeName>,
+    val callSiteReturnType: TypeName,
+    val callSiteArgs: List<JcRawValue>
 ) : JcRawCallExpr {
     override val declaringClass get() = bsm.declaringClass
     override val methodName get() = bsm.name
     override val argumentTypes get() = bsm.argTypes
     override val returnType get() = bsm.returnType
     override val typeName get() = returnType
-    override val args get() = callCiteArgs
+    override val args get() = callSiteArgs
 
     override fun <T> accept(visitor: JcRawExprVisitor<T>): T {
         return visitor.visitJcRawDynamicCallExpr(this)

jacodb-core/src/main/kotlin/org/jacodb/impl/analysis/impl/StringConcatSimplifier.kt

@@ -58,12 +58,12 @@ class StringConcatSimplifier(val jcGraph: JcGraph) : DefaultJcInstVisitor<JcInst
                 val lhv = inst.lhv
                 val rhv = inst.rhv
 
-                if (rhv is JcDynamicCallExpr && rhv.callCiteMethodName == "makeConcatWithConstants") {
+                if (rhv is JcDynamicCallExpr && rhv.callSiteMethodName == "makeConcatWithConstants") {
 
                     val (first, second) = when {
-                        rhv.callCiteArgs.size == 2 -> rhv.callCiteArgs
-                        rhv.callCiteArgs.size == 1 && rhv.bsmArgs.size == 1 && rhv.bsmArgs[0] is BsmStringArg -> listOf(
-                            rhv.callCiteArgs[0],
+                        rhv.callSiteArgs.size == 2 -> rhv.callSiteArgs
+                        rhv.callSiteArgs.size == 1 && rhv.bsmArgs.size == 1 && rhv.bsmArgs[0] is BsmStringArg -> listOf(
+                            rhv.callSiteArgs[0],
                             JcStringConstant((rhv.bsmArgs[0] as BsmStringArg).value, stringType)
                         )
 

jacodb-core/src/main/kotlin/org/jacodb/impl/cfg/JcInstListBuilder.kt

@@ -51,7 +51,6 @@ import org.jacodb.api.cfg.JcFieldRef
 import org.jacodb.api.cfg.JcFloat
 import org.jacodb.api.cfg.JcGeExpr
 import org.jacodb.api.cfg.JcGotoInst
-import org.jacodb.api.cfg.JcGraph
 import org.jacodb.api.cfg.JcGtExpr
 import org.jacodb.api.cfg.JcIfInst
 import org.jacodb.api.cfg.JcInst
@@ -412,9 +411,9 @@ class JcInstListBuilder(val method: JcMethod,val instList: JcInstList<JcRawInst>
                 return JcDynamicCallExpr(
                     classpath.methodRef(expr),
                     expr.bsmArgs,
-                    expr.callCiteMethodName,
-                    expr.callCiteArgTypes.map { it.asType() },
-                    expr.callCiteReturnType.asType(),
+                    expr.callSiteMethodName,
+                    expr.callSiteArgTypes.map { it.asType() },
+                    expr.callSiteReturnType.asType(),
                     expr.args.map { it.accept(this) as JcValue }
                 )
             }

jacodb-core/src/main/kotlin/org/jacodb/impl/cfg/MethodNodeBuilder.kt

@@ -660,8 +660,8 @@ class MethodNodeBuilder(
         expr.args.forEach { it.accept(this) }
         currentInsnList.add(
             InvokeDynamicInsnNode(
-                expr.callCiteMethodName,
-                "(${expr.callCiteArgTypes.joinToString("") { it.jvmTypeName }})${expr.callCiteReturnType.jvmTypeName}",
+                expr.callSiteMethodName,
+                "(${expr.callSiteArgTypes.joinToString("") { it.jvmTypeName }})${expr.callSiteReturnType.jvmTypeName}",
                 expr.bsm.asAsmHandle,
                 *expr.bsmArgs.map {
                     when (it) {

jacodb-core/src/main/kotlin/org/jacodb/impl/cfg/util/ExprMapper.kt

@@ -318,9 +318,9 @@ class ExprMapper(val mapping: Map<JcRawExpr, JcRawExpr>) : JcRawInstVisitor<JcRa
             else -> JcRawDynamicCallExpr(
                 expr.bsm,
                 expr.bsmArgs,
-                expr.callCiteMethodName,
-                expr.callCiteArgTypes,
-                expr.callCiteReturnType,
+                expr.callSiteMethodName,
+                expr.callSiteArgTypes,
+                expr.callSiteReturnType,
                 newArgs
             )
         }

jacodb-core/src/main/kotlin/org/jacodb/impl/features/HierarchyExtension.kt

@@ -49,14 +49,16 @@ class HierarchyExtensionImpl(private val cp: JcClasspath) : HierarchyExtension {
                 JOIN Classes ON Classes.id = hierarchy.class_id
                 JOIN Symbols ON Symbols.id = Classes.name
              WHERE location_id in ($locationIds)
+             ORDER BY Classes.id
         """.trimIndent()
 
         private fun directSubClassesQuery(locationIds: String, sinceId: Long?) = """
             SELECT Classes.id, Classes.location_id, SymbolsName.name as name_name, Classes.bytecode FROM ClassHierarchies
                 JOIN Symbols ON Symbols.id = ClassHierarchies.super_id
                 JOIN Symbols as SymbolsName ON SymbolsName.id = Classes.name
                 JOIN Classes ON Classes.id = ClassHierarchies.class_id
-            WHERE Symbols.name = ? and ($sinceId is null or ClassHierarchies.class_id > $sinceId) AND Classes.location_id in ($locationIds) 
+            WHERE Symbols.name = ? and ($sinceId is null or ClassHierarchies.class_id > $sinceId) AND Classes.location_id in ($locationIds)
+            ORDER BY Classes.id
         """.trimIndent()
 
     }

jacodb-core/src/main/kotlin/org/jacodb/impl/types/Objects.kt

@@ -108,59 +108,9 @@ sealed class AnnotationValue
 @Serializable
 open class AnnotationValueList(val annotations: List<AnnotationValue>) : AnnotationValue()
 
-@Serializable(with = PrimitiveValueSerializer::class)
+@Serializable
 class PrimitiveValue(val dataType: AnnotationValueKind, val value: Any) : AnnotationValue()
 
-object PrimitiveValueSerializer : KSerializer<PrimitiveValue> {
-    override val descriptor: SerialDescriptor = buildClassSerialDescriptor("PrimitiveValue") {
-        element("dataType", serialDescriptor<String>())
-        element("value", buildClassSerialDescriptor("Any"))
-    }
-
-    @Suppress("UNCHECKED_CAST")
-    private val dataTypeSerializers: Map<AnnotationValueKind, KSerializer<Any>> =
-        mapOf(
-            AnnotationValueKind.STRING to serializer<String>(),
-            AnnotationValueKind.BYTE to serializer<Byte>(),
-            AnnotationValueKind.SHORT to serializer<Short>(),
-            AnnotationValueKind.CHAR to serializer<Char>(),
-            AnnotationValueKind.LONG to serializer<Long>(),
-            AnnotationValueKind.INT to serializer<Int>(),
-            AnnotationValueKind.FLOAT to serializer<Float>(),
-            AnnotationValueKind.DOUBLE to serializer<Double>(),
-            AnnotationValueKind.BYTE to serializer<Byte>(),
-            AnnotationValueKind.BOOLEAN to serializer<Boolean>()
-            //list them all
-        ).mapValues { (_, v) -> v as KSerializer<Any> }
-
-    private fun getPayloadSerializer(dataType: AnnotationValueKind): KSerializer<Any> = dataTypeSerializers[dataType]
-        ?: throw SerializationException("Serializer for class $dataType is not registered in PacketSerializer")
-
-    override fun serialize(encoder: Encoder, value: PrimitiveValue) {
-        encoder.encodeStructure(descriptor) {
-            encodeStringElement(descriptor, 0, value.dataType.name)
-            encodeSerializableElement(descriptor, 1, getPayloadSerializer(value.dataType), value.value)
-        }
-    }
-
-    @ExperimentalSerializationApi
-    override fun deserialize(decoder: Decoder): PrimitiveValue = decoder.decodeStructure(descriptor) {
-        val dataType = AnnotationValueKind.valueOf(decodeStringElement(descriptor, 0))
-        if (decodeSequentially()) {
-            val payload = decodeSerializableElement(descriptor, 1, getPayloadSerializer(dataType))
-            PrimitiveValue(dataType, payload)
-        } else {
-            require(decodeElementIndex(descriptor) == 0) { "dataType field should precede payload field" }
-            val payload = when (val index = decodeElementIndex(descriptor)) {
-                1 -> decodeSerializableElement(descriptor, 1, getPayloadSerializer(dataType))
-                CompositeDecoder.DECODE_DONE -> throw SerializationException("payload field is missing")
-                else -> error("Unexpected index: $index")
-            }
-            PrimitiveValue(dataType, payload)
-        }
-    }
-}
-
 @Serializable
 class ClassRef(val className: String) : AnnotationValue()
 

jacodb-core/src/main/resources/sqlite/add-indexes.sql

@@ -1,4 +1,24 @@
 CREATE INDEX IF NOT EXISTS "Classes_name" ON "Classes" ("name");
+
+CREATE INDEX IF NOT EXISTS "Classes_outerMethodId" ON "Classes" ("outer_method");
+CREATE INDEX IF NOT EXISTS "ClassInnerClasses_classId" ON "ClassInnerClasses" ("class_id");
+CREATE INDEX IF NOT EXISTS "ClassInnerClasses_classId" ON "ClassInnerClasses" ("class_id");
+CREATE INDEX IF NOT EXISTS "ClassInnerClasses_innerClassId" ON "ClassInnerClasses" ("inner_class_id");
+
+CREATE INDEX IF NOT EXISTS "ClassHierarchies_classId" ON "ClassHierarchies" ("class_id");
+CREATE INDEX IF NOT EXISTS "ClassHierarchies_superId" ON "ClassHierarchies" ("super_id");
+
+CREATE INDEX IF NOT EXISTS "Annotations_classId" ON "Annotations" ("class_id");
+CREATE INDEX IF NOT EXISTS "Annotations_fieldId" ON "Annotations" ("field_id");
+CREATE INDEX IF NOT EXISTS "Annotations_methodId" ON "Annotations" ("method_id");
+CREATE INDEX IF NOT EXISTS "Annotations_paramsId" ON "Annotations" ("param_id");
+
+CREATE INDEX IF NOT EXISTS "Classes_location" ON "Classes" ("location_id");
+CREATE INDEX IF NOT EXISTS "Fields_classId" ON "Fields" ("class_id");
+CREATE INDEX IF NOT EXISTS "Methods_classId" ON "Methods" ("class_id");
+
+CREATE INDEX IF NOT EXISTS "MethodParameters_methodId" ON "MethodParameters" ("method_id");
+
 CREATE UNIQUE INDEX IF NOT EXISTS "Symbols_name" ON "Symbols" ("name");
 CREATE UNIQUE INDEX IF NOT EXISTS "Bytecodelocations_hash" ON "BytecodeLocations" ("uniqueId");
 CREATE UNIQUE INDEX IF NOT EXISTS "Methods_class_id_name_desc" ON "Methods" ("class_id", "name", "desc");