Test Kotlin API #637
Merged
Test Kotlin API #637
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We are going to write Kotlin in JavaThemis to avoid adding new run-time dependencies. Kotlin has great interop with Java due to this JVM thingie. However, it will be nice to test our Java code with Kotlin to ensure that our API works as intended. Use the current latest stable version of Kotlin, configuruable via the "kotlin_version" variable defined in the root project. There we also add Maven Central repos where Kotlin pluggin and runtime are hosted. Each subproject has Kotlin configured for it, even BoringSSL that does not have any Kotlin code, but must have relevant targets as a dependency. Note that desktop Java and Android use different plugin because Kotlin compiles a little bit different on Android. Kotlin runtime is required to run Kotlin code. Since we use Kotlin only for tests, the runtime is added as test dependency. We build our code for Java 1.7 so an appropriate runtime flavor is used. Adding Kotlin also triggers a weird compilation error in Android's DEX compiler as Kotlin runtime uses a lot of JetBrains annotations. This is a known issue encountered by some project, and there is a workaround.
Add test suite written in Kotlin. This code has been automatically converted by IntelliJ from Java test suite and cleaned up manually after that. One painful point is exception testing, the try-catch idiom from Java looks really awful in Kotlin so I've simply polyfilled assertThrows() method which is not available with Java 1.7. Kotlin can translate its lambdas into Runnables so it works pretty well.
Note that Java 8 support is now required since Kotlin compiler needs it.
ilammy
added
O-Android 🤖
vixentael
approved these changes
May 12, 2020
No, no changes are necessary. It is possible to import the current code and it will just work. Gradle will also pick up any new Kotlin files automatically and will test them, both for desktop systems and for Android. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
From now on we officially™ support Kotlin API of JavaThemis on Android and desktop JVM.
It was possible to use JavaThemis via Kotlin before but we were not sure in the API we provided and we not guaranteeing its stability. Now we do.
User notes
API stability and maturity
All existing Kotlin API is now considered stable. That is, we will do our best to avoid breaking it and if there is a need to deprecate some parts of Kotlin API, you will be notified about that.
SecureCellAPIs are considered mature for Kotlin. That is, we are happy with this API in Kotlin and will not update it unless absolutely necessary.As of JavaThemis 0.13, other APIs are not yet mature for Kotlin. We will not break these APIs, but you might expect some new, improved APIs to appear and some APIs to be deprecated in later releases, until Kotlin API has stabilized and matured.
Java 1.7 is minimum target for apps, Java 1.8 is needed for compilation
The minimum target for applications using JavaThemis or AndroidThemis is still Java 1.7.
If you get JavaThemis from Maven, you can still use Java 1.7 to compile your applications.
However, JavaThemis now requires Java 1.8 or later for compilation from source. This is the requirement of Kotlin compiler.
Technical notes
We are using the latest current version of Kotlin: 1.3.72. Kotlin is used only for tests. JavaThemis does not and will not require Kotlin at runtime for applications.
Since Kotlin supports lambdas out of the box, a polyfill for
org.junit.Assert#assertThrowsis added. It makes exception testing much more readable.The tests themselves were automatically converted from Java code by IntelliJ, they are basically the same. Though, they did require some manual cleanup after that.
We currently test only
SecureCellin Kotlin. Other cryptosystems will require additional review which is out of scope for Themis 0.13. We will get back to them in next releases.Checklist
Benchmark results are attached(nope, not right now)Example projects and code samples are up-to-date(we don't have Kotlin examples, maybe later)