Skip to content

Commit

Permalink
docs(Contributing): add sandbox test acct details (#240)
Browse files Browse the repository at this point in the history
Added a bit more guidance on how to run the integration tests locally.
  • Loading branch information
adamweeks authored Aug 27, 2024
2 parents 470225f + c0cc333 commit 5d29998
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,11 @@ See the project's `Makefile` targets for a list of common developer tasks, which
Notes on the Test Suite
-----------------------

To test all the API endpoints, the account that you use for testing must be an *admin* user for your Webex Organization. Additionally, you should know that that the testing process creates some test people, rooms, messages, teams, and etc. as part of executing the test suite. We strongly recommend *NOT* running the test suite using your personal Webex account (not that you can't; it's just that you probably don't want it cluttering your account with all these test artifacts).
To test all the API endpoints, the account that you use for testing must be an *admin* and *compliance officer* user for your Webex Organization. Additionally, you should know that that the testing process creates some test people, rooms, messages, teams, and etc. as part of executing the test suite.

We strongly recommend *NOT* running the test suite using your personal Webex account (not that you can't; it's just that you probably don't want it cluttering your account with all these test artifacts).

Webex now offers a free developer sandbox organization that you can use for testing purposes. You can request the sandbox at https://developer.webex.com/docs/developer-sandbox-guide. Once you have your sandbox organization, you can create a test account with *admin* and *compliance officer* privileges via [Webex Control Hub](https://admin.webex.com) and use that account for testing. (Be sure to login to Control Hub with the new admin so that the roles are assigned properly to the Webex token.)

If you cannot create a test account with *admin* privileges or configure your environment to run the test suite locally, you may always submit your code via a pull request. We will test your code before merging and releasing the changes.

Expand Down

0 comments on commit 5d29998

Please sign in to comment.