16 Commits

Author SHA1 Message Date
a934ee679e ReadMe++ 2019-12-04 14:38:07 +01:00
299f9556d4 prepare release 1.3.0 2019-12-04 14:30:43 +01:00
bc91529721 JavaDoc corrections 2019-12-04 14:29:56 +01:00
7d044a1f95 minor dependency updates 2019-12-04 14:19:49 +01:00
06ce5a22cf Merge pull request #7 from stklcode/feature/5-messages
fetch public messages from API (#5)
2019-12-04 11:59:29 +01:00
d1cf795106 update Jackson dependency to 2.10 2019-11-04 18:11:57 +01:00
5b6c02d6a3 implement client methods for reading messages
Reading response type 2 (messages) from API with optional stop filter.
2019-11-04 18:02:59 +01:00
d0e118f1fd explicitly declare pipeline type in Drone CI configuration 2019-11-04 17:55:34 +01:00
431de69549 typo fixes in comments and test messages [skip ci] 2019-11-04 17:55:10 +01:00
4f3d8694e1 implement model for message responses 2019-11-04 17:15:36 +01:00
2fd8d2a87c update copyright notice to 2019 2019-11-04 16:54:29 +01:00
4bb7c595c2 update Hamcrest library for testing 2019-10-20 11:51:34 +02:00
8ce5ea3aef add JDK 13 to automated builds
Test all current LTS versions (8, 11) and the latest stable release (13)
2019-10-02 20:18:57 +02:00
ec0ceada2d Update Jackson dependency to 2.9.10 2019-10-02 20:16:27 +02:00
71902b072b minor dependency updates 2019-07-26 20:02:14 +02:00
e20baf7b11 fix Javadoc generation with JDK11+ 2019-07-26 20:02:00 +02:00
20 changed files with 550 additions and 85 deletions

View File

@ -1,4 +1,5 @@
kind: pipeline
type: docker
name: java8
steps:
@ -9,6 +10,7 @@ steps:
---
kind: pipeline
type: docker
name: java11
steps:
@ -16,3 +18,14 @@ steps:
image: maven:3-jdk-11-slim
commands:
- mvn clean test
---
kind: pipeline
type: docker
name: java13
steps:
- name: test
image: maven:3-jdk-13
commands:
- mvn clean test

View File

@ -2,6 +2,7 @@ language: java
jdk:
- openjdk8
- openjdk11
- openjdk13
install: true
addons:
sonarcloud:

View File

@ -1,6 +1,14 @@
# Changelog
All notable changes to this project will be documented in this file.
## 1.3.0 - 2019-12-04
### Security
* Updated dependencies
### Features
* Added support for reading messages, using `getMessages()` method (#5)
## 1.2.0 - 2019-06-20
### Security
* Updated dependencies
@ -8,11 +16,12 @@ All notable changes to this project will be documented in this file.
### Features
* Added support for stream API with asynchronous reader, using `getTripsStream()` method (#1)
## 1.1.4 - 2018-11-19
### Fixed
* Fixed issue with direction ID as `String` instead if `Integer` (#2)
* Fixed issue with vehicle ID being `null` (#3)
* Fixed issue with spaces in search parametes (#4)
* Fixed issue with spaces in search parameters (#4)
## 1.1.3 - 2018-11-13

View File

@ -17,7 +17,7 @@ local bus station or any other custom queries. API versions 1.x and 2.x are supp
// Instantiate the client (e.g. using the TFL API)
UraClient ura = new UraClient("http://countdown.api.tfl.gov.uk");
// Initiailize the API with non-standard endpoints (e.g. ASEAG with API V2)
// Initialize the API with non-standard endpoints (e.g. ASEAG with API V2)
UraClient ura = new UraClient("http://ivu.aseag.de",
"interfaces/ura/instant_V2",
"interfaces/ura/stream_V2");
@ -50,20 +50,23 @@ List<Trip> trips = ura.forStopByName("Piccadilly Circus")
.getTrips();
```
## Maven Artifact
### Get Messages
```java
// Get next 10 trips for given stops and lines in a single direction (all filters optional)
List<Message> msgs = ura.forStop("100000")
.getMessages();
```
## Maven Artifact
```xml
<dependency>
<groupId>de.stklcode.pubtrans</groupId>
<artifactId>juraclient</artifactId>
<version>1.1.4</version>
<version>1.3.0</version>
</dependency>
```
## Planned Features
* More refined query parameters
* Stream API with asynchronous consumer
## License
The project is licensed under [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0).

32
pom.xml
View File

@ -6,7 +6,7 @@
<groupId>de.stklcode.pubtrans</groupId>
<artifactId>juraclient</artifactId>
<version>1.2.0</version>
<version>1.3.0</version>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@ -47,38 +47,33 @@
</issueManagement>
<dependencies>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-core</artifactId>
<version>2.9.9</version>
</dependency>
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.9.9</version>
<version>2.10.1</version>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-engine</artifactId>
<version>5.4.2</version>
<artifactId>junit-jupiter</artifactId>
<version>5.5.2</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.hamcrest</groupId>
<artifactId>hamcrest-junit</artifactId>
<version>2.0.0.0</version>
<artifactId>hamcrest</artifactId>
<version>2.2</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>net.bytebuddy</groupId>
<artifactId>byte-buddy</artifactId>
<version>1.9.13</version>
<version>1.10.4</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>net.bytebuddy</groupId>
<artifactId>byte-buddy-agent</artifactId>
<version>1.9.13</version>
<version>1.10.4</version>
<scope>test</scope>
</dependency>
</dependencies>
@ -97,7 +92,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-jar-plugin</artifactId>
<version>3.1.2</version>
<version>3.2.0</version>
<configuration>
<archive>
<manifestEntries>
@ -121,7 +116,7 @@
<dependency>
<groupId>org.jacoco</groupId>
<artifactId>org.jacoco.agent</artifactId>
<version>0.8.4</version>
<version>0.8.5</version>
<classifier>runtime</classifier>
</dependency>
</dependencies>
@ -130,7 +125,7 @@
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
<version>0.8.4</version>
<version>0.8.5</version>
<executions>
<execution>
<id>default-instrument</id>
@ -180,7 +175,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-source-plugin</artifactId>
<version>3.1.0</version>
<version>3.2.0</version>
<executions>
<execution>
<id>attach-sources</id>
@ -204,9 +199,10 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.1.0</version>
<version>3.1.1</version>
<configuration>
<overview>${basedir}/src/main/javadoc/overview.html</overview>
<source>1.8</source>
</configuration>
<executions>
<execution>

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2018 Stefan Kalscheuer
* Copyright 2016-2019 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -17,6 +17,7 @@
package de.stklcode.pubtrans.ura;
import com.fasterxml.jackson.databind.ObjectMapper;
import de.stklcode.pubtrans.ura.model.Message;
import de.stklcode.pubtrans.ura.model.Stop;
import de.stklcode.pubtrans.ura.model.Trip;
import de.stklcode.pubtrans.ura.reader.AsyncUraTripReader;
@ -58,14 +59,21 @@ public class UraClient implements Serializable {
private static final String PAR_ESTTIME = "EstimatedTime";
private static final String PAR_TOWARDS = "Towards";
private static final String PAR_CIRCLE = "Circle";
private static final String PAR_MSG_UUID = "MessageUUID";
private static final String PAR_MSG_TYPE = "MessageType";
private static final String PAR_MSG_PRIORITY = "MessagePriority";
private static final String PAR_MSG_TEXT = "MessageText";
private static final Integer RES_TYPE_STOP = 0;
private static final Integer RES_TYPE_PREDICTION = 1;
private static final Integer RES_TYPE_FLEX_MESSAGE = 2;
private static final Integer RES_TYPE_URA_VERSION = 4;
private static final String[] REQUEST_STOP = {PAR_STOP_NAME, PAR_STOP_ID, PAR_STOP_INDICATOR, PAR_STOP_STATE, PAR_GEOLOCATION};
private static final String[] REQUEST_TRIP = {PAR_STOP_NAME, PAR_STOP_ID, PAR_STOP_INDICATOR, PAR_STOP_STATE, PAR_GEOLOCATION,
PAR_VISIT_NUMBER, PAR_LINE_ID, PAR_LINE_NAME, PAR_DIR_ID, PAR_DEST_NAME, PAR_DEST_TEXT, PAR_VEHICLE_ID, PAR_TRIP_ID, PAR_ESTTIME};
private static final String[] REQUEST_MESSAGE = {PAR_STOP_NAME, PAR_STOP_ID, PAR_STOP_INDICATOR, PAR_STOP_STATE, PAR_GEOLOCATION,
PAR_MSG_UUID, PAR_MSG_TYPE, PAR_MSG_PRIORITY, PAR_MSG_TEXT};
private final String baseURL;
private final String instantURL;
@ -248,6 +256,8 @@ public class UraClient implements Serializable {
*
* @param query The query.
* @param consumer Consumer(s) for single trips.
* @return Trip reader.
* @throws IOException Error reading response.
* @see #getTripsStream(Query, List)
* @since 1.2.0
*/
@ -260,6 +270,8 @@ public class UraClient implements Serializable {
*
* @param query The query.
* @param consumers Consumer(s) for single trips.
* @return Trip reader.
* @throws IOException Error retrieving stream response.
* @since 1.2.0
*/
public AsyncUraTripReader getTripsStream(final Query query, final List<Consumer<Trip>> consumers) throws IOException {
@ -278,7 +290,7 @@ public class UraClient implements Serializable {
/**
* Get list of stops without filters.
*
* @return Lhe list.
* @return The list of stops.
*/
public List<Stop> getStops() {
return getStops(new Query());
@ -309,6 +321,61 @@ public class UraClient implements Serializable {
return stops;
}
/**
* Get list of messages.
*
* @return List of messages.
* @since 1.3
*/
public List<Message> getMessages() {
return getMessages(new Query(), null);
}
/**
* Get list of messages.
* If forStops() has been called, those will be used as filter.
*
* @param query The query.
* @return List of trips.
* @since 1.3
*/
public List<Message> getMessages(final Query query) {
return getMessages(query, null);
}
/**
* Get list of messages for given stopIDs with result limit.
*
* @param query The query.
* @param limit Maximum number of results.
* @return List of trips.
* @since 1.3
*/
public List<Message> getMessages(final Query query, final Integer limit) {
List<Message> messages = new ArrayList<>();
try (InputStream is = requestInstant(REQUEST_MESSAGE, query);
BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
String version = null;
String line = br.readLine();
while (line != null && (limit == null || messages.size() < limit)) {
List l = mapper.readValue(line, List.class);
/* Check if result exists and has correct response type */
if (l != null && !l.isEmpty()) {
if (l.get(0).equals(RES_TYPE_URA_VERSION)) {
version = l.get(1).toString();
} else if (l.get(0).equals(RES_TYPE_FLEX_MESSAGE)) {
messages.add(new Message(l, version));
}
}
line = br.readLine();
}
} catch (IOException e) {
throw new IllegalStateException("Failed to read from API", e);
}
return messages;
}
/**
* Issue request to instant endpoint and return input stream.
*
@ -367,7 +434,7 @@ public class UraClient implements Serializable {
*
* @param url The URL.
* @return Input Stream of results.
* @throws IOException Error opening conneciton or reading data.
* @throws IOException Error opening connection or reading data.
*/
private InputStream request(String url) throws IOException {
return new URL(url).openStream();
@ -501,6 +568,8 @@ public class UraClient implements Serializable {
* Get trips for set filters.
*
* @param consumer Consumer for single trips.
* @return Trip reader.
* @throws IOException Errors retrieving stream response.
* @see #getTripsStream(List)
* @since 1.2.0
*/
@ -512,10 +581,22 @@ public class UraClient implements Serializable {
* Get trips for set filters.
*
* @param consumers Consumers for single trips.
* @return Trip reader.
* @throws IOException Errors retrieving stream response.
* @since 1.2.0
*/
public AsyncUraTripReader getTripsStream(List<Consumer<Trip>> consumers) throws IOException {
return UraClient.this.getTripsStream(this, consumers);
}
/**
* Get trips for set filters.
*
* @return List of matching messages.
* @since 1.3
*/
public List<Message> getMessages() {
return UraClient.this.getMessages(this);
}
}
}

View File

@ -0,0 +1,165 @@
package de.stklcode.pubtrans.ura.model;
import java.io.IOException;
import java.util.List;
/**
* Entity for a message.
*
* @author Stefan Kalscheuer
* @since 1.3
*/
public class Message implements Model {
private static final int MSG_UUID = 7;
private static final int MSG_TYPE = 8;
private static final int MSG_PRIORITY = 9;
private static final int MSG_TEXT = 10;
private static final int NUM_OF_FIELDS = 11;
private final Stop stop;
private final String uuid;
private final Integer type;
private final Integer priority;
private final String text;
/**
* Construct Message object from complete set of data.
*
* @param stopID Stop ID.
* @param stopName Stop name.
* @param stopIndicator Stop Indicator.
* @param stopState Stop state.
* @param stopLatitude Stop geolocation latitude.
* @param stopLongitude Stop geolocation latitude.
* @param msgUUID Message UUID.
* @param msgType Message type.
* @param msgPriority Message priority.
* @param msgText Message text.
*/
public Message(final String stopID,
final String stopName,
final String stopIndicator,
final Integer stopState,
final Double stopLatitude,
final Double stopLongitude,
final String msgUUID,
final Integer msgType,
final Integer msgPriority,
final String msgText) {
this(new Stop(stopID,
stopName,
stopIndicator,
stopState,
stopLatitude,
stopLongitude),
msgUUID,
msgType,
msgPriority,
msgText);
}
/**
* Construct Message object from Stop model and set of additional data.
*
* @param stop Stop model
* @param msgUUID Message UUID.
* @param msgType Message type.
* @param msgPriority Message priority.
* @param msgText Message text.
*/
public Message(final Stop stop,
final String msgUUID,
final Integer msgType,
final Integer msgPriority,
final String msgText) {
this.stop = stop;
this.uuid = msgUUID;
this.type = msgType;
this.priority = msgPriority;
this.text = msgText;
}
/**
* Construct Message object from raw list of attributes parsed from JSON.
*
* @param raw List of attributes from JSON line
* @throws IOException Thrown on invalid line format.
*/
public Message(final List raw) throws IOException {
this(raw, null);
}
/**
* Construct Message object from raw list of attributes parsed from JSON with explicitly specified version.
*
* @param raw List of attributes from JSON line
* @param version API version
* @throws IOException Thrown on invalid line format.
*/
public Message(final List raw, final String version) throws IOException {
if (raw == null || raw.size() < NUM_OF_FIELDS) {
throw new IOException("Invalid number of fields");
}
stop = new Stop(raw);
if (raw.get(MSG_UUID) instanceof String) {
uuid = (String) raw.get(MSG_UUID);
} else {
throw Model.typeErrorString(MSG_UUID, raw.get(MSG_UUID).getClass());
}
if (raw.get(MSG_TYPE) instanceof Integer) {
type = (Integer) raw.get(MSG_TYPE);
} else {
throw Model.typeError(MSG_TYPE, raw.get(MSG_TYPE).getClass(), "Integer");
}
if (raw.get(MSG_PRIORITY) instanceof Integer) {
priority = (Integer) raw.get(MSG_PRIORITY);
} else {
throw Model.typeError(MSG_PRIORITY, raw.get(MSG_PRIORITY).getClass(), "Integer");
}
if (raw.get(MSG_TEXT) instanceof String) {
text = (String) raw.get(MSG_TEXT);
} else {
throw Model.typeErrorString(MSG_TEXT, raw.get(MSG_TEXT).getClass());
}
}
/**
* @return The affected stop.
*/
public Stop getStop() {
return stop;
}
/**
* @return Message's unique identifier.
*/
public String getUuid() {
return uuid;
}
/**
* @return Message type.
*/
public Integer getType() {
return type;
}
/**
* @return Message priority. Lower value equals higher priority.
*/
public Integer getPriority() {
return priority;
}
/**
* @return Message text.
*/
public String getText() {
return text;
}
}

View File

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

View File

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

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2018 Stefan Kalscheuer
* Copyright 2016-2019 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -145,7 +145,7 @@ public final class Trip implements Model {
}
/**
* Construct Stop object from raw list of attributes parsed from JSON with explicitly specified version.
* Construct Trip object from raw list of attributes parsed from JSON with explicitly specified version.
*
* @param raw List of attributes from JSON line
* @param version API version

View File

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

View File

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

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2018 Stefan Kalscheuer
* Copyright 2016-2019 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -30,7 +30,7 @@ import java.util.concurrent.*;
import java.util.function.Consumer;
/**
* Asynchronous stream reader foR URA stream API.
* Asynchronous stream reader for URA stream API.
* <p>
* This reader provides a handler for asynchronous stream events.
*
@ -44,7 +44,7 @@ public class AsyncUraTripReader implements AutoCloseable {
private final List<Consumer<Trip>> consumers;
private final URL url;
private CompletableFuture<Void> future;
private boolean cancelled;
private boolean canceled;
/**
* Initialize trip reader.
@ -70,7 +70,7 @@ public class AsyncUraTripReader implements AutoCloseable {
}
public void open() {
// Throw exeption, if future is already present.
// Throw exception, if future is already present.
if (future != null) {
throw new IllegalStateException("Reader already opened");
}
@ -82,7 +82,7 @@ public class AsyncUraTripReader implements AutoCloseable {
BufferedReader br = new BufferedReader(new InputStreamReader(is))) {
String version = null;
String line = br.readLine();
while (line != null && !this.cancelled) {
while (line != null && !this.canceled) {
List l = mapper.readValue(line, List.class);
// Check if result exists and has correct response type.
if (l != null && !l.isEmpty()) {
@ -113,8 +113,8 @@ public class AsyncUraTripReader implements AutoCloseable {
/**
* Close the reader.
* This is done by signaliung cancel to the asyncronous task. If the task is not completed
* within 1 second however it is cancelled hard.
* This is done by signaling cancel to the asynchronous task. If the task is not completed
* within 1 second however it is canceled hard.
*/
@Override
public void close() {
@ -124,7 +124,7 @@ public class AsyncUraTripReader implements AutoCloseable {
}
// Signal cancelling to gracefully stop future.
cancelled = true;
canceled = true;
try {
future.get(1, TimeUnit.SECONDS);
} catch (InterruptedException e) {

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2018 Stefan Kalscheuer
* Copyright 2016-2019 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,13 +16,14 @@
package de.stklcode.pubtrans.ura;
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.Test;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import java.io.IOException;
import java.io.InputStream;
@ -331,6 +332,43 @@ public class UraClientTest {
}
@Test
public void getMessages() {
// Mock the HTTP call.
mockHttpToFile("instant_V1_messages.txt");
// Get messages without filter and verify some values.
List<Message> messages = new UraClient("mocked")
.getMessages();
assertThat(messages, hasSize(2));
assertThat(messages.get(0).getStop().getId(), is("100707"));
assertThat(messages.get(0).getUuid(), is("016e1231d4e30014_100707"));
assertThat(messages.get(1).getStop().getName(), is("Herzogenr. Rathaus"));
assertThat(messages.get(1).getUuid(), is("016e2cc3a3750006_210511"));
assertThat(messages.get(0).getType(), is(0));
assertThat(messages.get(1).getPriority(), is(0));
assertThat(messages.get(0).getText(), is("Sehr geehrte Fahrgäste, wegen Strassenbauarbeiten kann diese Haltestelle nicht von den Bussen der Linien 17, 44 und N2 angefahren werden."));
assertThat(messages.get(1).getText(), is("Sehr geehrte Fahrgäste, diese Haltestelle wird vorübergehend von den Linien 47, 147 und N3 nicht angefahren."));
}
@Test
public void getMessagesForStop() {
// Mock the HTTP call.
mockHttpToFile("instant_V2_messages_stop.txt");
// Get trips for stop ID 100707 (Berensberger Str.) and verify some values.
List<Message> messages = new UraClient("mocked")
.forStops("100707")
.getMessages();
assertThat(messages, hasSize(1));
assertThat(messages.stream().filter(t -> !t.getStop().getId().equals("100707")).findAny(), is(Optional.empty()));
assertThat(messages.get(0).getUuid(), is("016e1231d4e30014_100707"));
assertThat(messages.get(0).getType(), is(0));
assertThat(messages.get(0).getPriority(), is(3));
assertThat(messages.get(0).getText(), is("Sehr geehrte Fahrgäste, wegen Strassenbauarbeiten kann diese Haltestelle nicht von den Bussen der Linien 17, 44 und N2 angefahren werden."));
}
private static void mockHttpToFile(String newResourceFile) {
mockResource = newResourceFile;
}

View File

@ -0,0 +1,153 @@
/*
* Copyright 2016-2019 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package de.stklcode.pubtrans.ura.model;
import org.junit.jupiter.api.Test;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import static org.hamcrest.CoreMatchers.instanceOf;
import static org.hamcrest.CoreMatchers.notNullValue;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.core.Is.is;
import static org.junit.jupiter.api.Assertions.fail;
/**
* Unit test for the {@link Message} meta model.
*
* @author Stefan Kalscheuer
*/
public class MessageTest {
@Test
public void basicConstructorTest() {
Message message = new Message("sid",
"name",
"indicator",
1,
2.345,
6.789,
"msg_uuid",
1,
3,
"message text");
assertThat(message.getStop().getId(), is("sid"));
assertThat(message.getStop().getName(), is("name"));
assertThat(message.getStop().getIndicator(), is("indicator"));
assertThat(message.getStop().getState(), is(1));
assertThat(message.getStop().getLatitude(), is(2.345));
assertThat(message.getStop().getLongitude(), is(6.789));
assertThat(message.getUuid(), is("msg_uuid"));
assertThat(message.getType(), is(1));
assertThat(message.getPriority(), is(3));
assertThat(message.getText(), is("message text"));
}
@Test
public void listConstructorTest() {
/* Create valid raw data list */
List<Object> raw = new ArrayList<>();
raw.add(1);
raw.add("stopName");
raw.add("stopId");
raw.add("stopIndicator");
raw.add(9);
raw.add(8.765);
raw.add(43.21);
raw.add("msg_uuid");
raw.add(1);
raw.add(3);
raw.add("message text");
try {
Message message = new Message(raw);
assertThat(message.getStop().getId(), is("stopId"));
assertThat(message.getStop().getName(), is("stopName"));
assertThat(message.getStop().getIndicator(), is("stopIndicator"));
assertThat(message.getStop().getState(), is(9));
assertThat(message.getStop().getLatitude(), is(8.765));
assertThat(message.getStop().getLongitude(), is(43.21));
assertThat(message.getUuid(), is("msg_uuid"));
assertThat(message.getType(), is(1));
assertThat(message.getPriority(), is(3));
assertThat(message.getText(), is("message text"));
} catch (IOException e) {
fail("Creation of Message from valid list failed: " + e.getMessage());
}
/* Excess elements should be ignored */
raw.add("foo");
try {
Message message = new Message(raw);
assertThat(message, is(notNullValue()));
raw.remove(11);
} catch (IOException e) {
fail("Creation of Message from valid list failed: " + e.getMessage());
}
/* Test exceptions on invalid data */
List<Object> invalid = new ArrayList<>(raw);
invalid.remove(7);
invalid.add(7, 123L);
try {
new Message(invalid);
fail("Creation of Message with invalid UUID field successful");
} catch (Exception e) {
assertThat(e, is(instanceOf(IOException.class)));
}
invalid = new ArrayList<>(raw);
invalid.remove(8);
invalid.add(8, "abc");
try {
new Message(invalid);
fail("Creation of Message with invalid type field successful");
} catch (Exception e) {
assertThat(e, is(instanceOf(IOException.class)));
}
invalid = new ArrayList<>(raw);
invalid.remove(9);
invalid.add(9, "xyz");
try {
new Message(invalid);
fail("Creation of Message with invalid priority field successful");
} catch (Exception e) {
assertThat(e, is(instanceOf(IOException.class)));
}
invalid = new ArrayList<>(raw);
invalid.remove(10);
invalid.add(10, 1.23);
try {
new Message(invalid);
fail("Creation of Message with invalid text field successful");
} catch (Exception e) {
assertThat(e, is(instanceOf(IOException.class)));
}
invalid = new ArrayList<>(raw);
invalid.remove(10);
try {
new Message(invalid);
fail("Creation of Message with too short list successful");
} catch (Exception e) {
assertThat(e, is(instanceOf(IOException.class)));
}
}
}

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2018 Stefan Kalscheuer
* Copyright 2016-2019 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -29,7 +29,7 @@ import static org.hamcrest.core.Is.is;
import static org.junit.jupiter.api.Assertions.fail;
/**
* Unit test for the Stop metamodel.
* Unit test for the {@link Stop} meta model.
*
* @author Stefan Kalscheuer
*/
@ -85,7 +85,7 @@ public class StopTest {
invalid.add(1, 5);
try {
new Stop(invalid);
fail("Creation of Stop with invalid name field successfull");
fail("Creation of Stop with invalid name field successful");
} catch (Exception e) {
assertThat(e, is(instanceOf(IOException.class)));
}
@ -95,7 +95,7 @@ public class StopTest {
invalid.add(2, 0);
try {
new Stop(invalid);
fail("Creation of Stop with invalid id field successfull");
fail("Creation of Stop with invalid id field successful");
} catch (Exception e) {
assertThat(e, is(instanceOf(IOException.class)));
}
@ -105,7 +105,7 @@ public class StopTest {
invalid.add(3, -1.23);
try {
new Stop(invalid);
fail("Creation of Stop with invalid indicator field successfull");
fail("Creation of Stop with invalid indicator field successful");
} catch (Exception e) {
assertThat(e, is(instanceOf(IOException.class)));
}
@ -115,7 +115,7 @@ public class StopTest {
invalid.add(4, "foo");
try {
new Stop(invalid);
fail("Creation of Stop with invalid state field successfull");
fail("Creation of Stop with invalid state field successful");
} catch (Exception e) {
assertThat(e, is(instanceOf(IOException.class)));
}
@ -125,7 +125,7 @@ public class StopTest {
invalid.add(5, "123");
try {
new Stop(invalid);
fail("Creation of Stop with invalid latitude field successfull");
fail("Creation of Stop with invalid latitude field successful");
} catch (Exception e) {
assertThat(e, is(instanceOf(IOException.class)));
}
@ -135,7 +135,7 @@ public class StopTest {
invalid.add(6, 456);
try {
new Stop(invalid);
fail("Creation of Stop with invalid longitude field successfull");
fail("Creation of Stop with invalid longitude field successful");
} catch (Exception e) {
assertThat(e, is(instanceOf(IOException.class)));
}
@ -144,7 +144,7 @@ public class StopTest {
invalid.remove(6);
try {
new Stop(invalid);
fail("Creation of Stop with too short list successfull");
fail("Creation of Stop with too short list successful");
} catch (Exception e) {
assertThat(e, is(instanceOf(IOException.class)));
}

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2018 Stefan Kalscheuer
* Copyright 2016-2019 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -29,7 +29,7 @@ import static org.hamcrest.core.Is.is;
import static org.junit.jupiter.api.Assertions.fail;
/**
* Unit test for the Trip metamodel.
* Unit test for the {@link Trip} meta model.
*
* @author Stefan Kalscheuer
*/
@ -156,7 +156,7 @@ public class TripTest {
invalid.add(7, "123");
try {
new Trip(invalid);
fail("Creation of Trip with invalid visitID field successfull");
fail("Creation of Trip with invalid visitID field successful");
} catch (Exception e) {
assertThat(e, is(instanceOf(IOException.class)));
}
@ -166,7 +166,7 @@ public class TripTest {
invalid.add(8, 25);
try {
new Trip(invalid);
fail("Creation of Trip with invalid lineID field successfull");
fail("Creation of Trip with invalid lineID field successful");
} catch (Exception e) {
assertThat(e, is(instanceOf(IOException.class)));
}
@ -176,7 +176,7 @@ public class TripTest {
invalid.add(9, 234L);
try {
new Trip(invalid);
fail("Creation of Trip with invalid line name field successfull");
fail("Creation of Trip with invalid line name field successful");
} catch (Exception e) {
assertThat(e, is(instanceOf(IOException.class)));
}
@ -186,7 +186,7 @@ public class TripTest {
invalid.add(10, "7"); // Strings are generally OK, but 7 is out of range (#2).
try {
new Trip(invalid);
fail("Creation of Trip with invalid directionID field successfull");
fail("Creation of Trip with invalid directionID field successful");
} catch (Exception e) {
assertThat(e, is(instanceOf(IOException.class)));
}
@ -196,7 +196,7 @@ public class TripTest {
invalid.add(11, 987);
try {
new Trip(invalid);
fail("Creation of Trip with invalid destinationName field successfull");
fail("Creation of Trip with invalid destinationName field successful");
} catch (Exception e) {
assertThat(e, is(instanceOf(IOException.class)));
}
@ -206,7 +206,7 @@ public class TripTest {
invalid.add(12, 456.78);
try {
new Trip(invalid);
fail("Creation of Trip with invalid destinationText field successfull");
fail("Creation of Trip with invalid destinationText field successful");
} catch (Exception e) {
assertThat(e, is(instanceOf(IOException.class)));
}
@ -216,7 +216,7 @@ public class TripTest {
invalid.add(13, 'x');
try {
new Trip(invalid);
fail("Creation of Trip with invalid vehicleID field successfull");
fail("Creation of Trip with invalid vehicleID field successful");
} catch (Exception e) {
assertThat(e, is(instanceOf(IOException.class)));
}
@ -226,7 +226,7 @@ public class TripTest {
invalid.add(14, 1.2);
try {
new Trip(invalid);
fail("Creation of Trip with invalid id field successfull");
fail("Creation of Trip with invalid id field successful");
} catch (Exception e) {
assertThat(e, is(instanceOf(IOException.class)));
}
@ -236,7 +236,7 @@ public class TripTest {
invalid.add(15, 456);
try {
new Trip(invalid);
fail("Creation of Trip with invalid estimatedTime field successfull");
fail("Creation of Trip with invalid estimatedTime field successful");
} catch (Exception e) {
assertThat(e, is(instanceOf(IOException.class)));
}
@ -245,7 +245,7 @@ public class TripTest {
invalid.remove(15);
try {
new Trip(invalid);
fail("Creation of Trip with too short list successfull");
fail("Creation of Trip with too short list successful");
} catch (Exception e) {
assertThat(e, is(instanceOf(IOException.class)));
}
@ -254,7 +254,7 @@ public class TripTest {
invalid.set(10, 3);
try {
new Trip(invalid);
fail("Creation of Trip with direction ID 3 successfull");
fail("Creation of Trip with direction ID 3 successful");
} catch (Exception e) {
assertThat(e, is(instanceOf(IOException.class)));
}

View File

@ -1,5 +1,5 @@
/*
* Copyright 2016-2018 Stefan Kalscheuer
* Copyright 2016-2019 Stefan Kalscheuer
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
@ -27,7 +27,10 @@ import org.junit.jupiter.api.Test;
import java.io.*;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.util.*;
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;
@ -35,10 +38,8 @@ import java.util.concurrent.atomic.AtomicInteger;
import static net.bytebuddy.implementation.MethodDelegation.to;
import static net.bytebuddy.matcher.ElementMatchers.named;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.empty;
import static org.hamcrest.core.Is.is;
import static org.junit.Assume.assumeThat;
import static org.junit.Assume.assumeTrue;
import static org.junit.jupiter.api.Assumptions.assumeTrue;
/**
* Unit test for the asynchronous URA Trip reader.
@ -91,15 +92,15 @@ public class AsyncUraTripReaderTest {
)
);
// Open the rewader.
// Open the reader.
tr.open();
// Read for 1 second.
TimeUnit.SECONDS.sleep(1);
assumeThat("Trips should empty after 1s without reading", trips, is(empty()));
assumeTrue(trips.isEmpty(), "Trips should empty after 1s without reading");
// Now write a single line to the stream pipe.
assumeTrue("First line (version info) should be written", writeNextLine());
assumeTrue("Second line (first record) should be written", writeNextLine());
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;
@ -136,10 +137,10 @@ public class AsyncUraTripReaderTest {
tr.open();
// Read for 1 second.
TimeUnit.SECONDS.sleep(1);
assumeThat("Trips should empty after 1s without reading", trips, is(empty()));
assumeTrue(trips.isEmpty(), "Trips should empty after 1s without reading");
assumeTrue("First line of v2 (version info) should be written", writeNextLine());
assumeTrue("Second line of v2 (first record) should be written", writeNextLine());
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);
@ -202,11 +203,11 @@ public class AsyncUraTripReaderTest {
// Read for 100ms.
TimeUnit.MILLISECONDS.sleep(100);
assumeThat("Trips should empty after 100ms without reading", trips, is(empty()));
assumeTrue(trips.isEmpty(), "Trips should empty after 100ms without reading");
// Now write a single line to the stream pipe.
assumeTrue("First line (version info) should be written", writeNextLine());
assumeTrue("Second line (first record) should be written", writeNextLine());
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;
@ -214,7 +215,7 @@ public class AsyncUraTripReaderTest {
TimeUnit.MILLISECONDS.sleep(100);
}
assumeThat("Unexpected number of trips after first entry", trips.size(), is(1));
assumeTrue(1 == trips.size(), "Unexpected number of trips after first entry");
// Close the stream.
mockOutputStream.close();
@ -252,7 +253,7 @@ public class AsyncUraTripReaderTest {
* Write next line from the buffer to the mocked stream pipe.
*
* @return {@code true} if a line has been written.
* @throws IOException Errir writing the data.
* @throws IOException Error writing the data.
*/
private static boolean writeNextLine() throws IOException {
String line = MOCK_LINES.poll();

View File

@ -0,0 +1,3 @@
[4,"1.0",1572882473479]
[2,"Berensberger Str.","100707","",0,50.8087069,6.0607177,"016e1231d4e30014_100707",0,3,"Sehr geehrte Fahrgäste, wegen Strassenbauarbeiten kann diese Haltestelle nicht von den Bussen der Linien 17, 44 und N2 angefahren werden."]
[2,"Herzogenr. Rathaus","210511","",0,50.8718175,6.1025675,"016e2cc3a3750006_210511",0,0,"Sehr geehrte Fahrgäste, diese Haltestelle wird vorübergehend von den Linien 47, 147 und N3 nicht angefahren."]

View File

@ -0,0 +1,2 @@
[4,"2.0",1572882473479]
[2,"Berensberger Str.","100707","",0,50.8087069,6.0607177,"016e1231d4e30014_100707",0,3,"Sehr geehrte Fahrgäste, wegen Strassenbauarbeiten kann diese Haltestelle nicht von den Bussen der Linien 17, 44 und N2 angefahren werden."]