frank/wirevpn
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases 2 Wiki Activity

tunnel: Add an initial set of unit tests

Browse Source 
Includes a control set of broken configuration files that we attempt to parse and
verify that the parser fails in a predictable and consistent manner.

Signed-off-by: Harsh Shandilya <me@msfjarvis.dev>
This commit is contained in:
Harsh Shandilya
2020-03-14 10:32:12 +05:30
parent 6c8a4a6a28
commit 093139bc91
15 changed files with 323 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tunnel/build.gradle
+6
View File
@@ -21,6 +21,11 @@ android {
path 'tools/CMakeLists.txt'
}
}
testOptions.unitTests.all {
testLogging {
events 'passed', 'skipped', 'failed', 'standardOut', 'standardError'
}
}
}
dependencies {
@@ -30,6 +35,7 @@ dependencies {
implementation "com.google.code.findbugs:jsr305:$jsr305Version"
implementation "com.jakewharton.threetenabp:threetenabp:$threetenabpVersion"
implementation "net.i2p.crypto:eddsa:$eddsaVersion"
testImplementation "junit:junit:$junitVersion"
}
apply from: "publish.gradle"
tunnel/src/test/java/com/wireguard/config/BadConfigExceptionTest.java
+172
View File
@@ -0,0 +1,172 @@
/*
* Copyright © 2020 WireGuard LLC. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0
*/
package com.wireguard.config;
import com.wireguard.config.BadConfigException.Location;
import com.wireguard.config.BadConfigException.Reason;
import com.wireguard.config.BadConfigException.Section;
import org.junit.AfterClass;
import org.junit.BeforeClass;
import org.junit.Test;
import java.io.IOException;
import java.io.InputStream;
import java.util.HashMap;
import java.util.Map;
import static org.junit.Assert.*;
public class BadConfigExceptionTest {
private static final String[] CONFIG_NAMES = {
"invalid-key",
"invalid-number",
"invalid-value",
"missing-attribute",
"missing-section",
"syntax-error",
"unknown-attribute",
"unknown-section"
};
private static final Map<String, InputStream> CONFIG_MAP = new HashMap<>();
@BeforeClass
public static void readConfigs() {
for (final String config: CONFIG_NAMES) {
CONFIG_MAP.put(config, BadConfigExceptionTest.class.getClassLoader().getResourceAsStream(config + ".conf"));
}
}
@AfterClass
public static void closeStreams() {
for (final InputStream inputStream : CONFIG_MAP.values()) {
try {
inputStream.close();
} catch (final IOException ignored) {
}
}
}
@Test
public void throws_correctly_with_INVALID_KEY_reason() {
try {
Config.parse(CONFIG_MAP.get("invalid-key"));
fail("Config parsing must fail in this test");
} catch (final BadConfigException e) {
assertEquals(e.getReason(), Reason.INVALID_KEY);
assertEquals(e.getLocation(), Location.PUBLIC_KEY);
assertEquals(e.getSection(), Section.PEER);
} catch (final IOException e) {
e.printStackTrace();
fail("IOException thrown during test");
}
}
@Test
public void throws_correctly_with_INVALID_NUMBER_reason() {
try {
Config.parse(CONFIG_MAP.get("invalid-number"));
fail("Config parsing must fail in this test");
} catch (final BadConfigException e) {
assertEquals(e.getReason(), Reason.INVALID_NUMBER);
assertEquals(e.getLocation(), Location.PERSISTENT_KEEPALIVE);
assertEquals(e.getSection(), Section.PEER);
} catch (final IOException e) {
e.printStackTrace();
fail("IOException thrown during test");
}
}
@Test
public void throws_correctly_with_INVALID_VALUE_reason() {
try {
Config.parse(CONFIG_MAP.get("invalid-value"));
fail("Config parsing must fail in this test");
} catch (final BadConfigException e) {
assertEquals(e.getReason(), Reason.INVALID_VALUE);
assertEquals(e.getLocation(), Location.DNS);
assertEquals(e.getSection(), Section.INTERFACE);
} catch (final IOException e) {
e.printStackTrace();
fail("IOException throwing during test");
}
}
@Test
public void throws_correctly_with_MISSING_ATTRIBUTE_reason() {
try {
Config.parse(CONFIG_MAP.get("missing-attribute"));
fail("Config parsing must fail in this test");
} catch (final BadConfigException e) {
assertEquals(e.getReason(), Reason.MISSING_ATTRIBUTE);
assertEquals(e.getLocation(), Location.PUBLIC_KEY);
assertEquals(e.getSection(), Section.PEER);
} catch (final IOException e) {
e.printStackTrace();
fail("IOException throwing during test");
}
}
@Test
public void throws_correctly_with_MISSING_SECTION_reason() {
try {
Config.parse(CONFIG_MAP.get("missing-section"));
fail("Config parsing must fail in this test");
} catch (final BadConfigException e) {
assertEquals(e.getReason(), Reason.MISSING_SECTION);
assertEquals(e.getLocation(), Location.TOP_LEVEL);
assertEquals(e.getSection(), Section.CONFIG);
} catch (final IOException e) {
e.printStackTrace();
fail("IOException throwing during test");
}
}
@Test
public void throws_correctly_with_SYNTAX_ERROR_reason() {
try {
Config.parse(CONFIG_MAP.get("syntax-error"));
fail("Config parsing must fail in this test");
} catch (final BadConfigException e) {
assertEquals(e.getReason(), Reason.SYNTAX_ERROR);
assertEquals(e.getLocation(), Location.TOP_LEVEL);
assertEquals(e.getSection(), Section.PEER);
} catch (final IOException e) {
e.printStackTrace();
fail("IOException throwing during test");
}
}
@Test
public void throws_correctly_with_UNKNOWN_ATTRIBUTE_reason() {
try {
Config.parse(CONFIG_MAP.get("unknown-attribute"));
fail("Config parsing must fail in this test");
} catch (final BadConfigException e) {
assertEquals(e.getReason(), Reason.UNKNOWN_ATTRIBUTE);
assertEquals(e.getLocation(), Location.TOP_LEVEL);
assertEquals(e.getSection(), Section.PEER);
} catch (final IOException e) {
e.printStackTrace();
fail("IOException throwing during test");
}
}
@Test
public void throws_correctly_with_UNKNOWN_SECTION_reason() {
try {
Config.parse(CONFIG_MAP.get("unknown-section"));
fail("Config parsing must fail in this test");
} catch (final BadConfigException e) {
assertEquals(e.getReason(), Reason.UNKNOWN_SECTION);
assertEquals(e.getLocation(), Location.TOP_LEVEL);
assertEquals(e.getSection(), Section.CONFIG);
} catch (final IOException e) {
e.printStackTrace();
fail("IOException throwing during test");
}
}
}
tunnel/src/test/java/com/wireguard/config/ConfigTest.java
+45
View File
@@ -0,0 +1,45 @@
/*
* Copyright © 2020 WireGuard LLC. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0
*/
package com.wireguard.config;
import static org.junit.Assert.*;
import org.junit.Test;
import java.io.IOException;
import java.io.InputStream;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashSet;
import java.util.Objects;
public class ConfigTest {
@Test
public void valid_config_parses_correctly() throws IOException, ParseException {
Config config = null;
final Collection<InetNetwork> expectedAllowedIps = new HashSet<>(Arrays.asList(InetNetwork.parse("0.0.0.0/0"), InetNetwork.parse("::0/0")));
try (final InputStream is = Objects.requireNonNull(getClass().getClassLoader()).getResourceAsStream("working.conf")) {
config = Config.parse(is);
} catch (final BadConfigException e) {
fail("'working.conf' should never fail to parse");
}
assertNotNull("config cannot be null after parsing", config);
assertTrue(
"No applications should be excluded by default",
config.getInterface().getExcludedApplications().isEmpty()
);
assertEquals("Test config has exactly one peer", 1, config.getPeers().size());
assertEquals("Test config's allowed IPs are 0.0.0.0/0 and ::0/0", config.getPeers().get(0).getAllowedIps(), expectedAllowedIps);
assertEquals("Test config has one DNS server", 1, config.getInterface().getDnsServers().size());
}
@Test(expected = BadConfigException.class)
public void invalid_config_throws() throws IOException, BadConfigException {
try (final InputStream is = Objects.requireNonNull(getClass().getClassLoader()).getResourceAsStream("broken.conf")) {
Config.parse(is);
}
}
}
tunnel/src/test/resources/broken.conf
+9
View File
@@ -0,0 +1,9 @@
[Interface]
PrivateKey = l0lth1s1sd3f1n1t3lybr0k3n=
Address = 192.0.2.2/32,2001:db8:ffff:ffff:ffff:ffff:ffff:ffff/128
DNS = 192.0.2.0
[Peer]
PublicKey = vBN7qyUTb5lJtWYJ8LhbPio1Z4RcyBPGnqFBGn6O6Qg=
AllowedIPs = 0.0.0.0/0,::0/0
Endpoint = 192.0.2.1:51820
tunnel/src/test/resources/invalid-key.conf
+9
View File
@@ -0,0 +1,9 @@
[Interface]
Address = 192.0.2.2/32,2001:db8:ffff:ffff:ffff:ffff:ffff:ffff/128
DNS = 192.0.2.0
PrivateKey = TFlmmEUC7V7VtiDYLKsbP5rySTKLIZq1yn8lMqK83wo=
[Peer]
AllowedIPs = 0.0.0.0/0, ::0/0
Endpoint = 192.0.2.1:51820
PersistentKeepalive = 0
PublicKey = vBN7qyUTb5lJtWYJ8LhbPio1Z4RcyBPGnqFBGn6Og=
tunnel/src/test/resources/invalid-number.conf
+9
View File
@@ -0,0 +1,9 @@
[Interface]
Address = 192.0.2.2/32,2001:db8:ffff:ffff:ffff:ffff:ffff:ffff/128
DNS = 192.0.2.0
PrivateKey = TFlmmEUC7V7VtiDYLKsbP5rySTKLIZq1yn8lMqK83wo=
[Peer]
AllowedIPs = 0.0.0.0/0, ::0/0
Endpoint = 192.0.2.1:51820
PersistentKeepalive = 0L
PublicKey = vBN7qyUTb5lJtWYJ8LhbPio1Z4RcyBPGnqFBGn6O6Qg=
tunnel/src/test/resources/invalid-value.conf
+9
View File
@@ -0,0 +1,9 @@
[Interface]
Address = 192.0.2.2/32,2001:db8:ffff:ffff:ffff:ffff:ffff:ffff/128
DNS = 192.0.2.0,yes
PrivateKey = TFlmmEUC7V7VtiDYLKsbP5rySTKLIZq1yn8lMqK83wo=
[Peer]
AllowedIPs = 0.0.0.0/0, ::0/0
Endpoint = 192.0.2.1:51820
PersistentKeepalive = 0
PublicKey = vBN7qyUTb5lJtWYJ8LhbPio1Z4RcyBPGnqFBGn6O6Qg=
tunnel/src/test/resources/missing-attribute.conf
+8
View File
@@ -0,0 +1,8 @@
[Interface]
Address = 192.0.2.2/32,2001:db8:ffff:ffff:ffff:ffff:ffff:ffff/128
DNS = 192.0.2.0
PrivateKey = TFlmmEUC7V7VtiDYLKsbP5rySTKLIZq1yn8lMqK83wo=
[Peer]
AllowedIPs = 0.0.0.0/0, ::0/0
Endpoint = 192.0.2.1:51820
PersistentKeepalive = 0
tunnel/src/test/resources/missing-section.conf
+5
View File
@@ -0,0 +1,5 @@
[Peer]
AllowedIPs = 0.0.0.0/0, ::0/0
Endpoint = 192.0.2.1:51820
PersistentKeepalive = 0
PublicKey = vBN7qyUTb5lJtWYJ8LhbPio1Z4RcyBPGnqFBGn6O6Qg=
tunnel/src/test/resources/syntax-error.conf
+9
View File
@@ -0,0 +1,9 @@
[Interface]
Address = 192.0.2.2/32,2001:db8:ffff:ffff:ffff:ffff:ffff:ffff/128
DNS = 192.0.2.0
PrivateKey = TFlmmEUC7V7VtiDYLKsbP5rySTKLIZq1yn8lMqK83wo=
[Peer]
AllowedIPs = 0.0.0.0/0, ::0/0
Endpoint =
PersistentKeepalive = 0
PublicKey = vBN7qyUTb5lJtWYJ8LhbPio1Z4RcyBPGnqFBGn6O6Qg=
tunnel/src/test/resources/unknown-attribute.conf
+9
View File
@@ -0,0 +1,9 @@
[Interface]
Address = 192.0.2.2/32,2001:db8:ffff:ffff:ffff:ffff:ffff:ffff/128
DNS = 192.0.2.0
PrivateKey = TFlmmEUC7V7VtiDYLKsbP5rySTKLIZq1yn8lMqK83wo=
[Peer]
AllowedIPs = 0.0.0.0/0, ::0/0
Endpoint = 192.0.2.1:51820
DontLetTheFeelingFade = 1
PublicKey = vBN7qyUTb5lJtWYJ8LhbPio1Z4RcyBPGnqFBGn6O6Qg=
tunnel/src/test/resources/unknown-section.conf
+9
View File
@@ -0,0 +1,9 @@
[Interface]
Address = 192.0.2.2/32,2001:db8:ffff:ffff:ffff:ffff:ffff:ffff/128
DNS = 192.0.2.0
PrivateKey = TFlmmEUC7V7VtiDYLKsbP5rySTKLIZq1yn8lMqK83wo=
[Peers]
AllowedIPs = 0.0.0.0/0, ::0/0
Endpoint = 192.0.2.1:51820
PersistentKeepalive = 0
PublicKey = vBN7qyUTb5lJtWYJ8LhbPio1Z4RcyBPGnqFBGn6O6Qg=
tunnel/src/test/resources/working.conf
+9
View File
@@ -0,0 +1,9 @@
[Interface]
Address = 192.0.2.2/32,2001:db8:ffff:ffff:ffff:ffff:ffff:ffff/128
DNS = 192.0.2.0
PrivateKey = TFlmmEUC7V7VtiDYLKsbP5rySTKLIZq1yn8lMqK83wo=
[Peer]
AllowedIPs = 0.0.0.0/0, ::0/0
Endpoint = 192.0.2.1:51820
PersistentKeepalive = 0
PublicKey = vBN7qyUTb5lJtWYJ8LhbPio1Z4RcyBPGnqFBGn6O6Qg=