New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add Testing Guide #32
Conversation
very nice, however we need to think about how to include it in the actual web-site doc, here is a preview : http://www.julienviet.com/vertx-3.5.0/docs/ |
Appears that all the docs on the Vert.x website are connected to a library. In order to convert the guide to website documentation it would need to be connected to a library. Would make sense to create a new library called vertx-kotlintest that is managed in the vertx-lang-kotlin repository. |
@napperley I think we should rather shoot a guide and make this in its own repo and link the web site to this repo and keep things simple without a deploy process. |
something like : vertx-guide-for-kotlin-devs |
Do you have in mind a Kotlin Test example (using Vert.x)? Would be a idea to have a new repository in vertx-examples called kotlintest-example. That way nothing special has to be done for deployment, especially on the Vert.x website, and other Kotliner's can learn about Vert.x testing by example :). |
@napperley yes |
you can contribute examples on this branch https://github.com/vert-x3/vertx-examples/tree/3.5.0-staging . in this same branch I shall contribute soon coroutine example |
@napperley I've flushed the coroutines example and the kotlin example reorg : https://github.com/vert-x3/vertx-examples/tree/3.5.0-staging/kotlin-examples/ so you could make a project for testing best practices in this directory along with web and coroutines |
In the process of setting up a new directory (Gradle project via Gradle Kotlin DSL) in kotlin-examples. Going to be a bit of a delay setting up the project since IntelliJ only recognises the Maven projects. Gradle works fine via the terminal which is a bit annoying since there is some context switching involved. |
some projects in vertx-examples use gradle, so you don't need to contribute with gradle, for instance kotlin-examples/web uses it. the coroutines use maven because I'm used to it, however I wouldn't mind it uses gradle |
@napperley how are you going to contribute this ? as an example or as a guide ? |
@vietj - As an example. Refer to this PR: vert-x3/vertx-examples#236 |
Kotliners (Kotlin developers) using Vert.x don't have a clear way to do testing. The new testing guide provides guidance on how to test Vert.x code that is Kotlinic (idiomatic Kotlin). Currently the guide is a draft version and hasn't been converted to AsciiDoc. More important to ensure that the approach for the guide is correct before getting the formatting right.