1 package net.pterodactylus.sone.core;
3 import static com.google.common.base.Objects.equal;
4 import static java.lang.String.format;
5 import static java.util.logging.Level.OFF;
6 import static org.hamcrest.MatcherAssert.assertThat;
7 import static org.hamcrest.Matchers.containsInAnyOrder;
8 import static org.hamcrest.Matchers.empty;
9 import static org.hamcrest.Matchers.is;
10 import static org.hamcrest.Matchers.notNullValue;
11 import static org.hamcrest.Matchers.nullValue;
12 import static org.hamcrest.collection.IsIterableContainingInOrder.contains;
13 import static org.mockito.Matchers.anyString;
14 import static org.mockito.Mockito.mock;
15 import static org.mockito.Mockito.when;
17 import java.io.InputStream;
18 import java.util.logging.Logger;
20 import net.pterodactylus.sone.core.SoneParser.DuplicateField;
21 import net.pterodactylus.sone.core.SoneParser.InvalidParentAlbum;
22 import net.pterodactylus.sone.core.SoneParser.InvalidProtocolVersion;
23 import net.pterodactylus.sone.core.SoneParser.InvalidXml;
24 import net.pterodactylus.sone.core.SoneParser.MalformedTime;
25 import net.pterodactylus.sone.core.SoneParser.MalformedXml;
26 import net.pterodactylus.sone.data.Client;
27 import net.pterodactylus.sone.data.Image;
28 import net.pterodactylus.sone.data.Post;
29 import net.pterodactylus.sone.data.PostReply;
30 import net.pterodactylus.sone.data.Profile.Field;
31 import net.pterodactylus.sone.data.Sone;
32 import net.pterodactylus.sone.database.Database;
33 import net.pterodactylus.sone.database.SoneBuilder.SoneCreated;
34 import net.pterodactylus.sone.database.memory.MemoryDatabase;
36 import com.google.common.base.Optional;
37 import org.hamcrest.Description;
38 import org.hamcrest.Matcher;
39 import org.hamcrest.TypeSafeMatcher;
40 import org.junit.Test;
43 * Unit test for {@link SoneParser}.
45 * @author <a href="mailto:d.roden@xplosion.de">David Roden</a>
47 public class SoneParserTest {
50 Logger.getLogger("").setLevel(OFF);
53 private final Core core = mock(Core.class);
54 private final Database database = new MemoryDatabase(null);
55 private final Sone originalSone = database.newSoneBuilder().by("test").using(new Client("TestClient", "1.0")).build(Optional.<SoneCreated>absent());
56 private final SoneParser soneParser = new SoneParser();
58 public SoneParserTest() {
59 Optional<Image> image = mock(Optional.class);
60 when(core.getImage(anyString())).thenReturn(image);
63 @Test(expected = InvalidXml.class)
64 public void verifyThatAnInvalidXmlDocumentIsNotParsed() {
65 soneParser.parseSone(database, originalSone, getXml("invalid-xml"));
68 @Test(expected = InvalidProtocolVersion.class)
69 public void verifyThatANegativeProtocolVersionCausesAnError() {
70 soneParser.parseSone(database, originalSone, getXml("negative-protocol-version"));
73 @Test(expected = InvalidProtocolVersion.class)
74 public void verifyThatATooLargeProtocolVersionCausesAnError() {
75 soneParser.parseSone(database, originalSone, getXml("too-large-protocol-version"));
78 @Test(expected = MalformedXml.class)
79 public void verifyThatAMissingTimeCausesAnError() {
80 soneParser.parseSone(database, originalSone, getXml("missing-time"));
84 public void verifyThatAMissingClientCausesTheOriginalClientToBeUsed() {
85 Sone sone = soneParser.parseSone(database, originalSone, getXml("missing-client"));
86 assertThat(sone, notNullValue());
87 assertThat(sone.getClient(), notNullValue());
88 assertThat(sone.getClient(), is(originalSone.getClient()));
92 public void verifyThatAnInvalidClientCausesTheOriginalClientToBeUsed() {
93 Sone sone = soneParser.parseSone(database, originalSone, getXml("invalid-client"));
94 assertThat(sone, notNullValue());
95 assertThat(sone.getClient(), notNullValue());
96 assertThat(sone.getClient(), is(originalSone.getClient()));
99 @Test(expected = MalformedXml.class)
100 public void verifyThatAMissingProfileCausesAnError() {
101 soneParser.parseSone(database, originalSone, getXml("missing-profile"));
104 @Test(expected = MalformedXml.class)
105 public void verifyThatInvalidFieldsCauseAnError() {
106 soneParser.parseSone(database, originalSone, getXml("invalid-field"));
109 @Test(expected = DuplicateField.class)
110 public void verifyThatDuplicateFieldsCauseAnError() {
111 soneParser.parseSone(database, originalSone, getXml("duplicate-field"));
115 public void verifyThatMissingPostsDoNotCauseAnError() {
116 soneParser.parseSone(database, originalSone, getXml("missing-posts"));
119 @Test(expected = MalformedXml.class)
120 public void verifyThatInvalidPostsCauseAnError() {
121 soneParser.parseSone(database, originalSone, getXml("invalid-posts"));
124 @Test(expected = MalformedTime.class)
125 public void verifyThatAMalformedTimeCausesAnError() {
126 soneParser.parseSone(database, originalSone, getXml("invalid-post-time"));
130 public void verifyThatMissingRepliesDoNotCauseAnError() {
131 soneParser.parseSone(database, originalSone, getXml("missing-replies"));
134 @Test(expected = MalformedXml.class)
135 public void verifyThatInvalidRepliesCauseAnError() {
136 soneParser.parseSone(database, originalSone, getXml("invalid-replies"));
139 @Test(expected = MalformedTime.class)
140 public void verifyThatAMalformedReplyTimeCausesAnError() {
141 soneParser.parseSone(database, originalSone, getXml("invalid-reply-time"));
145 public void verifyThatAMissingPostLikesSectionDoesNotCauseAnError() {
146 soneParser.parseSone(database, originalSone, getXml("missing-post-likes"));
150 public void verifyThatAMissingReplyLikesSectionDoesNotCauseAnError() {
151 soneParser.parseSone(database, originalSone, getXml("missing-reply-likes"));
155 public void verifyThatMissingAlbumsSectionDoNotCauseAnError() {
156 soneParser.parseSone(database, originalSone, getXml("missing-albums"));
159 @Test(expected = MalformedXml.class)
160 public void verifyThatAnInvalidAlbumCausesAnError() {
161 soneParser.parseSone(database, originalSone, getXml("invalid-album"));
164 @Test(expected = InvalidParentAlbum.class)
165 public void verifyThatAnInvalidParentAlbumCausesAnError() {
166 soneParser.parseSone(database, originalSone, getXml("invalid-parent-album"));
170 public void verifyThatAnEmptyProfileIsParsedWithoutError() {
171 Sone sone = soneParser.parseSone(database, originalSone, getXml("empty-profile"));
172 assertThat(sone.getProfile().getFirstName(), nullValue());
173 assertThat(sone.getProfile().getMiddleName(), nullValue());
174 assertThat(sone.getProfile().getLastName(), nullValue());
175 assertThat(sone.getProfile().getBirthYear(), nullValue());
176 assertThat(sone.getProfile().getBirthMonth(), nullValue());
177 assertThat(sone.getProfile().getBirthDay(), nullValue());
178 assertThat(sone.getProfile().getAvatar(), nullValue());
179 assertThat(sone.getProfile().getFields(), empty());
183 public void verifyThatTheCreatedSoneMeetsAllExpectations() {
184 Sone sone = soneParser.parseSone(database, originalSone, getXml("complete"));
185 assertThat(sone, notNullValue());
186 assertThat(sone.getTime(), is(1382419919000L));
187 assertThat(sone.getClient(), notNullValue());
188 assertThat(sone.getClient().getName(), is("Sone"));
189 assertThat(sone.getClient().getVersion(), is("0.8.7"));
190 assertThat(sone.getProfile(), notNullValue());
191 assertThat(sone.getProfile().getFirstName(), is("First"));
192 assertThat(sone.getProfile().getMiddleName(), is("M."));
193 assertThat(sone.getProfile().getLastName(), is("Last"));
194 assertThat(sone.getProfile().getBirthYear(), is(2013));
195 assertThat(sone.getProfile().getBirthMonth(), is(10));
196 assertThat(sone.getProfile().getBirthDay(), is(22));
197 assertThat(sone.getProfile().getAvatar(), is("96431abe-3add-11e3-8a46-67047503bf6d"));
198 assertThat(sone.getProfile().getFields(), contains(
199 fieldMatcher("Field1", "Value1"),
200 fieldMatcher("Field2", "Value2")
202 assertThat(sone.getPosts(), contains(
203 postMatcher("d8c9586e-3adb-11e3-bb31-171fc040e645", "0rpD4gL8mszav2trndhIdKIxvKUCNAe2kjA3dLV8CVU", 1382420181000L, "Hello, User!"),
204 postMatcher("bbb7ebf0-3adb-11e3-8a0b-630cd8f21cf3", null, 1382420140000L, "Hello, World!")
206 assertThat(sone.getReplies(), containsInAnyOrder(
207 postReplyMatcher("f09fa448-3adb-11e3-a783-ab54a11aacc4", "bbb7ebf0-3adb-11e3-8a0b-630cd8f21cf3", 1382420224000L, "Talking to myself."),
208 postReplyMatcher("0a376440-3adc-11e3-8f45-c7cc157436a5", "11ebe86e-3adc-11e3-b7b9-7f2c88018a33", 1382420271000L, "Talking to somebody I can't see.")
210 assertThat(sone.getLikedPostIds(), containsInAnyOrder(
211 "bbb7ebf0-3adb-11e3-8a0b-630cd8f21cf3",
212 "305d85e6-3adc-11e3-be45-8b53dd91f0af"
214 assertThat(sone.getLikedReplyIds(), containsInAnyOrder(
215 "f09fa448-3adb-11e3-a783-ab54a11aacc4",
216 "3ba28960-3adc-11e3-93c7-6713d170f44c"
220 private Matcher<PostReply> postReplyMatcher(final String id, final String postId, final long time, final String text) {
221 return new TypeSafeMatcher<PostReply>() {
223 protected boolean matchesSafely(PostReply postReply) {
224 return postReply.getId().equals(id) && postReply.getPostId().equals(postId) && (postReply.getTime() == time) && postReply.getText().equals(text);
228 public void describeTo(Description description) {
229 description.appendText("PostReply(")
230 .appendValue(id).appendText(", ")
231 .appendValue(postId).appendText(", ")
232 .appendValue(time).appendText(", ")
233 .appendValue(text).appendText(")");
237 protected void describeMismatchSafely(PostReply postReply, Description mismatchDescription) {
238 mismatchDescription.appendText("PostReply(")
239 .appendValue(postReply.getId()).appendText(", ")
240 .appendValue(postReply.getPostId()).appendText(", ")
241 .appendValue(postReply.getTime()).appendText(", ")
242 .appendValue(postReply.getText()).appendText(")");
247 private Matcher<Post> postMatcher(final String id, final String recipient, final long time, final String text) {
248 return new TypeSafeMatcher<Post>() {
250 protected boolean matchesSafely(Post post) {
251 return post.getId().equals(id) && equal(post.getRecipientId().orNull(), recipient) && (post.getTime() == time) && post.getText().equals(text);
255 public void describeTo(Description description) {
256 description.appendText("Post(")
257 .appendValue(id).appendText(", ")
258 .appendValue(recipient).appendText(", ")
259 .appendValue(time).appendText(", ")
260 .appendValue(text).appendText(")");
264 protected void describeMismatchSafely(Post post, Description mismatchDescription) {
265 mismatchDescription.appendText("Post(")
266 .appendValue(post.getId()).appendText(", ")
267 .appendValue(post.getRecipientId().orNull()).appendText(", ")
268 .appendValue(post.getTime()).appendText(", ")
269 .appendValue(post.getText()).appendText(")");
274 private Matcher<Field> fieldMatcher(final String name, final String value) {
275 return new TypeSafeMatcher<Field>() {
277 protected boolean matchesSafely(Field field) {
278 return field.getName().equals(name) && field.getValue().equals(value);
282 public void describeTo(Description description) {
283 description.appendText("field named ").appendValue(name).appendText(" with value ").appendValue(value);
287 protected void describeMismatchSafely(Field field, Description mismatchDescription) {
288 mismatchDescription.appendText("field named ").appendValue(field.getName()).appendText(" with value ").appendValue(field.getValue());
293 private InputStream getXml(String name) {
294 return getClass().getResourceAsStream(format("/sone-parser/%s.xml", name));