Skip to content

Commit ed90043

Browse files
francisffrancisf
authored
Merge pull request #4 from browserstack/sessions_with_offset
Offset functionality for fetching sessions. Addition of more Session fields.
2 parents dfa3adf + aff8d8e commit ed90043

File tree

8 files changed

+203
-39
lines changed

8 files changed

+203
-39
lines changed

‎pom.xml

+5-5
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<groupId>com.browserstack</groupId>
77
<artifactId>automate-client-java</artifactId>
88
<name>automate-client</name>
9-
<version>0.4</version>
9+
<version>0.5</version>
1010
<packaging>jar</packaging>
1111
<description>Java bindings for BrowserStack Automate REST API</description>
1212
<url>https://www.browserstack.com</url>
@@ -38,8 +38,8 @@
3838
<jackson.version>2.1.0</jackson.version>
3939
<junit.version>4.12</junit.version>
4040
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
41-
<maven.compiler.source>1.5</maven.compiler.source>
42-
<maven.compiler.target>1.5</maven.compiler.target>
41+
<maven.compiler.source>1.8</maven.compiler.source>
42+
<maven.compiler.target>1.8</maven.compiler.target>
4343
</properties>
4444

4545
<build>
@@ -49,8 +49,8 @@
4949
<artifactId>maven-compiler-plugin</artifactId>
5050
<version>3.5.1</version>
5151
<configuration>
52-
<source>1.5</source>
53-
<target>1.5</target>
52+
<source>1.8</source>
53+
<target>1.8</target>
5454
</configuration>
5555
</plugin>
5656
<plugin>

‎src/main/java/com/browserstack/appautomate/AppAutomateClient.java

+19-1
Original file line numberDiff line numberDiff line change
@@ -20,12 +20,14 @@
2020
import com.google.api.client.http.HttpMediaType;
2121
import com.google.api.client.http.MultipartContent;
2222

23+
import javax.annotation.Nonnull;
24+
2325
public class AppAutomateClient extends BrowserStackClient implements AppAutomate {
2426

2527
private static final String BASE_URL = "https://api-cloud.browserstack.com/app-automate";
2628

2729
public AppAutomateClient(String username, String accessKey) {
28-
super(BASE_URL, username, accessKey);
30+
super(System.getProperty("browserstack.app-automate.api", BASE_URL), username, accessKey);
2931
}
3032

3133
/**
@@ -171,6 +173,22 @@ public Build getBuild(final String buildId) throws BuildNotFound, AppAutomateExc
171173
}
172174
}
173175

176+
/**
177+
* Gets the build identified by the build name.
178+
*
179+
* @param buildName - Name of the build to search with
180+
* @return {@link Build} object.
181+
* @throws BuildNotFound
182+
* @throws AppAutomateException
183+
*/
184+
public final Build getBuildByName(@Nonnull final String buildName) throws BuildNotFound, AppAutomateException {
185+
try {
186+
return super.getBuildByName(buildName);
187+
} catch (BrowserStackException e) {
188+
throw new AppAutomateException(e);
189+
}
190+
}
191+
174192
/**
175193
* Delete the build identified by the build identifier.
176194
*

‎src/main/java/com/browserstack/automate/AutomateClient.java

+24-2
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,20 @@
1111
import com.browserstack.client.exception.BrowserStackObjectNotFound;
1212
import com.browserstack.client.model.Browser;
1313
import com.fasterxml.jackson.databind.node.ObjectNode;
14-
import java.util.*;
14+
15+
import javax.annotation.Nonnull;
16+
import java.util.ArrayList;
17+
import java.util.Arrays;
18+
import java.util.HashMap;
19+
import java.util.List;
20+
import java.util.Map;
1521

1622
/**
1723
* Access and manage information about your BrowserStack Automate tests.
1824
*/
1925
public final class AutomateClient extends BrowserStackClient implements Automate {
2026

21-
private static final String BASE_URL = "https://www.browserstack.com/automate";
27+
private static final String BASE_URL = "https://api.browserstack.com/automate";
2228
private static final String CACHE_KEY_BROWSERS = "browsers";
2329

2430
/**
@@ -234,6 +240,22 @@ public final Build getBuild(final String buildId) throws BuildNotFound, Automate
234240
}
235241
}
236242

243+
/**
244+
* Gets the build identified by the build name.
245+
*
246+
* @param buildName - Name of the build to search with
247+
* @return {@link Build} object.
248+
* @throws BuildNotFound
249+
* @throws AutomateException
250+
*/
251+
public final Build getBuildByName(@Nonnull final String buildName) throws BuildNotFound, AutomateException {
252+
try {
253+
return super.getBuildByName(buildName);
254+
} catch (BrowserStackException e) {
255+
throw new AutomateException(e);
256+
}
257+
}
258+
237259
/**
238260
* Delete the build identified by the build identifier.
239261
*

‎src/main/java/com/browserstack/automate/model/Session.java

+46
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,12 @@ public class Session extends BrowserStackObject {
5353
@JsonProperty("status")
5454
private String status;
5555

56+
@JsonProperty("browserstack_status")
57+
private String browserStackStatus;
58+
59+
@JsonProperty("created_at")
60+
private String createdAt;
61+
5662
@JsonProperty("reason")
5763
private String reason;
5864

@@ -244,6 +250,44 @@ private void setStatus(String status) {
244250
this.status = status;
245251
}
246252

253+
/**
254+
* BrowserStack status, i.e. non user marked status
255+
*
256+
* @return The browserStackStatus
257+
*/
258+
@JsonProperty("browserstack_status")
259+
public String getBrowserStackStatus() {
260+
return browserStackStatus;
261+
}
262+
263+
/**
264+
* @param status The browserStackStatus
265+
*/
266+
@JsonProperty("browserstack_status")
267+
public void setBrowserStackStatus(String status) {
268+
this.browserStackStatus = status;
269+
}
270+
271+
/**
272+
* Session creation date
273+
*
274+
* @return The createdAt
275+
*/
276+
@JsonProperty("created_at")
277+
public String getCreatedAt() {
278+
return createdAt;
279+
}
280+
281+
/**
282+
* Set session creation date
283+
*
284+
* @param createdAt Date type
285+
*/
286+
@JsonProperty("created_at")
287+
public void setCreatedAt(String createdAt) {
288+
this.createdAt = createdAt;
289+
}
290+
247291
/**
248292
* @return The browserVersion
249293
*/
@@ -380,6 +424,8 @@ private boolean copyFrom(Session s) {
380424
setDuration(s.getDuration());
381425
setLogUrl(s.getLogUrl());
382426
setStatus(s.getStatus());
427+
setBrowserStackStatus(s.getBrowserStackStatus());
428+
setCreatedAt(s.getCreatedAt());
383429
setReason(s.getReason());
384430
this.additionalProperties = s.getAdditionalProperties();
385431
return true;

‎src/main/java/com/browserstack/client/BrowserStackClient.java

+96-26
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,5 @@
11
package com.browserstack.client;
22

3-
import java.io.IOException;
4-
import java.io.InputStream;
5-
import java.io.Reader;
6-
import java.lang.reflect.Type;
7-
import java.nio.charset.Charset;
8-
import java.util.ArrayList;
9-
import java.util.Arrays;
10-
import java.util.List;
11-
import java.util.Map;
123
import com.browserstack.automate.Automate.BuildStatus;
134
import com.browserstack.automate.exception.BuildNotFound;
145
import com.browserstack.automate.exception.SessionNotFound;
@@ -34,6 +25,17 @@
3425
import com.google.api.client.http.javanet.NetHttpTransport;
3526
import com.google.api.client.util.ObjectParser;
3627

28+
import javax.annotation.Nonnull;
29+
import java.io.IOException;
30+
import java.io.InputStream;
31+
import java.io.Reader;
32+
import java.lang.reflect.Type;
33+
import java.nio.charset.Charset;
34+
import java.util.ArrayList;
35+
import java.util.Arrays;
36+
import java.util.List;
37+
import java.util.Map;
38+
3739
public abstract class BrowserStackClient implements BrowserStackClientInterface {
3840
private static final String BASE_URL = "https://www.browserstack.com";
3941
private static final String CACHE_KEY_PREFIX_BROWSERS = "browsers";
@@ -262,10 +264,11 @@ public enum Product {
262264
*
263265
* @param status Return only builds that match the specified build status.
264266
* @param limit Limit results to the specified count.
267+
* @param buildName build name to be searched with.
265268
* @return List of {@link Build} objects.
266269
* @throws BrowserStackException
267270
*/
268-
public List<Build> getBuilds(final BuildStatus status, final int limit)
271+
public List<Build> getBuilds(final BuildStatus status, final int limit, final String buildName)
269272
throws BrowserStackException {
270273
BrowserStackRequest httpRequest;
271274
try {
@@ -282,7 +285,11 @@ public List<Build> getBuilds(final BuildStatus status, final int limit)
282285
httpRequest.queryString(Constants.Filter.FILTER, status.name().toLowerCase());
283286
}
284287

285-
List<BuildNode> buildNodes;
288+
if (buildName != null && !buildName.isEmpty()) {
289+
httpRequest.queryString(Constants.Filter.BUILD_NAME, buildName);
290+
}
291+
292+
final List<BuildNode> buildNodes;
286293
try {
287294
buildNodes = Arrays.asList(httpRequest.asObject(BuildNode[].class));
288295
} catch (BrowserStackException e) {
@@ -299,6 +306,23 @@ public List<Build> getBuilds(final BuildStatus status, final int limit)
299306
return builds;
300307
}
301308

309+
/**
310+
* Gets the list of builds via build status and the count required
311+
*
312+
* <p>
313+
* A build is an organizational structure for tests.
314+
* </p>
315+
*
316+
* @param status Return only builds that match the specified build status.
317+
* @param limit Limit results to the specified count.
318+
* @return List of {@link Build} objects.
319+
* @throws BrowserStackException
320+
*/
321+
public List<Build> getBuilds(final BuildStatus status, final int limit)
322+
throws BrowserStackException {
323+
return getBuilds(status, limit, null);
324+
}
325+
302326
/**
303327
* Gets the list of builds.
304328
*
@@ -368,6 +392,26 @@ public Build getBuild(final String buildId) throws BuildNotFound, BrowserStackEx
368392
}
369393
}
370394

395+
/**
396+
* Gets the build identified using the build name.
397+
*
398+
* @param buildName Name of the build which will be used for searching
399+
* @return {@link Build} object
400+
* @throws BuildNotFound
401+
* @throws BrowserStackException
402+
*/
403+
public Build getBuildByName(@Nonnull final String buildName) throws BuildNotFound, BrowserStackException {
404+
try {
405+
final List<Build> build = getBuilds(null, 1, buildName);
406+
if (build.size() == 1) {
407+
return build.get(0);
408+
}
409+
throw new BuildNotFound("Build not found by name: " + buildName);
410+
} catch (BrowserStackException e) {
411+
throw e;
412+
}
413+
}
414+
371415
/**
372416
* Delete the build identified by the build identifier.
373417
*
@@ -389,6 +433,7 @@ public boolean deleteBuild(final String buildId) throws BrowserStackException {
389433

390434
/**
391435
* Retrieves the list of sessions existing under a specific build.
436+
* If no limit is specified, all the sessions will be fetched from that build
392437
*
393438
* @param buildId ID that uniquely identifies a build.
394439
* @param status Include only builds that match the specified build status.
@@ -400,39 +445,64 @@ public boolean deleteBuild(final String buildId) throws BrowserStackException {
400445
public List<Session> getSessions(final String buildId, final BuildStatus status, final int limit)
401446
throws BuildNotFound, BrowserStackException {
402447

403-
BrowserStackRequest httpRequest = null;
448+
// validation of the limit field. Default will be set to 1000 if 0 is provided
449+
final int totalLimit =
450+
(limit <= 0 || limit > Constants.Filter.MAX_SESSIONS)
451+
? Constants.Filter.MAX_SESSIONS
452+
: limit;
453+
int totalRequests = totalLimit/Constants.Filter.MAX_LIMIT;
454+
455+
// An extra request to fetch the remainder sessions
456+
if ((totalLimit % Constants.Filter.MAX_LIMIT) > 0) {
457+
totalRequests++;
458+
}
459+
460+
final List <Session> sessions = new ArrayList<Session>();
461+
462+
// currReq will act as offset to fetch all* sessions from the build
463+
for (int currReq = 0; currReq < totalRequests; currReq++) {
464+
final List<SessionNode> sessionNodes = getSessionNodes(buildId, status, totalLimit, currReq * Constants.Filter.MAX_LIMIT);
465+
466+
for (SessionNode sessionNode : sessionNodes) {
467+
if (sessionNode != null && sessionNode.getSession() != null) {
468+
sessions.add(sessionNode.getSession().<Session>setClient(this));
469+
}
470+
}
471+
472+
// break the loop since there are no more sessions left to fetch
473+
if (sessionNodes.size() < Constants.Filter.MAX_LIMIT) {
474+
break;
475+
}
476+
}
477+
478+
return sessions;
479+
}
480+
481+
private List<SessionNode> getSessionNodes(String buildId, BuildStatus status, int totalLimit, int offset) throws BrowserStackException {
482+
BrowserStackRequest httpRequest;
404483
try {
405484
httpRequest =
406-
newRequest(Method.GET, "/builds/{buildId}/sessions.json").routeParam("buildId", buildId);
485+
newRequest(Method.GET, "/builds/{buildId}/sessions.json").routeParam("buildId", buildId);
407486
} catch (BrowserStackException e) {
408487
throw e;
409488
}
410489

411-
if (limit > 0) {
412-
httpRequest.queryString(Constants.Filter.LIMIT, limit);
413-
}
490+
httpRequest.queryString(Constants.Filter.LIMIT, totalLimit);
491+
httpRequest.queryString(Constants.Filter.OFFSET, offset);
414492

415493
if (status != null) {
416494
httpRequest.queryString(Constants.Filter.FILTER, status);
417495
}
418496

419-
List<SessionNode> sessionNodes;
497+
final List<SessionNode> sessionNodes;
420498
try {
421499
sessionNodes = Arrays.asList(httpRequest.asObject(SessionNode[].class));
422500
} catch (BrowserStackObjectNotFound e) {
423501
throw new BuildNotFound("Build not found: " + buildId);
424502
} catch (BrowserStackException e) {
425503
throw e;
426504
}
427-
428-
List<Session> sessions = new ArrayList<Session>();
429-
for (SessionNode sessionNode : sessionNodes) {
430-
if (sessionNode != null && sessionNode.getSession() != null) {
431-
sessions.add(sessionNode.getSession().<Session>setClient(this));
432-
}
433-
}
434-
435-
return sessions;
505+
return sessionNodes;
436506
}
437507

438508
/**

‎src/main/java/com/browserstack/client/BrowserStackClientInterface.java

+4
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ public interface BrowserStackClientInterface {
1212

1313
public Session getSession(String sessionId) throws SessionNotFound, BrowserStackException;
1414

15+
List<Build> getBuilds(BuildStatus status, int limit, String buildName) throws BrowserStackException;
16+
1517
List<Build> getBuilds(BuildStatus status, int limit) throws BrowserStackException;
1618

1719
List<Build> getBuilds(int limit) throws BrowserStackException;
@@ -22,6 +24,8 @@ public interface BrowserStackClientInterface {
2224

2325
Build getBuild(String buildId) throws BuildNotFound, BrowserStackException;
2426

27+
Build getBuildByName(String buildName) throws BuildNotFound, BrowserStackException;
28+
2529
boolean deleteBuild(String buildId) throws BrowserStackException;
2630

2731
List<Session> getSessions(String buildId, BuildStatus status, int limit)

0 commit comments

Comments
 (0)