Adding docs and ready for 1.0.0

Signed-off-by: Kris Nóva <kris@nivenly.com>
This commit is contained in:
Kris Nóva 2021-02-11 18:04:53 -08:00
parent c78e3d199e
commit 94dde03103
63 changed files with 394 additions and 5616 deletions

View file

@ -1,7 +1,39 @@
# Local Integration Tests
To run the tests
To run the tests.
```bash
sudo -E go test . -v
```
### Adding a test
To add a test please try to have both `Happy` and `Sad` tests defined for all new SDK methods.
Example test:
#####mymethod_test.go
```go
// TestHappyMethod will test my new method
func TestHappyMethod(t *testing.T) {
params := "my good input"
_, err := Client.V1().Method(params)
if err != nil {
t.Errorf("expected success running method: %v", err)
t.FailNow()
}
}
// TestSadMethod will false positive test my new method
func TestHappyMethod(t *testing.T) {
params := "my bad input"
_, err := Client.V1().Method(params)
if err == nil {
t.Errorf("expected failure running method: %v", err)
t.FailNow()
}
}
```