S6313 should respect @VisibleForTesting annotation

[jayasuryat (Jaya Surya Thotapalli)]

Using: SonarQube™ - Enterprise Edition - Version 9.9 (build 65466)
Language: Kotlin
Rule: S6313 (Classes extending “ViewModel” should not expose suspending functions).

Expectation:

Public suspend method in ViewModels which are annotated with @VisibleForTesting should not get flagged by SonarQube.

---

Example:

class DetailsViewModel : ViewModel() {

    @VisibleForTesting
    suspend fun getName(): String {
        TODO()
    }
}

getName() method which is explicitly annotated with @VisibleForTesting should not be flagged by rule S6313 (Classes extending “ViewModel” should not expose suspending functions) as the access modifier has been intentionally relaxed to accommodate for testing.

---

PS: There seem to be many other similar @VisibleForTesting annotations which are also needed to be considered, more info about those annotations have been documented here: Rules S2039 and S2156 should recognize `@VisibleForTesting` other than Guava's

I’m particularly interested in androidx.annotation.VisibleForTesting

[Leonardo_Pilastri]

Hi there, could you please share a self-contained reproducing code snippet that I could copy-paste to reproduce the error on my end? Thanks!

[jayasuryat (Jaya Surya Thotapalli)]

This piece of code should work. The getName() method would get flagged.

@jayasuryat

package com.example.test

import androidx.annotation.VisibleForTesting
import androidx.lifecycle.ViewModel
import kotlinx.coroutines.delay

class DetailsViewModel : ViewModel() {

    @VisibleForTesting
    suspend fun getName(): String {
        delay(2000)
        return "test"
    }
}

[Leonardo_Pilastri]

Hey, sorry for the delay, I created a ticket to tackle this problem! Thanks for the report.