Merge pull request #98 from UnitTestBot/develop

1.1.0 release

Author: lehvolk

.github/workflows/build-and-test.yml

@@ -10,13 +10,12 @@ name: Build and run tests
 on:
   push:
     branches:
-      - main
-      - develop
-      - 'feature-**'
-      - '*/feature-**'
+      - '*'
+      - '*/*'
   pull_request:
     branches:
       - main
+      - develop
 
 permissions:
   contents: read

.github/workflows/coverage.yml

@@ -2,7 +2,7 @@ name: Generate coverage report
 
 on:
   push:
-    branches: [ develop, main ]
+    branches: [ develop ]
   pull_request:
     branches: [ main ]
   workflow_dispatch:

.github/workflows/release.yml

@@ -13,7 +13,7 @@ jobs:
     if: ${{ github.actor == 'lehvolk' || github.actor == 'denis-fokin' || github.actor == 'bissquit' }}
     runs-on: ubuntu-latest
     permissions:
-      contents: read
+      contents: write
       packages: write
     steps:
       - uses: actions/checkout@v3

README.md

@@ -1,4 +1,7 @@
-[![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)
+[![Maven](https://maven-badges.herokuapp.com/maven-central/org.jacodb/jacodb-api/badge.svg)](https://central.sonatype.com/search?smo=true&q=org.jacodb)
+[![Last Release](https://img.shields.io/github/release-date/unittestbot/jacodb.svg?logo=github)](https://github.com/unittestbot/jacodb/releases/latest)
+[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
+![Pure Java + Kotlin](https://img.shields.io/badge/100%25-java%2bkotlin-orange.svg)
 [![Coverage](./docs/badges/jacoco.svg)](https://github.com/UnitTestBot/jacodb/actions/workflows/coverage.yml)
 
 ## Overview

build.gradle.kts

@@ -8,7 +8,7 @@ val includeDokka: String? by project
 
 group = "org.jacodb"
 
-project.version = semVer ?: "1.0-SNAPSHOT"
+project.version = semVer ?: "1.1-SNAPSHOT"
 
 buildscript {
     repositories {
@@ -175,6 +175,7 @@ if (!repoUrl.isNullOrEmpty()) {
             project(":jacodb-api"),
             project(":jacodb-core"),
             project(":jacodb-analysis"),
+            project(":jacodb-approximations"),
         )
     ) {
         publishing {

docs/badges/branches.svg

@@ -1 +1 @@
-{"branches": 68.14246846401187, "coverage": 69.80196523053665}
+{"branches": 68.50657108721624, "coverage": 70.46257629296498}

docs/badges/coverage-summary.json

@@ -9,4 +9,5 @@ jooqVersion=3.14.16
 junit5Version=5.9.0
 
 intellij_community_url=https://download-cdn.jetbrains.com/idea/ideaIC-2022.2.3.win.zip
-#database_location=d:\\work\\jacodb\\jcdb-http.db
+#database_location=d:\\work\\jacodb\\jcdb-http.db
+org.gradle.jvmargs=-XX:MaxMetaspaceSize=512m

docs/badges/jacoco.svg

@@ -222,7 +222,7 @@ private class NPEForwardFunctions(
         // Possibly null arguments
         result += method.flowGraph().locals
             .filterIsInstance<JcArgument>()
-            .filter { it.type.nullable != false }
+            .filter { method.parameters[it.index].isNullable != false }
             .map { NPETaintNode(AccessPath.fromLocal(it)) }
 
         // Possibly null statics

gradle.properties

@@ -140,19 +140,15 @@ class NpeAnalysisTest : BaseTest() {
     fun `npe on virtual call when possible`() {
         testOneMethod<NPEExamples>(
             "possibleNPEOnVirtualCall",
-
-            // TODO: first location is false-positive here due to not-parsed @NotNull annotation
-            listOf("%0 = arg\$0.functionThatCanThrowNPEOnNull(arg\$1)", "%0 = arg\$0.length()")
+            listOf("%0 = arg\$0.length()")
         )
     }
 
     @Test
     fun `no npe on virtual call when impossible`() {
         testOneMethod<NPEExamples>(
             "noNPEOnVirtualCall",
-
-            // TODO: false-positive here due to not-parsed @NotNull annotation
-            listOf("%0 = arg\$0.functionThatCanNotThrowNPEOnNull(arg\$1)")
+            emptyList()
         )
     }
 

jacodb-analysis/src/main/kotlin/org/jacodb/analysis/analyzers/NpeAnalyzer.kt

@@ -15,6 +15,4 @@ dependencies {
     api(group = "org.jetbrains.kotlinx", name = "kotlinx-coroutines-jdk8", version = coroutinesVersion)
 
     api(group = "org.jooq", name = "jooq", version = jooqVersion)
-    implementation(group = "org.jetbrains.kotlinx", name = "kotlinx-metadata-jvm", version = kmetadataVersion)
-
 }

jacodb-analysis/src/test/kotlin/org/jacodb/analysis/impl/NpeAnalysisTest.kt

@@ -20,6 +20,7 @@ import org.jacodb.api.cfg.JcGraph
 import org.jacodb.api.cfg.JcInst
 import org.jacodb.api.cfg.JcInstList
 import org.jacodb.api.cfg.JcRawInst
+import org.jacodb.api.ext.CONSTRUCTOR
 import org.objectweb.asm.Opcodes
 import org.objectweb.asm.tree.ClassNode
 import org.objectweb.asm.tree.MethodNode
@@ -116,7 +117,7 @@ interface JcMethod : JcSymbol, JcAnnotatedSymbol, JcAccessible {
      */
     val isConstructor: Boolean
         get() {
-            return name == "<init>"
+            return name == CONSTRUCTOR
         }
 
     val isClassInitializer: Boolean

jacodb-api/build.gradle.kts

@@ -56,9 +56,10 @@ interface JcClasspath : Closeable {
      */
     fun findTypeOrNull(name: String): JcType?
 
-    fun typeOf(jcClass: JcClassOrInterface): JcRefType
+    fun typeOf(jcClass: JcClassOrInterface, nullability: Boolean? = null, annotations: List<JcAnnotation> = listOf()): JcRefType
+
+    fun arrayTypeOf(elementType: JcType, nullability: Boolean? = null, annotations: List<JcAnnotation> = listOf()): JcArrayType
 
-    fun arrayTypeOf(elementType: JcType): JcArrayType
     fun toJcClass(source: ClassSource): JcClassOrInterface
 
     suspend fun refreshed(closeOld: Boolean): JcClasspath
@@ -138,7 +139,9 @@ interface JcClasspathExtFeature : JcClasspathFeature {
 interface JcClassExtFeature : JcClasspathFeature {
 
     fun fieldsOf(clazz: JcClassOrInterface): List<JcField>? = null
+    fun fieldsOf(clazz: JcClassOrInterface, originalFields: List<JcField>): List<JcField>? = fieldsOf(clazz)
     fun methodsOf(clazz: JcClassOrInterface): List<JcMethod>? = null
+    fun methodsOf(clazz: JcClassOrInterface, originalMethods: List<JcMethod>): List<JcMethod>? = methodsOf(clazz)
 
     fun extensionValuesOf(clazz: JcClassOrInterface): Map<String, Any>? = null
 
@@ -151,6 +154,7 @@ interface JcInstExtFeature : JcClasspathFeature {
     fun transformInstList(method: JcMethod, list: JcInstList<JcInst>): JcInstList<JcInst> = list
 }
 
+@JvmDefaultWithoutCompatibility
 interface JcMethodExtFeature : JcClasspathFeature {
 
     fun flowGraph(method: JcMethod): JcGraph? = null

jacodb-api/src/main/kotlin/org/jacodb/api/Classes.kt

@@ -36,9 +36,9 @@ object PredefinedPrimitives {
     private val valueSet = values.toHashSet()
 
     @JvmStatic
-    fun of(name: String, cp: JcClasspath): JcPrimitiveType? {
+    fun of(name: String, cp: JcClasspath, annotations: List<JcAnnotation> = listOf()): JcPrimitiveType? {
         if (valueSet.contains(name)) {
-            return PredefinedPrimitive(cp, name)
+            return PredefinedPrimitive(cp, name, annotations)
         }
         return null
     }
@@ -52,7 +52,8 @@ object PredefinedPrimitives {
 /**
  * Predefined primitive types
  */
-class PredefinedPrimitive(override val classpath: JcClasspath, override val typeName: String) : JcPrimitiveType {
+class PredefinedPrimitive(override val classpath: JcClasspath, override val typeName: String,
+                          override val annotations: List<JcAnnotation> = listOf()) : JcPrimitiveType {
 
     override fun equals(other: Any?): Boolean {
         if (this === other) return true
@@ -69,4 +70,6 @@ class PredefinedPrimitive(override val classpath: JcClasspath, override val type
         return typeName.hashCode()
     }
 
+    override fun copyWithAnnotations(annotations: List<JcAnnotation>): JcType =
+        PredefinedPrimitive(classpath, typeName, annotations)
 }

jacodb-api/src/main/kotlin/org/jacodb/api/JcClasspath.kt

@@ -48,14 +48,16 @@ interface JcTypedMethodParameter {
     val type: JcType
     val name: String?
     val enclosingMethod: JcTypedMethod
-    val nullable: Boolean?
 }
 
 interface JcType {
     val classpath: JcClasspath
     val typeName: String
 
     val nullable: Boolean?
+    val annotations: List<JcAnnotation>
+
+    fun copyWithAnnotations(annotations: List<JcAnnotation>): JcType
 }
 
 interface JcPrimitiveType : JcType {
@@ -109,12 +111,16 @@ interface JcTypeVariable : JcRefType {
 interface JcBoundedWildcard : JcRefType {
     val upperBounds: List<JcRefType>
     val lowerBounds: List<JcRefType>
+
+    override fun copyWithAnnotations(annotations: List<JcAnnotation>): JcType = this
 }
 
 interface JcUnboundWildcard : JcRefType {
     override val jcClass: JcClassOrInterface
         get() = classpath.objectClass
 
+    override fun copyWithAnnotations(annotations: List<JcAnnotation>): JcType = this
+
 }
 
 interface JcTypeVariableDeclaration {

jacodb-api/src/main/kotlin/org/jacodb/api/PredefinedPrimitive.kt

@@ -126,6 +126,7 @@ abstract class AbstractFullRawExprSetCollector : JcRawExprVisitor<Unit>, Default
     override fun visitJcRawStringConstant(value: JcRawStringConstant) = ifMatches(value)
     override fun visitJcRawClassConstant(value: JcRawClassConstant) = ifMatches(value)
     override fun visitJcRawMethodConstant(value: JcRawMethodConstant) = ifMatches(value)
+    override fun visitJcRawMethodType(value: JcRawMethodType) = ifMatches(value)
 
     abstract fun ifMatches(expr: JcRawExpr)
 }
@@ -235,33 +236,34 @@ abstract class AbstractFullExprSetCollector : JcExprVisitor<Any>, DefaultJcInstV
         return Unit
     }
 
-    override fun visitJcArrayAccess(value: JcArrayAccess) : Any{
+    override fun visitJcArrayAccess(value: JcArrayAccess): Any {
         ifMatches(value)
         value.array.accept(this)
         value.index.accept(this)
         return Unit
     }
 
-    override fun visitJcPhiExpr(expr: JcPhiExpr) : Any{
+    override fun visitJcPhiExpr(expr: JcPhiExpr): Any {
         ifMatches(expr)
         expr.args.forEach { it.accept(this) }
         expr.values.forEach { it.accept(this) }
         return Unit
     }
 
     override fun visitExternalJcExpr(expr: JcExpr): Any = ifMatches(expr)
-    override fun visitJcBool(value: JcBool) : Any= ifMatches(value)
+    override fun visitJcBool(value: JcBool): Any = ifMatches(value)
     override fun visitJcByte(value: JcByte): Any = ifMatches(value)
-    override fun visitJcChar(value: JcChar) : Any= ifMatches(value)
+    override fun visitJcChar(value: JcChar): Any = ifMatches(value)
     override fun visitJcShort(value: JcShort): Any = ifMatches(value)
     override fun visitJcInt(value: JcInt): Any = ifMatches(value)
     override fun visitJcLong(value: JcLong): Any = ifMatches(value)
     override fun visitJcFloat(value: JcFloat): Any = ifMatches(value)
     override fun visitJcDouble(value: JcDouble): Any = ifMatches(value)
     override fun visitJcNullConstant(value: JcNullConstant): Any = ifMatches(value)
-    override fun visitJcStringConstant(value: JcStringConstant) : Any= ifMatches(value)
-    override fun visitJcClassConstant(value: JcClassConstant) : Any= ifMatches(value)
-    override fun visitJcMethodConstant(value: JcMethodConstant) : Any= ifMatches(value)
+    override fun visitJcStringConstant(value: JcStringConstant): Any = ifMatches(value)
+    override fun visitJcClassConstant(value: JcClassConstant): Any = ifMatches(value)
+    override fun visitJcMethodConstant(value: JcMethodConstant): Any = ifMatches(value)
+    override fun visitJcMethodType(value: JcMethodType): Any = ifMatches(value)
 
     abstract fun ifMatches(expr: JcExpr)
 }

jacodb-api/src/main/kotlin/org/jacodb/api/Types.kt

@@ -1167,4 +1167,22 @@ data class JcMethodConstant(
     override fun <T> accept(visitor: JcExprVisitor<T>): T {
         return visitor.visitJcMethodConstant(this)
     }
+}
+
+data class JcMethodType(
+    val argumentTypes: List<JcType>,
+    val returnType: JcType,
+    override val type: JcType
+) : JcConstant {
+    override fun toString(): String = "${
+        argumentTypes.joinToString(
+            prefix = "(",
+            postfix = ")",
+            separator = ", "
+        )
+    }:${returnType}"
+
+    override fun <T> accept(visitor: JcExprVisitor<T>): T {
+        return visitor.visitJcMethodType(this)
+    }
 }

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

@@ -109,6 +109,7 @@ interface JcExprVisitor<T> {
     fun visitJcStringConstant(value: JcStringConstant): T
     fun visitJcClassConstant(value: JcClassConstant): T
     fun visitJcMethodConstant(value: JcMethodConstant): T
+    fun visitJcMethodType(value: JcMethodType): T
     fun visitJcPhiExpr(expr: JcPhiExpr): T
 
     fun visitExternalJcExpr(expr: JcExpr): T
@@ -216,6 +217,8 @@ interface DefaultJcExprVisitor<T> : JcExprVisitor<T> {
 
     override fun visitJcMethodConstant(value: JcMethodConstant): T = defaultExprHandler(value)
 
+    override fun visitJcMethodType(value: JcMethodType): T = defaultExprHandler(value)
+
     override fun visitJcPhiExpr(expr: JcPhiExpr): T = defaultExprHandler(expr)
 
     override fun visitExternalJcExpr(expr: JcExpr): T = defaultExprHandler(expr)

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

@@ -959,6 +959,21 @@ data class JcRawMethodConstant(
     }
 }
 
+data class JcRawMethodType(
+    val argumentTypes: List<TypeName>,
+    val returnType: TypeName,
+    private val methodType: TypeName
+) : JcRawConstant {
+    override val typeName: TypeName = methodType
+
+    override fun toString(): String =
+        "${argumentTypes.joinToString(prefix = "(", postfix = ")")}:$returnType"
+
+    override fun <T> accept(visitor: JcRawExprVisitor<T>): T {
+        return visitor.visitJcRawMethodType(this)
+    }
+}
+
 //
 //fun JcRawInstList.lineNumberOf(inst: JcRawInst): Int? {
 //    val idx: Int = instructions.indexOf(inst)

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

@@ -112,6 +112,7 @@ interface JcRawExprVisitor<T> {
     fun visitJcRawStringConstant(value: JcRawStringConstant): T
     fun visitJcRawClassConstant(value: JcRawClassConstant): T
     fun visitJcRawMethodConstant(value: JcRawMethodConstant): T
+    fun visitJcRawMethodType(value: JcRawMethodType): T
 }
 
 @JvmDefaultWithoutCompatibility
@@ -214,4 +215,6 @@ interface DefaultJcRawExprVisitor<T> : JcRawExprVisitor<T> {
     override fun visitJcRawClassConstant(value: JcRawClassConstant): T = defaultExprHandler(value)
 
     override fun visitJcRawMethodConstant(value: JcRawMethodConstant): T = defaultExprHandler(value)
+
+    override fun visitJcRawMethodType(value: JcRawMethodType): T = defaultExprHandler(value)
 }

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

@@ -52,6 +52,7 @@ fun JcClassOrInterface.toType(): JcClassType {
 
 val JcClassOrInterface.packageName get() = name.substringBeforeLast(".")
 
+const val JAVA_OBJECT = "java.lang.Object"
 
 /**
  * find field by name
@@ -67,10 +68,13 @@ fun JcClassOrInterface.findFieldOrNull(name: String): JcField? {
     }
 }
 
-fun JcClassOrInterface.findDeclaredFieldOrNull(name: String): JcField? = declaredFields.firstOrNull { it.name == name }
+fun JcClassOrInterface.findDeclaredFieldOrNull(name: String): JcField? = declaredFields.singleOrNull { it.name == name }
 
 fun JcClassOrInterface.findDeclaredMethodOrNull(name: String, desc: String? = null): JcMethod? {
-    return declaredMethods.firstOrNull { it.name == name && (desc == null || it.description == desc) }
+    return when (desc) {
+        null -> declaredMethods.firstOrNull { it.name == name }
+        else -> declaredMethods.singleOrNull { it.name == name && it.description == desc }
+    }
 }
 
 

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

@@ -26,6 +26,9 @@ import org.objectweb.asm.Type
 import org.objectweb.asm.tree.FieldInsnNode
 import org.objectweb.asm.tree.MethodInsnNode
 
+
+const val CONSTRUCTOR = "<init>"
+
 /**
  * is method has `strictfp` modifier
  */