dsrvlabs / vatz

Node management integration tools in purpose of maximizing node's uptime for any protocols
https://www.dsrvlabs.com/
GNU General Public License v3.0
30 stars 15 forks source link

Create `How to create a unit test and implements with github action` documents #119

Closed kim201212 closed 11 months ago

kim201212 commented 2 years ago

Checklist

Please describe, what it's about or related Problem with

A clear description of what feature need to be developed or enhanced in Vatz

=> We haven't decided how to do the unit test.

Describe the output that you are expecting for above

A clear and concise description of what you expect to happen.

=> If possible, make unit test possible on vatz-plugin.

Describe alternatives you've considered

A clear and concise description of any alternative solutions or features you've considered.

=> Document what code makes it possible.

Additional context

Add any other context or screenshots about the feature request here.

xellos00 commented 2 years ago

@kim201212 There are two requirements for this issue prior to create the documents on gitbook. Please, ping me if you need further discussion for following items.

  1. Develop sample unit test for each module's function in interface

    which registered issue

    • 85

Ex) HealthCheck module image

  1. Create a CI/CD to do unit-test through github action when PR has requested.

    Unit Test must passed when PR request or before release.
    I didn't ask this previously, because when you finish first item, I will ask this item as well after.

I think it is good to start with #85 and #120 on Sprint 9 if you don't mind.