Skip to content

Commit c216ed3

Browse files
JonahssJonahss
committed
add getNetworkConnection() and setNetworkConnection(). fixes appium#55 
1 parent 1bcf2ad commit c216ed3

4 files changed

Lines changed: 137 additions & 1 deletion

File tree

‎src/main/java/io/appium/java_client/AppiumDriver.java‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,8 @@ public AppiumDriver(URL remoteAddress, Capabilities desiredCapabilities){
7171
.put(SHAKE, postC("/session/:sessionId/appium/device/shake"))
7272
.put(COMPLEX_FIND, postC("/session/:sessionId/appium/app/complex_find"))
7373
.put(OPEN_NOTIFICATIONS, postC("/session/:sessionId/appium/device/open_notifications"))
74+
.put(GET_NETWORK_CONNECTION, getC("/session/:sessionId/network_connection"))
75+
.put(SET_NETWORK_CONNECTION, postC("/session/:sessionId/network_connection"))
7476
;
7577
ImmutableMap<String, CommandInfo> mobileCommands = builder.build();
7678

@@ -515,6 +517,36 @@ public MobileElement scrollToExact(String text) {
515517
return complexFind.scrollToExact(text);
516518
}
517519

520+
/**
521+
* Get the current network settings of the device.
522+
* This is an Android-only method
523+
*
524+
* @return NetworkConnectionSetting objects will let you inspect the status of AirplaneMode, Wifi, Data connections
525+
*/
526+
public NetworkConnectionSetting getNetworkConnection() {
527+
Response response = execute(GET_NETWORK_CONNECTION);
528+
529+
return new NetworkConnectionSetting(Integer.parseInt(response.getValue().toString()));
530+
}
531+
532+
/**
533+
* Set the network connection of the device.
534+
* This is an Android-only method
535+
*
536+
* @param connection The NetworkConnectionSetting configuration to use for the device
537+
*/
538+
public void setNetworkConnection(NetworkConnectionSetting connection) {
539+
// the new version of the webdriver protocol is going forward with sending JSON message which look like
540+
// {name: "name of endpoint", parameters: "JSON parameters"}
541+
// this is for webdrivers which run on protocols besides HTTP (like TCP)
542+
// we're implementing that pattern here, for this new method, but haven't translated it to all other commands yet
543+
ImmutableMap.Builder builder = ImmutableMap.builder();
544+
builder.put("name", "network_connection")
545+
.put("parameters", ImmutableMap.of("type", connection.value));
546+
547+
execute(SET_NETWORK_CONNECTION, builder.build());
548+
}
549+
518550
@Override
519551
public WebDriver context(String name) {
520552
if (name == null) {

‎src/main/java/io/appium/java_client/MobileCommand.java‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ public interface MobileCommand {
4646
String SHAKE = "shake";
4747
String COMPLEX_FIND = "complexFind";
4848
String OPEN_NOTIFICATIONS = "openNotifications";
49-
49+
String GET_NETWORK_CONNECTION = "getNetworkConnection";
50+
String SET_NETWORK_CONNECTION = "setNetworkConnection";
5051

5152
}

‎src/main/java/io/appium/java_client/NetworkConnectionSetting.java‎

Lines changed: 87 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,87 @@
1+
package io.appium.java_client;
2+
3+
/**
4+
* for use with setting Network Connections on a mobile device.
5+
* Each network option can be enabled or disabled.
6+
* Current network options available: Airplane Mode, Wifi, Data
7+
*/
8+
public class NetworkConnectionSetting {
9+
10+
public int value = 0;
11+
private int airplaneMode = 1;
12+
private int wifi = 2;
13+
private int data = 4;
14+
15+
/**
16+
*
17+
* @param airplaneMode boolean for airplane mode enabled
18+
* @param wifi boolean for wifi enabled
19+
* @param data boolean for data enabled
20+
*/
21+
public NetworkConnectionSetting(boolean airplaneMode, boolean wifi, boolean data) {
22+
int a = airplaneMode ? this.airplaneMode : 0;
23+
int b = wifi ? this.wifi : 0;
24+
int c = data ? this.data : 0;
25+
26+
value = a | b | c;
27+
}
28+
29+
/**
30+
* Instantiate Network Connection Settings with the straight-up bitmask. See the Mobile JSON Wire Protocol spec for details.
31+
* @param bitmask
32+
*/
33+
public NetworkConnectionSetting(int bitmask) {
34+
value = bitmask;
35+
}
36+
37+
public boolean airplaneModeEnabled() { return (value & airplaneMode) == 1; }
38+
39+
public boolean wifiEnabled() { return (value & wifi) == 1; }
40+
41+
public boolean dataEnabled() { return (value & data) == 1; }
42+
43+
public void setAirplaneMode(boolean enable) {
44+
if (enable) {
45+
value = value | airplaneMode;
46+
} else {
47+
value = value & ~airplaneMode;
48+
}
49+
}
50+
51+
public void setWifi(boolean enable) {
52+
if (enable) {
53+
value = value | wifi;
54+
} else {
55+
value = value & ~wifi;
56+
}
57+
}
58+
59+
public void setData(boolean enable) {
60+
if (enable) {
61+
value = value | data;
62+
} else {
63+
value = value & ~data;
64+
}
65+
}
66+
67+
public int hashCode() {
68+
return value;
69+
}
70+
71+
public boolean equals(Object obj) {
72+
if (obj instanceof Integer) {
73+
return value == obj;
74+
}
75+
if (obj instanceof NetworkConnectionSetting) {
76+
return value == ((NetworkConnectionSetting)obj).value;
77+
}
78+
else {
79+
return false;
80+
}
81+
}
82+
83+
public String toString() {
84+
return "{ AirplaneMode: " + airplaneModeEnabled() + ", Wifi: " + wifiEnabled() + ", Data: " + dataEnabled() + "}";
85+
}
86+
87+
}

‎src/test/java/io/appium/java_client/MobileDriverAndroidTest.java‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ public void setup() throws Exception {
4545
capabilities.setCapability(MobileCapabilityType.DEVICE_NAME, "Android Emulator");
4646
capabilities.setCapability(MobileCapabilityType.PLATFORM_NAME, "Android");
4747
capabilities.setCapability(MobileCapabilityType.APP, app.getAbsolutePath());
48+
capabilities.setCapability(MobileCapabilityType.NEW_COMMAND_TIMEOUT, 120);
4849
driver = new AppiumDriver(new URL("http://127.0.0.1:4723/wd/hub"), capabilities);
4950
}
5051

@@ -106,4 +107,19 @@ public void pushFileTest() {
106107
String returnDataDecoded = new String(Base64.decodeBase64(returnData));
107108
assertEquals("The eventual code is no more than the deposit of your understanding. ~E. W. Dijkstra", returnDataDecoded);
108109
}
110+
111+
@Test
112+
public void networkConnectionTest() {
113+
NetworkConnectionSetting networkConnection = new NetworkConnectionSetting(false, true, true);
114+
115+
networkConnection.setData(false);
116+
networkConnection.setWifi(false);
117+
118+
119+
driver.setNetworkConnection(networkConnection);
120+
networkConnection = driver.getNetworkConnection();
121+
122+
assertEquals(new NetworkConnectionSetting(false, false, false), networkConnection);
123+
124+
}
109125
}

0 commit comments

Comments
 (0)