Make an internal function visible for unit tests

31.6k views Asked by At

In case the tests are in a different module than the production code (which is common), what's the best way to make internal functions visible for tests?

In Java, I would have the production code and the test in the same package and make the methods-to-be-tested package-private (plus, add a @VisibleForTest annotation if the only reason for having it package-private rather than private is the test). Unfortunately, Kotlin doesn't have the concept of package-private.

3

There are 3 answers

8
Jayson Minard On BEST ANSWER

Classes and methods marked with internal access modifier will work from within current versions of Kotlin, Gradle and also Intellij for accessing those methods from test classes. The tools consider the main and test source paths as part of the same module.

Did you try this already? And if it failed you should report a bug since this was already reported, fixed and should be fine in any current version.

0
Franklin Wang On

In my case it didn't work because we renamed our projects inside settings.gradle to add a prefix and Kotlin didn't seem to like that.

Once we removed the lines renaming the projects, we were able to see internal members from main/ inside test/.

0
hotkey On

Probably the easiest solution is to place your unit tests depending on internal code in the same module with the production сode and leave only the integration tests, which use public API, in the separate module.

This seems reasonable since the internal modifier means exactly the visibility inside the same module.