How to run capacitor Android plugin unit tests?

[distante]

When you creates a new capacitor plugin it comes with a couple of androidTest and test folder.

I am interested on write and run the unit tests on the test folder from the command line (or in a CI) but I do not find any way to do it. And no documentation about exist (or I have not found anything).

There is even an unanswered Stackoverflow question from Dec 2019.

How does one run an android unit test on an capacitor plugin?

[imhoffd]

Try running ./gradlew test in the android directory.

[distante]

This was easier than I thought. Thank you!

Coming from just knowing something about Cordova I would like to have this kind of info on the capacitor docs. For people who doesn't know about this like me.

[imhoffd]

That's a great idea! I think it would benefit devs to have some concise documentation about the native projects.

[distante]

Actually It did not worked as well as I though @dwieeb.

While the task says it was successful It does not check the tests created on test\src\java\com\getcapacitor\community\myplugin\.
It always passes even if a set an assertEquals(true, false);

So I suppose it need info about where the tests are found?

Using "run tests on" works (fails) as expected inside Android Studio

I am working here btw: https://github.com/capacitor-community/admob/tree/feat/saninn/add-test-devices__npa-flag

[distante]

Extra info, when I change the view to "project" in android studio, it has node_modules\@capacitor\android\capacitor\src\main\java\com\getcapacitor as root. No idea why.

Edit: Maybe it is related to the settings.gradle file?

include ':capacitor-android'
project(':capacitor-android').projectDir = new File('../node_modules/@capacitor/android/capacitor')

[distante]

I am still looking for an answer to this. Maybe somebody with better understanding of the Android configs can help me.

[hemangsk]

Hey @distante , Can you please share the output after running ./gradlew test on the terminal ? The screenshot you shared previously shows the build passing.. but for me, after the builds pass through, it shows the tests execution results.

[distante]

It returns @hemangsk :

Starting a Gradle Daemon (subsequent builds will be faster)

> Task :capacitor-android:compileReleaseJavaWithJavac
Note: Some input files use or override a deprecated API.
Note: Recompile with -Xlint:deprecation for details.

> Task :compileReleaseUnitTestJavaWithJavac
Note: C:\_SSD_DEV\capacitor\capacitor-admob\android\src\test\java\com\getcapacitor\community\admob\executors\AdRewardExecutorTest.java uses unchecked or unsafe operations.
Note: Recompile with -Xlint:unchecked for details.

BUILD SUCCESSFUL in 21s
56 actionable tasks: 41 executed, 15 up-to-date

running them from android gradlew task returns more info

09:32:56: Executing task 'test'...

Executing tasks: [test] in project C:\_SSD_DEV\capacitor\capacitor-admob\android

Starting Gradle Daemon...
Gradle Daemon started in 1 s 816 ms
> Task :preBuild UP-TO-DATE
> Task :preDebugBuild UP-TO-DATE
> Task :processDebugJavaRes NO-SOURCE
> Task :bundleLibResDebug UP-TO-DATE
> Task :capacitor-android:preBuild UP-TO-DATE
> Task :capacitor-android:preDebugBuild UP-TO-DATE
> Task :capacitor-android:compileDebugAidl NO-SOURCE
> Task :compileDebugAidl NO-SOURCE
> Task :capacitor-android:packageDebugRenderscript NO-SOURCE
> Task :generateDebugBuildConfig UP-TO-DATE
> Task :compileDebugRenderscript NO-SOURCE
> Task :generateDebugResValues UP-TO-DATE
> Task :generateDebugResources UP-TO-DATE
> Task :packageDebugResources UP-TO-DATE
> Task :parseDebugLocalResources UP-TO-DATE
> Task :processDebugManifest UP-TO-DATE
> Task :capacitor-android:generateDebugResValues UP-TO-DATE
> Task :capacitor-android:processDebugManifest UP-TO-DATE
> Task :capacitor-android:compileDebugRenderscript NO-SOURCE
> Task :capacitor-android:generateDebugResources UP-TO-DATE
> Task :capacitor-android:packageDebugResources UP-TO-DATE
> Task :capacitor-android:parseDebugLocalResources UP-TO-DATE
> Task :capacitor-android:generateDebugRFile UP-TO-DATE
> Task :generateDebugRFile UP-TO-DATE
> Task :capacitor-android:generateDebugBuildConfig UP-TO-DATE
> Task :capacitor-android:javaPreCompileDebug UP-TO-DATE
> Task :capacitor-android:compileDebugJavaWithJavac UP-TO-DATE
> Task :capacitor-android:bundleLibCompileDebug UP-TO-DATE
> Task :javaPreCompileDebug UP-TO-DATE
> Task :compileDebugJavaWithJavac UP-TO-DATE
> Task :preDebugUnitTestBuild UP-TO-DATE
> Task :processDebugUnitTestJavaRes NO-SOURCE
> Task :generateDebugUnitTestStubRFile UP-TO-DATE
> Task :javaPreCompileDebugUnitTest UP-TO-DATE
> Task :compileDebugUnitTestJavaWithJavac UP-TO-DATE
> Task :capacitor-android:processDebugJavaRes NO-SOURCE
> Task :capacitor-android:bundleLibResDebug UP-TO-DATE
> Task :capacitor-android:bundleLibRuntimeDebug UP-TO-DATE
> Task :testDebugUnitTest UP-TO-DATE
> Task :preReleaseBuild UP-TO-DATE
> Task :processReleaseJavaRes NO-SOURCE
> Task :bundleLibResRelease UP-TO-DATE
> Task :capacitor-android:preReleaseBuild UP-TO-DATE
> Task :capacitor-android:compileReleaseAidl NO-SOURCE
> Task :compileReleaseAidl NO-SOURCE
> Task :capacitor-android:packageReleaseRenderscript NO-SOURCE
> Task :compileReleaseRenderscript NO-SOURCE
> Task :generateReleaseBuildConfig UP-TO-DATE
> Task :generateReleaseResValues UP-TO-DATE
> Task :generateReleaseResources UP-TO-DATE
> Task :packageReleaseResources UP-TO-DATE
> Task :parseReleaseLocalResources UP-TO-DATE
> Task :processReleaseManifest UP-TO-DATE
> Task :capacitor-android:compileReleaseRenderscript NO-SOURCE
> Task :capacitor-android:generateReleaseResValues UP-TO-DATE
> Task :capacitor-android:generateReleaseResources UP-TO-DATE
> Task :capacitor-android:packageReleaseResources UP-TO-DATE
> Task :capacitor-android:parseReleaseLocalResources UP-TO-DATE
> Task :capacitor-android:processReleaseManifest UP-TO-DATE
> Task :capacitor-android:generateReleaseRFile UP-TO-DATE
> Task :generateReleaseRFile UP-TO-DATE
> Task :capacitor-android:generateReleaseBuildConfig UP-TO-DATE
> Task :capacitor-android:javaPreCompileRelease UP-TO-DATE
> Task :capacitor-android:compileReleaseJavaWithJavac UP-TO-DATE
> Task :capacitor-android:bundleLibCompileRelease UP-TO-DATE
> Task :javaPreCompileRelease UP-TO-DATE
> Task :compileReleaseJavaWithJavac UP-TO-DATE
> Task :preReleaseUnitTestBuild UP-TO-DATE
> Task :generateReleaseUnitTestStubRFile UP-TO-DATE
> Task :javaPreCompileReleaseUnitTest UP-TO-DATE
> Task :compileReleaseUnitTestJavaWithJavac UP-TO-DATE
> Task :processReleaseUnitTestJavaRes NO-SOURCE
> Task :capacitor-android:processReleaseJavaRes NO-SOURCE
> Task :capacitor-android:bundleLibResRelease UP-TO-DATE
> Task :capacitor-android:bundleLibRuntimeRelease UP-TO-DATE
> Task :testReleaseUnitTest UP-TO-DATE
> Task :test UP-TO-DATE
> Task :capacitor-android:preDebugUnitTestBuild UP-TO-DATE
> Task :capacitor-android:generateDebugUnitTestStubRFile UP-TO-DATE
> Task :capacitor-android:javaPreCompileDebugUnitTest UP-TO-DATE
> Task :capacitor-android:compileDebugUnitTestJavaWithJavac UP-TO-DATE
> Task :capacitor-android:processDebugUnitTestJavaRes NO-SOURCE
> Task :capacitor-android:testDebugUnitTest UP-TO-DATE
> Task :capacitor-android:preReleaseUnitTestBuild UP-TO-DATE
> Task :capacitor-android:generateReleaseUnitTestStubRFile UP-TO-DATE
> Task :capacitor-android:javaPreCompileReleaseUnitTest UP-TO-DATE
> Task :capacitor-android:compileReleaseUnitTestJavaWithJavac UP-TO-DATE
> Task :capacitor-android:processReleaseUnitTestJavaRes NO-SOURCE
> Task :capacitor-android:testReleaseUnitTest UP-TO-DATE
> Task :capacitor-android:test UP-TO-DATE

BUILD SUCCESSFUL in 9s
56 actionable tasks: 56 up-to-date
09:33:07: Task execution finished 'test'.

[hemangsk]

Hey @distante , Thanks for sharing the logs. I also tried gradlew test in CLI and was able to reproduce this same output. Its really strange why gradlew test doesn't identify those tests in AdMobTest file 🤔

BTW, I tried to add tests to a fresh plugin and gradlew test works there Action logs

Repo

[distante]

Mmmm, I am sure it is a configuration problem. Maybe the plugin template was changed after the AdMob repo was created (I do kot own it).

[distante]

Weird enough, I had created a new repo (with the cli) an gradlew test finds the tests in
com.getcapacitor but not in com.mydomain.mypackage.mysub.... I do not understand it.

[distante]

So!!! I finally understood why this was failing.

The problem was that my unit tests were using JUnit 5 and gradle did not understood how to read them (weirdly enough Android Studio does that just fine)

I had to add this at the top level of my build.gradle file:

tasks.withType(Test) {
    useJUnitPlatform()
}