Document and test CouchDB module

enseadaio / enseada

A Cloud native multi-package registry

https://enseada.io

Mozilla Public License 2.0

85 stars 10 forks source link

Document and test CouchDB module #46

Open MatteoJoliveau opened 3 years ago

MatteoJoliveau commented 3 years ago

Since we are approaching the first usable release we should start to pour more effort into documenting and cleaning up the codebase. One of the simplest modules to start is the CouchDB client.

TODO

[ ] add integration tests for methods that interact with CouchDB. We can use the mockito library to mock the CouchDB API and provide assertions
[ ] add documentation comments on every public type, function and method
[ ] cleanup any Clippy warnings. This can be tested by running cargo clippy in the couchdb directory

MarcoIeni commented 3 years ago

I will work on this :)

MarcoIeni commented 3 years ago

Hi Matteo, I am really sorry but I didn't have a lot of fun while working on this, so at the moment I prefer to work on some other projects. Again, sorry! 😅

I removed the assignment in case someone else wants to work on this issue.

As a side note I leave you with a thought of mine: instead of mocking the CouchDB API wouldn't it be better to launch a local couchdb instance (for example with docker) and test the client against it? I see two main benefits by doing so:

enseada doesn't have to reproduce couchdb logic, so less code is required
tests will be more reliable, since mocks could contain errors

MatteoJoliveau commented 3 years ago

No worries @MarcoIeni, totally understandable!

I personally prefere to have unit tests not depend on external network targets, but it's true that mocking is hard to do right. I'll consider your suggestion when I'll get around this task :)

MatteoJoliveau commented 3 years ago

I'm sorry you didn't have fun, is there something specifically that can be improved in order to make the codebase more pleasant to work with?

MarcoIeni commented 3 years ago

I think that for me the problem was adding tests and documentation to an already existing code base. Maybe if I had to develop (and document and test of course) a new functionality it would have been better. Anyway I will keep an eye on this nice project for the future :)