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.InvalidProtocolVersion;
22 import net.pterodactylus.sone.core.SoneParser.InvalidXml;
23 import net.pterodactylus.sone.core.SoneParser.MalformedTime;
24 import net.pterodactylus.sone.core.SoneParser.MalformedXml;
25 import net.pterodactylus.sone.data.Client;
26 import net.pterodactylus.sone.data.Image;
27 import net.pterodactylus.sone.data.Post;
28 import net.pterodactylus.sone.data.PostReply;
29 import net.pterodactylus.sone.data.Profile.Field;
30 import net.pterodactylus.sone.data.Sone;
31 import net.pterodactylus.sone.database.Database;
32 import net.pterodactylus.sone.database.SoneBuilder.SoneCreated;
33 import net.pterodactylus.sone.database.memory.MemoryDatabase;
35 import com.google.common.base.Optional;
36 import org.hamcrest.Description;
37 import org.hamcrest.Matcher;
38 import org.hamcrest.TypeSafeMatcher;
39 import org.junit.Test;
42 * Unit test for {@link SoneParser}.
44 * @author <a href="mailto:d.roden@xplosion.de">David Roden</a>
46 public class SoneParserTest {
49 Logger.getLogger("").setLevel(OFF);
52 private final Core core = mock(Core.class);
53 private final Database database = new MemoryDatabase(null);
54 private final Sone originalSone = database.newSoneBuilder().by("test").using(new Client("TestClient", "1.0")).build(Optional.<SoneCreated>absent());
55 private final SoneParser soneParser = new SoneParser();
57 public SoneParserTest() {
58 Optional<Image> image = mock(Optional.class);
59 when(core.getImage(anyString())).thenReturn(image);
62 @Test(expected = InvalidXml.class)
63 public void verifyThatAnInvalidXmlDocumentIsNotParsed() {
64 soneParser.parseSone(database, originalSone, getXml("invalid-xml"));
67 @Test(expected = InvalidProtocolVersion.class)
68 public void verifyThatANegativeProtocolVersionCausesAnError() {
69 soneParser.parseSone(database, originalSone, getXml("negative-protocol-version"));
72 @Test(expected = InvalidProtocolVersion.class)
73 public void verifyThatATooLargeProtocolVersionCausesAnError() {
74 soneParser.parseSone(database, originalSone, getXml("too-large-protocol-version"));
77 @Test(expected = MalformedXml.class)
78 public void verifyThatAMissingTimeCausesAnError() {
79 soneParser.parseSone(database, originalSone, getXml("missing-time"));
83 public void verifyThatAMissingClientCausesTheOriginalClientToBeUsed() {
84 Sone sone = soneParser.parseSone(database, originalSone, getXml("missing-client"));
85 assertThat(sone, notNullValue());
86 assertThat(sone.getClient(), notNullValue());
87 assertThat(sone.getClient(), is(originalSone.getClient()));
91 public void verifyThatAnInvalidClientCausesTheOriginalClientToBeUsed() {
92 Sone sone = soneParser.parseSone(database, originalSone, getXml("invalid-client"));
93 assertThat(sone, notNullValue());
94 assertThat(sone.getClient(), notNullValue());
95 assertThat(sone.getClient(), is(originalSone.getClient()));
98 @Test(expected = MalformedXml.class)
99 public void verifyThatAMissingProfileCausesAnError() {
100 soneParser.parseSone(database, originalSone, getXml("missing-profile"));
103 @Test(expected = MalformedXml.class)
104 public void verifyThatInvalidFieldsCauseAnError() {
105 soneParser.parseSone(database, originalSone, getXml("invalid-field"));
108 @Test(expected = DuplicateField.class)
109 public void verifyThatDuplicateFieldsCauseAnError() {
110 soneParser.parseSone(database, originalSone, getXml("duplicate-field"));
114 public void verifyThatMissingPostsDoNotCauseAnError() {
115 soneParser.parseSone(database, originalSone, getXml("missing-posts"));
118 @Test(expected = MalformedXml.class)
119 public void verifyThatInvalidPostsCauseAnError() {
120 soneParser.parseSone(database, originalSone, getXml("invalid-posts"));
123 @Test(expected = MalformedTime.class)
124 public void verifyThatAMalformedTimeCausesAnError() {
125 soneParser.parseSone(database, originalSone, getXml("invalid-post-time"));
129 public void verifyThatMissingRepliesDoNotCauseAnError() {
130 soneParser.parseSone(database, originalSone, getXml("missing-replies"));
133 @Test(expected = MalformedXml.class)
134 public void verifyThatInvalidRepliesCauseAnError() {
135 soneParser.parseSone(database, originalSone, getXml("invalid-replies"));
138 @Test(expected = MalformedTime.class)
139 public void verifyThatAMalformedReplyTimeCausesAnError() {
140 soneParser.parseSone(database, originalSone, getXml("invalid-reply-time"));
144 public void verifyThatAnEmptyProfileIsParsedWithoutError() {
145 Sone sone = soneParser.parseSone(database, originalSone, getXml("empty-profile"));
146 assertThat(sone.getProfile().getFirstName(), nullValue());
147 assertThat(sone.getProfile().getMiddleName(), nullValue());
148 assertThat(sone.getProfile().getLastName(), nullValue());
149 assertThat(sone.getProfile().getBirthYear(), nullValue());
150 assertThat(sone.getProfile().getBirthMonth(), nullValue());
151 assertThat(sone.getProfile().getBirthDay(), nullValue());
152 assertThat(sone.getProfile().getAvatar(), nullValue());
153 assertThat(sone.getProfile().getFields(), empty());
157 public void verifyThatTheCreatedSoneMeetsAllExpectations() {
158 Sone sone = soneParser.parseSone(database, originalSone, getXml("complete"));
159 assertThat(sone, notNullValue());
160 assertThat(sone.getTime(), is(1382419919000L));
161 assertThat(sone.getClient(), notNullValue());
162 assertThat(sone.getClient().getName(), is("Sone"));
163 assertThat(sone.getClient().getVersion(), is("0.8.7"));
164 assertThat(sone.getProfile(), notNullValue());
165 assertThat(sone.getProfile().getFirstName(), is("First"));
166 assertThat(sone.getProfile().getMiddleName(), is("M."));
167 assertThat(sone.getProfile().getLastName(), is("Last"));
168 assertThat(sone.getProfile().getBirthYear(), is(2013));
169 assertThat(sone.getProfile().getBirthMonth(), is(10));
170 assertThat(sone.getProfile().getBirthDay(), is(22));
171 assertThat(sone.getProfile().getAvatar(), is("96431abe-3add-11e3-8a46-67047503bf6d"));
172 assertThat(sone.getProfile().getFields(), contains(
173 fieldMatcher("Field1", "Value1"),
174 fieldMatcher("Field2", "Value2")
176 assertThat(sone.getPosts(), contains(
177 postMatcher("d8c9586e-3adb-11e3-bb31-171fc040e645", "0rpD4gL8mszav2trndhIdKIxvKUCNAe2kjA3dLV8CVU", 1382420181000L, "Hello, User!"),
178 postMatcher("bbb7ebf0-3adb-11e3-8a0b-630cd8f21cf3", null, 1382420140000L, "Hello, World!")
180 assertThat(sone.getReplies(), containsInAnyOrder(
181 postReplyMatcher("f09fa448-3adb-11e3-a783-ab54a11aacc4", "bbb7ebf0-3adb-11e3-8a0b-630cd8f21cf3", 1382420224000L, "Talking to myself."),
182 postReplyMatcher("0a376440-3adc-11e3-8f45-c7cc157436a5", "11ebe86e-3adc-11e3-b7b9-7f2c88018a33", 1382420271000L, "Talking to somebody I can't see.")
184 assertThat(sone.getLikedPostIds(), containsInAnyOrder(
185 "bbb7ebf0-3adb-11e3-8a0b-630cd8f21cf3",
186 "305d85e6-3adc-11e3-be45-8b53dd91f0af"
188 assertThat(sone.getLikedReplyIds(), containsInAnyOrder(
189 "f09fa448-3adb-11e3-a783-ab54a11aacc4",
190 "3ba28960-3adc-11e3-93c7-6713d170f44c"
194 private Matcher<PostReply> postReplyMatcher(final String id, final String postId, final long time, final String text) {
195 return new TypeSafeMatcher<PostReply>() {
197 protected boolean matchesSafely(PostReply postReply) {
198 return postReply.getId().equals(id) && postReply.getPostId().equals(postId) && (postReply.getTime() == time) && postReply.getText().equals(text);
202 public void describeTo(Description description) {
203 description.appendText("PostReply(")
204 .appendValue(id).appendText(", ")
205 .appendValue(postId).appendText(", ")
206 .appendValue(time).appendText(", ")
207 .appendValue(text).appendText(")");
211 protected void describeMismatchSafely(PostReply postReply, Description mismatchDescription) {
212 mismatchDescription.appendText("PostReply(")
213 .appendValue(postReply.getId()).appendText(", ")
214 .appendValue(postReply.getPostId()).appendText(", ")
215 .appendValue(postReply.getTime()).appendText(", ")
216 .appendValue(postReply.getText()).appendText(")");
221 private Matcher<Post> postMatcher(final String id, final String recipient, final long time, final String text) {
222 return new TypeSafeMatcher<Post>() {
224 protected boolean matchesSafely(Post post) {
225 return post.getId().equals(id) && equal(post.getRecipientId().orNull(), recipient) && (post.getTime() == time) && post.getText().equals(text);
229 public void describeTo(Description description) {
230 description.appendText("Post(")
231 .appendValue(id).appendText(", ")
232 .appendValue(recipient).appendText(", ")
233 .appendValue(time).appendText(", ")
234 .appendValue(text).appendText(")");
238 protected void describeMismatchSafely(Post post, Description mismatchDescription) {
239 mismatchDescription.appendText("Post(")
240 .appendValue(post.getId()).appendText(", ")
241 .appendValue(post.getRecipientId().orNull()).appendText(", ")
242 .appendValue(post.getTime()).appendText(", ")
243 .appendValue(post.getText()).appendText(")");
248 private Matcher<Field> fieldMatcher(final String name, final String value) {
249 return new TypeSafeMatcher<Field>() {
251 protected boolean matchesSafely(Field field) {
252 return field.getName().equals(name) && field.getValue().equals(value);
256 public void describeTo(Description description) {
257 description.appendText("field named ").appendValue(name).appendText(" with value ").appendValue(value);
261 protected void describeMismatchSafely(Field field, Description mismatchDescription) {
262 mismatchDescription.appendText("field named ").appendValue(field.getName()).appendText(" with value ").appendValue(field.getValue());
267 private InputStream getXml(String name) {
268 return getClass().getResourceAsStream(format("/sone-parser/%s.xml", name));