Cosmos-sdk: Document how to use the mock module

Created on 19 Aug 2018  Â·  8Comments  Â·  Source: cosmos/cosmos-sdk

Summary

Write documentation on how to test a basecoin app or module using the mock module.

Problem Definition

We currently are using mock to test logic of several modules and examples, but there's no clear documentation on how to use it (besides looking at the code).

Proposal

Create documentation for developers in a Modules section to so they can also use mock to test their apps and extensions.


For Admin Use

  • [ ] Not duplicate issue
  • [ ] Appropriate labels applied
  • [ ] Appropriate contributors tagged
  • [ ] Contributor assigned/self-assigned
docs good first issue help wanted

All 8 comments

@fedekunze can you update the issue template data or remove it all together and just write a brief sentence of what and why needs to be done?

@alexanderbez updated !

Were going to breaking this several more times, doesn't seem worth prioritizing improving the docs here prelaunch. (Godocs excluded, I think we've done a fair job with the godocs here and should continue to do so)

@ValarDragon I disagree. There are developers working on top of the SDK and if we want to increase adoption we need to have this documentation ready

Good point. We do have a couple of prelaunch breaking changes planned that would mostly invalidate docs if they were written for the simulator's current state. I also think in purports of launching sooner, we can prioritize docs for these "extra" components more as we get more feature complete / right after launch. This would be fairly simple to document though, so if anyones free to do it, by all means go ahead!

ooh i would love to work on this next. very interested in learning how to test the sdk

Actually, I recall us talking about nuking the mock module to some extent. We should first discuss the mock module and how we'd like to use it in an ideal manner before we work on documentation.

My general thoughts are it should not be a module but rather another parent-level package. In addition, now that we've moved gaia out of the SDK and have a SimApp, there is probably a good deal of overlap and it may very well be the case we can just nuke mock and use the SimApp all together.

moved to #4875

Was this page helpful?
0 / 5 - 0 ratings