Add example with dao tests #1

tonilopezmr · 2018-08-03T12:43:42Z

📝 Notes

This project is based on H2 Testing Play Framework repository with more behavior to show a Play Framework example with tests running in Kotlin.
I have used Java Play Framework ecosystem instead of Scala described in this blogspot
This is an example code with some invented behavior if you think I can add something more behavior or add more features, write it here.
~~The new version of kotlin-plugin for sbt it's not released then I need to use a local release snapshot 1.0.9-SNAPSHOT.~~ Right now has been released the 1.0.9 version.

🎩 What is the goal?

Show an example code in Play Framework using sbt in kotlin.
Uses the new version of kotlin-plugin for sbt we implemented here Fix kotlin tests pfn/kotlin-plugin#24 to run kotlin tests.
Show running test in kotlin with sbt
Database tests using H2
End to End tests using H2
Uses karumi/ktlint-sbt plugin

📝 How is it being implemented?

Download the code of kotlin-plugin for sbt and run sbt scripted to add in the last version 1.0.9-SNAPSHOT to the local ivy cache, after that, we can run tests in kotlin with sbt and use kotlin in play framework. Just add the kotlin-plugin with the 1.0.9 version.
Add GET /developer/:developerId endpoint to get a developer by id
Add POST /developer endpoint to create a new karumi developer given the json body:

{
 "username": "unkown",
 "email@karumi.com"
}

It's a valid karumi developer if it has an karumi email.

It uses postgresql v9.6 in production, to run in local you need to run the following docker command: docker-compose up -d.
It uses an H2 database to run the tests, to reset the database I use ApplicationWithDatabase parent class in the tests which want to use the H2 database.

💥 How can it be tested?

Run sbt test

pedrovgs

Nice PR @tonilopezmr congrats! 🎉 🎉 I've added some comments I'd like to review with you before merging this PR 😃

pedrovgs · 2018-08-03T12:57:31Z

README.md

+1. Clone or download in your machine [kotlin-plugin][ktlint-plugin]
+2. Run `sbt scripted`. This will release locally the `1.0.9-SNAPSHOT` version in your local `ivy cache`.
+3. Add the kotlin plugin in `project/plugins.sbt` with the given version. `addSbtPlugin("com.hanhuy.sbt" % "kotlin-plugin" % "1.0.9-SNAPSHOT")` 
+


Why don't you use the snapshots repository? https://www.scala-sbt.org/1.x/docs/Resolvers.html

That version isn't be released, then you need to publish locally. I'm going to explain it in the README 👍

pedrovgs · 2018-08-03T13:00:54Z

app/controllers/Application.kt

+    }
+  }
+
+  fun processError(error: Throwable): Result = badRequest()


You should not return bad request if you catch an exception. You can return a 5xx error instead.

pedrovgs · 2018-08-03T13:01:57Z

app/controllers/Application.kt

+
+  fun processError(error: Throwable): Result = badRequest()
+  fun created(developer: Developer): Result = created(developer.toJson())
+  fun ok(developer: Developer): Result = ok(developer.toJson())


Every function in this file but the controller methods associated to the routes should be private.

Yes that's right

pedrovgs · 2018-08-03T13:03:38Z

app/developers/domain/KarumiDeveloperValidator.kt

+    private const val KARUMI_EMAIL = "@karumi.com"
+  }
+
+  fun isKarumiDeveloper(developer: Developer): Boolean =


As this is a single function class you'll never mock I'd implement this as an object with a public method or a an invoke operator.

I will never 👍

pedrovgs · 2018-08-03T13:04:39Z

app/developers/domain/usecase/CreateKarumiDeveloper.kt

+  private val developerValidator: KarumiDeveloperValidator
+) {
+
+  operator fun invoke(developer: Developer): Developer? =


Nice usage of the invoke operator 😃

pedrovgs · 2018-08-03T13:12:15Z

test/utils/ApplicationWithDatabase.kt

+  fun givenANewKarumiDev(): NewDeveloperJson = NewDeveloperJson(
+    username = "Unknown",
+    email = "email@karumi.com"
+  )


I'd move these methods to a mother object file.

Yes, I will use a technique we use in our internal projects, an interface with the given methods with a default implementation to use kotlin delegates 👍

I have used the kotlin delegates to provide the objects in this commit to fix this comment, We use in our projects to create stubs of our objects with mockito and add it to the injector.

pedrovgs · 2018-08-03T13:13:32Z

test/controllers/ApplicationTest.kt

+      .bodyJson(newDeveloper.toJson()))
+
+    val createdDeveloper = result.asObject(Developer::class)
+    val developer = Developer(createdDeveloper.id, newDeveloper.username, newDeveloper.email)


Do you really need this line? Can't you use newDeveloper?

The POST json body is:

{ "username": "unkown", "email@karumi.com" }

Then doesn't have any id field, if I compare a new developer to the developer just I have created then they are going to be different because the new developer doesn't have the id.

Reviewing the test, I think I can assert the username and the email of the createdDeveloper with the newDeveloper and assert the obtainedDeveloper got by id with the createdDeveloper (which these two has the same id).

What do you think? I'm going to write it and push it.

I have changed it 47895ed

pedrovgs · 2018-08-03T13:15:51Z

test/controllers/ApplicationTest.kt

+
+  data class InvalidJson(val invalid: String = "")
+  fun getById(id: UUID) = dao.getById(id)
+  fun create(developer: Developer) = dao.create(developer)


This should be private.

pedrovgs · 2018-08-03T13:16:33Z

test/controllers/ApplicationTest.kt

+  @Test
+  fun `developer POST should returns 400 if the json is bad formed`() {
+    val result = route(app, fakeRequest("POST", "/developer")
+      .bodyJson(InvalidJson().toJson()))


This is not a bad formed JSON body. This is actually a valid JSON body. I guess you mean you are going to send a request using a not expected JSON body.

yes it is, I was wrong

pedrovgs · 2018-08-03T13:17:22Z

test/developers/DeveloperDaoTest.kt

+import org.junit.Test
+import utils.ApplicationWithDatabase
+
+class DeveloperDaoTest : ApplicationWithDatabase() {


If you are not mocking the dao as part of the previous controller tests, aren't you testing the same twice?

The only difference I see is (apart from the scope of the tests) is that here you test the update process too.

Yes, that's right. I started to write this tests then I moved to write the application test, I can remove the create developer and get by id developer tests.

I want to keep this test file here to show how to test only the DAO part.

tonilopezmr · 2018-08-03T15:53:52Z

Thanks @pedrovgs I have changed your suggestions

pedrovgs

👍 ready to merge @tonilopezmr Really nice PR 👏

tonilopezmr added 5 commits August 3, 2018 13:44

Add example based on Peddros blogspot about database testing

7a203f4

Fix compilation test

94f0bdc

Addebehaviour to the ddomain

ee02384

Merge branch 'master' into add-example-with-dato-tests

330da6d

Merge branch 'master' into add-example-with-dato-tests

cea8846

tonilopezmr requested review from flipper83, Serchinastico, pedrovgs and a team August 3, 2018 12:43

tonilopezmr added 2 commits August 3, 2018 14:46

erge branch 'master' into add-example-with-dato-tests

9dcb950

Update readme

a45e6df

pedrovgs suggested changes Aug 3, 2018

View reviewed changes

tonilopezmr added 7 commits August 3, 2018 15:54

Private methods

6b12d33

Developer validator to object with isKarumiDeveloper method

3f5ed1a

Remove drop table migration

f29836f

Use GivenDeveloper delegate

46a5f04

Refactor ApplicationTest

12fdc4a

Refactor test

47895ed

Remove duplicated dao test

f97b7ce

tonilopezmr added 2 commits August 4, 2018 02:21

Update README with the new ktlint-plugin release 1.0.9

e767b87

Add limitation section

30ca557

tonilopezmr changed the title ~~Add example with dato tests~~ Add example with dao tests Aug 10, 2018

pedrovgs approved these changes Aug 13, 2018

View reviewed changes

Serchinastico approved these changes Aug 20, 2018

View reviewed changes

tonilopezmr merged commit 95cbfc7 into master Aug 22, 2018

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add example with dao tests #1

Add example with dao tests #1

tonilopezmr commented Aug 3, 2018 •

edited

pedrovgs left a comment

pedrovgs Aug 3, 2018

tonilopezmr Aug 3, 2018

pedrovgs Aug 3, 2018

pedrovgs Aug 3, 2018

tonilopezmr Aug 3, 2018

pedrovgs Aug 3, 2018

tonilopezmr Aug 3, 2018

pedrovgs Aug 3, 2018

pedrovgs Aug 3, 2018

tonilopezmr Aug 3, 2018

tonilopezmr Aug 3, 2018 •

edited

pedrovgs Aug 13, 2018

pedrovgs Aug 3, 2018

tonilopezmr Aug 3, 2018

tonilopezmr Aug 3, 2018 •

edited

pedrovgs Aug 3, 2018

pedrovgs Aug 3, 2018

tonilopezmr Aug 3, 2018

pedrovgs Aug 3, 2018

pedrovgs Aug 3, 2018

tonilopezmr Aug 3, 2018

tonilopezmr Aug 3, 2018

tonilopezmr commented Aug 3, 2018

pedrovgs left a comment

Add example with dao tests #1

Add example with dao tests #1

Conversation

tonilopezmr commented Aug 3, 2018 • edited

📝 Notes

🎩 What is the goal?

📝 How is it being implemented?

💥 How can it be tested?

pedrovgs left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tonilopezmr Aug 3, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tonilopezmr Aug 3, 2018 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tonilopezmr commented Aug 3, 2018

pedrovgs left a comment

Choose a reason for hiding this comment

tonilopezmr commented Aug 3, 2018 •

edited

tonilopezmr Aug 3, 2018 •

edited

tonilopezmr Aug 3, 2018 •

edited