Skip to content
This repository has been archived by the owner on Jul 19, 2024. It is now read-only.

Commit

Permalink
Update README for integration testing.
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewrankin committed Aug 24, 2022
1 parent fd59aa0 commit a2d712c
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 2 deletions.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ Contributions are welcome! To contribute please:
Prior to submitting a [pull request][], please run:

```bash
$ make check
$ make check # formats, vets, and unit tests the code
$ make lint # lints code using staticcheck
```

To update and view the test coverage report:
Expand All @@ -52,6 +53,28 @@ To update and view the test coverage report:
$ make cover
```

#### Integration Testing

To perform the integration tests run:

```bash
$ make int
```

Prior to doing so, you'll need to create a `config_test.toml` file with your IEX
Cloud API Token and the base URL. It is recommended to use your sandbox token
and the sandbox URL, so as to not be charged credits when running the
integration tests. Sandbox tokens start with `Tpk_` instead of `pk_` for
non-sandbox tokens. Using the sandbox does make integration a little more
difficult, since results are scrambled in sandbox mode.

Example `config_test.toml` file:

```toml
Token = "Tpk_your_iexcloud_test_token"
BaseURL = "https://sandbox.iexapis.com/v1"
```

## License

[iexcloud][] is released under the MIT license. Please see the
Expand Down
2 changes: 1 addition & 1 deletion premiumdata.go
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// Copyright (c) 2019-2020 The iexcloud developers. All rights reserved.
// Copyright (c) 2019-2022 The iexcloud developers. All rights reserved.
// Project site: https://github.com/goinvest/iexcloud
// Use of this source code is governed by a MIT-style license that
// can be found in the LICENSE file for the project.
Expand Down

0 comments on commit a2d712c

Please sign in to comment.