Skip to content

Update README.md to include testing section #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
wkoszek merged 1 commit into from
Nov 24, 2025
Merged

Update README.md to include testing section #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,35 @@ This SDK is based on bsubio.io OpenAPI specification available at:

https://app.bsub.io/static/openapi.yaml

## Testing

The SDK includes a comprehensive test suite that supports two testing modes:

### Mock Tests (Default)

Run tests against an in-memory mock server (fast and deterministic):

```bash
go test -v -cover
```

### Production Tests

Run tests against the real bsub.io API to verify integration:

```bash
# Using environment variable
export BSUB_TEST_MODE=production
export BSUB_API_KEY=your_api_key_here
go test -v

# Or using config file (~/.config/bsubio/config.json)
export BSUB_TEST_MODE=production
go test -v
```

Production tests verify that the SDK works correctly with the actual API and are useful for catching API changes.

## License

MIT
Expand Down