Skip to content

Commit c92ae7f

Browse files
committed
[chore] Few docs about ITs
1 parent d80090b commit c92ae7f

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

CONTRIBUTING.adoc

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,3 +166,21 @@ public void setWidgetCount(int widgetCount) {
166166
**** import all other imports
167167
**** blank line
168168
**** import static all other imports
169+
170+
== Integration Tests
171+
172+
This library has a set of integration tests in the class `src/test/java/org/zendesk/client/v2/RealSmokeTest.java`. These tests are used to validate the API calls with a real Zendesk instance. The project never got access to a specific sandbox provided by @zendesk thus we are using the sandbox used by CloudBees.
173+
174+
Some of these tests are sadly relying on some specific data of this instance (ex: https://github.com/cloudbees-oss/zendesk-java-client/blob/master/src/test/java/org/zendesk/client/v2/RealSmokeTest.java#L102-L103) and thus you cannot expect to execute all of them in a different instance.
175+
176+
To execute these tests you have to pass several settings in the file `src/test/resources/zendesk.properties`:
177+
178+
```
179+
url=#A ZENDESK SANDBOX URL#
180+
username=#A EMAIL OF AN ACCOUNT HAVING ACCESS TO THE INSTANCE#
181+
password=#THE PASSWORD OF THE ACCOUNT#
182+
token=#A TOKEN TO ACCESS TO THE INSTANCE#
183+
requester.email=#A EMAIL - can be like username - TO CREATE THE REPORTER#
184+
requester.name=#A NAME FOR THE REPORTER#
185+
```
186+

0 commit comments

Comments
 (0)