stklcode/juraclient
0
0
Fork 0
Code Issues Actions Releases 21 Activity

Merge branch '1.x'
All checks were successful
continuous-integration/drone/push Build is passing
Details

Browse Source
This commit is contained in:
Stefan Kalscheuer 2020-12-12 14:06:10 +01:00
commit 242a371f84
38 changed files with 223 additions and 272 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
.drone.yml
View File

@ -4,7 +4,7 @@ name: java8
steps:
- name: test
image: maven:3-jdk-8-alpine
image: maven:3-openjdk-8
commands:
- mvn clean test
@ -15,17 +15,17 @@ name: java11
steps:
- name: test
image: maven:3-jdk-11
image: maven:3-openjdk-11
commands:
- mvn clean test
---
kind: pipeline
type: docker
name: java13
name: java15
steps:
- name: test
image: maven:3-jdk-14
image: maven:3-openjdk-15
commands:
- mvn clean test

4
.travis.yml
View File

@ -2,7 +2,7 @@ language: java
jdk:
- openjdk8
- openjdk11
- openjdk14
- openjdk15
install: true
addons:
sonarcloud:
@ -14,4 +14,4 @@ cache:
- '$HOME/.m2/repository'
- '$HOME/.sonar/cache'
script:
- if [ "$TRAVIS_JDK_VERSION" == "openjdk11" ]; then mvn -P jacoco clean package sonar:sonar; else mvn clean test; fi
- if [ "$TRAVIS_JDK_VERSION" == "openjdk11" ]; then mvn -P coverage clean package sonar:sonar; else mvn clean test; fi

8
CHANGELOG.md
View File

@ -1,6 +1,14 @@
# Changelog
All notable changes to this project will be documented in this file.
## 1.3.1 - 2020-12-12
### Fixed
* Allow reopening an `AsyncUraTripReader` without raising an exception (#13)
### Improvements
* Dependency updates
## 1.3.0 - 2019-12-04
### Security
* Updated dependencies

8
CONTRIBUTING.md
View File

@ -49,7 +49,7 @@ Feel free to adapt these naming scheme to your forks.
### Merge Requirements
To be merged into the master branch, your code has to pass the automated continuous integration tests, to ensure compatibility.
In Addition your code has to be approved by a project member.
In addition, your code has to be approved by a project member.
#### What if my code fails the tests?
@ -77,7 +77,7 @@ You might sign your work, although that's no must.
Short answer: When it makes sense.
Bugfixes should be merged in time - assuming they pass the above criteria.
Bug fixes should be merged in time - assuming they pass the above criteria.
New features might be assigned to a certain milestone and as a result of this be scheduled according to the planned release cycle.
@ -87,7 +87,7 @@ This projects tries to adapt the [Semantic Versioning](https://semver.org).
In short, bug fixes without do not affect any compatibility will raise the third number only, new features will be reflected in the second number and any change breaking compatibility with the public API require raising the first number.
If you have to make a decision for which version to go please keep this in mind.
However for most non-member commits this is mostly informative, as the decision will be made by the project team later.
However, for most non-member commits this is mostly informative, as the decision will be made by the project team later.
## Build Environment
@ -114,5 +114,5 @@ Keep in mind that the ruleset is not yet perfect, so not every minor issue has t
## Still Open Questions?
If anything is still left unanswered and you're unsure if you got it right, don't hesitate to contact a team member.
If anything is still left unanswered, and you're unsure if you got it right, don't hesitate to contact a team member.
In any case you might submit your request/issue anyway, we won't refuse good code only for formal reasons.

72
pom.xml
View File

@ -1,12 +1,11 @@
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>de.stklcode.pubtrans</groupId>
<artifactId>juraclient</artifactId>
<version>1.3.0</version>
<version>1.3.1</version>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@ -50,12 +49,12 @@
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.10.1</version>
<version>2.11.3</version>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
<version>5.5.2</version>
<version>5.7.0</version>
<scope>test</scope>
</dependency>
<dependency>
@ -65,19 +64,23 @@
<scope>test</scope>
</dependency>
<dependency>
<groupId>net.bytebuddy</groupId>
<artifactId>byte-buddy</artifactId>
<version>1.10.4</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>net.bytebuddy</groupId>
<artifactId>byte-buddy-agent</artifactId>
<version>1.10.4</version>
<groupId>com.github.tomakehurst</groupId>
<artifactId>wiremock</artifactId>
<version>2.27.2</version>
<scope>test</scope>
</dependency>
</dependencies>
<dependencyManagement>
<dependencies>
<dependency>
<groupId>org.sonarsource.scanner.maven</groupId>
<artifactId>sonar-maven-plugin</artifactId>
<version>3.7.0.1746</version>
</dependency>
</dependencies>
</dependencyManagement>
<build>
<plugins>
<plugin>
@ -111,32 +114,18 @@
<profiles>
<profile>
<id>jacoco</id>
<dependencies>
<dependency>
<groupId>org.jacoco</groupId>
<artifactId>org.jacoco.agent</artifactId>
<version>0.8.5</version>
<classifier>runtime</classifier>
</dependency>
</dependencies>
<id>coverage</id>
<build>
<plugins>
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<version>0.8.5</version>
<version>0.8.6</version>
<executions>
<execution>
<id>default-instrument</id>
<id>prepare-agent</id>
<goals>
<goal>instrument</goal>
</goals>
</execution>
<execution>
<id>default-restore-instrumented-classes</id>
<goals>
<goal>restore-instrumented-classes</goal>
<goal>prepare-agent</goal>
</goals>
</execution>
<execution>
@ -145,22 +134,9 @@
<goals>
<goal>report</goal>
</goals>
<configuration>
<dataFile>${project.build.directory}/coverage.exec</dataFile>
</configuration>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<version>2.22.2</version>
<configuration>
<systemPropertyVariables>
<jacoco-agent.destfile>${project.build.directory}/jacoco.exec</jacoco-agent.destfile>
</systemPropertyVariables>
</configuration>
</plugin>
</plugins>
</build>
</profile>
@ -175,7 +151,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>3.2.0</version>
<version>3.2.1</version>
<executions>
<execution>
<id>attach-sources</id>
@ -199,7 +175,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.1.1</version>
<version>3.2.0</version>
<configuration>
<overview>${basedir}/src/main/javadoc/overview.html</overview>
<source>1.8</source>

4
src/main/java/de/stklcode/pubtrans/ura/UraClient.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2019 Stefan Kalscheuer
* Copyright 2016-2020 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -40,6 +40,8 @@ import static java.nio.charset.StandardCharsets.UTF_8;
* @author Stefan Kalscheuer
*/
public class UraClient implements Serializable {
private static final long serialVersionUID = -1183740075816686611L;
private static final String DEFAULT_INSTANT_URL = "/interfaces/ura/instant_V1";
private static final String DEFAULT_STREAM_URL = "/interfaces/ura/stream_V1";

2
src/main/java/de/stklcode/pubtrans/ura/model/Message.java
View File

@ -10,6 +10,8 @@ import java.util.List;
* @since 1.3
*/
public class Message implements Model {
private static final long serialVersionUID = 5233610751062774273L;
private static final int MSG_UUID = 7;
private static final int MSG_TYPE = 8;
private static final int MSG_PRIORITY = 9;

2
src/main/java/de/stklcode/pubtrans/ura/model/Model.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2019 Stefan Kalscheuer
* Copyright 2016-2020 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.

6
src/main/java/de/stklcode/pubtrans/ura/model/Stop.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2019 Stefan Kalscheuer
* Copyright 2016-2020 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -25,6 +25,8 @@ import java.util.List;
* @author Stefan Kalscheuer
*/
public final class Stop implements Model {
private static final long serialVersionUID = 202040044477267787L;
private static final int F_STOP_NAME = 1;
private static final int F_STOP_ID = 2;
private static final int F_INDICATOR = 3;
@ -143,7 +145,7 @@ public final class Stop implements Model {
}
/**
* @return The stop geoloaction latitude.
* @return The stop geolocation latitude.
*/
public Double getLatitude() {
return latitude;

4
src/main/java/de/stklcode/pubtrans/ura/model/Trip.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2019 Stefan Kalscheuer
* Copyright 2016-2020 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -25,6 +25,8 @@ import java.util.List;
* @author Stefan Kalscheuer
*/
public final class Trip implements Model {
private static final long serialVersionUID = 7477381188869237381L;
private static final int VISIT_ID = 7;
private static final int LINE_ID = 8;
private static final int LINE_NAME = 9;

2
src/main/java/de/stklcode/pubtrans/ura/model/package-info.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2019 Stefan Kalscheuer
* Copyright 2016-2020 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.

2
src/main/java/de/stklcode/pubtrans/ura/package-info.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2019 Stefan Kalscheuer
* Copyright 2016-2020 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.

4
src/main/java/de/stklcode/pubtrans/ura/reader/AsyncUraTripReader.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2019 Stefan Kalscheuer
* Copyright 2016-2020 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -134,6 +134,8 @@ public class AsyncUraTripReader implements AutoCloseable {
} catch (TimeoutException e) {
// Task failed to finish within 1 second.
future.cancel(true);
} finally {
future = null;
}
}

159
src/test/java/de/stklcode/pubtrans/ura/UraClientTest.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2019 Stefan Kalscheuer
* Copyright 2016-2020 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -16,23 +16,23 @@
package de.stklcode.pubtrans.ura;
import com.github.tomakehurst.wiremock.WireMockServer;
import com.github.tomakehurst.wiremock.client.WireMock;
import com.github.tomakehurst.wiremock.core.WireMockConfiguration;
import de.stklcode.pubtrans.ura.model.Message;
import de.stklcode.pubtrans.ura.model.Stop;
import de.stklcode.pubtrans.ura.model.Trip;
import net.bytebuddy.ByteBuddy;
import net.bytebuddy.agent.ByteBuddyAgent;
import net.bytebuddy.dynamic.loading.ClassReloadingStrategy;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
import java.util.Optional;
import static net.bytebuddy.implementation.MethodDelegation.to;
import static net.bytebuddy.matcher.ElementMatchers.named;
import static com.github.tomakehurst.wiremock.client.WireMock.*;
import static org.hamcrest.CoreMatchers.nullValue;
import static org.hamcrest.CoreMatchers.startsWith;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.hasSize;
import static org.hamcrest.Matchers.instanceOf;
@ -46,29 +46,29 @@ import static org.hamcrest.core.Is.is;
* @author Stefan Kalscheuer
*/
public class UraClientTest {
// Mocked resource URL and exception message.
private static String mockResource = null;
private static String mockException = null;
private static WireMockServer httpMock;
@BeforeAll
public static void initByteBuddy() {
// Install ByteBuddy Agent.
ByteBuddyAgent.install();
public static void setUp() {
// Initialize HTTP mock.
httpMock = new WireMockServer(WireMockConfiguration.options().dynamicPort());
httpMock.start();
WireMock.configureFor("localhost", httpMock.port());
}
new ByteBuddy().redefine(UraClient.class)
.method(named("request"))
.intercept(to(UraClientTest.class))
.make()
.load(UraClient.class.getClassLoader(), ClassReloadingStrategy.fromInstalledAgent());
@AfterAll
public static void tearDown() {
httpMock.stop();
httpMock = null;
}
@Test
public void getStopsTest() {
// Mock the HTTP call.
mockHttpToFile("instant_V2_stops.txt");
mockHttpToFile(2, "instant_V2_stops.txt");
// List stops and verify some values.
List<Stop> stops = new UraClient("mocked").getStops();
List<Stop> stops = new UraClient(httpMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream").getStops();
assertThat(stops, hasSize(10));
assertThat(stops.get(0).getId(), is("100210"));
assertThat(stops.get(1).getName(), is("Brockenberg"));
@ -77,36 +77,26 @@ public class UraClientTest {
assertThat(stops.get(4).getLongitude(), is(6.0708663));
// Test Exception handling.
mockHttpToException("Provoked Exception 1");
mockHttpToError(500);
try {
new UraClient("mocked").getStops();
new UraClient(httpMock.baseUrl()).getStops();
} catch (RuntimeException e) {
assertThat(e, is(instanceOf(IllegalStateException.class)));
assertThat(e.getCause(), is(instanceOf(IOException.class)));
assertThat(e.getCause().getMessage(), is("Provoked Exception 1"));
assertThat(e.getCause().getMessage(), startsWith("Server returned HTTP response code: 500 for URL"));
}
}
public static InputStream request(String originalURL) throws IOException {
if (mockResource == null && mockException != null) {
IOException e = new IOException(mockException);
mockException = null;
throw e;
}
InputStream res = UraClientTest.class.getResourceAsStream(mockResource);
mockResource = null;
return res;
}
@Test
public void getStopsForLineTest() {
// Mock the HTTP call.
mockHttpToFile("instant_V2_stops_line.txt");
mockHttpToFile(2, "instant_V2_stops_line.txt");
// List stops and verify some values.
List<Stop> stops = new UraClient("mocked").forLines("33").getStops();
List<Stop> stops = new UraClient(httpMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream")
.forLines("33")
.getStops();
assertThat(stops, hasSize(47));
assertThat(stops.get(0).getId(), is("100000"));
assertThat(stops.get(1).getName(), is("Kuckelkorn"));
@ -119,10 +109,10 @@ public class UraClientTest {
@Test
public void getStopsForPositionTest() {
// Mock the HTTP call.
mockHttpToFile("instant_V1_stops_circle.txt");
mockHttpToFile(1, "instant_V1_stops_circle.txt");
// List stops and verify some values.
List<Stop> stops = new UraClient("mocked")
List<Stop> stops = new UraClient(httpMock.baseUrl())
.forPosition(51.51009, -0.1345734, 200)
.getStops();
assertThat(stops, hasSize(13));
@ -133,8 +123,8 @@ public class UraClientTest {
assertThat(stops.get(4).getLongitude(), is(-0.134172));
assertThat(stops.get(5).getIndicator(), is(nullValue()));
mockHttpToFile("instant_V1_stops_circle_name.txt");
stops = new UraClient("mocked")
mockHttpToFile(1, "instant_V1_stops_circle_name.txt");
stops = new UraClient(httpMock.baseUrl())
.forStopsByName("Piccadilly Circus")
.forPosition(51.51009, -0.1345734, 200)
.getStops();
@ -145,16 +135,16 @@ public class UraClientTest {
@Test
public void getTripsForDestinationNamesTest() {
// Mock the HTTP call.
mockHttpToFile("instant_V1_trips_destination.txt");
mockHttpToFile(1, "instant_V1_trips_destination.txt");
// List stops and verify some values.
List<Trip> trips = new UraClient("mocked").forDestinationNames("Piccadilly Circus").getTrips();
List<Trip> trips = new UraClient(httpMock.baseUrl()).forDestinationNames("Piccadilly Circus").getTrips();
assertThat(trips, hasSize(9));
assertThat(trips.stream().filter(t -> !t.getDestinationName().equals("Piccadilly Cir")).findAny(),
is(Optional.empty()));
mockHttpToFile("instant_V1_trips_stop_destination.txt");
trips = new UraClient("mocked")
mockHttpToFile(1, "instant_V1_trips_stop_destination.txt");
trips = new UraClient(httpMock.baseUrl())
.forStops("156")
.forDestinationNames("Marble Arch")
.getTrips();
@ -168,14 +158,14 @@ public class UraClientTest {
@Test
public void getTripsTowardsTest() {
// Mock the HTTP call.
mockHttpToFile("instant_V1_trips_towards.txt");
mockHttpToFile(1, "instant_V1_trips_towards.txt");
/* List stops and verify some values */
List<Trip> trips = new UraClient("mocked").towards("Marble Arch").getTrips();
List<Trip> trips = new UraClient(httpMock.baseUrl()).towards("Marble Arch").getTrips();
assertThat(trips, hasSize(10));
mockHttpToFile("instant_V1_trips_stop_towards.txt");
trips = new UraClient("mocked").forStops("156").towards("Marble Arch").getTrips();
mockHttpToFile(1, "instant_V1_trips_stop_towards.txt");
trips = new UraClient(httpMock.baseUrl()).forStops("156").towards("Marble Arch").getTrips();
assertThat(trips, hasSize(17));
assertThat(trips.stream().filter(t -> !t.getStop().getId().equals("156")).findAny(), is(Optional.empty()));
}
@ -183,10 +173,10 @@ public class UraClientTest {
@Test
public void getTripsTest() {
// Mock the HTTP call.
mockHttpToFile("instant_V1_trips_all.txt");
mockHttpToFile(1, "instant_V1_trips_all.txt");
// Get trips without filters and verify some values.
List<Trip> trips = new UraClient("mocked").getTrips();
List<Trip> trips = new UraClient(httpMock.baseUrl()).getTrips();
assertThat(trips, hasSize(10));
assertThat(trips.get(0).getId(), is("27000165015001"));
assertThat(trips.get(1).getLineID(), is("55"));
@ -200,10 +190,11 @@ public class UraClientTest {
assertThat(trips.get(9).getStop().getId(), is("100002"));
// Repeat test for API V2.
mockHttpToFile("instant_V2_trips_all.txt");
mockHttpToFile(2, "instant_V2_trips_all.txt");
// Get trips without filters and verify some values.
trips = new UraClient("mocked").getTrips();
trips = new UraClient(httpMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream")
.getTrips();
assertThat(trips, hasSize(10));
assertThat(trips.get(0).getId(), is("27000165015001"));
assertThat(trips.get(1).getLineID(), is("55"));
@ -217,28 +208,28 @@ public class UraClientTest {
assertThat(trips.get(9).getStop().getId(), is("100002"));
// Get limited number of trips.
mockHttpToFile("instant_V1_trips_all.txt");
trips = new UraClient("mocked").getTrips(5);
mockHttpToFile(1, "instant_V1_trips_all.txt");
trips = new UraClient(httpMock.baseUrl()).getTrips(5);
assertThat(trips, hasSize(5));
// Test mockException handling.
mockHttpToException("Provoked mockException 2");
mockHttpToError(502);
try {
new UraClient("mocked").getTrips();
new UraClient(httpMock.baseUrl()).getTrips();
} catch (RuntimeException e) {
assertThat(e, is(instanceOf(IllegalStateException.class)));
assertThat(e.getCause(), is(instanceOf(IOException.class)));
assertThat(e.getCause().getMessage(), is("Provoked mockException 2"));
assertThat(e.getCause().getMessage(), startsWith("Server returned HTTP response code: 502 for URL"));
}
}
@Test
public void getTripsForStopTest() {
// Mock the HTTP call.
mockHttpToFile("instant_V1_trips_stop.txt");
mockHttpToFile(1, "instant_V1_trips_stop.txt");
// Get trips for stop ID 100000 (Aachen Bushof) and verify some values.
List<Trip> trips = new UraClient("mocked")
List<Trip> trips = new UraClient(httpMock.baseUrl())
.forStops("100000")
.getTrips();
assertThat(trips, hasSize(10));
@ -249,8 +240,8 @@ public class UraClientTest {
assertThat(trips.get(3).getStop().getIndicator(), is("H.15"));
// Get trips for stop name "Uniklinik" and verify some values.
mockHttpToFile("instant_V1_trips_stop_name.txt");
trips = new UraClient("mocked")
mockHttpToFile(1, "instant_V1_trips_stop_name.txt");
trips = new UraClient(httpMock.baseUrl())
.forStopsByName("Uniklinik")
.getTrips();
assertThat(trips, hasSize(10));
@ -265,10 +256,10 @@ public class UraClientTest {
@Test
public void getTripsForLine() {
// Mock the HTTP call.
mockHttpToFile("instant_V1_trips_line.txt");
mockHttpToFile(1, "instant_V1_trips_line.txt");
// Get trips for line ID 3 and verify some values.
List<Trip> trips = new UraClient("mocked")
List<Trip> trips = new UraClient(httpMock.baseUrl())
.forLines("3")
.getTrips();
assertThat(trips, hasSize(10));
@ -279,8 +270,8 @@ public class UraClientTest {
assertThat(trips.get(3).getStop().getIndicator(), is("H.4 (Pontwall)"));
// Get trips for line name "3.A" and verify some values.
mockHttpToFile("instant_V1_trips_line_name.txt");
trips = new UraClient("mocked")
mockHttpToFile(1, "instant_V1_trips_line_name.txt");
trips = new UraClient(httpMock.baseUrl())
.forLinesByName("3.A")
.getTrips();
assertThat(trips, hasSize(10));
@ -291,8 +282,8 @@ public class UraClientTest {
assertThat(trips.get(3).getStop().getName(), is("Aachen Gartenstraße"));
// Get trips for line 3 with direction 1 and verify some values.
mockHttpToFile("instant_V1_trips_line_direction.txt");
trips = new UraClient("mocked")
mockHttpToFile(1, "instant_V1_trips_line_direction.txt");
trips = new UraClient(httpMock.baseUrl())
.forLines("412")
.forDirection(2)
.getTrips();
@ -301,8 +292,8 @@ public class UraClientTest {
assertThat(trips.stream().filter(t -> !t.getDirectionID().equals(2)).findAny(), is(Optional.empty()));
// Test lineID and direction in different order.
mockHttpToFile("instant_V1_trips_line_direction.txt");
trips = new UraClient("mocked")
mockHttpToFile(1, "instant_V1_trips_line_direction.txt");
trips = new UraClient(httpMock.baseUrl())
.forDirection(2)
.forLines("412")
.getTrips();
@ -314,10 +305,10 @@ public class UraClientTest {
@Test
public void getTripsForStopAndLine() {
// Mock the HTTP call.
mockHttpToFile("instant_V1_trips_stop_line.txt");
mockHttpToFile(1, "instant_V1_trips_stop_line.txt");
// Get trips for line ID 25 and 25 at stop 100000 and verify some values.
List<Trip> trips = new UraClient("mocked")
List<Trip> trips = new UraClient(httpMock.baseUrl())
.forLines("25", "35")
.forStops("100000")
.getTrips();
@ -335,10 +326,10 @@ public class UraClientTest {
@Test
public void getMessages() {
// Mock the HTTP call.
mockHttpToFile("instant_V1_messages.txt");
mockHttpToFile(1, "instant_V1_messages.txt");
// Get messages without filter and verify some values.
List<Message> messages = new UraClient("mocked")
List<Message> messages = new UraClient(httpMock.baseUrl())
.getMessages();
assertThat(messages, hasSize(2));
assertThat(messages.get(0).getStop().getId(), is("100707"));
@ -354,10 +345,10 @@ public class UraClientTest {
@Test
public void getMessagesForStop() {
// Mock the HTTP call.
mockHttpToFile("instant_V2_messages_stop.txt");
mockHttpToFile(2, "instant_V2_messages_stop.txt");
// Get trips for stop ID 100707 (Berensberger Str.) and verify some values.
List<Message> messages = new UraClient("mocked")
List<Message> messages = new UraClient(httpMock.baseUrl(), "/interfaces/ura/instant_V2", "/interfaces/ura/stream")
.forStops("100707")
.getMessages();
assertThat(messages, hasSize(1));
@ -369,11 +360,19 @@ public class UraClientTest {
}
private static void mockHttpToFile(String newResourceFile) {
mockResource = newResourceFile;
private static void mockHttpToFile(int version, String resourceFile) {
WireMock.stubFor(
get(urlPathEqualTo("/interfaces/ura/instant_V" + version)).willReturn(
aResponse().withBodyFile(resourceFile)
)
);
}
private static void mockHttpToException(String newException) {
mockException = newException;
private static void mockHttpToError(int code) {
WireMock.stubFor(
get(anyUrl()).willReturn(
aResponse().withStatus(code)
)
);
}
}

2
src/test/java/de/stklcode/pubtrans/ura/model/MessageTest.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2019 Stefan Kalscheuer
* Copyright 2016-2020 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.

2
src/test/java/de/stklcode/pubtrans/ura/model/StopTest.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2019 Stefan Kalscheuer
* Copyright 2016-2020 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.

2
src/test/java/de/stklcode/pubtrans/ura/model/TripTest.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2019 Stefan Kalscheuer
* Copyright 2016-2020 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.

204
src/test/java/de/stklcode/pubtrans/ura/reader/AsyncUraTripReaderTest.java
View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2019 Stefan Kalscheuer
* Copyright 2016-2020 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -16,51 +16,61 @@
package de.stklcode.pubtrans.ura.reader;
import de.stklcode.pubtrans.ura.UraClientTest;
import com.github.tomakehurst.wiremock.WireMockServer;
import com.github.tomakehurst.wiremock.client.WireMock;
import com.github.tomakehurst.wiremock.common.FileSource;
import com.github.tomakehurst.wiremock.core.WireMockConfiguration;
import com.github.tomakehurst.wiremock.extension.Parameters;
import com.github.tomakehurst.wiremock.extension.ResponseTransformer;
import com.github.tomakehurst.wiremock.http.ChunkedDribbleDelay;
import com.github.tomakehurst.wiremock.http.Request;
import com.github.tomakehurst.wiremock.http.Response;
import de.stklcode.pubtrans.ura.model.Trip;
import net.bytebuddy.ByteBuddy;
import net.bytebuddy.agent.ByteBuddyAgent;
import net.bytebuddy.dynamic.loading.ClassReloadingStrategy;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import java.io.*;
import java.io.IOException;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.util.ArrayDeque;
import java.util.Collections;
import java.util.Deque;
import java.util.Queue;
import java.util.concurrent.ConcurrentLinkedDeque;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.atomic.AtomicInteger;
import static net.bytebuddy.implementation.MethodDelegation.to;
import static net.bytebuddy.matcher.ElementMatchers.named;
import static com.github.tomakehurst.wiremock.client.WireMock.*;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.core.Is.is;
import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
import static org.junit.jupiter.api.Assertions.assertThrows;
import static org.junit.jupiter.api.Assumptions.assumeTrue;
/**
* Unit test for the asynchronous URA Trip reader.
* <p>
* Because this test runs asynchronously, it might not work as expected in debugging environments.
* Stream input files are normalized to equal line length and split into chunks, one line each 500ms.
*
* @author Stefan Kalscheuer
*/
public class AsyncUraTripReaderTest {
private static final Queue<String> MOCK_LINES = new ArrayDeque<>();
private static PipedOutputStream mockOutputStream = new PipedOutputStream();
private static WireMockServer httpMock;
@BeforeAll
public static void initByteBuddy() {
// Install ByteBuddy Agent.
ByteBuddyAgent.install();
public static void setUp() {
// Initialize HTTP mock.
httpMock = new WireMockServer(WireMockConfiguration.options().dynamicPort()
.asynchronousResponseEnabled(true)
.extensions(StreamTransformer.class)
);
httpMock.start();
WireMock.configureFor("localhost", httpMock.port());
}
// Mock the URL.openStream() call.
new ByteBuddy().redefine(AsyncUraTripReader.class)
.method(named("getInputStream"))
.intercept(to(AsyncUraTripReaderTest.class))
.make()
.load(AsyncUraTripReader.class.getClassLoader(), ClassReloadingStrategy.fromInstalledAgent());
@AfterAll
public static void tearDown() {
httpMock.stop();
httpMock = null;
}
/**
@ -80,10 +90,10 @@ public class AsyncUraTripReaderTest {
Deque<Trip> trips = new ConcurrentLinkedDeque<>();
// Start with V1 data and read file to mock list.
readLinesToMock(UraClientTest.class.getResource("stream_V1_stops_all.txt"));
readLinesToMock(1, "/__files/stream_V1_stops_all.txt", 8);
AsyncUraTripReader tr = new AsyncUraTripReader(
UraClientTest.class.getResource("stream_V1_stops_all.txt"),
new URL(httpMock.baseUrl() + "/interfaces/ura/stream_V1"),
Collections.singletonList(
trip -> {
trips.add(trip);
@ -98,39 +108,23 @@ public class AsyncUraTripReaderTest {
TimeUnit.SECONDS.sleep(1);
assumeTrue(trips.isEmpty(), "Trips should empty after 1s without reading");
// Now write a single line to the stream pipe.
assumeTrue(writeNextLine(), "First line (version info) should be written");
assumeTrue(writeNextLine(), "Second line (first record) should be written");
// Wait another 1s for the callback to be triggered.
TimeUnit.SECONDS.sleep(1);
// Wait up to 1s for the callback to be triggered.
int i = 10;
while (counter.get() < 1 && i-- > 0) {
TimeUnit.MILLISECONDS.sleep(100);
}
assertThat("Unexpected number of trips after first entry", trips.size(), is(1));
assertThat("Unexpected number of trips after first entry", trips.size(), is(2));
// Flush all remaining lines.
while (writeNextLine()) {
TimeUnit.MILLISECONDS.sleep(10);
}
i = 10;
counter.set(0);
while (counter.get() < 1 && i-- > 0) {
TimeUnit.MILLISECONDS.sleep(100);
}
tr.close();
TimeUnit.SECONDS.sleep(3);
assertThat("Unexpected number of trips after all lines have been flushed", trips.size(), is(7));
// Clear trip list and repeat with V2 data.
trips.clear();
readLinesToMock(UraClientTest.class.getResource("stream_V2_stops_all.txt"));
readLinesToMock(2, "/__files/stream_V2_stops_all.txt", 8);
tr = new AsyncUraTripReader(
UraClientTest.class.getResource("stream_V2_stops_all.txt"),
Collections.singletonList(trips::add)
new URL(httpMock.baseUrl() + "/interfaces/ura/stream_V2"),
trips::add
);
// Open the reader.
@ -139,36 +133,26 @@ public class AsyncUraTripReaderTest {
TimeUnit.SECONDS.sleep(1);
assumeTrue(trips.isEmpty(), "Trips should empty after 1s without reading");
assumeTrue(writeNextLine(), "First line of v2 (version info) should be written");
assumeTrue(writeNextLine(), "Second line of v2 (first record) should be written");
i = 10;
counter.set(0);
while (counter.get() < 1 && i-- > 0) {
TimeUnit.MILLISECONDS.sleep(100);
}
assertThat("Unexpected number of v2 trips after first entry", trips.size(), is(1));
TimeUnit.SECONDS.sleep(1);
assertThat("Unexpected number of v2 trips after first entry", trips.size(), is(2));
// Add a second consumer that pushes to another list.
Deque<Trip> trips2 = new ConcurrentLinkedDeque<>();
tr.addConsumer(trips2::add);
// Flush all remaining lines.
while (writeNextLine()) {
TimeUnit.MILLISECONDS.sleep(10);
}
i = 10;
counter.set(0);
while (counter.get() < 1 && i-- > 0) {
TimeUnit.MILLISECONDS.sleep(100);
}
TimeUnit.SECONDS.sleep(3);
tr.close();
assertThat("Unexpected number of v2 trips after all lines have been flushed", trips.size(), is(7));
assertThat("Unexpected number of v2 trips in list 2 after all lines have been flushed", trips2.size(), is(6));
assertThat("Unexpected number of v2 trips in list 2 after all lines have been flushed", trips2.size(), is(5));
assertThat("Same object should have been pushed to both lists", trips.containsAll(trips2));
// Opening the reader twice should raise an exception.
assertDoesNotThrow(tr::open, "Opening the reader after closing should not fail");
assertThrows(IllegalStateException.class, tr::open, "Opening the reader twice should raise an exception");
tr.close();
}
/**
@ -186,10 +170,10 @@ public class AsyncUraTripReaderTest {
Deque<Trip> trips = new ConcurrentLinkedDeque<>();
// Start with V1 data and read file to mock list.
readLinesToMock(UraClientTest.class.getResource("stream_V1_stops_all.txt"));
readLinesToMock(1, "/__files/stream_V1_stops_all.txt", 8);
AsyncUraTripReader tr = new AsyncUraTripReader(
UraClientTest.class.getResource("stream_V1_stops_all.txt"),
new URL(httpMock.baseUrl() + "/interfaces/ura/stream_V1"),
Collections.singletonList(
trip -> {
trips.add(trip);
@ -205,29 +189,16 @@ public class AsyncUraTripReaderTest {
TimeUnit.MILLISECONDS.sleep(100);
assumeTrue(trips.isEmpty(), "Trips should empty after 100ms without reading");
// Now write a single line to the stream pipe.
assumeTrue(writeNextLine(), "First line (version info) should be written");
assumeTrue(writeNextLine(), "Second line (first record) should be written");
// Wait up to 1s for the callback to be triggered.
int i = 10;
while (counter.get() < 1 && i-- > 0) {
TimeUnit.MILLISECONDS.sleep(100);
}
// Wait for 1s for the callback to be triggered.
TimeUnit.SECONDS.sleep(1);
assumeTrue(1 == trips.size(), "Unexpected number of trips after first entry");
// Close the stream.
mockOutputStream.close();
i = 10;
counter.set(0);
while (counter.get() < 1 && i-- > 0) {
TimeUnit.MILLISECONDS.sleep(100);
}
tr.close();
// Wait for another second.
TimeUnit.MILLISECONDS.sleep(100);
assertThat("Unexpected number of trips after all lines have been flushed", trips.size(), is(1));
}
@ -235,47 +206,34 @@ public class AsyncUraTripReaderTest {
/**
* Read an input file to the line buffer.
*
* @param url Input URL.
* @throws IOException Error reading the data.
* @param version API version.
* @param resourceFile Resource file name.
* @param chunks Number of chunks.
*/
private static void readLinesToMock(URL url) throws IOException {
try (InputStream is = url.openStream();
BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
String line = br.readLine();
while (line != null) {
MOCK_LINES.add(line);
line = br.readLine();
}
}
private void readLinesToMock(int version, String resourceFile, int chunks) {
WireMock.stubFor(get(urlPathEqualTo("/interfaces/ura/stream_V" + version))
.willReturn(aResponse()
.withTransformer("stream-transformer", "source", resourceFile)
.withTransformer("stream-transformer", "chunks", chunks)
)
);
}
/**
* Write next line from the buffer to the mocked stream pipe.
*
* @return {@code true} if a line has been written.
* @throws IOException Error writing the data.
*/
private static boolean writeNextLine() throws IOException {
String line = MOCK_LINES.poll();
if (line != null) {
line += "\n";
mockOutputStream.write(line.getBytes(StandardCharsets.UTF_8));
mockOutputStream.flush();
return true;
} else {
return false;
public static class StreamTransformer extends ResponseTransformer {
@Override
public Response transform(Request request, Response response, FileSource files, Parameters parameters) {
int chunks = parameters.getInt("chunks", 1);
return Response.Builder.like(response)
// Read source file to response.
.body(() -> AsyncUraTripReaderTest.class.getResourceAsStream(parameters.getString("source")))
// Split response in given number of chunks with 500ms delay.
.chunkedDribbleDelay(new ChunkedDribbleDelay(chunks, chunks * 500))
.build();
}
}
/**
* Function to mock the static {@code AsyncUraTripReader#getInputStream(URL)} method.
*
* @param url URL to read from.
* @return Input Stream.
* @throws IOException On errors.
*/
public static InputStream getInputStream(URL url) throws IOException {
mockOutputStream = new PipedOutputStream();
return new PipedInputStream(mockOutputStream);
@Override
public String getName() {
return "stream-transformer";
}
}
}

0
src/test/resources/de/stklcode/pubtrans/ura/instant_V1_messages.txt → src/test/resources/__files/instant_V1_messages.txt
View File

0
src/test/resources/de/stklcode/pubtrans/ura/instant_V1_stops_circle.txt → src/test/resources/__files/instant_V1_stops_circle.txt
View File

0
src/test/resources/de/stklcode/pubtrans/ura/instant_V1_stops_circle_name.txt → src/test/resources/__files/instant_V1_stops_circle_name.txt
View File

0
src/test/resources/de/stklcode/pubtrans/ura/instant_V1_trips_all.txt → src/test/resources/__files/instant_V1_trips_all.txt
View File

0
src/test/resources/de/stklcode/pubtrans/ura/instant_V1_trips_destination.txt → src/test/resources/__files/instant_V1_trips_destination.txt
View File

0
src/test/resources/de/stklcode/pubtrans/ura/instant_V1_trips_line.txt → src/test/resources/__files/instant_V1_trips_line.txt
View File

0
src/test/resources/de/stklcode/pubtrans/ura/instant_V1_trips_line_direction.txt → src/test/resources/__files/instant_V1_trips_line_direction.txt
View File

0
src/test/resources/de/stklcode/pubtrans/ura/instant_V1_trips_line_name.txt → src/test/resources/__files/instant_V1_trips_line_name.txt
View File

0
src/test/resources/de/stklcode/pubtrans/ura/instant_V1_trips_stop.txt → src/test/resources/__files/instant_V1_trips_stop.txt
View File

0
src/test/resources/de/stklcode/pubtrans/ura/instant_V1_trips_stop_destination.txt → src/test/resources/__files/instant_V1_trips_stop_destination.txt
View File

0
src/test/resources/de/stklcode/pubtrans/ura/instant_V1_trips_stop_line.txt → src/test/resources/__files/instant_V1_trips_stop_line.txt
View File

0
src/test/resources/de/stklcode/pubtrans/ura/instant_V1_trips_stop_name.txt → src/test/resources/__files/instant_V1_trips_stop_name.txt
View File

0
src/test/resources/de/stklcode/pubtrans/ura/instant_V1_trips_stop_towards.txt → src/test/resources/__files/instant_V1_trips_stop_towards.txt
View File

0
src/test/resources/de/stklcode/pubtrans/ura/instant_V1_trips_towards.txt → src/test/resources/__files/instant_V1_trips_towards.txt
View File

0
src/test/resources/de/stklcode/pubtrans/ura/instant_V2_messages_stop.txt → src/test/resources/__files/instant_V2_messages_stop.txt
View File

0
src/test/resources/de/stklcode/pubtrans/ura/instant_V2_stops.txt → src/test/resources/__files/instant_V2_stops.txt
View File

0
src/test/resources/de/stklcode/pubtrans/ura/instant_V2_stops_line.txt → src/test/resources/__files/instant_V2_stops_line.txt
View File

0
src/test/resources/de/stklcode/pubtrans/ura/instant_V2_trips_all.txt → src/test/resources/__files/instant_V2_trips_all.txt
View File

0
src/test/resources/de/stklcode/pubtrans/ura/stream_V1_stops_all.txt → src/test/resources/__files/stream_V1_stops_all.txt
View File

0
src/test/resources/de/stklcode/pubtrans/ura/stream_V2_stops_all.txt → src/test/resources/__files/stream_V2_stops_all.txt
View File